From d33cd9132138c7c29a5927957b6315943e07600f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tilen=20Kav=C4=8Di=C4=8D?= Date: Wed, 28 May 2025 14:37:22 +0200 Subject: [PATCH 01/22] Update IDM docs --- .../pages/airdrop/initial-domain-mapping.mdx | 49 ++++++++++++++----- 1 file changed, 36 insertions(+), 13 deletions(-) diff --git a/fern/docs/pages/airdrop/initial-domain-mapping.mdx b/fern/docs/pages/airdrop/initial-domain-mapping.mdx index 740af979..29ca2a5b 100644 --- a/fern/docs/pages/airdrop/initial-domain-mapping.mdx +++ b/fern/docs/pages/airdrop/initial-domain-mapping.mdx @@ -100,29 +100,52 @@ You can now use the chef-cli web UI to create initial domain mappings. ## Use the local UI to create initial domain mappings -The final artifact of the recipe creation process is the `initial_domain_mapping.json`, which has to be embedded in the extractor. +The chef-cli UI generates an `initial_domain_mapping.json` file that must be embedded in your extractor. This defines the options that the end-user will see when they are mapping the data. -This mapping, unlike the recipe blueprint of a concrete import, can contain multiple options for each external record type from which the end-user might choose (for example, allow *task* from an external system to map either to *issue* or *ticket* in DevRev), and it can also contain mappings that apply to a record type category. -When the user runs a new import, and the extractor reports in its metadata record types belonging to this category that are not directly mapped in the initial domain mappings, the recipe manager applies the per-category default to them. +Initial domain mappings differ from user mappings in two key ways: -After the blueprint of the test import is completed, the *Install in this org* button takes you to the initial domain mapping creation screen, where you can *merge* the blueprint to the existing initial mappings of the org. +1. **Multiple mapping options**: The developer can choose how external record types map to DevRev records (e.g., external *task* can map to either *issue* or *ticket*). +2. **Category-based defaults**: Mappings can apply to entire record type categories, automatically handling new record types. -By repeating this process (run a new import, create a different configuration, merge to the initial mappings), you can create an initial mapping that contains multiple options for the user to choose from. + + +### Map record types and fields + +Use the chef-cli UI to map record types and fields. +The UI will show you the record types that are available in the org and allow you to map them to the external record types. +You should map one record type at a time. + +### Install the blueprint + +Click **Install in this org** to access the initial domain mapping creation screen. +Follow the instructions to create your initial domain mapping. + +### Merge configurations + +You can repeat steps 1-2 for different record types and fields to create multiple mappings. +In the install screen, you can merge your mappings with existing initial mappings. + +### Export the mapping file + +When all fields are mapped correctly, click **Export** to download `initial_domain_mapping.json`. + + + +### Advanced configuration -Finally, when all the fields are mapped without deficiencies and the blueprint is installed, the Export button allows you to retrieve the `initial_domain_mapping.json`. +You can provide a local metadata file for enhanced functionality: - -You can also provide a local metadata file to the command using the `-m` flag, for example: ```bash chef-cli configure-mappings --env prod -m metadata.json ``` -This enables the following features: -- Raw jq transformations using an external field as input (experimental feature). -- Filling in example input data for trying out the transformation. +This enables: +- Raw jq transformations using external fields as input (experimental) +- Example input data for testing transformations -In this case, it's not validated that the local file is the same as the one submitted by the snap-in. - + +The local metadata file is not validated against the snap-in submission. + ### Test an import with initial mapping using the in-app UI From 720c6c68a8d09bb6c6b3a0a6265b59b86add9a6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tilen=20Kav=C4=8Di=C4=8D?= Date: Wed, 28 May 2025 17:29:22 +0200 Subject: [PATCH 02/22] Update supported object types --- .../pages/airdrop/supported-object-types.mdx | 623 ++++++++++++++++-- 1 file changed, 580 insertions(+), 43 deletions(-) diff --git a/fern/docs/pages/airdrop/supported-object-types.mdx b/fern/docs/pages/airdrop/supported-object-types.mdx index 48e0acc0..896712b1 100644 --- a/fern/docs/pages/airdrop/supported-object-types.mdx +++ b/fern/docs/pages/airdrop/supported-object-types.mdx @@ -1,6 +1,6 @@ # Supported DevRev object types for Airdrop -Last updated: _2025-04_ +Last updated: _2025-05_ This document contains the list of all DevRev object types that are supported for Airdrop. @@ -8,6 +8,7 @@ This document contains the list of all DevRev object types that are supported fo | Object Type | Object Hierarchy | Loading | Extraction | Subtype | AppFragment | Comment | |-------|-------------|:-------:|:----------:|:-------:|:----------:|-------------| +| [A new custom object type](#a new custom object type) | custom_object | ✔︎ | ✔︎ | ✔︎ | | | | [account](#account) | account | ✔︎ | | | | | | [airdrop_authorization_policy](#airdrop_authorization_policy) | airdrop_authorization_policy | ✔︎ | | | | _Airdrop authorization policy object type is the intermediate object type for creating MFZ object types: role, role_set, object_member, and access_control_entry._ | | [airdrop_platform_group](#airdrop_platform_group) | airdrop_platform_group | ✔︎ | | | | _Airdrop platform group object type is the representation of the default DevRev groups._ | @@ -39,7 +40,6 @@ This document contains the list of all DevRev object types that are supported fo | [sysu](#sysu) | sys_user | ✔︎ | | | | | | [tag](#tag) | tag | ✔︎ | | | | | | [task](#task) | work->task | ✔︎ | ✔︎ | ✔︎ | | | -| [test_custom_type](#test_custom_type) | custom_object | ✔︎ | | ✔︎ | | _Test custom object type for testing purposes. Available only for old mappings._ | | [ticket](#ticket) | work->ticket | ✔︎ | ✔︎ | ✔︎ | | | ## Key Capabilities @@ -51,6 +51,32 @@ This document contains the list of all DevRev object types that are supported fo | Can Subtype | Indicates that the object type supports [subtype](https://developer.devrev.ai/beta/guides/object-customization#subtype) creation. | | Can App Fragment | Indicates that the object type supports application fragments. | +## A new custom object type + +**Resource Type:** `custom_object` + +**Capabilities:** Can Extract, Can Load, Can Subtype + +### Fixed Fields + +| Field | Value | +|-------|-------| +| `leaf_type` | get_leaf | + +### Fields + +| Field | Type | Required | Description | +|-------|------|----------|-------------| +| `created_by_id` | reference -> [#category:user] | | User ID of the user that created the object | +| `item_url_field` | text | | Link to the item in the origin system | +| `modified_by_id` | reference -> [#category:user] | | User ID of the user that last modified the object | +| `title` | text | | Title of the custom object | + + +[ ▲ top](#summary) + +--- + ## account **Resource Type:** `account` @@ -73,6 +99,24 @@ This document contains the list of all DevRev object types that are supported fo | `tags` | reference (collection) -> [#record:tag] | | Tags associated with an object. | | `websites` | text (collection) | | Websites | +#### Enum Values + +**environment** + +| Value | Name | Description | +|-----|------|-------------| +| `PRODUCTION` | PRODUCTION | - | +| `STAGING` | STAGING | - | +| `TEST` | TEST | - | + +**state** + +| Value | Name | Description | +|-----|------|-------------| +| `ACTIVE` | ACTIVE | - | +| `INACTIVE` | INACTIVE | - | +| `LOCKED` | LOCKED | - | + ### Structs #### postal_address @@ -106,6 +150,17 @@ This document contains the list of all DevRev object types that are supported fo | `targets` | type_key (collection) | ✔︎ | Target object types the role applies to. | | `users` | reference (collection) -> [#record:devu #record:revu] | | Users this role applies to. | +#### Enum Values + +**privileges** + +| Value | Name | Description | +|-----|------|-------------| +| `create` | create | - | +| `delete` | delete | - | +| `read` | read | - | +| `update` | update | - | + [ ▲ top](#summary) @@ -123,6 +178,16 @@ This document contains the list of all DevRev object types that are supported fo |-------|------|----------|-------------| | `key` | enum | ✔︎ | Key of the platform provided group. | +#### Enum Values + +**key** + +| Value | Name | Description | +|-----|------|-------------| +| `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" | + [ ▲ top](#summary) @@ -147,7 +212,6 @@ This document contains the list of all DevRev object types that are supported fo | `content_filetype` | enum | | | | `created_by_id` | reference -> [#category:user] | | User ID of the user that created the object | | `description` | rich_text | | Description of the article. | -| `extracted_content` | reference (collection) -> [#record:artifact] | | Extracted content of the article. | | `extracted_plain_text` | text | | Extracted Plain Text | | `item_url_field` | text | | Link to the item in the origin system | | `language` | text | | Language of the article for i18n support. | @@ -168,6 +232,68 @@ This document contains the list of all DevRev object types that are supported fo | `type` | enum | | Type of the article. | | `visible_to` | enum | | | +#### Enum Values + +**access_level** + +| Value | Name | Description | +|-----|------|-------------| +| `EXTERNAL` | - | - | +| `INTERNAL` | - | - | +| `PRIVATE` | - | - | +| `PUBLIC` | - | - | +| `RESTRICTED` | - | - | + +**content_filetype** + +| Value | Name | Description | +|-----|------|-------------| +| `application/json` | - | - | +| `devrev/rt` | - | - | +| `image/avif` | - | - | +| `image/gif` | - | - | +| `image/jpeg` | - | - | +| `image/png` | - | - | +| `image/svg+xml` | - | - | +| `image/webp` | - | - | +| `paligo/html` | - | - | +| `text/css; charset=utf-8` | - | - | +| `text/html; charset=utf-8` | - | - | +| `text/javascript; charset=utf-8` | - | - | +| `text/plain` | - | - | +| `text/xml; charset=utf-8` | - | - | + +**scope** + +| Value | Name | Description | +|-----|------|-------------| +| `1` | internal | - | +| `2` | external | - | + +**status** + +| Value | Name | Description | +|-----|------|-------------| +| `archived` | archived | - | +| `draft` | draft | - | +| `published` | published | - | +| `review_needed` | review_needed | - | + +**type** + +| Value | Name | Description | +|-----|------|-------------| +| `article` | article | - | +| `content_block` | content_block | - | + +**visible_to** + +| Value | Name | Description | +|-----|------|-------------| +| `customer_admins` | - | - | +| `customers` | - | - | +| `verified_customers` | - | - | + ### Structs #### resource @@ -212,11 +338,20 @@ This document contains the list of all DevRev object types that are supported fo | `name` | text | ✔︎ | Name of the part | | `owned_by_ids` | reference (collection) -> [#record:devu] | ✔︎ | User IDs of the users that own the part | | `parent_part` | reference -> [#category:part] | ✔︎ | Parent of this part | -| `part_of_part_id` | reference -> [#category:part] | | Product ID of this Capability | | `pm_owner_id` | reference -> [#record:devu] | | User ID of the PM owner of the part | | `ref_url` | text | | URL to the part details (git url, website, etc.) | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | +#### Enum Values + +**delivered_as** + +| Value | Name | Description | +|-----|------|-------------| +| `goods` | goods | - | +| `service` | service | - | +| `software` | software | - | + [ ▲ top](#summary) @@ -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_-]. | | `title` | text | | The title given to the chat. | +#### Enum Values + +**access_level** + +| Value | Name | Description | +|-----|------|-------------| +| `EXTERNAL` | EXTERNAL | - | +| `INTERNAL` | INTERNAL | - | +| `PRIVATE` | PRIVATE | - | +| `PUBLIC` | PUBLIC | - | +| `RESTRICTED` | RESTRICTED | - | +| `UNKNOWN` | UNKNOWN | - | + [ ▲ top](#summary) @@ -262,14 +410,25 @@ This document contains the list of all DevRev object types that are supported fo | `created_by_id` | reference -> [#category:user] | ✔︎ | User ID of the user that created the object | | `creator_display_name` | text | | Creator display name | | `external_ref` | text | | The external reference to associate with the entry. This must be unique across the entry's siblings, i.e. all children of its parent. | -| `grandparent_object_id` | reference -> [#category:chat #category:part #category:work #record:account #record:conversation #record:incident #record:revu] | | The object this relates to | +| `grandparent_object_id` | reference -> [#category:chat #category:custom_object #category:part #category:work #record:account #record:conversation #record:incident #record:revu] | | The object this relates to | | `grandparent_object_type` | text | | The object type this relates to | | `item_url_field` | text | | Link to the item in the origin system | | `modified_by_id` | reference -> [#category:user] | ✔︎ | User ID of the user that last modified the object | -| `parent_object_id` | reference -> [#category:chat #category:part #category:work #record:account #record:comment #record:conversation #record:incident #record:revu] | ✔︎ | The object this relates to | +| `parent_object_id` | reference -> [#category:chat #category:custom_object #category:part #category:work #record:account #record:comment #record:conversation #record:incident #record:revu] | ✔︎ | The object this relates to | | `parent_object_type` | text | | The object type this relates to | | `visibility` | enum | | Visibility of the comment | +#### Enum Values + +**visibility** + +| Value | Name | Description | +|-----|------|-------------| +| `Visibility_EXTERNAL` | Visibility_EXTERNAL | - | +| `Visibility_INTERNAL` | Visibility_INTERNAL | - | +| `Visibility_PRIVATE` | Visibility_PRIVATE | - | +| `Visibility_PUBLIC` | Visibility_PUBLIC | - | + [ ▲ top](#summary) @@ -306,6 +465,16 @@ This document contains the list of all DevRev object types that are supported fo | `ref_url` | text | | URL to the part details (git url, website, etc.) | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | +#### Enum Values + +**delivered_as** + +| Value | Name | Description | +|-----|------|-------------| +| `goods` | goods | - | +| `service` | service | - | +| `software` | software | - | + [ ▲ top](#summary) @@ -355,6 +524,34 @@ This document contains the list of all DevRev object types that are supported fo | `turing_active` | bool | | Whether Turing is active on the conversation. Will be true when Turing is active and false when it stops responding or when a dev user responds to the conversation. | | `user_sessions` | reference (collection) -> [#record:user_session] | | User sessions associated with the conversation. | +#### Enum Values + +**conversation_type** + +| Value | Name | Description | +|-----|------|-------------| +| `support` | Support | - | + +**priority** + +| Value | Name | Description | +|-----|------|-------------| +| `P0` | P0 | - | +| `P1` | P1 | - | +| `P2` | P2 | - | + +**stage** + +| Value | Name | Description | +|-----|------|-------------| +| `archived` | Archived | - | +| `hold` | Hold | - | +| `needs_response` | Needs Response | - | +| `new` | New | - | +| `resolved` | Resolved | - | +| `suspended` | Suspended | - | +| `waiting_on_user` | Waiting On User | - | + [ ▲ top](#summary) @@ -378,8 +575,19 @@ This document contains the list of all DevRev object types that are supported fo |-------|------|----------|-------------| | `created_by_id` | reference -> [#category:user] | | User ID of the user that created the object | | `link_type_id` | enum | ✔︎ | Link Type | -| `source_id` | reference -> [#record:account #record:capability #record:enhancement #record:feature #record:incident #record:issue #record:opportunity #record:product #record:project #record:revu #record:task #record:ticket] | ✔︎ | Source object ID | -| `target_id` | reference -> [#record:account #record:capability #record:enhancement #record:feature #record:incident #record:issue #record:opportunity #record:product #record:project #record:revu #record:task #record:ticket] | ✔︎ | Target object ID | +| `source_id` | reference -> [#category:custom_object #record:account #record:capability #record:enhancement #record:feature #record:incident #record:issue #record:opportunity #record:product #record:project #record:revu #record:task #record:ticket] | ✔︎ | Source object ID | +| `target_id` | reference -> [#category:custom_object #record:account #record:capability #record:enhancement #record:feature #record:incident #record:issue #record:opportunity #record:product #record:project #record:revu #record:task #record:ticket] | ✔︎ | Target object ID | + +#### Enum Values + +**link_type_id** + +| Value | Name | Description | +|-----|------|-------------| +| `is_dependent_on` | Is Dependent On | - | +| `is_duplicate_of` | Is Duplicate Of | - | +| `is_parent_of` | Is Parent Of | - | +| `is_related_to` | Is Related To | - | [ ▲ top](#summary) @@ -414,6 +622,16 @@ This document contains the list of all DevRev object types that are supported fo | `ref_url` | text | | URL to the part details (git url, website, etc.) | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | +#### Enum Values + +**delivered_as** + +| Value | Name | Description | +|-----|------|-------------| +| `goods` | goods | - | +| `service` | service | - | +| `software` | software | - | + [ ▲ top](#summary) @@ -433,7 +651,6 @@ This document contains the list of all DevRev object types that are supported fo | `email` | text | | Email address of the user. | | `external_identities` | struct (collection) | | IDs of the Dev User outside the DevRev SOR. | | `full_name` | text | | Full name of the user. | -| `state` | enum | | State of the user. | [ ▲ top](#summary) @@ -450,7 +667,6 @@ This document contains the list of all DevRev object types that are supported fo | Field | Type | Required | Description | |-------|------|----------|-------------| -| `body` | reference -> [#record:artifact] | | Body of the directory | | `created_by_id` | reference -> [#category:user] | | User ID of the user that created the object | | `description` | rich_text | | Description of the directory | | `icon` | text | | Icon of the directory | @@ -460,7 +676,6 @@ This document contains the list of all DevRev object types that are supported fo | `published` | bool | ✔︎ | Whether the directory is published | | `rank` | text | | Rank of the directory | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the directory | -| `thumbnail` | reference -> [#record:artifact] | | Thumbnail of the directory | | `title` | text | ✔︎ | Title of the directory | @@ -486,6 +701,7 @@ This document contains the list of all DevRev object types that are supported fo |-------|------|----------|-------------| | `created_by_id` | reference -> [#category:user] | | User ID of the user that created the object | | `is_default` | bool | | Whether this is the default DM for messaging the constituent users. If true, then this DM is always returned when opening a DM for the users. Note only one DM may be the default for a given set of users. | +| `modified_by_id` | reference -> [#category:user] | | User ID of the user that last modified the object | | `record_ids` | text (collection) | | The associated records for this DM. | | `title` | text | | The title given to the chat. | | `user_ids` | reference (collection) -> [#category:user] | ✔︎ | The users in the direct message. Only these users have access the chat's history and can send new messages. | @@ -527,12 +743,45 @@ This document contains the list of all DevRev object types that are supported fo | `release_notes` | text | | Release notes of the enhancement | | `rev_score` | float | | Rev Score of the enhancement | | `rev_score_tier` | enum | | Rev Score tier of the enhancement | -| `stage` | enum | | Stage of the part | +| `stage` | enum | ✔︎ | Stage of the part | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | | `target_close_date` | timestamp | | Target close date for the object | | `target_start_date` | timestamp | | Target start date for the object | | `ticket_ids` | reference (collection) -> [#category:work] | | Tickets associated with the enhancement | +#### Enum Values + +**delivered_as** + +| Value | Name | Description | +|-----|------|-------------| +| `goods` | goods | - | +| `service` | service | - | +| `software` | software | - | + +**rev_score_tier** + +| Value | Name | Description | +|-----|------|-------------| +| `high` | high | - | +| `low` | low | - | +| `medium` | medium | - | + +**stage** + +| Value | Name | Description | +|-----|------|-------------| +| `deprecated` | Deprecated | - | +| `deprioritized` | Deprioritized | - | +| `general_availability` | General Availability | - | +| `ideation` | Ideation | - | +| `in_development` | In Development | - | +| `in_testing` | In testing | - | +| `limited_availability` | Limited Availability | - | +| `prioritized` | Prioritized | - | +| `ux_design` | UX Design | - | +| `wont_do` | Won't do | - | + [ ▲ top](#summary) @@ -569,12 +818,21 @@ This document contains the list of all DevRev object types that are supported fo | `name` | text | ✔︎ | Name of the part | | `owned_by_ids` | reference (collection) -> [#record:devu] | ✔︎ | User IDs of the users that own the part | | `parent_part` | reference -> [#category:part] | ✔︎ | Parent of this part | -| `part_of_part_id` | reference -> [#category:part] | | Capability ID or Parent Feature ID of this feature | | `pm_owner_id` | reference -> [#record:devu] | | User ID of the PM owner of the part | | `qa_owner_id` | reference -> [#record:devu] | | User ID of the QA owner of the part | | `ref_url` | text | | URL to the part details (git url, website, etc.) | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | +#### Enum Values + +**delivered_as** + +| Value | Name | Description | +|-----|------|-------------| +| `goods` | goods | - | +| `service` | service | - | +| `software` | software | - | + [ ▲ top](#summary) @@ -598,6 +856,23 @@ This document contains the list of all DevRev object types that are supported fo | `owner` | reference -> [#record:devu] | | Owner of the group | | `type` | enum | | Type of the group | +#### Enum Values + +**member_type** + +| Value | Name | Description | +|-----|------|-------------| +| `dev_user` | dev_user | - | +| `rev_user` | rev_user | - | +| `svc_acc` | svc_acc | - | + +**type** + +| Value | Name | Description | +|-----|------|-------------| +| `dynamic` | dynamic | - | +| `static` | static | - | + [ ▲ top](#summary) @@ -631,6 +906,37 @@ This document contains the list of all DevRev object types that are supported fo | `target_close_date` | timestamp | | Timestamp when the work is expected to be complete | | `title` | text | ✔︎ | Title of the work object | +#### Enum Values + +**reported_by** + +| Value | Name | Description | +|-----|------|-------------| +| `1` | Customer | - | +| `2` | Internal Users | - | +| `3` | System | - | + +**severity** + +| Value | Name | Description | +|-----|------|-------------| +| `1` | sev-0 | - | +| `2` | sev-1 | - | +| `3` | sev-2 | - | +| `4` | sev-3 | - | + +**stage** + +| Value | Name | Description | +|-----|------|-------------| +| `acknowledged` | Acknowledged | - | +| `canceled` | Canceled | - | +| `duplicate` | Duplicate | - | +| `fixing` | Fixing | - | +| `mitigated` | Mitigated | - | +| `resolved` | Resolved | - | +| `triage` | Triage | - | + [ ▲ top](#summary) @@ -677,6 +983,32 @@ This document contains the list of all DevRev object types that are supported fo | `target_start_date` | timestamp | | Target start date for the object | | `title` | text | ✔︎ | Title of the work object | +#### Enum Values + +**priority** + +| Value | Name | Description | +|-----|------|-------------| +| `P0` | P0 | - | +| `P1` | P1 | - | +| `P2` | P2 | - | +| `P3` | P3 | - | + +**stage** + +| Value | Name | Description | +|-----|------|-------------| +| `backlog` | Backlog | - | +| `completed` | Completed | - | +| `duplicate` | Duplicate | - | +| `in_deployment` | In Deployment | - | +| `in_development` | In Development | - | +| `in_review` | In Review | - | +| `in_testing` | In Testing | - | +| `prioritized` | Prioritized | - | +| `triage` | Triage | - | +| `wont_fix` | Won't Fix | - | + [ ▲ top](#summary) @@ -700,6 +1032,33 @@ This document contains the list of all DevRev object types that are supported fo | `target_object_type` | enum | | Target object type | | `transformed_from_id` | text | | | +#### Enum Values + +**link_type** + +| Value | Name | Description | +|-----|------|-------------| +| `is_dependent_on` | Is Dependent On | - | +| `is_duplicate_of` | Is Duplicate Of | - | +| `is_parent_of` | Is Parent Of | - | +| `is_related_to` | Is Related To | - | + +**source_object_type** + +| Value | Name | Description | +|-----|------|-------------| +| `conversation` | - | - | +| `incident` | - | - | +| `work` | - | - | + +**target_object_type** + +| Value | Name | Description | +|-----|------|-------------| +| `conversation` | - | - | +| `incident` | - | - | +| `work` | - | - | + [ ▲ top](#summary) @@ -737,6 +1096,23 @@ This document contains the list of all DevRev object types that are supported fo | `ref_url` | text | | URL to the part details (git url, website, etc.) | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | +#### Enum Values + +**delivered_as** + +| Value | Name | Description | +|-----|------|-------------| +| `goods` | goods | - | +| `service` | service | - | +| `software` | software | - | + +**kind** + +| Value | Name | Description | +|-----|------|-------------| +| `component` | component | - | +| `library` | library | - | + [ ▲ top](#summary) @@ -769,6 +1145,40 @@ This document contains the list of all DevRev object types that are supported fo | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the meeting. | | `title` | text | ✔︎ | Title of the meeting object. | +#### Enum Values + +**channel** + +| Value | Name | Description | +|-----|------|-------------| +| `amazon_connect` | amazon_connect | - | +| `devrev` | devrev | - | +| `google_meet` | google_meet | - | +| `offline` | offline | - | +| `other` | other | - | +| `teams` | teams | - | +| `zoom` | zoom | - | + +**parent_object_type** + +| Value | Name | Description | +|-----|------|-------------| +| `account` | - | - | +| `work` | - | - | + +**state** + +| Value | Name | Description | +|-----|------|-------------| +| `canceled` | canceled | - | +| `completed` | completed | - | +| `no_show` | no_show | - | +| `ongoing` | ongoing | - | +| `rejected` | rejected | - | +| `rescheduled` | rescheduled | - | +| `scheduled` | scheduled | - | +| `waiting` | waiting | - | + [ ▲ top](#summary) @@ -805,6 +1215,16 @@ This document contains the list of all DevRev object types that are supported fo | `ref_url` | text | | URL to the part details (git url, website, etc.) | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | +#### Enum Values + +**delivered_as** + +| Value | Name | Description | +|-----|------|-------------| +| `goods` | goods | - | +| `service` | service | - | +| `software` | software | - | + [ ▲ top](#summary) @@ -820,15 +1240,25 @@ This document contains the list of all DevRev object types that are supported fo | Field | Type | Required | Description | |-------|------|----------|-------------| -| `conditional_role_id` | reference -> [#record:conditional_role] | | Conditional Role that entails the permissions of the member | +| `add_member_ids` | reference (collection) -> [#category:user] | | Add or update user IDs in the group | | `created_by_id` | reference -> [#category:user] | | User ID of the user that created the object | -| `member_id` | reference -> [#category:user] | ✔︎ | ID of the user or group | +| `member_id` | reference -> [#category:user] | | ID of the user or group | | `object_id` | reference -> [#record:group] | ✔︎ | Globally unique DevRev Object Name (DON) for the object where the member is being added. | +| `remove_member_ids` | reference (collection) -> [#category:user] | | Remove user IDs from the group | | `role_id` | reference -> [#record:role] | | Role that entails the permissions of the member | | `target_object_type` | enum | ✔︎ | Type of target object | | `valid_from_date` | timestamp | ✔︎ | Timestamp when this membership is valid | | `valid_to_date` | timestamp | | Timestamp when this membership expires | +#### Enum Values + +**target_object_type** + +| Value | Name | Description | +|-----|------|-------------| +| `dashboard` | - | - | +| `group` | - | - | + [ ▲ top](#summary) @@ -852,14 +1282,11 @@ This document contains the list of all DevRev object types that are supported fo |-------|------|----------|-------------| | `account_id` | reference -> [#record:account] | | ID of the account that the opportunity is related to. | | `actual_close_date` | timestamp | | Timestamp when the work was actually completed | -| `amount` | float | | Total opportunity amount. | | `annual_contract_value` | struct | | Annual contract value of the opportunity. | -| `annual_recurring_revenue` | float | | Annual recurring revenue of the opportunity. | | `body` | rich_text | | Body of the work object | | `budget` | struct | | Budget of the opportunity. | | `contact_ids` | reference (collection) -> [#record:revu] | | Contacts involved in the opportunity. | | `created_by_id` | reference -> [#category:user] | | User ID of the user that created the object | -| `customer_budget` | float | | Budget of the customer. | | `fallback_parts` | reference -> [#category:part] | | Other values that could serve as part if apples_to_part_id is found to be invalid. | | `forecast_category` | enum | ✔︎ | Forecast category of the opportunity. | | `item_url_field` | text | | Link to the item in the origin system | @@ -874,6 +1301,40 @@ This document contains the list of all DevRev object types that are supported fo | `title` | text | ✔︎ | Title of the work object | | `value` | struct | | Value of the opportunity. | +#### Enum Values + +**forecast_category** + +| Value | Name | Description | +|-----|------|-------------| +| `commit` | commit | - | +| `omitted` | omitted | - | +| `pipeline` | pipeline | - | +| `strong_upside` | strong_upside | - | +| `upside` | upside | - | +| `won` | won | - | + +**priority** + +| Value | Name | Description | +|-----|------|-------------| +| `P0` | P0 | - | +| `P1` | P1 | - | +| `P2` | P2 | - | +| `P3` | P3 | - | + +**stage** + +| Value | Name | Description | +|-----|------|-------------| +| `closed_lost` | Closed Lost | - | +| `closed_won` | Closed Won | - | +| `contract` | Contract | - | +| `negotiation` | Negotiation | - | +| `qualification` | Qualification | - | +| `stalled` | Stalled | - | +| `validation` | Validation | - | + ### Structs #### money @@ -918,6 +1379,23 @@ This document contains the list of all DevRev object types that are supported fo | `ref_url` | text | | URL to the part details (git url, website, etc.) | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | +#### Enum Values + +**delivered_as** + +| Value | Name | Description | +|-----|------|-------------| +| `goods` | goods | - | +| `service` | service | - | +| `software` | software | - | + +**product_delivered_as** + +| Value | Name | Description | +|-----|------|-------------| +| `goods` | goods | - | +| `service` | service | - | + [ ▲ top](#summary) @@ -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. | -| `state` | enum | | State of the user. | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | -| `user_type` | enum | | Type of the user. | [ ▲ top](#summary) @@ -984,6 +1459,25 @@ This document contains the list of all DevRev object types that are supported fo | `ref_url` | text | | URL to the part details (git url, website, etc.) | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | +#### Enum Values + +**delivered_as** + +| Value | Name | Description | +|-----|------|-------------| +| `goods` | goods | - | +| `service` | service | - | +| `software` | software | - | + +**kind** + +| Value | Name | Description | +|-----|------|-------------| +| `ecr_image` | ecr_image | - | +| `lambda` | lambda | - | +| `microservice` | microservice | - | +| `service` | service | - | + [ ▲ top](#summary) @@ -1001,7 +1495,6 @@ This document contains the list of all DevRev object types that are supported fo |-------|------|----------|-------------| | `display_name` | text | ✔︎ | The user's display name. The name is non-unique and mutable. | | `full_name` | text | | Full name of the user. | -| `state` | enum | | State of the user. | [ ▲ top](#summary) @@ -1024,6 +1517,17 @@ This document contains the list of all DevRev object types that are supported fo | `name` | text | ✔︎ | Name of the tag | | `style` | text | | hex color of in the format #RRGGBB | +#### Enum Values + +**access_level** + +| Value | Name | Description | +|-----|------|-------------| +| `internal` | internal | - | +| `private` | private | - | +| `public` | public | - | +| `restricted` | restricted | - | + [ ▲ top](#summary) @@ -1065,30 +1569,24 @@ This document contains the list of all DevRev object types that are supported fo | `target_close_date` | timestamp | | Timestamp when the work is expected to be complete | | `title` | text | ✔︎ | Title of the work object | +#### Enum Values -[ ▲ top](#summary) - ---- - -## test_custom_type - -**Resource Type:** `custom_object` - -**Capabilities:** Can Load, Can Subtype - -### Fixed Fields +**priority** -| Field | Value | -|-------|-------| -| `leaf_type` | "test_custom_type" | +| Value | Name | Description | +|-----|------|-------------| +| `P0` | P0 | - | +| `P1` | P1 | - | +| `P2` | P2 | - | +| `P3` | P3 | - | -### Fields +**stage** -| Field | Type | Required | Description | -|-------|------|----------|-------------| -| `created_by_id` | reference -> [#category:user] | | User ID of the user that created the object | -| `modified_by_id` | reference -> [#category:user] | | User ID of the user that last modified the object | -| `title` | text | | Title of the custom object | +| Value | Name | Description | +|-----|------|-------------| +| `in_development` | In Development | - | +| `open` | Open | - | +| `resolved` | Resolved | - | [ ▲ top](#summary) @@ -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'. | +#### Enum Values + +**channels** + +| Value | Name | Description | +|-----|------|-------------| +| `email` | - | - | +| `plug` | - | - | +| `slack` | - | - | + +**severity** + +| Value | Name | Description | +|-----|------|-------------| +| `blocker` | Blocker | - | +| `high` | High | - | +| `low` | Low | - | +| `medium` | Medium | - | + +**stage** + +| Value | Name | Description | +|-----|------|-------------| +| `awaiting_customer_response` | Awaiting Customer Response | - | +| `awaiting_development` | Awaiting Development | - | +| `awaiting_product_assist` | Awaiting Product Assist | - | +| `canceled` | Canceled | - | +| `in_development` | In Development | - | +| `queued` | Queued | - | +| `resolved` | Resolved | - | +| `work_in_progress` | Work In Progress | - | + +**visibility** + +| Value | Name | Description | +|-----|------|-------------| +| `1` | internal | - | +| `2` | external | - | + [ ▲ top](#summary) ---- \ No newline at end of file +--- From c8cff51c4c0ef3524a7ecab6be80a0f6f1cc92ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tilen=20Kav=C4=8Di=C4=8D?= Date: Wed, 28 May 2025 17:30:01 +0200 Subject: [PATCH 03/22] Add fallback description --- fern/docs/pages/airdrop/initial-domain-mapping.mdx | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/fern/docs/pages/airdrop/initial-domain-mapping.mdx b/fern/docs/pages/airdrop/initial-domain-mapping.mdx index 29ca2a5b..1a02cbea 100644 --- a/fern/docs/pages/airdrop/initial-domain-mapping.mdx +++ b/fern/docs/pages/airdrop/initial-domain-mapping.mdx @@ -115,6 +115,13 @@ Use the chef-cli UI to map record types and fields. The UI will show you the record types that are available in the org and allow you to map them to the external record types. You should map one record type at a time. +### Specify fallback mappings + +For most required DevRev fields we require a fallback. This is used on object creation if the extractor doesn't provide a value. + +The fallback should be a DevRev value that is valid for the field. +For enum fields, the fallback should be the enum **value** as specified in [Supported object types](./supported-object-types.mdx). + ### Install the blueprint Click **Install in this org** to access the initial domain mapping creation screen. @@ -122,7 +129,7 @@ Follow the instructions to create your initial domain mapping. ### Merge configurations -You can repeat steps 1-2 for different record types and fields to create multiple mappings. +You can repeat the process for different record types and fields to create multiple mappings. In the install screen, you can merge your mappings with existing initial mappings. ### Export the mapping file From 2ed743a073dfbe5462a359f5a3a9764f3a77cdec Mon Sep 17 00:00:00 2001 From: Faris Date: Mon, 9 Jun 2025 08:17:07 +0200 Subject: [PATCH 04/22] Add documentation for mapping custom objects and custom links --- .../pages/airdrop/initial-domain-mapping.mdx | 6 ++ .../pages/airdrop/metadata-extraction.mdx | 57 +++++++++++ .../pages/airdrop/supported-object-types.mdx | 98 +++++++++---------- 3 files changed, 112 insertions(+), 49 deletions(-) diff --git a/fern/docs/pages/airdrop/initial-domain-mapping.mdx b/fern/docs/pages/airdrop/initial-domain-mapping.mdx index 1a02cbea..b0f9d214 100644 --- a/fern/docs/pages/airdrop/initial-domain-mapping.mdx +++ b/fern/docs/pages/airdrop/initial-domain-mapping.mdx @@ -115,6 +115,12 @@ Use the chef-cli UI to map record types and fields. The UI will show you the record types that are available in the org and allow you to map them to the external record types. You should map one record type at a time. +#### Mapping as custom object +The system allows importing record types and categories as custom objects. To achieve this you have to select `new_custom_object` when mapping the record type. For each external record type mapped as a custom object, a new custom **Leaf type** will be defined in DevRev and a **Subtype** will automatically be created. For more details on customization concepts, please refer to the +[Customization](../customization.mdx) and [Custom Objects](../custom-objects.mdx) documentation. + +The field mapping works the same as for the stock DevRev types, with the difference being that there are significantly fewer fields to map. All the unmapped fields of the external record type will be created as custom fields. + ### Specify fallback mappings For most required DevRev fields we require a fallback. This is used on object creation if the extractor doesn't provide a value. diff --git a/fern/docs/pages/airdrop/metadata-extraction.mdx b/fern/docs/pages/airdrop/metadata-extraction.mdx index 317cb7ca..75d98ce0 100644 --- a/fern/docs/pages/airdrop/metadata-extraction.mdx +++ b/fern/docs/pages/airdrop/metadata-extraction.mdx @@ -506,4 +506,61 @@ be changed by the end user at any time, such as mandatory fields or custom field - The `starting_stage` defines the initial stage for new object instances. This data should always be provided if available, otherwise the starting stage is selected alphabetically. - In current metadata format (v0.2.0), the order and human-readable name are taken from the enum values defined on the controlling field. - If the `states` field is not provided, default DevRev states are used: `open`, `in_progress`, and `closed`. + + ### Declare custom link types + + External record types that represent links between other record types can be imported as ***custom links***, which means that each delcared link type will be recreated in DevRev with the same names. This allows closer preservation of the original data without the need to map the links to DevRev's predefined link types. + + To achieve this, the external record type needs to have an enum field defined that represents the link types and you need to declare a special field called `link_naming_data` in the record type. + + ```json + { + "fields": { + "type": { + "name": "Link Type", + "is_required": true, + "type": "enum", + "enum": { + "values": [ + { + "key": "1", + "name": "Parent Of" + }, + { + "key": "2", + "name": "Related" + }, + { + "key": "3", + "name": "Blocks" + } + ] + } + } + }, + "link_naming_data": { + "link_type_field": "type", + "link_direction_names": { + "1": { + "forward_name": "Parent of", + "backward_name": "Child of" + }, + "2": { + "forward_name": "Relates To", + "backward_name": "Relates To" + }, + "3": { + "forward_name": "Blocks", + "backward_name": "Is Blocked By" + } + } + } + } + ``` + + In the above example: + - The external *type* field is declared as the `link_type_field`. + - The `link_direction_names` provide a mapping of each value in the `link_type_field` to their directional names. `forward_name` and `backward_name` can be the same, but both are required. + - In current metadata format (v0.2.0), the human-readable name of the link type is taken from the enum values defined on the `link_type_field`. The linkable object types in DevRev will be defined based on the mappings of the *source_id* and *target_id* [fields](./supported-object-types.mdx#custom_link#). + \ No newline at end of file diff --git a/fern/docs/pages/airdrop/supported-object-types.mdx b/fern/docs/pages/airdrop/supported-object-types.mdx index 896712b1..c2e0042a 100644 --- a/fern/docs/pages/airdrop/supported-object-types.mdx +++ b/fern/docs/pages/airdrop/supported-object-types.mdx @@ -1,6 +1,6 @@ # Supported DevRev object types for Airdrop -Last updated: _2025-05_ +Last updated: _June 9, 2025_ This document contains the list of all DevRev object types that are supported for Airdrop. @@ -8,7 +8,7 @@ This document contains the list of all DevRev object types that are supported fo | Object Type | Object Hierarchy | Loading | Extraction | Subtype | AppFragment | Comment | |-------|-------------|:-------:|:----------:|:-------:|:----------:|-------------| -| [A new custom object type](#a new custom object type) | custom_object | ✔︎ | ✔︎ | ✔︎ | | | +| [new_custom_object](#new_custom_object) | custom_object | ✔︎ | ✔︎ | ✔︎ | | _New custom object is an example of how custom objects look in the context of Airdrop mapping._ | | [account](#account) | account | ✔︎ | | | | | | [airdrop_authorization_policy](#airdrop_authorization_policy) | airdrop_authorization_policy | ✔︎ | | | | _Airdrop authorization policy object type is the intermediate object type for creating MFZ object types: role, role_set, object_member, and access_control_entry._ | | [airdrop_platform_group](#airdrop_platform_group) | airdrop_platform_group | ✔︎ | | | | _Airdrop platform group object type is the representation of the default DevRev groups._ | @@ -42,7 +42,7 @@ This document contains the list of all DevRev object types that are supported fo | [task](#task) | work->task | ✔︎ | ✔︎ | ✔︎ | | | | [ticket](#ticket) | work->ticket | ✔︎ | ✔︎ | ✔︎ | | | -## Key Capabilities +## Key capabilities | Capability | Description | |-------|-------------| @@ -51,13 +51,13 @@ This document contains the list of all DevRev object types that are supported fo | Can Subtype | Indicates that the object type supports [subtype](https://developer.devrev.ai/beta/guides/object-customization#subtype) creation. | | Can App Fragment | Indicates that the object type supports application fragments. | -## A new custom object type +## new_custom_object **Resource Type:** `custom_object` **Capabilities:** Can Extract, Can Load, Can Subtype -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -99,7 +99,7 @@ This document contains the list of all DevRev object types that are supported fo | `tags` | reference (collection) -> [#record:tag] | | Tags associated with an object. | | `websites` | text (collection) | | Websites | -#### Enum Values +#### Enum values **environment** @@ -150,7 +150,7 @@ This document contains the list of all DevRev object types that are supported fo | `targets` | type_key (collection) | ✔︎ | Target object types the role applies to. | | `users` | reference (collection) -> [#record:devu #record:revu] | | Users this role applies to. | -#### Enum Values +#### Enum values **privileges** @@ -178,7 +178,7 @@ This document contains the list of all DevRev object types that are supported fo |-------|------|----------|-------------| | `key` | enum | ✔︎ | Key of the platform provided group. | -#### Enum Values +#### Enum values **key** @@ -232,7 +232,7 @@ This document contains the list of all DevRev object types that are supported fo | `type` | enum | | Type of the article. | | `visible_to` | enum | | | -#### Enum Values +#### Enum values **access_level** @@ -318,7 +318,7 @@ This document contains the list of all DevRev object types that are supported fo **Capabilities:** Can Extract, Can Load, Can Subtype -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -342,7 +342,7 @@ This document contains the list of all DevRev object types that are supported fo | `ref_url` | text | | URL to the part details (git url, website, etc.) | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | -#### Enum Values +#### Enum values **delivered_as** @@ -363,7 +363,7 @@ This document contains the list of all DevRev object types that are supported fo **Capabilities:** Can Load -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -378,7 +378,7 @@ 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_-]. | | `title` | text | | The title given to the chat. | -#### Enum Values +#### Enum values **access_level** @@ -418,7 +418,7 @@ This document contains the list of all DevRev object types that are supported fo | `parent_object_type` | text | | The object type this relates to | | `visibility` | enum | | Visibility of the comment | -#### Enum Values +#### Enum values **visibility** @@ -440,7 +440,7 @@ This document contains the list of all DevRev object types that are supported fo **Capabilities:** Can Extract, Can Load, Can Subtype -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -465,7 +465,7 @@ This document contains the list of all DevRev object types that are supported fo | `ref_url` | text | | URL to the part details (git url, website, etc.) | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | -#### Enum Values +#### Enum values **delivered_as** @@ -524,7 +524,7 @@ This document contains the list of all DevRev object types that are supported fo | `turing_active` | bool | | Whether Turing is active on the conversation. Will be true when Turing is active and false when it stops responding or when a dev user responds to the conversation. | | `user_sessions` | reference (collection) -> [#record:user_session] | | User sessions associated with the conversation. | -#### Enum Values +#### Enum values **conversation_type** @@ -563,7 +563,7 @@ This document contains the list of all DevRev object types that are supported fo **Capabilities:** Can Extract, Can Load -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -578,7 +578,7 @@ This document contains the list of all DevRev object types that are supported fo | `source_id` | reference -> [#category:custom_object #record:account #record:capability #record:enhancement #record:feature #record:incident #record:issue #record:opportunity #record:product #record:project #record:revu #record:task #record:ticket] | ✔︎ | Source object ID | | `target_id` | reference -> [#category:custom_object #record:account #record:capability #record:enhancement #record:feature #record:incident #record:issue #record:opportunity #record:product #record:project #record:revu #record:task #record:ticket] | ✔︎ | Target object ID | -#### Enum Values +#### Enum values **link_type_id** @@ -600,7 +600,7 @@ This document contains the list of all DevRev object types that are supported fo **Capabilities:** Can Extract, Can Load, Can Subtype -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -622,7 +622,7 @@ This document contains the list of all DevRev object types that are supported fo | `ref_url` | text | | URL to the part details (git url, website, etc.) | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | -#### Enum Values +#### Enum values **delivered_as** @@ -668,7 +668,7 @@ This document contains the list of all DevRev object types that are supported fo | Field | Type | Required | Description | |-------|------|----------|-------------| | `created_by_id` | reference -> [#category:user] | | User ID of the user that created the object | -| `description` | rich_text | | Description of the directory | +| `description` | text | | Description of the directory | | `icon` | text | | Icon of the directory | | `language` | text | | Language of the directory | | `modified_by_id` | reference -> [#category:user] | | User ID of the user that last modified the object | @@ -689,7 +689,7 @@ This document contains the list of all DevRev object types that are supported fo **Capabilities:** Can Load -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -717,7 +717,7 @@ This document contains the list of all DevRev object types that are supported fo **Capabilities:** Can Extract, Can Load, Can Subtype -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -749,7 +749,7 @@ This document contains the list of all DevRev object types that are supported fo | `target_start_date` | timestamp | | Target start date for the object | | `ticket_ids` | reference (collection) -> [#category:work] | | Tickets associated with the enhancement | -#### Enum Values +#### Enum values **delivered_as** @@ -793,7 +793,7 @@ This document contains the list of all DevRev object types that are supported fo **Capabilities:** Can Extract, Can Load, Can Subtype -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -823,7 +823,7 @@ This document contains the list of all DevRev object types that are supported fo | `ref_url` | text | | URL to the part details (git url, website, etc.) | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | -#### Enum Values +#### Enum values **delivered_as** @@ -856,7 +856,7 @@ This document contains the list of all DevRev object types that are supported fo | `owner` | reference -> [#record:devu] | | Owner of the group | | `type` | enum | | Type of the group | -#### Enum Values +#### Enum values **member_type** @@ -906,7 +906,7 @@ This document contains the list of all DevRev object types that are supported fo | `target_close_date` | timestamp | | Timestamp when the work is expected to be complete | | `title` | text | ✔︎ | Title of the work object | -#### Enum Values +#### Enum values **reported_by** @@ -948,7 +948,7 @@ This document contains the list of all DevRev object types that are supported fo **Capabilities:** Can Extract, Can Load, Can Subtype -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -983,7 +983,7 @@ This document contains the list of all DevRev object types that are supported fo | `target_start_date` | timestamp | | Target start date for the object | | `title` | text | ✔︎ | Title of the work object | -#### Enum Values +#### Enum values **priority** @@ -1032,7 +1032,7 @@ This document contains the list of all DevRev object types that are supported fo | `target_object_type` | enum | | Target object type | | `transformed_from_id` | text | | | -#### Enum Values +#### Enum values **link_type** @@ -1070,7 +1070,7 @@ This document contains the list of all DevRev object types that are supported fo **Capabilities:** Can Extract, Can Load, Can Subtype -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -1096,7 +1096,7 @@ This document contains the list of all DevRev object types that are supported fo | `ref_url` | text | | URL to the part details (git url, website, etc.) | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | -#### Enum Values +#### Enum values **delivered_as** @@ -1145,7 +1145,7 @@ This document contains the list of all DevRev object types that are supported fo | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the meeting. | | `title` | text | ✔︎ | Title of the meeting object. | -#### Enum Values +#### Enum values **channel** @@ -1190,7 +1190,7 @@ This document contains the list of all DevRev object types that are supported fo **Capabilities:** Can Extract, Can Load, Can Subtype -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -1215,7 +1215,7 @@ This document contains the list of all DevRev object types that are supported fo | `ref_url` | text | | URL to the part details (git url, website, etc.) | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | -#### Enum Values +#### Enum values **delivered_as** @@ -1250,7 +1250,7 @@ This document contains the list of all DevRev object types that are supported fo | `valid_from_date` | timestamp | ✔︎ | Timestamp when this membership is valid | | `valid_to_date` | timestamp | | Timestamp when this membership expires | -#### Enum Values +#### Enum values **target_object_type** @@ -1270,7 +1270,7 @@ This document contains the list of all DevRev object types that are supported fo **Capabilities:** Can Extract, Can Load, Can Subtype -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -1301,7 +1301,7 @@ This document contains the list of all DevRev object types that are supported fo | `title` | text | ✔︎ | Title of the work object | | `value` | struct | | Value of the opportunity. | -#### Enum Values +#### Enum values **forecast_category** @@ -1355,7 +1355,7 @@ This document contains the list of all DevRev object types that are supported fo **Capabilities:** Can Extract, Can Load, Can Subtype -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -1379,7 +1379,7 @@ This document contains the list of all DevRev object types that are supported fo | `ref_url` | text | | URL to the part details (git url, website, etc.) | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | -#### Enum Values +#### Enum values **delivered_as** @@ -1433,7 +1433,7 @@ This document contains the list of all DevRev object types that are supported fo **Capabilities:** Can Extract, Can Load, Can Subtype -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -1459,7 +1459,7 @@ This document contains the list of all DevRev object types that are supported fo | `ref_url` | text | | URL to the part details (git url, website, etc.) | | `tags` | reference (collection) -> [#record:tag] | | Tags associated with the object | -#### Enum Values +#### Enum values **delivered_as** @@ -1517,7 +1517,7 @@ This document contains the list of all DevRev object types that are supported fo | `name` | text | ✔︎ | Name of the tag | | `style` | text | | hex color of in the format #RRGGBB | -#### Enum Values +#### Enum values **access_level** @@ -1539,7 +1539,7 @@ This document contains the list of all DevRev object types that are supported fo **Capabilities:** Can Extract, Can Load, Can Subtype -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -1569,7 +1569,7 @@ This document contains the list of all DevRev object types that are supported fo | `target_close_date` | timestamp | | Timestamp when the work is expected to be complete | | `title` | text | ✔︎ | Title of the work object | -#### Enum Values +#### Enum values **priority** @@ -1599,7 +1599,7 @@ This document contains the list of all DevRev object types that are supported fo **Capabilities:** Can Extract, Can Load, Can Subtype -### Fixed Fields +### Fixed fields | Field | Value | |-------|-------| @@ -1639,7 +1639,7 @@ 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'. | -#### Enum Values +#### Enum values **channels** From 393dbd60af16d8ebc2a5de7bfe1f716bb56f2593 Mon Sep 17 00:00:00 2001 From: Faris Date: Mon, 9 Jun 2025 13:16:39 +0200 Subject: [PATCH 05/22] Comments --- fern/docs/pages/airdrop/metadata-extraction.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/fern/docs/pages/airdrop/metadata-extraction.mdx b/fern/docs/pages/airdrop/metadata-extraction.mdx index 75d98ce0..e473d1f6 100644 --- a/fern/docs/pages/airdrop/metadata-extraction.mdx +++ b/fern/docs/pages/airdrop/metadata-extraction.mdx @@ -509,7 +509,7 @@ be changed by the end user at any time, such as mandatory fields or custom field ### Declare custom link types - External record types that represent links between other record types can be imported as ***custom links***, which means that each delcared link type will be recreated in DevRev with the same names. This allows closer preservation of the original data without the need to map the links to DevRev's predefined link types. + External record types that represent links between other record types can be imported as ***custom links***, which means that each declared link type will be recreated in DevRev with the same names. This allows closer preservation of the original data without the need to map the links to DevRev's predefined link types. To achieve this, the external record type needs to have an enum field defined that represents the link types and you need to declare a special field called `link_naming_data` in the record type. @@ -561,6 +561,6 @@ be changed by the end user at any time, such as mandatory fields or custom field In the above example: - The external *type* field is declared as the `link_type_field`. - The `link_direction_names` provide a mapping of each value in the `link_type_field` to their directional names. `forward_name` and `backward_name` can be the same, but both are required. - - In current metadata format (v0.2.0), the human-readable name of the link type is taken from the enum values defined on the `link_type_field`. The linkable object types in DevRev will be defined based on the mappings of the *source_id* and *target_id* [fields](./supported-object-types.mdx#custom_link#). + - The human-readable name of the link type is taken from the enum values defined on the `link_type_field`. The linkable object types in DevRev will be defined based on the mappings of the *source_id* and *target_id* [fields](./supported-object-types.mdx#custom_link#). \ No newline at end of file From a07cd0cc93d3c6f4b5296a3548a42c41754c70a1 Mon Sep 17 00:00:00 2001 From: shalomgk Date: Fri, 30 May 2025 11:34:23 +0530 Subject: [PATCH 06/22] frontend user-identity method (#232) * Update user-identity.mdx * Update user-identity.mdx Add beta message with limitations --- fern/docs/pages/sdks/web/user-identity.mdx | 43 ++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/fern/docs/pages/sdks/web/user-identity.mdx b/fern/docs/pages/sdks/web/user-identity.mdx index 22ab62cb..ed33083c 100644 --- a/fern/docs/pages/sdks/web/user-identity.mdx +++ b/fern/docs/pages/sdks/web/user-identity.mdx @@ -120,3 +120,46 @@ const sessionToken = '' })})(); ``` + +## Identify users without session token + +You can also pass the identifiers in the `plugSDK.init` option without generating the session token. + + +This frontend user identification, by its nature, is not secure as the data is transmitted through the client side. It is recommended to use the session token method to securely identify users. + + + +This method is currently in beta and comes with the following limitations: +- Unverified users cannot be converted or merged into verified users. +- An external reference used by an unverified user cannot be reused for any other user. + + +```jsx +window.plugSDK.init({ + app_id: '', + identity: { + user_ref: string; + user_traits?: { // optional + custom_fields?: object; // optional + display_name?: string; // optional + email?: string; // optional + phone_numbers?: string[]; // optional + } + } +}) +``` + +You can add or update the data in `user_traits` by using the `updateIdentity` method on the PLuG SDK. Attached is a sample code snippet for the same. + +```jsx +window.plugSDK.updateIdentity({ + user_traits: { + custom_fields?: object; // optional + display_name?: string; // optional + email?: string; // optional + phone_numbers?: string[]; // optional + } +}) +``` + From 177c1307811d3e8e00bc48a1dd4668ff9a814520 Mon Sep 17 00:00:00 2001 From: Avinash Singh Date: Sat, 31 May 2025 11:27:45 +0530 Subject: [PATCH 07/22] changed the position of note (#243) * adding a note * Update ue-migration.mdx --------- Co-authored-by: Atul-Butola --- fern/docs/pages/sdks/web/ue-migration.mdx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/fern/docs/pages/sdks/web/ue-migration.mdx b/fern/docs/pages/sdks/web/ue-migration.mdx index 74f274b3..08979c98 100644 --- a/fern/docs/pages/sdks/web/ue-migration.mdx +++ b/fern/docs/pages/sdks/web/ue-migration.mdx @@ -45,11 +45,15 @@ ue.startRecording("") ``` + + + To enable session recordings, go to **Settings** > **Support** > **Session Replays** and enable recordings for your desired platforms. + + ```jsx window.plugSDK.init({ app_id: "", - enable_session_recording: true, }); window.plugSDK.onEvent((payload) => { if (payload.type === 'ON_OBSERVABILITY_READY') { From 302beb993399215706b2cc092e72e3d5d08afe26 Mon Sep 17 00:00:00 2001 From: Brian Byrne Date: Mon, 2 Jun 2025 16:14:55 -0700 Subject: [PATCH 08/22] chore: Update OpenAPI specs (#245) --- fern/apis/beta/changelog/2025-06-02.md | 30 + fern/apis/beta/openapi-beta.yaml | 1635 +- fern/apis/public/changelog/2025-06-02.md | 93 + fern/apis/public/openapi-public.yaml | 29453 +++++++++++++-------- fern/fern.config.json | 4 +- 5 files changed, 20384 insertions(+), 10831 deletions(-) create mode 100644 fern/apis/beta/changelog/2025-06-02.md create mode 100644 fern/apis/public/changelog/2025-06-02.md diff --git a/fern/apis/beta/changelog/2025-06-02.md b/fern/apis/beta/changelog/2025-06-02.md new file mode 100644 index 00000000..9b2b0a97 --- /dev/null +++ b/fern/apis/beta/changelog/2025-06-02.md @@ -0,0 +1,30 @@ +## New Endpoints + +### Chats +- [`/chats.update`](/beta/api-reference/chats/update): Updates a chat (DM) + +### Record Templates +- [`/record-templates.get`](/beta/api-reference/record-templates/record-template-get-post): Gets a record template's information + +### Service Accounts +- [`/service-accounts.update`](/beta/api-reference/service-accounts/update): Updates a service account's information + +### Subscribers +- [`/subscribers.list`](/beta/api-reference/subscribers/list-post): Lists subscribers for an object + +### Surveys +- [`/surveys.get`](/beta/api-reference/surveys/get-post): Gets the information for a survey + +## Modified Endpoints + +### Accounts +- Adds `primary_account` field, which is set when the account is merged with another + +### AI Agents +- Adds `suggestions` agent response type to the `ai_agent_response` webhook event + +### Rev Orgs +- Adds `primary_rev_org` field, which is set when the Rev org (workspace) is merged with another + +### Users +- Adds `primary_identity` field, which is set when the user is merged with another diff --git a/fern/apis/beta/openapi-beta.yaml b/fern/apis/beta/openapi-beta.yaml index d2058fc1..662ef776 100644 --- a/fern/apis/beta/openapi-beta.yaml +++ b/fern/apis/beta/openapi-beta.yaml @@ -106,6 +106,8 @@ components: description: List of Dev user IDs owning this Account. items: $ref: '#/components/schemas/user-summary' + primary_account: + $ref: '#/components/schemas/account-summary' stock_schema_fragment: type: string description: Stock schema fragment. @@ -739,6 +741,8 @@ components: items: type: string format: id + custom_schema_spec: + $ref: '#/components/schemas/custom-schema-spec-for-read' is_custom_leaf_type: type: boolean description: Whether the leaf type corresponds to a custom object. @@ -757,8 +761,6 @@ components: type: string description: The stock schema fragment which is to be aggregated. format: id - required: - - custom_schema_fragment_ids title: aggregated-schema-get-request aggregated-schema-get-response: type: object @@ -888,6 +890,11 @@ components: args: type: object description: The arguments for the skill call. + metadata: + type: object + description: | + The metadata of the skill call. The fields depend on the skill that + was executed. output: type: object description: The output of the skill call. @@ -953,6 +960,18 @@ components: required: - event_source title: ai-agent-event-source-target + ai-agent-event-suggestions: + type: object + description: A list of suggestions generated for the AI agent event. + properties: + suggestions: + type: array + description: The suggestions generated for the AI agent event. + items: + $ref: '#/components/schemas/ai-agent-suggestion' + required: + - suggestions + title: ai-agent-event-suggestions ai-agent-events-execute-async-request: type: object description: | @@ -1021,6 +1040,17 @@ components: allOf: - $ref: '#/components/schemas/atom-base-summary' title: ai-agent-session-summary + ai-agent-suggestion: + type: object + description: A suggestion generated for the AI agent event. + properties: + suggestion: + type: string + description: The text of the suggestion. + format: text + required: + - suggestion + title: ai-agent-suggestion ai-agent-webhook-target: type: object description: | @@ -1367,6 +1397,8 @@ components: - $ref: '#/components/schemas/atom-base-summary' - type: object properties: + article_type: + $ref: '#/components/schemas/article-type' resource: $ref: '#/components/schemas/resource-summary' sync_metadata: @@ -1382,6 +1414,7 @@ components: enum: - article - content_block + - page articles-count-request: type: object properties: @@ -1414,6 +1447,13 @@ components: items: type: string format: id + brands: + type: array + description: | + Filters for articles belonging to any of the provided brands. + items: + type: string + format: id created_by: type: array description: | @@ -1502,6 +1542,10 @@ components: items: type: string format: id + brand: + type: string + description: The brand associated with the article. + format: id content_format: $ref: '#/components/schemas/article-content-format' custom_fields: @@ -1642,6 +1686,11 @@ components: type: object description: The request to get an article. properties: + dev_org: + type: string + description: Optional Dev Org ID for the unauthenticated user. + example: DEV-AbCdEfGh + format: id id: type: string description: The ID of the required article. @@ -1689,6 +1738,13 @@ components: items: type: string format: id + brands: + type: array + description: | + Filters for articles belonging to any of the provided brands. + items: + type: string + format: id created_by: type: array description: | @@ -1704,6 +1760,11 @@ components: The cursor to resume iteration from. If not provided, then iteration starts from the beginning. format: text + dev_org: + type: string + description: Optional Dev Org ID for the unauthenticated user. + example: DEV-AbCdEfGh + format: id limit: type: integer description: | @@ -1792,6 +1853,11 @@ components: $ref: '#/components/schemas/articles-update-request-artifacts' authored_by: $ref: '#/components/schemas/articles-update-request-authored-by' + brand: + type: string + description: The updated brand of the article. + format: id + nullable: true content_blocks: $ref: '#/components/schemas/articles-update-request-content-blocks' content_format: @@ -2008,6 +2074,25 @@ components: file: $ref: '#/components/schemas/artifact-file' title: artifact + artifact-configuration-set: + type: string + description: | + Represents a set of configuration to be used with the artifacts object. + enum: + - article_media + - default + - email_media + - job_data + - marketplace_listing_icon + - marketplace_media + - org_logo + - plug_setting + - plug_setting_banner_card + - portal_css + - snap_in_functions_code + - snap_widget + - user_profile_picture + - work artifact-file: type: object description: Defines a file object. @@ -2188,6 +2273,8 @@ components: type: object description: The request to prepare a URL to upload a file. properties: + configuration_set: + $ref: '#/components/schemas/artifact-configuration-set' file_name: type: string description: The name of the file that's being uploaded. @@ -3905,6 +3992,83 @@ components: - chat title: chats-get-response x-go-name: ChatsGetResponseBody + chats-update-request: + type: object + discriminator: + mapping: + dm: '#/components/schemas/chats-update-request-dm' + none: '#/components/schemas/empty' + propertyName: type + oneOf: + - $ref: '#/components/schemas/chats-update-request-dm' + - $ref: '#/components/schemas/empty' + properties: + type: + $ref: '#/components/schemas/chat-type' + custom_fields: + type: object + description: Application-defined custom fields. + custom_schema_spec: + $ref: '#/components/schemas/custom-schema-spec' + id: + type: string + description: The chat's ID. + example: CHAN-AbCdEfGh + format: id + title: + type: string + description: | + The updated title for the chat, or unchanged if not provided. + format: text + required: + - id + title: chats-update-request + chats-update-request-dm: + type: object + properties: + records: + $ref: '#/components/schemas/chats-update-request-dm-records' + users: + $ref: '#/components/schemas/chats-update-request-dm-users' + title: chats-update-request-dm + chats-update-request-dm-records: + type: object + properties: + set: + type: array + description: The associated records to set for this DM. + items: + type: string + format: id + maxItems: 16 + title: chats-update-request-dm-records + chats-update-request-dm-users: + type: object + properties: + set: + type: array + description: | + The updated list of users to send direct messages to. The + authenticated user must be included in this list. + example: + - DEVU-12345 + items: + type: string + format: id + maxItems: 16 + minItems: 1 + required: + - set + title: chats-update-request-dm-users + chats-update-response: + type: object + properties: + chat: + $ref: '#/components/schemas/chat' + required: + - chat + title: chats-update-response + x-go-name: ChatsUpdateResponseBody client-context: type: object description: Properties of client to be used in track API. @@ -4998,6 +5162,10 @@ components: properties: type: $ref: '#/components/schemas/conversations-create-request-type-value' + brand: + type: string + description: The brand associated with the conversation. + format: id channels: type: array description: Channel IDs of the conversation. @@ -5045,6 +5213,10 @@ components: type: string description: Whether the conversation is from a source channel. format: text + source_channel_v2: + type: string + description: Source channel ID of the conversation. + format: id stage: $ref: '#/components/schemas/stage-init' tags: @@ -5134,6 +5306,13 @@ components: items: type: string format: id + brand: + type: array + description: | + Filters for tickets that are associated with any of the brands. + items: + type: string + format: id channels: type: array description: | @@ -5217,6 +5396,14 @@ components: items: type: string format: text + source_channel_v2: + type: array + description: | + Filters for conversations that are associated with the source + channel. + items: + type: string + format: id source_channels: type: array deprecated: true @@ -5306,6 +5493,13 @@ components: items: type: string format: id + brand: + type: array + description: | + Filters for tickets that are associated with any of the brands. + items: + type: string + format: id channels: type: array description: | @@ -5396,6 +5590,14 @@ components: items: type: string format: text + source_channel_v2: + type: array + description: | + Filters for conversations that are associated with the source + channel. + items: + type: string + format: id source_channels: type: array deprecated: true @@ -5467,6 +5669,10 @@ components: properties: applies_to_parts: $ref: '#/components/schemas/conversations-update-request-applies-to-parts' + brand: + type: string + description: The brand associated with the conversation. + format: id channels: $ref: '#/components/schemas/conversations-update-request-channels' custom_fields: @@ -5498,6 +5704,10 @@ components: $ref: '#/components/schemas/conversations-update-request-metadata' owned_by: $ref: '#/components/schemas/conversations-update-request-owned-by' + source_channel_v2: + type: string + description: Source channel ID of the conversation. + format: id stage: $ref: '#/components/schemas/stage-update' status: @@ -6147,11 +6357,15 @@ components: format: text deprecated: type: boolean + deprecated: true description: Whether the link type is deprecated. forward_name: type: string description: The name of the link in the forward direction. format: text + is_deprecated: + type: boolean + description: Whether the link type is deprecated. name: type: string description: The name of the custom link type. @@ -6215,6 +6429,10 @@ components: iteration starts from the beginning. format: text deprecated: + type: boolean + deprecated: true + description: Whether only deprecated link types should be filtered. + is_deprecated: type: boolean description: Whether only deprecated link types should be filtered. limit: @@ -6236,10 +6454,16 @@ components: items: type: string format: sort-by - source_types: - $ref: '#/components/schemas/link-descriptor-filter' - target_types: - $ref: '#/components/schemas/link-descriptor-filter' + source_types_v2: + type: array + description: Types from which a link can be made. + items: + $ref: '#/components/schemas/link-target-descriptor' + target_types_v2: + type: array + description: Types to which a link can be made. + items: + $ref: '#/components/schemas/link-target-descriptor' title: custom-link-type-list-request custom-link-type-list-response: type: object @@ -6278,6 +6502,7 @@ components: format: text deprecated: type: boolean + deprecated: true description: Whether the link type is deprecated. forward_name: type: string @@ -6287,14 +6512,23 @@ components: type: string description: The ID of the custom link type to update. format: id + is_deprecated: + type: boolean + description: Whether the link type is deprecated. name: type: string description: The updated name of the custom link type. format: text - source_types: - $ref: '#/components/schemas/update-link-target-descriptor-list' - target_types: - $ref: '#/components/schemas/update-link-target-descriptor-list' + source_types_v2: + type: array + description: Types from which a link can be made. + items: + $ref: '#/components/schemas/link-target-descriptor' + target_types_v2: + type: array + description: Types to which a link can be made. + items: + $ref: '#/components/schemas/link-target-descriptor' tooltip: type: string description: The updated tooltip of the custom link type. @@ -6473,6 +6707,10 @@ components: type: array description: List of filters to apply. items: {} + filters: + type: array + description: List of filters to apply. + items: {} leaf_type: type: string description: Leaf type to filter. @@ -6606,6 +6844,12 @@ components: $ref: '#/components/schemas/schema-field-descriptor' fragment_type: $ref: '#/components/schemas/custom-schema-fragment-fragment-type' + is_deprecated: + type: boolean + description: | + Indicates if the fragment is deprecated. Modifications to this + field are done in-place and don't result in creation of a new + fragment in chain. leaf_type: type: string description: Leaf type this fragment applies to. @@ -6740,10 +6984,14 @@ components: format: text deprecated: type: boolean + deprecated: true description: Whether only deprecated fragments should be filtered. is_custom_leaf_type: type: boolean description: Whether the leaf type corresponds to a custom object + is_deprecated: + type: boolean + description: Whether the fragment has been deprecated. leaf_type: type: array description: The list of leaf types. @@ -6844,6 +7092,7 @@ components: format: text deprecated: type: boolean + deprecated: true description: Whether this fragment has been deprecated. description: type: string @@ -6857,6 +7106,9 @@ components: is_custom_leaf_type: type: boolean description: Whether the leaf type corresponds to a custom object + is_deprecated: + type: boolean + description: Whether this fragment has been deprecated. leaf_type: type: string description: The leaf type this fragment applies to. @@ -7006,6 +7258,21 @@ components: Whether the subtype is to be dropped. Note: If set, the subtype field in the custom schema specifier should be nil title: custom-schema-spec-drop + custom-schema-spec-for-read: + type: object + description: Custom schemas described using identifiers + properties: + apps: + type: array + description: List of apps. + items: + type: string + format: text + subtype: + type: string + description: Name of the subtype. + format: text + title: custom-schema-spec-for-read custom-stage: allOf: - $ref: '#/components/schemas/atom-base' @@ -8552,6 +8819,11 @@ components: type: object description: The request to get a directory. properties: + dev_org: + type: string + description: Optional Dev Org ID for the unauthenticated user. + example: DEV-AbCdEfGh + format: id id: type: string description: The ID of the requested directory. @@ -8588,6 +8860,11 @@ components: The cursor to resume iteration from. If not provided, then iteration starts from the beginning. format: text + dev_org: + type: string + description: Optional Dev Org ID for the unauthenticated user. + example: DEV-AbCdEfGh + format: id limit: type: integer description: | @@ -10305,6 +10582,7 @@ components: - message - message_generation_started - progress + - suggestions client_metadata: type: object description: | @@ -10330,6 +10608,8 @@ components: type: string description: An identifier of the session with the AI agent. format: text + suggestions: + $ref: '#/components/schemas/ai-agent-event-suggestions' required: - agent - session @@ -13205,17 +13485,6 @@ components: - source - target title: link - link-descriptor-filter: - type: object - properties: - link_descriptors: - type: array - description: List of link descriptors. - items: - $ref: '#/components/schemas/link-target-descriptor' - required: - - link_descriptors - title: link-descriptor-filter link-endpoint-summary: type: object discriminator: @@ -13407,6 +13676,10 @@ components: type: object description: The request to create a new link. properties: + custom_link_type: + type: string + description: The ID of the custom link type. + format: id link_type: $ref: '#/components/schemas/link-type' source: @@ -13940,7 +14213,6 @@ components: required: - channel - members - - scheduled_date - state - title title: meetings-create-request @@ -15957,6 +16229,14 @@ components: format: int32 mode: $ref: '#/components/schemas/list-mode' + modified_by: + type: array + description: Filters for parts modified by any of these users. + example: + - DEVU-12345 + items: + type: string + format: id name: type: array description: Filters for parts of the provided name(s). @@ -15973,6 +16253,12 @@ components: format: id parent_part: $ref: '#/components/schemas/parent-part-filter' + subtype: + type: array + description: Filters for subtypes. + items: + type: string + format: text tags: type: array description: Filters for part with any of the provided tags. @@ -16857,6 +17143,104 @@ components: additionalProperties: false title: reactions-update-response x-go-name: ReactionsUpdateResponseBody + record-template: + allOf: + - $ref: '#/components/schemas/atom-base' + - type: object + properties: + custom_fields: + type: array + description: | + Custom Fields of the object that the record template is associated + with. + items: + $ref: '#/components/schemas/record-template-field-values' + description: + type: string + description: Description of the record template. + format: text + leaf_type: + type: string + description: | + Type of object that the record template is associated with. + format: text + name: + type: string + description: Name of the record template. + format: text + shared_with: + type: array + description: Shared with membership. + items: + $ref: '#/components/schemas/shared-with-membership' + state: + $ref: '#/components/schemas/record-template-state' + stock_fields: + type: array + description: | + Stock Fields of the object that the record template is associated + with. + items: + $ref: '#/components/schemas/record-template-field-values' + subtype: + type: string + description: | + Subtype of the object that the record template is associated with. + format: text + title: record-template + record-template-field-values: + type: object + description: Information about the field values. + properties: + field_name: + type: string + description: The field's name. + format: text + field_value: + description: Value of the given field. + title: record-template-field-values + record-template-get-request: + type: object + properties: + id: + type: string + description: The ID of the record template. + format: id + required: + - id + title: record-template-get-request + record-template-get-response: + type: object + properties: + record_template_info: + $ref: '#/components/schemas/record-template-info' + required: + - record_template_info + title: record-template-get-response + x-go-name: RecordTemplateGetResponseBody + record-template-info: + type: object + properties: + record_template: + $ref: '#/components/schemas/record-template' + stale_fields: + type: array + description: | + List of fields that do not conform to the expected schema of the + underlying leaf type of the template object. + items: + $ref: '#/components/schemas/record-template-field-values' + required: + - record_template + title: record-template-info + record-template-state: + type: string + description: State of the record template. + enum: + - active + - draft + - inactive + - needs_attention remove-tag-with-value: type: object properties: @@ -16956,6 +17340,8 @@ components: is specified, a system-generated identifier will be assigned to the organization. format: text + primary_rev_org: + $ref: '#/components/schemas/org-summary' stock_schema_fragment: type: string description: Stock schema fragment. @@ -19593,6 +19979,35 @@ components: - service_account title: service-accounts-get-response x-go-name: ServiceAccountsGetResponseBody + service-accounts-update-request: + type: object + description: The request object to update a service account. + properties: + display_name: + type: string + description: | + The service account's display name to be updated. A unique, human + readable name to identify a service account. + format: text + id: + type: string + description: The ID of the requested service account. + format: id + required: + - id + title: service-accounts-update-request + service-accounts-update-response: + type: object + description: | + The response object that carries the updated service account's + information. + properties: + service_account: + $ref: '#/components/schemas/service-account' + required: + - service_account + title: service-accounts-update-response + x-go-name: ServiceAccountsUpdateResponseBody set-issue-selector: type: object properties: @@ -21284,6 +21699,86 @@ components: - reference_id - visualization title: sub-widget + subscribers-list-request: + type: object + properties: + cursor: + type: string + description: | + The cursor to resume iteration from, otherwise if not provided, + then iteration starts from the beginning. + format: text + id: + type: string + description: The object's ID. + example: ISS-12345 + format: id + limit: + type: integer + description: | + The maximum number of subscribers to return. If not set or `<= 0`, + then this defaults to `50`. + format: int32 + required: + - id + title: subscribers-list-request + subscribers-list-response: + type: object + properties: + next_cursor: + type: string + description: | + The cursor that should be used to iterate the next sequence of + results, otherwise if not set, then no elements exist after. + format: text + users: + type: array + description: The list of subscribers on the object. + items: + $ref: '#/components/schemas/user-summary' + required: + - users + title: subscribers-list-response + x-go-name: SubscribersListResponseBody + subscribers-update-request: + type: object + properties: + id: + type: string + description: The object's ID. + example: ISS-12345 + format: id + subscribers: + $ref: '#/components/schemas/subscribers-update-request-subscribers' + required: + - id + title: subscribers-update-request + subscribers-update-request-subscribers: + type: object + properties: + add: + type: array + description: The list of users to add as subscribers on the object. + example: + - DEVU-12345 + items: + type: string + format: id + remove: + type: array + description: | + The list of users to remove as subscribers on the object. + example: + - DEVU-12345 + items: + type: string + format: id + title: subscribers-update-request-subscribers + subscribers-update-response: + type: object + additionalProperties: false + title: subscribers-update-response + x-go-name: SubscribersUpdateResponseBody subtype: type: object properties: @@ -21529,6 +22024,25 @@ components: additionalProperties: false title: surveys-delete-response x-go-name: SurveysDeleteResponseBody + surveys-get-request: + type: object + properties: + id: + type: string + description: The ID of the survey to get. + format: id + required: + - id + title: surveys-get-request + surveys-get-response: + type: object + properties: + survey: + $ref: '#/components/schemas/survey' + required: + - survey + title: surveys-get-response + x-go-name: SurveysGetResponseBody surveys-list-request: type: object properties: @@ -24184,17 +24698,6 @@ components: items: $ref: '#/components/schemas/update-tag-with-value' title: update-incident-tags - update-link-target-descriptor-list: - type: object - properties: - link_descriptors: - type: array - description: List of link descriptors. - items: - $ref: '#/components/schemas/link-target-descriptor' - required: - - link_descriptors - title: update-link-target-descriptor-list update-stage: type: object description: Update object for Stage. @@ -24398,6 +24901,8 @@ components: items: type: string format: text + primary_identity: + $ref: '#/components/schemas/user-summary' state: $ref: '#/components/schemas/user-state' title: user-base @@ -24761,6 +25266,10 @@ components: items: type: string format: text + user_agent: + type: string + description: User agent to use for crawling websites in this job. + format: text title: web-crawler-job web-crawler-job-state: type: string @@ -24890,6 +25399,11 @@ components: items: type: string format: text + user_agent: + type: string + description: User agent to use for crawling websites in this job. + format: text + maxLength: 1024 required: - applies_to_parts title: web-crawler-jobs-create-request @@ -26474,6 +26988,10 @@ components: type: string description: The source channel of the ticket. format: text + source_channel_v2: + type: string + description: Source channel ID of the ticket. + format: id title: works-create-request-ticket works-create-response: type: object @@ -26539,6 +27057,14 @@ components: format: int32 issue: $ref: '#/components/schemas/works-filter-issue' + modified_by: + type: array + description: Filters for work modified by any of these users. + example: + - DEVU-12345 + items: + type: string + format: id modified_date: $ref: '#/components/schemas/date-filter' opportunity: @@ -26693,6 +27219,13 @@ components: works-filter-ticket: type: object properties: + brand: + type: array + description: | + Filters for tickets that are associated with any of the brands. + items: + type: string + format: id channels: type: array description: Filters for tickets with any of the provided channels. @@ -26744,6 +27277,14 @@ components: items: type: string format: text + source_channel_v2: + type: array + description: | + Filters for tickets that are associated with any of the source + channels. + items: + type: string + format: id subtype: type: array description: Filters for tickets with any of the provided subtypes. @@ -26819,6 +27360,14 @@ components: format: int32 mode: $ref: '#/components/schemas/list-mode' + modified_by: + type: array + description: Filters for work modified by any of these users. + example: + - DEVU-12345 + items: + type: string + format: id modified_date: $ref: '#/components/schemas/date-filter' opportunity: @@ -27420,6 +27969,11 @@ components: format: text severity: $ref: '#/components/schemas/ticket-severity' + source_channel_v2: + type: string + description: Updates the source channel of the ticket. + format: id + nullable: true title: works-update-request-ticket works-update-request-ticket-channels: type: object @@ -27494,6 +28048,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /accounts.delete: post: description: Deletes an account. @@ -27531,6 +28086,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /accounts.export: get: description: Exports a collection of accounts. @@ -27713,6 +28269,7 @@ paths: - accounts x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: AccountsExportQuery post: description: Exports a collection of accounts. @@ -27748,6 +28305,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /accounts.get: get: description: Retrieves an account's information. @@ -27788,6 +28346,7 @@ paths: - accounts x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: AccountsGetQuery post: description: Retrieves an account's information. @@ -27825,6 +28384,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /accounts.list: get: description: Gets a list of accounts. @@ -28027,6 +28587,7 @@ paths: - accounts x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: AccountsListQuery post: description: Gets a list of accounts. @@ -28065,6 +28626,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /accounts.merge: post: description: Merges two accounts. @@ -28102,6 +28664,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /accounts.update: post: description: Updates an account's information. @@ -28141,6 +28704,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /ai-agents.events.execute-async: post: description: Execute an AI agent input event asynchronously. @@ -28178,6 +28742,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /airdrop.sync-units.get: get: description: Gets a single sync unit's information. @@ -28215,6 +28780,7 @@ paths: - airdrop x-fern-audiences: - docs + x-fern-availability: beta x-request-name: AirdropSyncUnitsGetQuery post: description: Gets a single sync unit's information. @@ -28250,6 +28816,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /airdrop.sync-units.history: get: description: Gets a list of sync unit historical records. @@ -28342,6 +28909,7 @@ paths: - airdrop x-fern-audiences: - docs + x-fern-availability: beta x-request-name: AirdropSyncUnitsHistoryQuery post: description: Gets a list of sync unit historical records. @@ -28377,6 +28945,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /articles.count: get: description: Get count of articles matching given filter. @@ -28423,6 +28992,16 @@ paths: items: type: string format: id + - description: | + Filters for articles belonging to any of the provided brands. + explode: false + in: query + name: brands + schema: + type: array + items: + type: string + format: id - description: Filters for articles created by any of the provided users. explode: false in: query @@ -28515,6 +29094,7 @@ paths: - articles x-fern-audiences: - docs + x-fern-availability: beta x-request-name: ArticlesCountQuery post: description: Get count of articles matching given filter. @@ -28550,6 +29130,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /articles.create: post: description: | @@ -28588,6 +29169,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /articles.delete: post: description: Deletes an article. @@ -28625,6 +29207,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /articles.get: get: description: Gets an article. @@ -28639,6 +29222,14 @@ paths: type: string example: ARTICLE-12345 format: id + - description: Optional Dev Org ID for the unauthenticated user. + explode: false + in: query + name: dev_org + schema: + type: string + example: DEV-AbCdEfGh + format: id responses: "200": content: @@ -28665,6 +29256,7 @@ paths: - articles x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: GetArticleQuery post: description: Gets an article. @@ -28702,6 +29294,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /articles.list: get: description: Lists a collection of articles. @@ -28741,6 +29334,16 @@ paths: items: type: string format: id + - description: | + Filters for articles belonging to any of the provided brands. + explode: false + in: query + name: brands + schema: + type: array + items: + type: string + format: id - description: Filters for articles created by any of the provided users. explode: false in: query @@ -28761,6 +29364,14 @@ paths: schema: type: string format: text + - description: Optional Dev Org ID for the unauthenticated user. + explode: false + in: query + name: dev_org + schema: + type: string + example: DEV-AbCdEfGh + format: id - description: | The maximum number of articles to return. The default is '50'. explode: false @@ -28858,6 +29469,7 @@ paths: - articles x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: ListArticlesQuery post: description: Lists a collection of articles. @@ -28893,6 +29505,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /articles.update: post: description: Updates an article. @@ -28930,6 +29543,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /artifacts.get: get: description: Gets the requested artifact's information. @@ -28977,6 +29591,7 @@ paths: - artifacts x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: ArtifactsGetQuery post: description: Gets the requested artifact's information. @@ -29014,6 +29629,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /artifacts.list: get: description: List the artifacts attached to an object. @@ -29052,6 +29668,7 @@ paths: - artifacts x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: ArtifactsListQuery post: description: List the artifacts attached to an object. @@ -29089,6 +29706,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /artifacts.locate: get: description: Gets the download URL for the artifact. @@ -29136,6 +29754,7 @@ paths: - artifacts x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: ArtifactsLocateQuery post: description: Gets the download URL for the artifact. @@ -29173,6 +29792,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /artifacts.prepare: post: description: | @@ -29209,6 +29829,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /artifacts.versions.delete: post: description: Permanently deletes a version of an artifact. @@ -29244,6 +29865,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /artifacts.versions.prepare: post: description: | @@ -29281,6 +29903,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /atoms.get: get: description: Gets the specified object. @@ -29318,6 +29941,7 @@ paths: - atoms x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: AtomsGetQuery post: description: Gets the specified object. @@ -29353,6 +29977,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /audit-logs.fetch: post: description: Retrieves audit logs. @@ -29392,6 +30017,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /auth-tokens.create: post: description: | @@ -29433,6 +30059,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /auth-tokens.delete: post: description: | @@ -29468,6 +30095,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /auth-tokens.get: get: description: | @@ -29510,6 +30138,7 @@ paths: - auth-tokens x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: AuthTokensGetQuery post: description: | @@ -29549,6 +30178,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /auth-tokens.info: get: description: | @@ -29583,6 +30213,7 @@ paths: - auth-tokens x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: AuthTokensInfoQuery post: description: | @@ -29624,6 +30255,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /auth-tokens.list: get: description: | @@ -29684,6 +30316,7 @@ paths: - auth-tokens x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: AuthTokensListQuery post: description: | @@ -29723,6 +30356,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /auth-tokens.self.delete: post: description: | @@ -29758,6 +30392,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /auth-tokens.update: post: description: | @@ -29797,6 +30432,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /brands.create: post: description: Creates a new brand. @@ -29834,6 +30470,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /brands.delete: post: description: Deletes a brand by its ID. @@ -29871,6 +30508,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /brands.get: get: description: Gets a brand by its ID. @@ -29910,6 +30548,7 @@ paths: - brands x-fern-audiences: - docs + x-fern-availability: beta x-request-name: BrandsGetQuery post: description: Gets a brand by its ID. @@ -29947,6 +30586,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /brands.list: get: description: Lists all brands. @@ -29985,6 +30625,7 @@ paths: - brands x-fern-audiences: - docs + x-fern-availability: beta x-request-name: BrandsListQuery post: description: Lists all brands. @@ -30020,6 +30661,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /brands.update: post: description: Updates a brand by its ID. @@ -30057,6 +30699,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /chats.create: post: description: Creates a new chat, or optionally opens an existing one. @@ -30092,6 +30735,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /chats.get: get: description: Gets a chat's information. @@ -30131,6 +30775,7 @@ paths: - chats x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: ChatsGetQuery post: description: Gets a chat's information. @@ -30168,6 +30813,45 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available + /chats.update: + post: + description: Updates a chat's information. + operationId: chats-update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/chats-update-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/chats-update-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Update Chat + tags: + - chats + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available /code-changes.create: post: description: Creates a code change object. @@ -30203,6 +30887,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /code-changes.delete: post: description: Deletes a code change object. @@ -30238,6 +30923,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /code-changes.get: get: description: Gets a code change object. @@ -30275,6 +30961,7 @@ paths: - code-changes x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: CodeChangesGetQuery post: description: Gets a code change object. @@ -30310,6 +30997,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /code-changes.list: get: description: Lists code change objects. @@ -30365,6 +31053,7 @@ paths: - code-changes x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: CodeChangesListQuery post: description: Lists code change objects. @@ -30400,6 +31089,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /code-changes.update: post: description: Updates a code change object. @@ -30435,6 +31125,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /commands.create: post: description: Creates a command. @@ -30472,6 +31163,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /commands.get: get: description: Gets a command. @@ -30511,6 +31203,7 @@ paths: - commands x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: CommandsGetQuery post: description: Gets a command. @@ -30548,6 +31241,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /commands.list: get: description: Lists commands for a Dev organization. @@ -30646,6 +31340,7 @@ paths: - commands x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: CommandsListQuery post: description: Lists commands for a Dev organization. @@ -30681,6 +31376,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /commands.update: post: description: Updates a command. @@ -30718,6 +31414,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /content-template.create: post: description: Create the content template. @@ -30753,6 +31450,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /content-template.get: get: description: Get the content template. @@ -30790,6 +31488,7 @@ paths: - notifications x-fern-audiences: - docs + x-fern-availability: beta x-request-name: ContentTemplateGetQuery post: description: Get the content template. @@ -30825,6 +31524,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /content-template.list: get: description: Lists the content templates. @@ -30920,6 +31620,7 @@ paths: - notifications x-fern-audiences: - docs + x-fern-availability: beta x-request-name: ContentTemplateListQuery post: description: Lists the content templates. @@ -30955,6 +31656,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /conversations.create: post: description: Creates a conversation. @@ -30990,6 +31692,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /conversations.delete: post: description: Deletes the requested conversation. @@ -31027,6 +31730,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /conversations.export: get: description: Exports a collection of conversation items. @@ -31044,6 +31748,16 @@ paths: items: type: string format: id + - description: | + Filters for tickets that are associated with any of the brands. + explode: false + in: query + name: brand + schema: + type: array + items: + type: string + format: id - description: | Filters for conversations that are associated with any of the channels. @@ -31140,7 +31854,8 @@ paths: items: type: string format: id - - description: | + - deprecated: true + description: | Filters for conversations that are associated with any of the provided Rev organizations. explode: false @@ -31186,6 +31901,18 @@ paths: type: string format: text - description: | + Filters for conversations that are associated with the source + channel. + explode: false + in: query + name: source_channel_v2 + schema: + type: array + items: + type: string + format: id + - deprecated: true + description: | Filters for conversations with any of the provided source channels. explode: false in: query @@ -31224,7 +31951,8 @@ paths: items: type: string format: text - - description: Filters for conversations with any of the provided tags. + - deprecated: true + description: Filters for conversations with any of the provided tags. explode: false in: query name: tags @@ -31277,6 +32005,7 @@ paths: - conversations x-fern-audiences: - docs + x-fern-availability: beta x-request-name: ConversationsExportQuery post: description: Exports a collection of conversation items. @@ -31312,6 +32041,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /conversations.get: get: description: Gets the requested conversation's information. @@ -31351,6 +32081,7 @@ paths: - conversations x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: ConversationsGetQuery post: description: Gets the requested conversation's information. @@ -31388,6 +32119,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /conversations.list: get: description: Lists the available conversations. @@ -31405,6 +32137,16 @@ paths: items: type: string format: id + - description: | + Filters for tickets that are associated with any of the brands. + explode: false + in: query + name: brand + schema: + type: array + items: + type: string + format: id - description: | Filters for conversations that are associated with any of the channels. @@ -31517,7 +32259,8 @@ paths: items: type: string format: id - - description: | + - deprecated: true + description: | Filters for conversations that are associated with any of the provided Rev organizations. explode: false @@ -31563,6 +32306,18 @@ paths: type: string format: text - description: | + Filters for conversations that are associated with the source + channel. + explode: false + in: query + name: source_channel_v2 + schema: + type: array + items: + type: string + format: id + - deprecated: true + description: | Filters for conversations with any of the provided source channels. explode: false in: query @@ -31601,7 +32356,8 @@ paths: items: type: string format: text - - description: Filters for conversations with any of the provided tags. + - deprecated: true + description: Filters for conversations with any of the provided tags. explode: false in: query name: tags @@ -31654,6 +32410,7 @@ paths: - conversations x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: ConversationsListQuery post: description: Lists the available conversations. @@ -31689,6 +32446,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /conversations.update: post: description: Updates the requested conversation. @@ -31726,6 +32484,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /custom-objects.count: get: description: Counts custom objects. @@ -31770,6 +32529,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: CustomObjectsCountQuery post: description: Counts custom objects. @@ -31805,6 +32565,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /custom-objects.create: post: description: Creates a custom object. @@ -31840,6 +32601,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /custom-objects.delete: post: description: Deletes a custom object. @@ -31877,6 +32639,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /custom-objects.get: get: description: Gets a custom object. @@ -31915,6 +32678,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: CustomObjectsGetQuery post: description: Gets a custom object. @@ -31952,6 +32716,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /custom-objects.list: get: description: Lists custom objects. @@ -31981,6 +32746,13 @@ paths: schema: type: array items: {} + - description: List of filters to apply. + explode: false + in: query + name: filters + schema: + type: array + items: {} - description: The maximum number of items. explode: false in: query @@ -32032,6 +32804,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: CustomObjectsListQuery post: description: Lists custom objects. @@ -32069,6 +32842,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /custom-objects.update: post: description: Updates a custom object. @@ -32106,6 +32880,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /dev-orgs.auth-connections.create: post: description: | @@ -32149,6 +32924,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-orgs.auth-connections.delete: post: description: | @@ -32186,6 +32962,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-orgs.auth-connections.get: get: description: Retrieves the details for an authentication connection. @@ -32228,6 +33005,7 @@ paths: - dev-orgs x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: DevOrgAuthConnectionsGetQuery post: description: Retrieves the details for an authentication connection. @@ -32268,6 +33046,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-orgs.auth-connections.list: get: description: | @@ -32303,6 +33082,7 @@ paths: - dev-orgs x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: DevOrgAuthConnectionsListQuery post: description: | @@ -32345,6 +33125,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-orgs.auth-connections.toggle: post: description: | @@ -32382,6 +33163,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-orgs.auth-connections.update: post: description: Updates an authentication connection. @@ -32422,6 +33204,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-orgs.get: get: description: | @@ -32453,6 +33236,7 @@ paths: - dev-orgs x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: DevOrgsGetQuery post: description: | @@ -32491,6 +33275,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-users.activate: post: description: Activates the requested user. @@ -32528,6 +33313,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-users.create: post: description: Creates a Dev user for a Dev organization. @@ -32565,6 +33351,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-users.deactivate: post: description: Deactivates the requested user. @@ -32602,6 +33389,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-users.get: get: description: Gets the requested user's information. @@ -32641,6 +33429,7 @@ paths: - dev-users x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: DevUsersGetQuery post: description: Gets the requested user's information. @@ -32678,6 +33467,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-users.identities.link: post: description: Links an external/secondary identity to the Dev user. @@ -32716,6 +33506,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-users.identities.unlink: post: description: Unlinks an external/secondary identity from the Dev user. @@ -32755,6 +33546,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-users.list: get: description: Lists users within your organization. @@ -32856,6 +33648,7 @@ paths: - dev-users x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: DevUsersListQuery post: description: Lists users within your organization. @@ -32891,6 +33684,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-users.merge: post: description: | @@ -32933,6 +33727,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-users.self: get: description: Gets the authenticated user's information. @@ -32962,6 +33757,7 @@ paths: - dev-users x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: DevUsersSelfQuery post: description: Gets the authenticated user's information. @@ -32998,6 +33794,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-users.self.update: post: description: Updates the authenticated user. @@ -33033,6 +33830,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /dev-users.update: post: description: Updates the user corresponding to the input Id. @@ -33068,6 +33866,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /directories.count: get: description: Get count of directories matching given filter. @@ -33121,6 +33920,7 @@ paths: - directory x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: DirectoriesCountQuery post: description: Get count of directories matching given filter. @@ -33156,6 +33956,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /directories.create: post: description: Creates a directory for the specified inputs. @@ -33191,6 +33992,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /directories.delete: post: description: Delete the specified directory. @@ -33228,6 +34030,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /directories.get: get: description: Gets the specified directory. @@ -33241,6 +34044,14 @@ paths: schema: type: string format: id + - description: Optional Dev Org ID for the unauthenticated user. + explode: false + in: query + name: dev_org + schema: + type: string + example: DEV-AbCdEfGh + format: id responses: "200": content: @@ -33267,6 +34078,7 @@ paths: - directory x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: DirectoriesGetQuery post: description: Gets the specified directory. @@ -33304,6 +34116,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /directories.list: get: description: Lists directories matching the request. @@ -33330,6 +34143,14 @@ paths: schema: type: string format: text + - description: Optional Dev Org ID for the unauthenticated user. + explode: false + in: query + name: dev_org + schema: + type: string + example: DEV-AbCdEfGh + format: id - description: | The maximum number of directories to return. The default is '50'. explode: false @@ -33382,6 +34203,7 @@ paths: - directory x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: DirectoriesListQuery post: description: Lists directories matching the request. @@ -33417,6 +34239,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /directories.update: post: description: Updates the specified directory. @@ -33454,6 +34277,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /engagements.count: get: description: Counts the engagement records. @@ -33522,6 +34346,7 @@ paths: - engagements x-fern-audiences: - docs + x-fern-availability: beta x-request-name: EngagementsCountQuery post: description: Counts the engagement records. @@ -33557,6 +34382,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /engagements.create: post: description: Creates a new engagement record. @@ -33592,6 +34418,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /engagements.delete: post: description: Deletes the engagement record. @@ -33629,6 +34456,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /engagements.get: get: description: Gets the engagement record. @@ -33668,6 +34496,7 @@ paths: - engagements x-fern-audiences: - docs + x-fern-availability: beta x-request-name: EngagementsGetQuery post: description: Gets the engagement record. @@ -33705,6 +34534,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /engagements.list: get: description: Lists the engagement records. @@ -33807,6 +34637,7 @@ paths: - engagements x-fern-audiences: - docs + x-fern-availability: beta x-request-name: EngagementsListQuery post: description: Lists the engagement records. @@ -33842,6 +34673,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /engagements.update: post: description: Updates the engagement record. @@ -33879,6 +34711,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /event-sources.get: get: description: Gets an event source. @@ -33918,6 +34751,7 @@ paths: - event-sources x-fern-audiences: - docs + x-fern-availability: beta x-request-name: EventSourcesGetQuery post: description: Gets an event source. @@ -33955,6 +34789,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /event-sources.schedule: post: description: | @@ -33993,6 +34828,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /event-sources.unschedule: post: description: Deletes an event scheduled for the specified event source. @@ -34026,6 +34862,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /groups.create: post: description: Creates a new group. A group is a collection of users. @@ -34061,6 +34898,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /groups.get: get: description: Gets the requested group. @@ -34100,6 +34938,7 @@ paths: - groups x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: GroupsGetQuery post: description: Gets the requested group. @@ -34137,6 +34976,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /groups.list: get: description: Lists the available groups. @@ -34319,6 +35159,7 @@ paths: - groups x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: GroupsListQuery post: description: Lists the available groups. @@ -34354,6 +35195,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /groups.members.add: post: description: Adds a member to a group. @@ -34391,6 +35233,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /groups.members.list: get: description: Lists the members in a group. @@ -34454,6 +35297,7 @@ paths: - groups x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: GroupMembersListQuery post: description: Lists the members in a group. @@ -34489,6 +35333,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /groups.members.remove: post: description: Removes a member from a group. @@ -34526,6 +35371,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /groups.update: post: description: Updates the requested group. @@ -34563,6 +35409,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /incidents.create: post: description: Creates an incident. @@ -34598,6 +35445,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /incidents.delete: post: description: Deletes an incident. @@ -34635,6 +35483,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /incidents.get: get: description: Gets an incident. @@ -34674,6 +35523,7 @@ paths: - incidents x-fern-audiences: - docs + x-fern-availability: beta x-request-name: IncidentsGetQuery post: description: Gets an incident. @@ -34711,6 +35561,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /incidents.group: get: description: Lists collections of incidents by groups. @@ -34858,7 +35709,8 @@ paths: items: type: string format: sort-by - - description: Filters for incidents with any of the provided sources. + - deprecated: true + description: Filters for incidents with any of the provided sources. explode: false in: query name: source @@ -34996,6 +35848,7 @@ paths: - incidents x-fern-audiences: - docs + x-fern-availability: beta x-request-name: IncidentsGroupQuery post: description: Lists collections of incidents by groups. @@ -35031,6 +35884,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /incidents.list: get: description: Lists incidents. @@ -35160,7 +36014,8 @@ paths: items: type: string format: sort-by - - description: Filters for incidents with any of the provided sources. + - deprecated: true + description: Filters for incidents with any of the provided sources. explode: false in: query name: source @@ -35298,6 +36153,7 @@ paths: - incidents x-fern-audiences: - docs + x-fern-availability: beta x-request-name: IncidentsListQuery post: description: Lists incidents. @@ -35333,6 +36189,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /incidents.update: post: description: Updates an incident. @@ -35370,6 +36227,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /keyrings.authorize: get: description: OAuth2 authorization callback. @@ -35412,6 +36270,7 @@ paths: - keyrings x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: KeyringsCreateCallbackQuery post: description: OAuth2 authorization callback. @@ -35443,6 +36302,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /link-types.custom.create: post: description: Creates a custom link type. @@ -35478,6 +36338,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /link-types.custom.get: get: description: Gets a custom link type. @@ -35517,6 +36378,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: CustomLinkTypeGetQuery post: description: Gets a custom link type. @@ -35554,6 +36416,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /link-types.custom.list: get: description: Lists custom link types. @@ -35568,10 +36431,18 @@ paths: schema: type: string format: text - - description: Whether only deprecated link types should be filtered. + - deprecated: true + description: Whether only deprecated link types should be filtered. explode: false in: query name: deprecated + schema: + type: boolean + deprecated: true + - description: Whether only deprecated link types should be filtered. + explode: false + in: query + name: is_deprecated schema: type: boolean - description: The maximum number of items. @@ -35611,7 +36482,7 @@ paths: - description: True when the descriptor describes a custom leaf type. explode: false in: query - name: source_types.link_descriptors.is_custom_leaf_type + name: source_types_v2.is_custom_leaf_type schema: type: boolean - description: | @@ -35619,27 +36490,27 @@ paths: allowed as a link target. explode: false in: query - name: source_types.link_descriptors.leaf_only + name: source_types_v2.leaf_only schema: type: boolean - description: Leaf type of the target objects. explode: false in: query - name: source_types.link_descriptors.leaf_type + name: source_types_v2.leaf_type schema: type: string format: text - description: Specific subtype of the target objects. explode: false in: query - name: source_types.link_descriptors.subtype + name: source_types_v2.subtype schema: type: string format: text - description: True when the descriptor describes a custom leaf type. explode: false in: query - name: target_types.link_descriptors.is_custom_leaf_type + name: target_types_v2.is_custom_leaf_type schema: type: boolean - description: | @@ -35647,20 +36518,20 @@ paths: allowed as a link target. explode: false in: query - name: target_types.link_descriptors.leaf_only + name: target_types_v2.leaf_only schema: type: boolean - description: Leaf type of the target objects. explode: false in: query - name: target_types.link_descriptors.leaf_type + name: target_types_v2.leaf_type schema: type: string format: text - description: Specific subtype of the target objects. explode: false in: query - name: target_types.link_descriptors.subtype + name: target_types_v2.subtype schema: type: string format: text @@ -35688,6 +36559,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: CustomLinkTypeListQuery post: description: Lists custom link types. @@ -35723,6 +36595,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /link-types.custom.update: post: description: Updates a custom link type. @@ -35760,6 +36633,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /links.create: post: description: | @@ -35796,6 +36670,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /links.delete: post: description: Deletes a link. @@ -35833,6 +36708,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /links.get: get: description: Gets the requested link's information. @@ -35872,6 +36748,7 @@ paths: - links x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: LinksGetQuery post: description: Gets the requested link's information. @@ -35909,6 +36786,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /links.list: get: description: Lists the available links. @@ -35976,7 +36854,8 @@ paths: type: array items: $ref: '#/components/schemas/link-endpoint-type' - - description: | + - deprecated: true + description: | The link types to filter for, otherwise if not present, all link types are included. explode: false @@ -36011,6 +36890,7 @@ paths: - links x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: LinksListQuery post: description: Lists the available links. @@ -36046,6 +36926,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /links.replace: post: description: Replaces a link. @@ -36081,6 +36962,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /meetings.count: get: description: Counts the meeting records. @@ -36160,7 +37042,8 @@ paths: items: type: string format: id - - description: Filters for meetings with the provided parent. + - deprecated: true + description: Filters for meetings with the provided parent. explode: false in: query name: parent @@ -36213,6 +37096,7 @@ paths: - meetings x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: MeetingsCountQuery post: description: Counts the meeting records. @@ -36248,6 +37132,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /meetings.create: post: description: Creates a new meeting record. @@ -36283,6 +37168,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /meetings.delete: post: description: Deletes the meeting record. @@ -36320,6 +37206,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /meetings.get: get: description: Gets the meeting record. @@ -36359,6 +37246,7 @@ paths: - meetings x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: MeetingsGetQuery post: description: Gets the meeting record. @@ -36396,6 +37284,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /meetings.list: get: description: Lists the meeting records. @@ -36499,7 +37388,8 @@ paths: items: type: string format: id - - description: Filters for meetings with the provided parent. + - deprecated: true + description: Filters for meetings with the provided parent. explode: false in: query name: parent @@ -36562,6 +37452,7 @@ paths: - meetings x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: MeetingsListQuery post: description: Lists the meeting records. @@ -36597,6 +37488,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /meetings.update: post: description: Updates the meeting record. @@ -36634,6 +37526,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /metric-action.execute: post: description: Executes the metric action on the given object. @@ -36671,6 +37564,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /metric-definitions.create: post: description: Creates a custom metric definition @@ -36706,6 +37600,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /metric-definitions.delete: post: description: Deletes a custom metric definition @@ -36743,6 +37638,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /metric-definitions.get: get: description: Gets a custom metric definition @@ -36788,6 +37684,7 @@ paths: - slas x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: MetricDefinitionsGetQuery post: description: Gets a custom metric definition @@ -36823,6 +37720,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /metric-definitions.list: get: description: Lists metric definitions matching a filter. @@ -36919,6 +37817,7 @@ paths: - slas x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: MetricDefinitionsListQuery post: description: Lists metric definitions matching a filter. @@ -36954,6 +37853,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /metric-definitions.update: post: description: Updates a custom metric definition @@ -36991,6 +37891,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /metric-trackers.get: get: description: Gets a metric tracker. @@ -37039,6 +37940,7 @@ paths: - slas x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: MetricTrackersGetQuery post: description: Gets a metric tracker. @@ -37076,6 +37978,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /metrics.devrev.ingest: post: description: Ingest endpoint for DevRev metrics data from clients. @@ -37107,6 +38010,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /notifications.send: post: description: Generate a notification. @@ -37142,6 +38046,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /org-schedule-fragments.create: post: description: Creates an organization schedule fragment. @@ -37177,6 +38082,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /org-schedule-fragments.get: get: description: Gets an organization schedule fragment. @@ -37214,6 +38120,7 @@ paths: - schedules x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: OrgScheduleFragmentsGetQuery post: description: Gets an organization schedule fragment. @@ -37249,6 +38156,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /org-schedule-fragments.transition: post: description: Changes stage of an organization schedule fragment. @@ -37284,6 +38192,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /org-schedules.create: post: description: | @@ -37321,6 +38230,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /org-schedules.evaluate: get: description: Evaluates an organization's schedule at specified instants. @@ -37371,6 +38281,7 @@ paths: - schedules x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: OrgSchedulesEvaluateQuery post: description: Evaluates an organization's schedule at specified instants. @@ -37406,6 +38317,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /org-schedules.get: get: description: Gets an organization schedule. @@ -37443,6 +38355,7 @@ paths: - schedules x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: OrgSchedulesGetQuery post: description: Gets an organization schedule. @@ -37478,6 +38391,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /org-schedules.list: get: description: Gets list of organization schedules. @@ -37550,6 +38464,7 @@ paths: - schedules x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: OrgSchedulesListQuery post: description: Gets list of organization schedules. @@ -37585,6 +38500,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /org-schedules.set-future: post: description: | @@ -37622,6 +38538,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /org-schedules.transition: post: description: Publishes or archives an organization schedule. @@ -37657,6 +38574,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /org-schedules.update: post: description: Updates an organization schedule. @@ -37694,6 +38612,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /parts.create: post: description: Creates new [part](https://devrev.ai/docs/product/parts). @@ -37729,6 +38648,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /parts.delete: post: description: Deletes a [part](https://devrev.ai/docs/product/parts). @@ -37766,6 +38686,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /parts.get: get: description: | @@ -37807,6 +38728,7 @@ paths: - parts x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: PartsGetQuery post: description: | @@ -37845,6 +38767,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /parts.list: get: description: | @@ -38027,6 +38950,17 @@ paths: name: mode schema: $ref: '#/components/schemas/list-mode' + - description: Filters for parts modified by any of these users. + explode: false + in: query + name: modified_by + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id - description: Filters for parts of the provided name(s). explode: false in: query @@ -38069,6 +39003,15 @@ paths: type: string format: id minItems: 1 + - description: Filters for subtypes. + explode: false + in: query + name: subtype + schema: + type: array + items: + type: string + format: text - description: Filters for part with any of the provided tags. explode: false in: query @@ -38112,6 +39055,7 @@ paths: - parts x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: PartsListQuery post: description: | @@ -38148,6 +39092,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /parts.update: post: description: | @@ -38186,6 +39131,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /preferences.get: get: description: Get the preferences object. @@ -38242,6 +39188,7 @@ paths: - preferences x-fern-audiences: - docs + x-fern-availability: beta x-request-name: PreferencesGetQuery post: description: Get the preferences object. @@ -38279,6 +39226,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /preferences.update: post: description: Updates the preference for a particular object. @@ -38316,6 +39264,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /question-answers.create: post: description: Creates a question-answer. @@ -38351,6 +39300,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /question-answers.delete: post: description: Deletes a question-answer. @@ -38384,6 +39334,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /question-answers.get: get: description: Gets a question-answer. @@ -38423,6 +39374,7 @@ paths: - question-answers x-fern-audiences: - docs + x-fern-availability: beta x-request-name: GetQuestionAnswerQuery post: description: Gets a question-answer. @@ -38460,6 +39412,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /question-answers.list: get: description: Lists a collection of question-answers. @@ -38564,6 +39517,7 @@ paths: - question-answers x-fern-audiences: - docs + x-fern-availability: beta x-request-name: ListQuestionAnswersQuery post: description: Lists a collection of question-answers. @@ -38599,6 +39553,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /question-answers.update: post: description: Updates a question-answer. @@ -38636,6 +39591,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /reactions.list: get: description: Lists the reactors for an object. @@ -38701,6 +39657,7 @@ paths: - works x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: ReactionsListQuery post: description: Lists the reactors for an object. @@ -38737,6 +39694,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /reactions.update: post: description: Updates a reaction for an object. @@ -38773,6 +39731,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /recommendations.chat.completions: post: description: Returns a response for the chat conversation. @@ -38808,6 +39767,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta x-fern-streaming: format: sse /recommendations.get-reply: @@ -38845,6 +39805,85 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta + /record-templates.get: + get: + description: Gets a record template object. + operationId: record-template-get + parameters: + - description: The ID of the record template. + explode: false + in: query + name: id + required: true + schema: + type: string + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/record-template-get-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Record Template + tags: + - record-templates + x-fern-audiences: + - docs + x-fern-availability: beta + x-request-name: RecordTemplateGetQuery + post: + description: Gets a record template object. + operationId: record-template-get-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/record-template-get-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/record-template-get-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Record Template (POST) + tags: + - record-templates + x-fern-audiences: + - docs + - sdks + x-fern-availability: beta /rev-orgs.create: post: description: | @@ -38885,6 +39924,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /rev-orgs.delete: post: description: Deletes the Rev organization. @@ -38922,6 +39962,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /rev-orgs.get: get: description: Retrieves the Rev organization's information. @@ -38971,6 +40012,7 @@ paths: - rev-orgs x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: RevOrgsGetQuery post: description: Retrieves the Rev organization's information. @@ -39008,6 +40050,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /rev-orgs.list: get: description: | @@ -39181,6 +40224,7 @@ paths: - rev-orgs x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: RevOrgsListQuery post: description: | @@ -39222,6 +40266,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /rev-orgs.update: post: description: Updates the Rev organization's information. @@ -39261,6 +40306,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /rev-users.associations.add: post: description: | @@ -39300,6 +40346,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /rev-users.associations.list: get: description: Returns a list of associations on a Rev user. @@ -39365,6 +40412,7 @@ paths: - rev-users x-fern-audiences: - docs + x-fern-availability: beta x-request-name: RevUsersAssociationsListQuery post: description: Returns a list of associations on a Rev user. @@ -39402,6 +40450,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /rev-users.associations.remove: post: description: | @@ -39441,6 +40490,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /rev-users.create: post: description: | @@ -39481,6 +40531,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /rev-users.delete: post: description: Deletes a Rev user. @@ -39518,6 +40569,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /rev-users.delete-personal-data: post: description: Deletes data of a contact. @@ -39558,6 +40610,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /rev-users.get: get: description: Returns the Rev user of a Rev organization by its ID. @@ -39597,6 +40650,7 @@ paths: - rev-users x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: RevUsersGetQuery post: description: Returns the Rev user of a Rev organization by its ID. @@ -39634,6 +40688,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /rev-users.link: post: deprecated: true @@ -39673,6 +40728,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: deprecated /rev-users.list: get: description: | @@ -39870,6 +40926,7 @@ paths: - rev-users x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: RevUsersListQuery post: description: | @@ -39910,6 +40967,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /rev-users.merge: post: description: Merges the secondary Rev user into the primary Rev user. @@ -39949,6 +41007,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /rev-users.personal-data: post: description: Retrieves data of a contact. @@ -39989,6 +41048,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /rev-users.scan: get: description: Scans through all Rev users. @@ -40157,6 +41217,7 @@ paths: - rev-users x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: RevUsersScanQuery post: description: Scans through all Rev users. @@ -40194,6 +41255,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /rev-users.unlink: post: deprecated: true @@ -40233,6 +41295,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: deprecated /rev-users.update: post: description: Updates a Rev user. @@ -40272,6 +41335,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /roles.apply: post: description: Assigns or revokes roles of a principal. @@ -40309,6 +41373,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /roles.create: post: description: Creates a new role. @@ -40344,6 +41409,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /schemas.aggregated.get: get: description: Gets the aggregated schema. @@ -40354,12 +41420,27 @@ paths: explode: false in: query name: custom_schema_fragment_ids - required: true schema: type: array items: type: string format: id + - description: List of apps. + explode: false + in: query + name: custom_schema_spec.apps + schema: + type: array + items: + type: string + format: text + - description: Name of the subtype. + explode: false + in: query + name: custom_schema_spec.subtype + schema: + type: string + format: text - description: Whether the leaf type corresponds to a custom object. explode: false in: query @@ -40408,6 +41489,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: AggregatedSchemaGetQuery post: description: Gets the aggregated schema. @@ -40445,6 +41527,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /schemas.custom.get: get: description: Gets a custom schema fragment. @@ -40484,6 +41567,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: CustomSchemaFragmentsGetQuery post: description: Gets a custom schema fragment. @@ -40521,6 +41605,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /schemas.custom.list: get: description: Lists custom schema fragments. @@ -40544,18 +41629,26 @@ paths: schema: type: string format: text - - description: Whether only deprecated fragments should be filtered. + - deprecated: true + description: Whether only deprecated fragments should be filtered. explode: false in: query name: deprecated schema: type: boolean + deprecated: true - description: Whether the leaf type corresponds to a custom object explode: false in: query name: is_custom_leaf_type schema: type: boolean + - description: Whether the fragment has been deprecated. + explode: false + in: query + name: is_deprecated + schema: + type: boolean - description: The list of leaf types. explode: false in: query @@ -40641,6 +41734,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: CustomSchemaFragmentsListQuery post: description: Lists custom schema fragments. @@ -40676,6 +41770,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /schemas.custom.set: post: description: Creates or updates a custom schema fragment. @@ -40711,6 +41806,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /schemas.stock.get: get: description: Gets a stock schema fragment. @@ -40756,6 +41852,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: StockSchemaFragmentsGetQuery post: description: Gets a stock schema fragment. @@ -40793,6 +41890,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /schemas.stock.list: get: description: Lists stock schema fragments. @@ -40883,6 +41981,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: StockSchemaFragmentsListQuery post: description: Lists stock schema fragments. @@ -40918,12 +42017,14 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /schemas.subtypes.list: get: description: Lists subtypes. operationId: subtypes-list parameters: - - description: Leaf type for which subtypes are required. + - deprecated: true + description: Leaf type for which subtypes are required. explode: false in: query name: leaf_type @@ -40964,6 +42065,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: SubtypesListQuery post: description: Lists subtypes. @@ -40999,6 +42101,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /schemas.subtypes.prepare-update: post: description: | @@ -41037,6 +42140,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /search.core: get: description: Searches for records based on a given query. @@ -41123,6 +42227,7 @@ paths: - search x-fern-audiences: - docs + x-fern-availability: beta x-request-name: SearchCoreQuery post: description: Searches for records based on a given query. @@ -41158,6 +42263,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /search.hybrid: get: description: | @@ -41226,6 +42332,7 @@ paths: - search x-fern-audiences: - docs + x-fern-availability: beta x-request-name: SearchHybridQuery post: description: | @@ -41262,6 +42369,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /service-accounts.create: post: description: Creates a service account. @@ -41299,6 +42407,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /service-accounts.get: get: description: Gets a service account. @@ -41340,6 +42449,7 @@ paths: - service-accounts x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: ServiceAccountsGetQuery post: description: Gets a service account. @@ -41379,6 +42489,47 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available + /service-accounts.update: + post: + description: Updates a service account. + operationId: service-accounts-update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/service-accounts-update-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/service-accounts-update-response' + description: | + The response object that carries the updated service account's + information. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Update Service Account + tags: + - service-accounts + x-fern-audiences: + - docs + - sdks + x-fern-availability: beta /sla-trackers.get: get: description: Gets an SLA tracker. @@ -41418,6 +42569,7 @@ paths: - slas x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: SlaTrackersGetQuery post: description: Gets an SLA tracker. @@ -41455,6 +42607,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /sla-trackers.list: get: description: Lists SLA trackers matching a filter. @@ -41575,6 +42728,7 @@ paths: - slas x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: SlaTrackersListQuery post: description: Lists SLA trackers matching a filter. @@ -41610,6 +42764,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /sla-trackers.remove-metric: post: description: Removes a metric from the given object's SLA. @@ -41647,6 +42802,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /slas.assign: post: description: ' Assigns the SLA to a set of Rev organizations.' @@ -41684,6 +42840,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /slas.create: post: description: Creates an SLA in draft status. @@ -41719,6 +42876,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /slas.get: get: description: Gets an SLA. @@ -41758,6 +42916,7 @@ paths: - slas x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: SlasGetQuery post: description: Gets an SLA. @@ -41795,6 +42954,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /slas.list: get: description: Lists SLAs matching a filter. @@ -41889,6 +43049,7 @@ paths: - slas x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: SlasListQuery post: description: Lists SLAs matching a filter. @@ -41924,6 +43085,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /slas.transition: post: description: Changes the status of an SLA. @@ -41961,6 +43123,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /slas.update: post: description: Updates a draft SLA. @@ -41998,6 +43161,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /snap-ins.resources: get: description: Gets snap-in resources for a user in a snap-in. @@ -42043,6 +43207,7 @@ paths: - snap-ins x-fern-audiences: - docs + x-fern-availability: beta x-request-name: SnapInsResourcesQuery post: description: Gets snap-in resources for a user in a snap-in. @@ -42078,6 +43243,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /snap-ins.update: post: description: Updates a snap-in. @@ -42115,6 +43281,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /snap-kit-action.execute.deferred: post: description: Executes deferred snap-kit actions. @@ -42150,6 +43317,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /snap-widgets.create: post: description: Create a snap widget object. @@ -42185,6 +43353,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /stage-diagrams.create: post: description: Creates a stage diagram. @@ -42220,6 +43389,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /stage-diagrams.get: get: description: Gets a stage diagram. @@ -42275,6 +43445,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: StageDiagramsGetQuery post: description: Gets a stage diagram. @@ -42312,6 +43483,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /stage-diagrams.list: get: description: Lists stage diagrams. @@ -42392,6 +43564,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: StageDiagramsListQuery post: description: Lists stage diagrams. @@ -42427,6 +43600,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /stage-diagrams.update: post: description: Updates a stage diagram. @@ -42464,6 +43638,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /stages.custom.create: post: description: Creates a custom stage. @@ -42499,6 +43674,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /stages.custom.get: get: description: Gets a custom stage. @@ -42538,6 +43714,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: CustomStagesGetQuery post: description: Gets a custom stage. @@ -42575,6 +43752,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /stages.custom.list: get: description: Lists custom stages. @@ -42648,6 +43826,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: CustomStagesListQuery post: description: Lists custom stages. @@ -42683,6 +43862,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /stages.custom.update: post: description: Updates a custom stage. @@ -42720,6 +43900,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /states.custom.create: post: description: Creates a custom state. @@ -42755,6 +43936,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /states.custom.get: get: description: Gets a custom state. @@ -42794,6 +43976,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: CustomStatesGetQuery post: description: Gets a custom state. @@ -42831,6 +44014,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /states.custom.list: get: description: Lists custom states. @@ -42910,6 +44094,7 @@ paths: - customization x-fern-audiences: - docs + x-fern-availability: beta x-request-name: CustomStatesListQuery post: description: Lists custom states. @@ -42945,6 +44130,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /states.custom.update: post: description: Updates a custom state. @@ -42982,6 +44168,142 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta + /subscribers.list: + get: + description: Lists subscribers of an object. + operationId: subscribers-list + parameters: + - description: The object's ID. + explode: false + in: query + name: id + required: true + schema: + type: string + example: ISS-12345 + format: id + - description: | + The cursor to resume iteration from, otherwise if not provided, then + iteration starts from the beginning. + explode: false + in: query + name: cursor + schema: + type: string + format: text + - description: | + The maximum number of subscribers to return. If not set or `<= 0`, + then this defaults to `50`. + explode: false + in: query + name: limit + schema: + type: integer + format: int32 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/subscribers-list-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Subscribers + tags: + - subscribers + x-fern-audiences: + - docs + x-fern-availability: beta + x-request-name: SubscribersListQuery + post: + description: Lists subscribers of an object. + operationId: subscribers-list-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/subscribers-list-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/subscribers-list-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Subscribers (POST) + tags: + - subscribers + x-fern-audiences: + - docs + - sdks + x-fern-availability: beta + /subscribers.update: + post: + description: Updates subscribers on the object. + operationId: subscribers-update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/subscribers-update-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/subscribers-update-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Update Subscriber + tags: + - subscribers + x-fern-audiences: + - docs + - sdks + x-fern-availability: beta /surveys.create: post: description: | @@ -43019,6 +44341,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /surveys.delete: post: description: Deletes the specified survey. @@ -43056,6 +44379,81 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available + /surveys.get: + get: + description: Gets a survey given the ID. + operationId: surveys-get + parameters: + - description: The ID of the survey to get. + explode: false + in: query + name: id + required: true + schema: + type: string + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/surveys-get-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Survey + tags: + - surveys + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: SurveysGetQuery + post: + description: Gets a survey given the ID. + operationId: surveys-get-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/surveys-get-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/surveys-get-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Survey (POST) + tags: + - surveys + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available /surveys.list: get: description: List surveys requested by the user. @@ -43141,6 +44539,7 @@ paths: - surveys x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: SurveysListQuery post: description: List surveys requested by the user. @@ -43176,6 +44575,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /surveys.responses.list: get: description: List survey responses requested by the user. @@ -43305,6 +44705,7 @@ paths: - surveys x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: SurveysResponsesListQuery post: description: List survey responses requested by the user. @@ -43340,6 +44741,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /surveys.responses.update: post: description: | @@ -43376,6 +44778,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /surveys.send: post: description: Sends a survey on the specified channels. @@ -43411,6 +44814,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /surveys.submit: post: description: | @@ -43447,6 +44851,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /surveys.update: post: description: Updates a survey's metadata. @@ -43482,6 +44887,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /sys-users.list: get: description: Lists system users within your organization. @@ -43547,6 +44953,7 @@ paths: - sys-users x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: SysUsersListQuery post: description: Lists system users within your organization. @@ -43582,6 +44989,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /sys-users.update: post: description: Updates the system user. @@ -43619,6 +45027,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /tags.create: post: description: | @@ -43656,6 +45065,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /tags.delete: post: description: Deletes a tag. @@ -43693,6 +45103,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /tags.get: get: description: Gets a tag's information. @@ -43733,6 +45144,7 @@ paths: - tags x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: TagsGetQuery post: description: Gets a tag's information. @@ -43770,6 +45182,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /tags.list: get: description: Lists the available tags. @@ -43841,6 +45254,7 @@ paths: - tags x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: TagsListQuery post: description: Lists the available tags. @@ -43876,6 +45290,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /tags.update: post: description: Updates a tag's information. @@ -43913,6 +45328,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /timeline-entries.create: post: description: Creates a new entry on an object's timeline. @@ -43950,6 +45366,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /timeline-entries.delete: post: description: Deletes an entry from an object's timeline. @@ -43985,6 +45402,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /timeline-entries.get: get: description: Gets an entry on an object's timeline. @@ -44036,6 +45454,7 @@ paths: - timeline-entries x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: TimelineEntriesGetQuery post: description: Gets an entry on an object's timeline. @@ -44073,6 +45492,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /timeline-entries.list: get: description: Lists the timeline entries for an object. @@ -44173,6 +45593,7 @@ paths: - timeline-entries x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: TimelineEntriesListQuery post: description: Lists the timeline entries for an object. @@ -44210,6 +45631,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /timeline-entries.update: post: description: Updates an entry on an object's timeline. @@ -44247,6 +45669,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /track-events.publish: post: description: Allows publishing of events (example from plug widget). @@ -44282,6 +45705,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /uoms.count: get: description: | @@ -44370,6 +45794,7 @@ paths: - uoms x-fern-audiences: - docs + x-fern-availability: beta x-request-name: UomsCountQuery post: description: | @@ -44406,6 +45831,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /uoms.create: post: description: Creates a Unit of Measurement on a part. @@ -44441,6 +45867,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /uoms.delete: post: description: Deletes a Unit of Measurement. @@ -44474,6 +45901,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /uoms.get: get: description: Gets a Unit of Measurement. @@ -44513,6 +45941,7 @@ paths: - uoms x-fern-audiences: - docs + x-fern-availability: beta x-request-name: UomsGetQuery post: description: Gets a Unit of Measurement. @@ -44550,6 +45979,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /uoms.list: get: description: Gets the Unit of Measurements based on the given filters. @@ -44674,6 +46104,7 @@ paths: - uoms x-fern-audiences: - docs + x-fern-availability: beta x-request-name: UomsListQuery post: description: Gets the Unit of Measurements based on the given filters. @@ -44709,6 +46140,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /uoms.update: post: description: Updates a Unit of Measurement. @@ -44746,6 +46178,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /web-crawler-jobs.control: post: description: | @@ -44785,6 +46218,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /web-crawler-jobs.create: post: description: | @@ -44822,6 +46256,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /web-crawler-jobs.get: get: description: Gets a web crawler job. @@ -44861,6 +46296,7 @@ paths: - web-crawler-job x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: GetWebCrawlerJobQuery post: description: Gets a web crawler job. @@ -44898,6 +46334,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /web-crawler-jobs.list: get: description: Lists web crawler jobs. @@ -44965,6 +46402,7 @@ paths: - web-crawler-job x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: ListWebCrawlerJobsQuery post: description: Lists web crawler jobs. @@ -45000,6 +46438,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /webhooks.create: post: description: Creates a new webhook target. @@ -45035,6 +46474,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /webhooks.delete: post: description: Deletes the requested webhook. @@ -45072,6 +46512,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /webhooks.event: post: description: | @@ -45111,6 +46552,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /webhooks.fetch: post: description: Fetches an object via webhook. @@ -45148,6 +46590,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /webhooks.get: get: description: Gets the requested webhook's information. @@ -45188,6 +46631,7 @@ paths: - webhooks x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: WebhooksGetQuery post: description: Gets the requested webhook's information. @@ -45225,6 +46669,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /webhooks.list: get: description: Lists the webhooks. @@ -45253,6 +46698,7 @@ paths: - webhooks x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: WebhooksListQuery post: description: Lists the webhooks. @@ -45288,6 +46734,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /webhooks.update: post: description: Updates the requested webhook. @@ -45325,6 +46772,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /widgets.get: get: description: Returns the requested widget. @@ -45362,6 +46810,7 @@ paths: - widgets x-fern-audiences: - docs + x-fern-availability: beta x-request-name: WidgetsGetQuery post: description: Returns the requested widget. @@ -45397,6 +46846,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: beta /works.create: post: description: | @@ -45436,6 +46886,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /works.delete: post: description: Deletes a work item. @@ -45473,6 +46924,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /works.export: get: description: Exports a collection of work items. @@ -45582,6 +47034,17 @@ paths: items: type: string format: text + - description: Filters for work modified by any of these users. + explode: false + in: query + name: modified_by + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id - description: | Filters for opportunities belonging to any of the provided accounts. explode: false @@ -45762,6 +47225,16 @@ paths: items: type: string format: id + - description: | + Filters for tickets that are associated with any of the brands. + explode: false + in: query + name: ticket.brand + schema: + type: array + items: + type: string + format: id - description: Filters for tickets with any of the provided channels. explode: false in: query @@ -45846,6 +47319,17 @@ paths: items: type: string format: text + - description: | + Filters for tickets that are associated with any of the source + channels. + explode: false + in: query + name: ticket.source_channel_v2 + schema: + type: array + items: + type: string + format: id - description: Filters for tickets with any of the provided subtypes. explode: false in: query @@ -45887,6 +47371,7 @@ paths: - works x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: WorksExportQuery post: description: Exports a collection of work items. @@ -45922,6 +47407,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /works.get: get: description: Gets a work item's information. @@ -45962,6 +47448,7 @@ paths: - works x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: WorksGetQuery post: description: Gets a work item's information. @@ -45999,6 +47486,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /works.list: get: description: Lists a collection of work items. @@ -46124,6 +47612,17 @@ paths: name: mode schema: $ref: '#/components/schemas/list-mode' + - description: Filters for work modified by any of these users. + explode: false + in: query + name: modified_by + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id - description: | Filters for opportunities belonging to any of the provided accounts. explode: false @@ -46304,6 +47803,16 @@ paths: items: type: string format: id + - description: | + Filters for tickets that are associated with any of the brands. + explode: false + in: query + name: ticket.brand + schema: + type: array + items: + type: string + format: id - description: Filters for tickets with any of the provided channels. explode: false in: query @@ -46388,6 +47897,17 @@ paths: items: type: string format: text + - description: | + Filters for tickets that are associated with any of the source + channels. + explode: false + in: query + name: ticket.source_channel_v2 + schema: + type: array + items: + type: string + format: id - description: Filters for tickets with any of the provided subtypes. explode: false in: query @@ -46429,6 +47949,7 @@ paths: - works x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: WorksListQuery post: description: Lists a collection of work items. @@ -46464,6 +47985,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /works.update: post: description: Updates a work item's information. @@ -46501,6 +48023,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available security: - auth-token: [] servers: @@ -46576,6 +48099,8 @@ tags: name: question-answers - description: Recommendations at DevRev. name: recommendations + - description: Record templates APIs. + name: record-templates - description: Rev organization interactions. name: rev-orgs - description: Rev user interactions. @@ -46596,6 +48121,8 @@ tags: name: snap-kit-execution - description: SnapWidget APIs. name: snap-widgets + - description: Object subscribers APIs. + name: subscribers - description: Surveys APIs. name: surveys - description: System user interactions. diff --git a/fern/apis/public/changelog/2025-06-02.md b/fern/apis/public/changelog/2025-06-02.md new file mode 100644 index 00000000..9403db87 --- /dev/null +++ b/fern/apis/public/changelog/2025-06-02.md @@ -0,0 +1,93 @@ +## Promoted Endpoints + +### Accounts +- [`/accounts.merge`](/public/api-reference/accounts/merge) + +### Chats +- [`/chats.create`](/public/api-reference/chats/create) +- [`/chats.get`](/public/api-reference/chats/get-post) + +### Code Changes +- [`/code-changes.create`](/public/api-reference/code-changes/create) +- [`/code-changes.delete`](/public/api-reference/code-changes/delete) +- [`/code-changes.get`](/public/api-reference/code-changes/get-post) +- [`/code-changes.list`](/public/api-reference/code-changes/list-post) +- [`/code-changes.update`](/public/api-reference/code-changes/update) + +### Commands +- [`/commands.create`](/public/api-reference/commands/create) +- [`/commands.get`](/public/api-reference/commands/get-post) +- [`/commands.list`](/public/api-reference/commands/list-post) +- [`/commands.update`](/public/api-reference/commands/update) + +### Dev Organizations +- [`/dev-orgs.get`](/public/api-reference/dev-orgs/get-post) + +### Directories +- [`/directories.count`](/public/api-reference/directory/directories-count) +- [`/directories.create`](/public/api-reference/directory/directories-create) +- [`/directories.delete`](/public/api-reference/directory/directories-delete) +- [`/directories.get`](/public/api-reference/directory/directories-get-post) +- [`/directories.list`](/public/api-reference/directory/directories-list-post) +- [`/directories.update`](/public/api-reference/directory/directories-update) + +### Meetings +- [`/meetings.count`](/public/api-reference/meetings/count) +- [`/meetings.create`](/public/api-reference/meetings/create) +- [`/meetings.delete`](/public/api-reference/meetings/delete) +- [`/meetings.get`](/public/api-reference/meetings/get-post) +- [`/meetings.list`](/public/api-reference/meetings/list-post) +- [`/meetings.update`](/public/api-reference/meetings/update) + +### Metric Definitions +- [`/metric-definitions.create`](/public/api-reference/slas/metric-definitions-create) +- [`/metric-definitions.delete`](/public/api-reference/slas/metric-definitions-delete) +- [`/metric-definitions.execute`](/public/api-reference/slas/metric-definitions-execute) +- [`/metric-definitions.get`](/public/api-reference/slas/metric-definitions-get-post) +- [`/metric-definitions.update`](/public/api-reference/slas/metric-definitions-update) + +### Organization Schedules +- [`/org-schedules.create`](/public/api-reference/schedules/org-schedules-create) +- [`/org-schedules.get`](/public/api-reference/schedules/org-schedules-get-post) +- [`/org-schedules.list`](/public/api-reference/schedules/org-schedules-list-post) +- [`/org-schedules.set-future`](/public/api-reference/schedules/org-schedules-set-future) +- [`/org-schedules.transition`](/public/api-reference/schedules/org-schedules-transition) +- [`/org-schedules.update`](/public/api-reference/schedules/org-schedules-update) + +### Organization Schedule Fragments +- [`/org-schedule-fragments.create`](/public/api-reference/schedules/org-schedule-fragments-create) +- [`/org-schedule-fragments.evaluate`](/public/api-reference/schedules/org-schedule-fragments-evaluate) +- [`/org-schedule-fragments.get`](/public/api-reference/schedules/org-schedule-fragments-get-post) +- [`/org-schedule-fragments.transition`](/public/api-reference/schedules/org-schedule-fragments-transition) + +### Reactions +- [`/reactions.list`](/public/api-reference/timeline-entries/reactions-list-post) +- [`/reactions.update`](/public/api-reference/timeline-entries/reactions-update) + +### Snap Widgets +- [`/snap-widgets.create`](/public/api-reference/snap-widgets/create) + +### Web Crawler Jobs +- [`/web-crawler-jobs.control`](/public/api-reference/web-crawler-job/web-crawler-jobs-control) +- [`/web-crawler-jobs.create`](/public/api-reference/web-crawler-job/create-web-crawler-job) +- [`/web-crawler-jobs.get`](/public/api-reference/web-crawler-job/get-web-crawler-job-post) +- [`/web-crawler-jobs.list`](/public/api-reference/web-crawler-job/list-web-crawler-jobs-post) + +## New Endpoints + +### Chats +- [`/chats.update`](/public/api-reference/chats/update): Updates a chat (DM) + +### Surveys +- [`/surveys.get`](/public/api-reference/surveys/get-post): Gets the information for a survey + +## Modified Endpoints + +### Accounts +- Adds `primary_account` field, which is set when the account is merged with another + +### Rev Orgs +- Adds `primary_rev_org` field, which is set when the Rev org (workspace) is merged with another + +### Users +- Adds `primary_identity` field, which is set when the user is merged with another diff --git a/fern/apis/public/openapi-public.yaml b/fern/apis/public/openapi-public.yaml index 8cbbaf27..1943f796 100644 --- a/fern/apis/public/openapi-public.yaml +++ b/fern/apis/public/openapi-public.yaml @@ -90,6 +90,8 @@ components: description: List of Dev user IDs owning this Account. items: $ref: '#/components/schemas/user-summary' + primary_account: + $ref: '#/components/schemas/account-summary' tier: type: string description: The Tier of the corresponding Account. @@ -414,6 +416,33 @@ components: - accounts title: accounts-list-response x-go-name: AccountsListResponseBody + accounts-merge-request: + type: object + description: Request object to merge two accounts. + properties: + primary_account: + type: string + description: | + The ID of the primary account, which will be retained post merge. + example: ACC-12345 + format: id + secondary_account: + type: string + description: | + The ID of the secondary account, which will be merged into the + primary account. + example: ACC-12345 + format: id + required: + - primary_account + - secondary_account + title: accounts-merge-request + accounts-merge-response: + type: object + additionalProperties: false + description: The response to merging an account. + title: accounts-merge-response + x-go-name: AccountsMergeResponseBody accounts-update-request: type: object description: Request to update details of the account. @@ -535,6 +564,11 @@ components: args: type: object description: The arguments for the skill call. + metadata: + type: object + description: | + The metadata of the skill call. The fields depend on the skill that + was executed. output: type: object description: The output of the skill call. @@ -573,6 +607,18 @@ components: - args - skill_name title: ai-agent-event-execute-progress-skill-triggered + ai-agent-event-suggestions: + type: object + description: A list of suggestions generated for the AI agent event. + properties: + suggestions: + type: array + description: The suggestions generated for the AI agent event. + items: + $ref: '#/components/schemas/ai-agent-suggestion' + required: + - suggestions + title: ai-agent-event-suggestions ai-agent-message-generation-started: type: object description: | @@ -589,6 +635,17 @@ components: required: - request_id title: ai-agent-message-generation-started + ai-agent-suggestion: + type: object + description: A suggestion generated for the AI agent event. + properties: + suggestion: + type: string + description: The text of the suggestion. + format: text + required: + - suggestion + title: ai-agent-suggestion archetype-metric-target: type: object description: Metric with corresponding target values. @@ -796,6 +853,7 @@ components: enum: - article - content_block + - page articles-create-request: type: object description: The request to create an article. @@ -827,6 +885,10 @@ components: items: type: string format: id + brand: + type: string + description: The brand associated with the article. + format: id content_format: $ref: '#/components/schemas/article-content-format' custom_fields: @@ -967,6 +1029,11 @@ components: type: object description: The request to get an article. properties: + dev_org: + type: string + description: Optional Dev Org ID for the unauthenticated user. + example: DEV-AbCdEfGh + format: id id: type: string description: The ID of the required article. @@ -1014,6 +1081,13 @@ components: items: type: string format: id + brands: + type: array + description: | + Filters for articles belonging to any of the provided brands. + items: + type: string + format: id created_by: type: array description: | @@ -1029,6 +1103,11 @@ components: The cursor to resume iteration from. If not provided, then iteration starts from the beginning. format: text + dev_org: + type: string + description: Optional Dev Org ID for the unauthenticated user. + example: DEV-AbCdEfGh + format: id limit: type: integer description: | @@ -1117,6 +1196,11 @@ components: $ref: '#/components/schemas/articles-update-request-artifacts' authored_by: $ref: '#/components/schemas/articles-update-request-authored-by' + brand: + type: string + description: The updated brand of the article. + format: id + nullable: true content_blocks: $ref: '#/components/schemas/articles-update-request-content-blocks' content_format: @@ -1333,6 +1417,25 @@ components: file: $ref: '#/components/schemas/artifact-file' title: artifact + artifact-configuration-set: + type: string + description: | + Represents a set of configuration to be used with the artifacts object. + enum: + - article_media + - default + - email_media + - job_data + - marketplace_listing_icon + - marketplace_media + - org_logo + - plug_setting + - plug_setting_banner_card + - portal_css + - snap_in_functions_code + - snap_widget + - user_profile_picture + - work artifact-file: type: object description: Defines a file object. @@ -1503,6 +1606,8 @@ components: type: object description: The request to prepare a URL to upload a file. properties: + configuration_set: + $ref: '#/components/schemas/artifact-configuration-set' file_name: type: string description: The name of the file that's being uploaded. @@ -2265,6 +2370,31 @@ components: - token title: auth-tokens-get-response x-go-name: AuthTokensGetResponseBody + auth-tokens-info-request: + type: object + additionalProperties: false + description: | + The request to get the Dev organization, user and token attributes + extracted from the auth token. + title: auth-tokens-info-request + auth-tokens-info-response: + type: object + description: | + The Dev organization, user and token attributes extracted from the auth + token. + properties: + organization: + $ref: '#/components/schemas/auth-tokens-org-attributes' + token: + $ref: '#/components/schemas/auth-tokens-token-attributes' + user: + $ref: '#/components/schemas/auth-tokens-user-attributes' + required: + - organization + - token + - user + title: auth-tokens-info-response + x-go-name: AuthTokensInfoResponseBody auth-tokens-list-request: type: object description: A request to list the token metadata. @@ -2298,6 +2428,28 @@ components: - tokens title: auth-tokens-list-response x-go-name: AuthTokensListResponseBody + auth-tokens-org-attributes: + type: object + description: | + The Dev organization attributes extracted from the auth token. + properties: + display_id: + type: string + description: The display ID of the Dev organization. + format: text + id: + type: string + description: The ID of the the Dev organization. + example: DEV-AbCdEfGh + format: id + slug: + type: string + description: The slug of the Dev organization. + format: text + required: + - display_id + - id + title: auth-tokens-org-attributes auth-tokens-org-traits: type: object description: Carries Rev org info. @@ -2374,6 +2526,34 @@ components: requested_token_type: $ref: '#/components/schemas/auth-token-requested-token-type' title: auth-tokens-self-delete-request + auth-tokens-token-attributes: + type: object + description: The token attributes extracted from the auth token. + properties: + expiry: + type: integer + description: | + The expiry (exp) of the token in seconds from Unix epoch. + format: int64 + issued_at: + type: integer + description: | + The issued at (iat) time of the token in seconds from Unix epoch. + format: int64 + issuer: + type: string + description: The issuer ID (iss) of the token. + format: text + subject: + type: string + description: The subject (sub) of the token. + format: text + required: + - expiry + - issued_at + - issuer + - subject + title: auth-tokens-token-attributes auth-tokens-update-request: type: object description: A request to update the token metadata. @@ -2401,6 +2581,37 @@ components: - token title: auth-tokens-update-response x-go-name: AuthTokensUpdateResponseBody + auth-tokens-user-attributes: + type: object + description: The user attributes extracted from the auth token. + properties: + type: + $ref: '#/components/schemas/user-type' + display_id: + type: string + description: The display ID of the user. + format: text + display_name: + type: string + description: The display name of the user. + format: text + email: + type: string + description: The email address of the user. + format: text + full_name: + type: string + description: The full name of the user. + format: text + id: + type: string + description: The ID of the user. + format: id + required: + - display_id + - id + - type + title: auth-tokens-user-attributes auth-tokens-user-traits: type: object description: Carries Rev user info. @@ -2504,4462 +2715,4669 @@ components: allOf: - $ref: '#/components/schemas/part-base-summary' title: capability-summary - conversation: - allOf: - - $ref: '#/components/schemas/atom-base' - - type: object - properties: - channels: - type: array - description: Channel IDs of the conversation. - items: - $ref: '#/components/schemas/external-communication-channel-summary' - description: - type: string - description: Description of the conversation object. - format: text - group: - $ref: '#/components/schemas/group-summary' - members: - type: array - description: The users in the conversation. - items: - $ref: '#/components/schemas/user-summary' - messages: - type: array - description: The latest messages on the conversation. - items: - $ref: '#/components/schemas/timeline-entry' - metadata: - $ref: '#/components/schemas/conversation-metadata' - owned_by: - type: array - description: Owner IDs for the conversation. - items: - $ref: '#/components/schemas/user-summary' - sla_summary: - $ref: '#/components/schemas/archetype-sla-summary' - sla_tracker: - $ref: '#/components/schemas/sla-tracker-summary' - stage: - $ref: '#/components/schemas/legacy-stage' - tags: - type: array - description: Tags associated with the object. - items: - $ref: '#/components/schemas/tag-with-value' - title: - type: string - description: Title of the conversation object. - format: text - required: - - members - title: conversation - conversation-metadata: + chat: type: object - description: Metadata on conversation. + discriminator: + propertyName: type properties: - url_context: - type: string - description: | - URL from which the conversation was created if the conversation was - created via PLuG. - format: text - title: conversation-metadata - conversation-summary: - allOf: - - $ref: '#/components/schemas/atom-base-summary' - - type: object - properties: - title: - type: string - description: Title of the conversation object. - format: text - title: conversation-summary - conversations-create-request: + type: + $ref: '#/components/schemas/chat-type' + required: + - type + title: chat + chat-type: + type: string + chats-create-request: type: object - description: The request to create a new conversation. + discriminator: + mapping: + dm: '#/components/schemas/chats-create-request-dm' + propertyName: type + oneOf: + - $ref: '#/components/schemas/chats-create-request-dm' properties: type: - $ref: '#/components/schemas/conversations-create-request-type-value' - channels: - type: array - description: Channel IDs of the conversation. - items: - type: string - format: id + $ref: '#/components/schemas/chat-type' custom_fields: type: object description: Application-defined custom fields. custom_schema_spec: $ref: '#/components/schemas/custom-schema-spec' - description: + get_if_conflict: + type: boolean + description: | + If true and a chat already exists with unique properties that + conflict with the chat creation, then the existing chat is returned + without error, otherwise if false, a conflict error is returned. + title: type: string - description: Description for the conversation. + description: The title for the chat. format: text - group: - type: string - description: The group that the conversation is associated with. - format: id - is_spam: + required: + - type + title: chats-create-request + chats-create-request-dm: + type: object + properties: + is_default: type: boolean - description: Whether the conversation is spam. - members: - type: array - description: The users in the conversation. - example: - - DEVU-12345 - items: - type: string - format: id - messages: - type: array - description: Initial messages on the conversation. - items: - $ref: '#/components/schemas/conversations-create-request-message' - metadata: - $ref: '#/components/schemas/conversations-create-request-metadata' - owned_by: + description: | + Whether this is the default DM for messaging the constituent users. + If true, then this DM is always returned when opening a DM for the + users. Note only one DM may be the default for a given set of + users. By Default, this is true. + records: type: array - description: The users that own the conversation. + description: The associated records for this DM. items: type: string format: id - source_channel: - type: string - description: Whether the conversation is from a source channel. - format: text - stage: - $ref: '#/components/schemas/stage-init' - tags: - type: array - description: Tags associated with the conversation. - items: - $ref: '#/components/schemas/set-tag-with-value' - title: - type: string - description: The title for the conversation. - format: text - user_sessions: + maxItems: 16 + users: type: array description: | - The IDs of user sessions associated with the conversation. + The users to send direct messages to. The authenticated user must + be included in this list. + example: + - DEVU-12345 items: type: string format: id + maxItems: 16 + minItems: 1 required: - - type - title: conversations-create-request - conversations-create-request-message: + - users + title: chats-create-request-dm + chats-create-response: type: object properties: - artifacts: - type: array - description: The IDs of the artifacts to the message. + chat: + $ref: '#/components/schemas/chat' + required: + - chat + title: chats-create-response + x-go-name: ChatsCreateResponseBody + chats-get-request: + type: object + discriminator: + mapping: + dm: '#/components/schemas/chats-get-request-dm' + none: '#/components/schemas/empty' + propertyName: type + oneOf: + - $ref: '#/components/schemas/chats-get-request-dm' + - $ref: '#/components/schemas/empty' + properties: + type: + $ref: '#/components/schemas/chat-type' + id: + type: string + description: The chat's ID. + example: CHAN-AbCdEfGh + format: id + title: chats-get-request + chats-get-request-dm: + type: object + properties: + users: + type: array + description: | + The users to send direct messages to. Note the authenticated user + must be included in this list. example: - - ARTIFACT-12345 + - DEVU-12345 items: type: string format: id - body: - type: string - description: The message's body. - format: text - title: conversations-create-request-message - conversations-create-request-metadata: + maxItems: 16 + minItems: 1 + required: + - users + title: chats-get-request-dm + chats-get-response: type: object properties: - url_context: + chat: + $ref: '#/components/schemas/chat' + required: + - chat + title: chats-get-response + x-go-name: ChatsGetResponseBody + chats-update-request: + type: object + discriminator: + mapping: + dm: '#/components/schemas/chats-update-request-dm' + none: '#/components/schemas/empty' + propertyName: type + oneOf: + - $ref: '#/components/schemas/chats-update-request-dm' + - $ref: '#/components/schemas/empty' + properties: + type: + $ref: '#/components/schemas/chat-type' + custom_fields: + type: object + description: Application-defined custom fields. + custom_schema_spec: + $ref: '#/components/schemas/custom-schema-spec' + id: + type: string + description: The chat's ID. + example: CHAN-AbCdEfGh + format: id + title: type: string + description: | + The updated title for the chat, or unchanged if not provided. format: text - title: conversations-create-request-metadata - conversations-create-request-type-value: + required: + - id + title: chats-update-request + chats-update-request-dm: + type: object + properties: + records: + $ref: '#/components/schemas/chats-update-request-dm-records' + users: + $ref: '#/components/schemas/chats-update-request-dm-users' + title: chats-update-request-dm + chats-update-request-dm-records: + type: object + properties: + set: + type: array + description: The associated records to set for this DM. + items: + type: string + format: id + maxItems: 16 + title: chats-update-request-dm-records + chats-update-request-dm-users: + type: object + properties: + set: + type: array + description: | + The updated list of users to send direct messages to. The + authenticated user must be included in this list. + example: + - DEVU-12345 + items: + type: string + format: id + maxItems: 16 + minItems: 1 + required: + - set + title: chats-update-request-dm-users + chats-update-response: + type: object + properties: + chat: + $ref: '#/components/schemas/chat' + required: + - chat + title: chats-update-response + x-go-name: ChatsUpdateResponseBody + code-change: + allOf: + - $ref: '#/components/schemas/atom-base' + - type: object + properties: + branch: + type: string + description: Name of the code branch in the repo. + format: text + closed_date: + type: string + description: | + Time at which the code change corresponding to this object reached + a closed or merged stage. For example, the time at which a Pull + Request was either closed without merging or successfully merged. + example: "2023-01-01T12:00:00.000Z" + format: date-time + commit_id: + type: string + description: Commit ID of the merged commit in the target branch. + format: text + description: + type: string + description: Detailed description of the contents of this change. + format: text + external_identifier: + type: string + description: | + Unique external identifier for this change.e.g Pull Request URL. + format: text + filtered_loc: + $ref: '#/components/schemas/lines-of-code' + repo_url: + type: string + description: URL pointing to the repo this change was on. + format: text + source: + $ref: '#/components/schemas/code-change-source' + target_branch: + type: string + description: Name of the target branch in the repo. + format: text + title: + type: string + description: Title describing in brief the contents of this change. + format: text + total_loc: + $ref: '#/components/schemas/lines-of-code' + title: code-change + code-change-source: type: string + description: Source of the code change object. enum: - - support - conversations-create-response: + - azure_devops + - bitbucket + - github + - gitlab + code-changes-create-request: type: object - description: The response to creating a new conversation. properties: - conversation: - $ref: '#/components/schemas/conversation' + custom_fields: + type: object + description: Application-defined custom fields. + custom_schema_spec: + $ref: '#/components/schemas/custom-schema-spec' + title: code-changes-create-request + code-changes-create-response: + type: object + properties: + code_change: + $ref: '#/components/schemas/code-change' required: - - conversation - title: conversations-create-response - x-go-name: ConversationsCreateResponseBody - conversations-delete-request: + - code_change + title: code-changes-create-response + x-go-name: CodeChangesCreateResponseBody + code-changes-delete-request: type: object - description: The request to delete a conversation. properties: id: type: string - description: The ID of the conversation to delete. + description: ID of the code change object which is to be deleted. format: id required: - id - title: conversations-delete-request - conversations-delete-response: + title: code-changes-delete-request + code-changes-delete-response: type: object additionalProperties: false - description: The response for deleting a conversation. - title: conversations-delete-response - x-go-name: ConversationsDeleteResponseBody - conversations-get-request: + title: code-changes-delete-response + x-go-name: CodeChangesDeleteResponseBody + code-changes-get-request: type: object - description: The request to get a conversation's information. properties: id: type: string - description: The requested conversation's ID. + description: The code change object ID. format: id required: - id - title: conversations-get-request - conversations-get-response: + title: code-changes-get-request + code-changes-get-response: type: object - description: The response to getting a conversation's information. properties: - conversation: - $ref: '#/components/schemas/conversation' + code_change: + $ref: '#/components/schemas/code-change' required: - - conversation - title: conversations-get-response - x-go-name: ConversationsGetResponseBody - conversations-list-request: + - code_change + title: code-changes-get-response + x-go-name: CodeChangesGetResponseBody + code-changes-list-request: type: object - description: | - The request to get information about a list of conversations. properties: - actual_close_date: + created_date: $ref: '#/components/schemas/date-filter' - applies_to_parts: - type: array - description: | - Filters for conversations belonging to any of the provided parts. - example: - - PROD-12345 - items: - type: string - format: id - channels: - type: array - description: | - Filters for conversations that are associated with any of the - channels. - items: - type: string - format: id cursor: type: string description: | The cursor to resume iteration from. If not provided, then iteration starts from the beginning. format: text - group: - type: array - description: | - Filters for conversation that belong to the given groups. - items: - type: string - format: id - is_creator_verified: - type: boolean - description: | - Filters for conversations that are created by verified users. - is_frozen: - type: boolean - description: Filters for conversations that are frozen. - is_spam: - type: boolean - description: Filters for conversations that are spam. limit: type: integer description: | - The maximum number of conversations to return. The default is '50'. + The maximum number of code change objects to return. The default is + '50'. format: int32 - members: - type: array - description: | - Filters for conversations where these users are participants. - example: - - DEVU-12345 - items: - type: string - format: id mode: $ref: '#/components/schemas/list-mode' modified_date: - $ref: '#/components/schemas/date-time-filter' - owned_by: - type: array - description: Filters for conversations owned by any of these users. - example: - - DEVU-12345 - items: - type: string - format: id - rev_org: - type: array - deprecated: true - description: | - Filters for conversations that are associated with any of the - provided Rev organizations. - example: - - REV-AbCdEfGh - items: - type: string - format: id - rev_orgs: - type: array - description: | - Filters for conversations that are associated with any of the - provided Rev organizations. - example: - - REV-AbCdEfGh - items: - type: string - format: id - sla_summary: - $ref: '#/components/schemas/sla-summary-filter' - source_channel: + $ref: '#/components/schemas/date-filter' + title: code-changes-list-request + code-changes-list-response: + type: object + properties: + code_changes: type: array - description: | - Filters for conversations with any of the provided source channels. + description: The list of requested code change objects. items: - type: string - format: text - source_channels: - type: array - deprecated: true + $ref: '#/components/schemas/code-change' + next_cursor: + type: string description: | - Filters for conversations with any of the provided source channels. - items: - type: string - format: text - stage: - $ref: '#/components/schemas/stage-filter' - state: - type: array - description: | - Filters for conversations with any of the provided states. - items: - type: string - format: text - tags: - type: array - deprecated: true - description: Filters for conversations with any of the provided tags. - example: - - TAG-12345 - items: - type: string - format: id - tags_v2: - type: array - description: | - Filters for conversations with any of the provided tags with value. - items: - $ref: '#/components/schemas/tag-with-value-filter' - title: conversations-list-request - conversations-list-response: - type: object - description: The response to listing the conversations. - properties: - conversations: - type: array - description: The list of conversations. - items: - $ref: '#/components/schemas/conversation' - next_cursor: - type: string - description: | - The cursor used to iterate subsequent results in accordance to the - sort order. If not set, then no later elements exist. - format: text - prev_cursor: - type: string + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. + format: text + prev_cursor: + type: string description: | The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. format: text required: - - conversations - title: conversations-list-response - x-go-name: ConversationsListResponseBody - conversations-update-request: + - code_changes + title: code-changes-list-response + x-go-name: CodeChangesListResponseBody + code-changes-update-request: type: object - description: The request to update a conversation. properties: - applies_to_parts: - $ref: '#/components/schemas/conversations-update-request-applies-to-parts' - channels: - $ref: '#/components/schemas/conversations-update-request-channels' custom_fields: type: object description: Application-defined custom fields. custom_schema_spec: $ref: '#/components/schemas/custom-schema-spec' + id: + type: string + description: The ID of the code change object to be updated. + format: id + required: + - id + title: code-changes-update-request + code-changes-update-response: + type: object + properties: + code_change: + $ref: '#/components/schemas/code-change' + required: + - code_change + title: code-changes-update-response + x-go-name: CodeChangesUpdateResponseBody + command: + allOf: + - $ref: '#/components/schemas/atom-base' + - type: object + properties: + description: + type: string + description: Description of the command. + format: text + display_name: + type: string + description: Display name of the command. + format: text + name: + type: string + description: Name of the command. + format: text + namespace: + type: string + description: Namespace of the command. + format: text + shared_with: + type: array + description: | + The list of users, groups and audiences with whom the command is + shared. + items: + $ref: '#/components/schemas/shared-with-membership' + status: + $ref: '#/components/schemas/command-status' + surfaces: + type: array + description: Surfaces where this command can be invoked. + items: + $ref: '#/components/schemas/command-surface' + usage_hint: + type: string + description: | + A user friendly description of the parameters which can be passed + to the command. + format: text + title: command + command-action-executor-type: + type: string + description: Specifies how the action is defined. + enum: + - rego + - workflow + command-action-template-type: + type: string + description: The template engine for resolving message. + enum: + - devrev_v1 + command-create-request: + type: object + description: The request to create a command. + properties: + action: + $ref: '#/components/schemas/create-command-action' description: type: string - description: The updated description for the conversation. + description: Description of the command. format: text - group: + display_name: type: string - description: The group that the conversation is associated with. - format: id - id: + description: Display name of the command. + format: text + name: type: string - description: The ID of the conversation to update. + description: Name of the command. + format: text + namespace: + type: string + description: Namespace of the command. + format: text + shared_with: + type: array + description: | + The list of users, groups and audiences with whom the command is + shared. + items: + $ref: '#/components/schemas/set-shared-with-membership' + source: + type: string + description: ID of the source which created this command. format: id - is_frozen: - type: boolean - description: Whether the conversation is frozen. - is_spam: - type: boolean - description: Whether the conversation is spam. - members: - $ref: '#/components/schemas/conversations-update-request-members' - metadata: - $ref: '#/components/schemas/conversations-update-request-metadata' - owned_by: - $ref: '#/components/schemas/conversations-update-request-owned-by' - stage: - $ref: '#/components/schemas/stage-update' status: + $ref: '#/components/schemas/command-status' + surfaces: + type: array + description: Surfaces where this command can be invoked. + items: + $ref: '#/components/schemas/create-command-surface' + usage_hint: type: string - description: The updated status of the conversation. + description: | + A user friendly description of the parameters which can be passed + to the command. format: text - tags: - $ref: '#/components/schemas/conversations-update-request-tags' - title: + required: + - name + - namespace + title: command-create-request + command-create-response: + type: object + properties: + command: + $ref: '#/components/schemas/command' + required: + - command + title: command-create-response + x-go-name: CommandCreateResponseBody + command-get-request: + type: object + description: The request to get a command. + properties: + id: type: string - description: The updated title of the conversation. - format: text - user_sessions: - $ref: '#/components/schemas/conversations-update-request-user-sessions' + description: The command's ID. + format: id required: - id - title: conversations-update-request - conversations-update-request-applies-to-parts: + title: command-get-request + command-get-response: type: object properties: - set: - type: array - description: Updates the parts that the conversation applies to. - example: - - PROD-12345 - items: - type: string - format: id - title: conversations-update-request-applies-to-parts - conversations-update-request-channels: + command: + $ref: '#/components/schemas/command' + required: + - command + title: command-get-response + x-go-name: CommandGetResponseBody + command-status: + type: string + description: Status of the command. + enum: + - disabled + - draft + - enabled + command-surface: type: object + description: | + Metadata defining which surfaces this command can be executed on. properties: - set: + object_types: type: array - description: Sets the channel IDs of the conversation. + description: Objects types on which a command can be invoked. items: - type: string - format: id - title: conversations-update-request-channels - conversations-update-request-members: + $ref: '#/components/schemas/command-surface-object-types' + surface: + $ref: '#/components/schemas/command-surface-surface' + title: command-surface + command-surface-object-types: + type: string + description: Objects types on which a command can be invoked. + enum: + - account + - ai_assistant_chat + - article + - conversation + - custom_object + - dm + - engagement + - flow + - incident + - issue + - opportunity + - part + - rev_org + - rev_user + - snap_in + - ticket + command-surface-surface: + type: string + description: Surfaces from where this command can be invoked. + enum: + - customer_chat + - discussions + command-update-request: type: object + description: The request to update a command. properties: - set: + action: + $ref: '#/components/schemas/update-command-action' + description: + type: string + description: Description of the command. + format: text + display_name: + type: string + description: Display name of the command. + format: text + id: + type: string + description: The ID of the command to update. + format: id + name: + type: string + description: Name of the command. + format: text + namespace: + type: string + description: Namespace of the command. + format: text + shared_with: type: array - description: Sets the member IDs to the provided user IDs. - example: - - DEVU-12345 + description: | + The list of users, groups and audiences with whom the command is + shared. items: - type: string - format: id - title: conversations-update-request-members - conversations-update-request-metadata: - type: object - properties: - url_context: + $ref: '#/components/schemas/set-shared-with-membership' + source: + type: string + description: ID of the source which created this command. + format: id + status: + $ref: '#/components/schemas/command-status' + surfaces: + type: array + description: Surfaces where this command can be invoked. + items: + $ref: '#/components/schemas/update-command-surface' + usage_hint: type: string + description: | + A user friendly description of the parameters which can be passed + to the command. format: text - title: conversations-update-request-metadata - conversations-update-request-owned-by: + required: + - id + title: command-update-request + command-update-response: type: object properties: - set: - type: array - description: Sets the owner IDs to the provided user IDs. - example: - - DEVU-12345 - items: - type: string - format: id - title: conversations-update-request-owned-by - conversations-update-request-tags: + command: + $ref: '#/components/schemas/command' + required: + - command + title: command-update-response + x-go-name: CommandUpdateResponseBody + commands-list-request: type: object properties: - add: - type: array - description: Adds the provided tags on the conversation. - items: - $ref: '#/components/schemas/add-tag-with-value' - remove: + cursor: + type: string + description: | + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. + format: text + executor_type: type: array - description: Removes the provided tags on the conversation. + description: Filtering based on executor_type. items: - $ref: '#/components/schemas/remove-tag-with-value' - set: + $ref: '#/components/schemas/command-action-executor-type' + limit: + type: integer + description: | + The maximum number of commands to return per page. The default is + '50'. + format: int32 + mode: + $ref: '#/components/schemas/list-mode' + namespace: type: array - description: Sets the tag IDs to the provided tags. + description: Filter commands based on namespace. items: - $ref: '#/components/schemas/set-tag-with-value' - title: conversations-update-request-tags - conversations-update-request-user-sessions: - type: object - properties: - set: + type: string + format: text + sort_by: type: array description: | - The updated user sessions that the conversation is associated with. + List of fields to sort the commands items by and how to sort them. items: type: string - format: id - title: conversations-update-request-user-sessions - conversations-update-response: - type: object - description: The response for updating a conversation. - properties: - conversation: - $ref: '#/components/schemas/conversation' - required: - - conversation - title: conversations-update-response - x-go-name: ConversationsUpdateResponseBody - custom-schema-spec: + format: sort-by + source_object_id: + type: string + description: | + ID of the object where command is invoked (work/part/conversation). + format: id + status: + type: array + description: Filter commands based on status. + items: + $ref: '#/components/schemas/command-status' + title: commands-list-request + commands-list-response: type: object - description: | - Custom schemas described using identifiers. Each custom field in the - request must have the corresponding schema specified; omission results - in a Bad Request error. If a custom schema is not included in the - specifier, it remains unchanged. For surfaces with human interactors, - it is recommended to provide tenant_fragment: true and - validate_required_fields: true. properties: - apps: + commands: type: array - description: List of apps. + description: List of commands. items: - type: string - format: text - subtype: + $ref: '#/components/schemas/command' + next_cursor: type: string - description: Name of the subtype. + description: | + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. format: text - tenant_fragment: - type: boolean - description: Whether the tenant schema is requested. - validate_required_fields: - type: boolean - description: Whether to enforce required fields validation. - title: custom-schema-spec - dashboard: + prev_cursor: + type: string + description: | + The cursor used to iterate preceding results in accordance to the + sort order. If not set, then no prior elements exist. + format: text + required: + - commands + title: commands-list-response + x-go-name: CommandsListResponseBody + conversation: allOf: - $ref: '#/components/schemas/atom-base' - title: dashboard - date-filter: + - type: object + properties: + channels: + type: array + description: Channel IDs of the conversation. + items: + $ref: '#/components/schemas/external-communication-channel-summary' + description: + type: string + description: Description of the conversation object. + format: text + group: + $ref: '#/components/schemas/group-summary' + members: + type: array + description: The users in the conversation. + items: + $ref: '#/components/schemas/user-summary' + messages: + type: array + description: The latest messages on the conversation. + items: + $ref: '#/components/schemas/timeline-entry' + metadata: + $ref: '#/components/schemas/conversation-metadata' + owned_by: + type: array + description: Owner IDs for the conversation. + items: + $ref: '#/components/schemas/user-summary' + sla_summary: + $ref: '#/components/schemas/archetype-sla-summary' + sla_tracker: + $ref: '#/components/schemas/sla-tracker-summary' + stage: + $ref: '#/components/schemas/legacy-stage' + tags: + type: array + description: Tags associated with the object. + items: + $ref: '#/components/schemas/tag-with-value' + title: + type: string + description: Title of the conversation object. + format: text + required: + - members + title: conversation + conversation-metadata: type: object - description: Provides ways to specify date ranges on objects. - discriminator: - mapping: - preset: '#/components/schemas/date-time-preset' - range: '#/components/schemas/date-time-filter' - propertyName: type - oneOf: - - $ref: '#/components/schemas/date-time-filter' - - $ref: '#/components/schemas/date-time-preset' + description: Metadata on conversation. properties: - type: - $ref: '#/components/schemas/date-filter-type' - required: - - type - title: date-filter - date-filter-type: - type: string - description: Type of date filter. - enum: - - preset - - range - date-time-filter: + url_context: + type: string + description: | + URL from which the conversation was created if the conversation was + created via PLuG. + format: text + title: conversation-metadata + conversation-summary: + allOf: + - $ref: '#/components/schemas/atom-base-summary' + - type: object + properties: + title: + type: string + description: Title of the conversation object. + format: text + title: conversation-summary + conversations-create-request: type: object + description: The request to create a new conversation. properties: - after: + type: + $ref: '#/components/schemas/conversations-create-request-type-value' + brand: type: string - description: | - Filters for objects created after the provided timestamp - (inclusive). - example: "2023-01-01T12:00:00.000Z" - format: date-time - before: + description: The brand associated with the conversation. + format: id + channels: + type: array + description: Channel IDs of the conversation. + items: + type: string + format: id + custom_fields: + type: object + description: Application-defined custom fields. + custom_schema_spec: + $ref: '#/components/schemas/custom-schema-spec' + description: + type: string + description: Description for the conversation. + format: text + group: + type: string + description: The group that the conversation is associated with. + format: id + is_spam: + type: boolean + description: Whether the conversation is spam. + members: + type: array + description: The users in the conversation. + example: + - DEVU-12345 + items: + type: string + format: id + messages: + type: array + description: Initial messages on the conversation. + items: + $ref: '#/components/schemas/conversations-create-request-message' + metadata: + $ref: '#/components/schemas/conversations-create-request-metadata' + owned_by: + type: array + description: The users that own the conversation. + items: + type: string + format: id + source_channel: + type: string + description: Whether the conversation is from a source channel. + format: text + source_channel_v2: + type: string + description: Source channel ID of the conversation. + format: id + stage: + $ref: '#/components/schemas/stage-init' + tags: + type: array + description: Tags associated with the conversation. + items: + $ref: '#/components/schemas/set-tag-with-value' + title: type: string + description: The title for the conversation. + format: text + user_sessions: + type: array description: | - Filters for objects created before the provided timestamp - (inclusive). - example: "2023-01-01T12:00:00.000Z" - format: date-time - title: date-time-filter - date-time-preset: - type: object - description: Provides preset types for date filter. - discriminator: - mapping: - last_n_days: '#/components/schemas/date-time-preset-last-n-days' - next_n_days: '#/components/schemas/date-time-preset-next-n-days' - propertyName: preset_type - oneOf: - - $ref: '#/components/schemas/date-time-preset-last-n-days' - - $ref: '#/components/schemas/date-time-preset-next-n-days' - properties: - preset_type: - $ref: '#/components/schemas/date-time-preset-type' + The IDs of user sessions associated with the conversation. + items: + type: string + format: id required: - - preset_type - title: date-time-preset - date-time-preset-last-n-days: + - type + title: conversations-create-request + conversations-create-request-message: type: object properties: - days: - type: integer - description: | - The range starts from the current timestamp and continues for the - past n days. - maximum: 4294967295 - minimum: 0 - required: - - days - title: date-time-preset-last-n-days - date-time-preset-next-n-days: - type: object - properties: - days: - type: integer - description: | - The range starts from the current timestamp and continues for the - next n days. - maximum: 4294967295 - minimum: 0 - required: - - days - title: date-time-preset-next-n-days - date-time-preset-type: - type: string - description: Type of date preset. - enum: - - last_n_days - - next_n_days - dev-org-auth-connections-create-request: - type: object - description: | - Request to create a new enterprise authentication connection. - discriminator: - mapping: - google_apps: '#/components/schemas/dev-org-auth-connections-create-request-google-apps-options' - oidc: '#/components/schemas/dev-org-auth-connections-create-request-oidc-options' - okta: '#/components/schemas/dev-org-auth-connections-create-request-okta-options' - samlp: '#/components/schemas/dev-org-auth-connections-create-request-saml-options' - waad: '#/components/schemas/dev-org-auth-connections-create-request-azure-ad-options' - propertyName: type - oneOf: - - $ref: '#/components/schemas/dev-org-auth-connections-create-request-azure-ad-options' - - $ref: '#/components/schemas/dev-org-auth-connections-create-request-google-apps-options' - - $ref: '#/components/schemas/dev-org-auth-connections-create-request-oidc-options' - - $ref: '#/components/schemas/dev-org-auth-connections-create-request-okta-options' - - $ref: '#/components/schemas/dev-org-auth-connections-create-request-saml-options' - properties: - type: - $ref: '#/components/schemas/dev-org-auth-connections-create-request-type' - display_name: - type: string - description: | - Display name of the authentication connection. This name will be - visible to all the users when they sign in to this Dev - organization. For example, if the display_name is 'abclogin', then - it would appear on the login button as 'Log in to abclogin'. - format: text - maxLength: 128 - minLength: 1 - required: - - type - title: dev-org-auth-connections-create-request - dev-org-auth-connections-create-request-azure-ad-options: - type: object - deprecated: true - description: | - Object encapsulating the configuration parameters for an Azure AD - authentication connection. - properties: - client_id: - type: string - description: Client ID for the Azure authentication connection. - format: text - client_secret: - type: string - description: Client secret for the Azure authentication connection. - format: text - domain: - type: string - description: Domain URL of the Azure authentication connection. - format: text - required: - - client_id - - client_secret - - domain - title: dev-org-auth-connections-create-request-azure-ad-options - dev-org-auth-connections-create-request-google-apps-options: - type: object - deprecated: true - description: | - Object encapsulating the configuration parameters for a Google Apps - authentication connection. - properties: - client_id: - type: string - description: Client ID for the Google Apps authentication connection. - format: text - client_secret: - type: string - description: | - Client secret for the Google Apps authentication connection. - format: text - tenant_domain: - type: string - description: | - Tenant domain URL of the Google Apps authentication connection. - format: text - required: - - client_id - - client_secret - - tenant_domain - title: dev-org-auth-connections-create-request-google-apps-options - dev-org-auth-connections-create-request-oidc-options: - type: object - description: | - Object encapsulating the configuration parameters for an OIDC - authentication connection. - properties: - client_id: - type: string - description: Client ID for the OIDC authentication connection. - format: text - client_secret: - type: string - description: Client secret for the OIDC authentication connection. - format: text - issuer: - type: string - description: Issuer URL of the OIDC authentication connection. - format: text - required: - - client_id - - client_secret - - issuer - title: dev-org-auth-connections-create-request-oidc-options - dev-org-auth-connections-create-request-okta-options: - type: object - deprecated: true - description: | - Object encapsulating the configuration parameters for an Okta - authentication connection. - properties: - client_id: - type: string - description: Client ID for the Okta authentication connection. - format: text - client_secret: - type: string - description: Client secret for the Okta authentication connection. - format: text - domain: + artifacts: + type: array + description: The IDs of the artifacts to the message. + example: + - ARTIFACT-12345 + items: + type: string + format: id + body: type: string - description: Domain URL of the Okta authentication connection. + description: The message's body. format: text - required: - - client_id - - client_secret - - domain - title: dev-org-auth-connections-create-request-okta-options - dev-org-auth-connections-create-request-saml-options: + title: conversations-create-request-message + conversations-create-request-metadata: type: object - description: | - Object encapsulating the configuration parameters for a SAML - authentication connection. properties: - connection_name: - type: string - description: | - Connection name for the SAML authentication connection. Must match - the `connection` query parameter specified in the sign on URL - during SAML configuration in your identity provider. - format: text - maxLength: 128 - minLength: 1 - fields_map: - $ref: '#/components/schemas/saml-connection-fields-map' - sign_in_endpoint: - type: string - description: Sign In endpoint for the SAML authentication connection. - format: text - signing_cert: + url_context: type: string - description: | - Signing certificate for the SAML authentication connection. format: text - required: - - sign_in_endpoint - - signing_cert - title: dev-org-auth-connections-create-request-saml-options - dev-org-auth-connections-create-request-type: + title: conversations-create-request-metadata + conversations-create-request-type-value: type: string - description: | - Defines the type for the authentication connection. Different types of - authentication connections have different configuration parameters. enum: - - google_apps - - oidc - - okta - - samlp - - waad - dev-org-auth-connections-create-response: + - support + conversations-create-response: type: object - description: | - Response for the request to create a new enterprise authentication - connection. + description: The response to creating a new conversation. properties: - auth_connection: - $ref: '#/components/schemas/auth-connection' + conversation: + $ref: '#/components/schemas/conversation' required: - - auth_connection - title: dev-org-auth-connections-create-response - x-go-name: DevOrgAuthConnectionsCreateResponseBody - dev-org-auth-connections-delete-request: + - conversation + title: conversations-create-response + x-go-name: ConversationsCreateResponseBody + conversations-delete-request: type: object - description: | - Request to delete an enterprise authentication connection for a Dev - organization. A default connection and a connection which is currently - enabled cannot be deleted. + description: The request to delete a conversation. properties: id: type: string - description: ID of the authentication connection to be deleted. - format: text + description: The ID of the conversation to delete. + format: id required: - id - title: dev-org-auth-connections-delete-request - dev-org-auth-connections-get-request: + title: conversations-delete-request + conversations-delete-response: type: object - description: | - Request to get configuration details of organization's authentication - Connection. + additionalProperties: false + description: The response for deleting a conversation. + title: conversations-delete-response + x-go-name: ConversationsDeleteResponseBody + conversations-get-request: + type: object + description: The request to get a conversation's information. properties: id: type: string - description: ID of the authentication connection. - format: text + description: The requested conversation's ID. + format: id required: - id - title: dev-org-auth-connections-get-request - dev-org-auth-connections-get-response: + title: conversations-get-request + conversations-get-response: type: object - description: | - Response object encapsulating the configuration details of an - authentication connection. + description: The response to getting a conversation's information. properties: - auth_connection: - $ref: '#/components/schemas/auth-connection' + conversation: + $ref: '#/components/schemas/conversation' required: - - auth_connection - title: dev-org-auth-connections-get-response - x-go-name: DevOrgAuthConnectionsGetResponseBody - dev-org-auth-connections-list-response: + - conversation + title: conversations-get-response + x-go-name: ConversationsGetResponseBody + conversations-list-request: type: object description: | - Response object for the request to list all the social and enterprise - authentication connections configured for a Dev organization. + The request to get information about a list of conversations. properties: - auth_connections: + actual_close_date: + $ref: '#/components/schemas/date-filter' + applies_to_parts: type: array description: | - List of all the authentication connections currently configured for - a Dev organization. + Filters for conversations belonging to any of the provided parts. + example: + - PROD-12345 items: - $ref: '#/components/schemas/auth-connection' - required: - - auth_connections - title: dev-org-auth-connections-list-response - x-go-name: DevOrgAuthConnectionsListResponseBody - dev-org-auth-connections-toggle-request: - type: object - description: | - Request to enable or disable an authentication connection for a Dev - organization. - properties: - id: + type: string + format: id + brand: + type: array + description: | + Filters for tickets that are associated with any of the brands. + items: + type: string + format: id + channels: + type: array + description: | + Filters for conversations that are associated with any of the + channels. + items: + type: string + format: id + cursor: type: string - description: ID of the authentication connection to be toggled. + description: | + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. format: text - toggle: - $ref: '#/components/schemas/auth-connection-toggle' - required: - - id - title: dev-org-auth-connections-toggle-request - dev-org-auth-connections-update-request: + group: + type: array + description: | + Filters for conversation that belong to the given groups. + items: + type: string + format: id + is_creator_verified: + type: boolean + description: | + Filters for conversations that are created by verified users. + is_frozen: + type: boolean + description: Filters for conversations that are frozen. + is_spam: + type: boolean + description: Filters for conversations that are spam. + limit: + type: integer + description: | + The maximum number of conversations to return. The default is '50'. + format: int32 + members: + type: array + description: | + Filters for conversations where these users are participants. + example: + - DEVU-12345 + items: + type: string + format: id + mode: + $ref: '#/components/schemas/list-mode' + modified_date: + $ref: '#/components/schemas/date-time-filter' + owned_by: + type: array + description: Filters for conversations owned by any of these users. + example: + - DEVU-12345 + items: + type: string + format: id + rev_org: + type: array + deprecated: true + description: | + Filters for conversations that are associated with any of the + provided Rev organizations. + example: + - REV-AbCdEfGh + items: + type: string + format: id + rev_orgs: + type: array + description: | + Filters for conversations that are associated with any of the + provided Rev organizations. + example: + - REV-AbCdEfGh + items: + type: string + format: id + sla_summary: + $ref: '#/components/schemas/sla-summary-filter' + source_channel: + type: array + description: | + Filters for conversations with any of the provided source channels. + items: + type: string + format: text + source_channel_v2: + type: array + description: | + Filters for conversations that are associated with the source + channel. + items: + type: string + format: id + source_channels: + type: array + deprecated: true + description: | + Filters for conversations with any of the provided source channels. + items: + type: string + format: text + stage: + $ref: '#/components/schemas/stage-filter' + state: + type: array + description: | + Filters for conversations with any of the provided states. + items: + type: string + format: text + tags: + type: array + deprecated: true + description: Filters for conversations with any of the provided tags. + example: + - TAG-12345 + items: + type: string + format: id + tags_v2: + type: array + description: | + Filters for conversations with any of the provided tags with value. + items: + $ref: '#/components/schemas/tag-with-value-filter' + title: conversations-list-request + conversations-list-response: type: object - description: | - Request to update an enterprise authentication connection for a Dev - organization. - discriminator: - mapping: - google_apps: '#/components/schemas/dev-org-auth-connections-update-request-google-apps-options' - none: '#/components/schemas/empty' - oidc: '#/components/schemas/dev-org-auth-connections-update-request-oidc-options' - okta: '#/components/schemas/dev-org-auth-connections-update-request-okta-options' - samlp: '#/components/schemas/dev-org-auth-connections-update-request-saml-options' - waad: '#/components/schemas/dev-org-auth-connections-update-request-azure-ad-options' - propertyName: type - oneOf: - - $ref: '#/components/schemas/dev-org-auth-connections-update-request-azure-ad-options' - - $ref: '#/components/schemas/dev-org-auth-connections-update-request-google-apps-options' - - $ref: '#/components/schemas/dev-org-auth-connections-update-request-oidc-options' - - $ref: '#/components/schemas/dev-org-auth-connections-update-request-okta-options' - - $ref: '#/components/schemas/dev-org-auth-connections-update-request-saml-options' - - $ref: '#/components/schemas/empty' + description: The response to listing the conversations. properties: - type: - $ref: '#/components/schemas/dev-org-auth-connections-update-request-type' - display_name: + conversations: + type: array + description: The list of conversations. + items: + $ref: '#/components/schemas/conversation' + next_cursor: type: string description: | - New display name of the authentication connection. This name will - be visible to all the users when they sign in to this Dev - organization. For example, if the display_name is 'abclogin', then - it would appear on the login button as 'Log in to abclogin'. + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. format: text - id: + prev_cursor: type: string description: | - ID of the authentication connection which is to be updated. + The cursor used to iterate preceding results in accordance to the + sort order. If not set, then no prior elements exist. format: text required: - - id - title: dev-org-auth-connections-update-request - dev-org-auth-connections-update-request-azure-ad-options: + - conversations + title: conversations-list-response + x-go-name: ConversationsListResponseBody + conversations-update-request: type: object - deprecated: true - description: | - Object encapsulating the configuration parameters for an Azure AD - authentication connection. + description: The request to update a conversation. properties: - client_id: + applies_to_parts: + $ref: '#/components/schemas/conversations-update-request-applies-to-parts' + brand: type: string - description: Client ID for the Azure authentication connection. - format: text - client_secret: + description: The brand associated with the conversation. + format: id + channels: + $ref: '#/components/schemas/conversations-update-request-channels' + custom_fields: + type: object + description: Application-defined custom fields. + custom_schema_spec: + $ref: '#/components/schemas/custom-schema-spec' + description: type: string - description: Client secret for the Azure authentication connection. + description: The updated description for the conversation. format: text - domain: + group: type: string - description: Domain URL of the Azure authentication connection. - format: text - title: dev-org-auth-connections-update-request-azure-ad-options - dev-org-auth-connections-update-request-google-apps-options: - type: object - deprecated: true - description: | - Object encapsulating the configuration parameters for a Google Apps - authentication connection. - properties: - client_id: + description: The group that the conversation is associated with. + format: id + id: type: string - description: Client ID for the Google Apps authentication connection. - format: text - client_secret: + description: The ID of the conversation to update. + format: id + is_frozen: + type: boolean + description: Whether the conversation is frozen. + is_spam: + type: boolean + description: Whether the conversation is spam. + members: + $ref: '#/components/schemas/conversations-update-request-members' + metadata: + $ref: '#/components/schemas/conversations-update-request-metadata' + owned_by: + $ref: '#/components/schemas/conversations-update-request-owned-by' + source_channel_v2: type: string - description: | - Client secret for the Google Apps authentication connection. + description: Source channel ID of the conversation. + format: id + stage: + $ref: '#/components/schemas/stage-update' + status: + type: string + description: The updated status of the conversation. format: text - tenant_domain: + tags: + $ref: '#/components/schemas/conversations-update-request-tags' + title: type: string - description: | - Tenant domain URL of the Google Apps authentication connection. + description: The updated title of the conversation. format: text - title: dev-org-auth-connections-update-request-google-apps-options - dev-org-auth-connections-update-request-oidc-options: + user_sessions: + $ref: '#/components/schemas/conversations-update-request-user-sessions' + required: + - id + title: conversations-update-request + conversations-update-request-applies-to-parts: type: object - description: | - Object encapsulating the configuration parameters for an OIDC - authentication connection. properties: - client_id: - type: string - description: Client ID for the OIDC authentication connection. - format: text - client_secret: - type: string - description: Client secret for the OIDC authentication connection. - format: text - issuer: + set: + type: array + description: Updates the parts that the conversation applies to. + example: + - PROD-12345 + items: + type: string + format: id + title: conversations-update-request-applies-to-parts + conversations-update-request-channels: + type: object + properties: + set: + type: array + description: Sets the channel IDs of the conversation. + items: + type: string + format: id + title: conversations-update-request-channels + conversations-update-request-members: + type: object + properties: + set: + type: array + description: Sets the member IDs to the provided user IDs. + example: + - DEVU-12345 + items: + type: string + format: id + title: conversations-update-request-members + conversations-update-request-metadata: + type: object + properties: + url_context: type: string - description: Issuer URL of the OIDC authentication connection. format: text - title: dev-org-auth-connections-update-request-oidc-options - dev-org-auth-connections-update-request-okta-options: + title: conversations-update-request-metadata + conversations-update-request-owned-by: type: object - description: | - Object encapsulating the configuration parameters for an Okta - authentication connection. properties: - client_id: + set: + type: array + description: Sets the owner IDs to the provided user IDs. + example: + - DEVU-12345 + items: + type: string + format: id + title: conversations-update-request-owned-by + conversations-update-request-tags: + type: object + properties: + add: + type: array + description: Adds the provided tags on the conversation. + items: + $ref: '#/components/schemas/add-tag-with-value' + remove: + type: array + description: Removes the provided tags on the conversation. + items: + $ref: '#/components/schemas/remove-tag-with-value' + set: + type: array + description: Sets the tag IDs to the provided tags. + items: + $ref: '#/components/schemas/set-tag-with-value' + title: conversations-update-request-tags + conversations-update-request-user-sessions: + type: object + properties: + set: + type: array + description: | + The updated user sessions that the conversation is associated with. + items: + type: string + format: id + title: conversations-update-request-user-sessions + conversations-update-response: + type: object + description: The response for updating a conversation. + properties: + conversation: + $ref: '#/components/schemas/conversation' + required: + - conversation + title: conversations-update-response + x-go-name: ConversationsUpdateResponseBody + create-command-action: + type: object + properties: + action_details: + $ref: '#/components/schemas/create-command-action-details' + artifacts: + type: array + description: IDs of the new artifact items + example: + - ARTIFACT-12345 + items: + type: string + format: id + code: type: string - description: Client ID for the Okta authentication connection. + description: | + The raw code to execute, defined in the language specified by + executor format: text - client_secret: + executor_config: + type: object + description: Executor specific config + executor_type: + $ref: '#/components/schemas/command-action-executor-type' + message: type: string - description: Client secret for the Okta authentication connection. + description: | + The message to populate in discussion box, when the command is + selected to execute. format: text - domain: + snap_in_function_id: type: string - description: Domain URL of the Okta authentication connection. - format: text - title: dev-org-auth-connections-update-request-okta-options - dev-org-auth-connections-update-request-saml-options: + description: | + Function containing logic for the command. If function ID is + specified the executor config is ignored and command is executed by + functions. + format: id + template_type: + $ref: '#/components/schemas/command-action-template-type' + required: + - executor_type + title: create-command-action + create-command-action-details: type: object - description: | - Object encapsulating the configuration parameters for a SAML - authentication connection. properties: - fields_map: - $ref: '#/components/schemas/saml-connection-fields-map' - sign_in_endpoint: - type: string - description: Sign In endpoint for the SAML authentication connection. - format: text - signing_cert: - type: string + object_update_payload: + type: object description: | - Signing certificate for the SAML authentication connection. - format: text - title: dev-org-auth-connections-update-request-saml-options - dev-org-auth-connections-update-request-type: - type: string - description: | - Specifies the type for the authentication connection. Different types - of authentication connections have different configuration parameters - that can be updated. - enum: - - google_apps - - none - - oidc - - okta - - samlp - - waad - dev-org-auth-connections-update-response: + The payload to update the object in context upon command execution. + title: create-command-action-details + create-command-surface: type: object - description: | - Response for the request to update an enterprise authentication - connection. properties: - auth_connection: - $ref: '#/components/schemas/auth-connection' + object_types: + type: array + description: Objects types on which a command can be invoked + items: + $ref: '#/components/schemas/command-surface-object-types' + surface: + $ref: '#/components/schemas/command-surface-surface' required: - - auth_connection - title: dev-org-auth-connections-update-response - x-go-name: DevOrgAuthConnectionsUpdateResponseBody - dev-user: - allOf: - - $ref: '#/components/schemas/user-base' - - type: object - properties: - experience_start_date: - type: string - description: Start date of the user's employment. - example: "2023-01-01T12:00:00.000Z" - format: date-time - external_identities: - type: array - description: IDs of the Dev User outside the DevRev SOR. - items: - $ref: '#/components/schemas/external-identity' - job_history: - type: array - description: Job history of the user. - items: - $ref: '#/components/schemas/job-history-item' - skills: - type: array - description: Array of skills of the user. - items: - $ref: '#/components/schemas/user-skill' - title: dev-user - dev-user-external-identity-filter: + - surface + title: create-command-surface + create-org-schedule-interval: type: object properties: - id: + from: type: string - description: Unique ID of the user in the external source. - format: text - issuer: + description: Date (inclusive) on which the interval begins. + example: "2023-01-01T12:00:00.000Z" + format: date-time + is_excluded: + type: boolean + description: | + If true, no organization schedule is looked up for these days and + they are marked as holidays. + name: type: string - description: Issuer of the external identity of the user. + description: | + The name of the period, for example the event or holiday it + represents. format: text - title: dev-user-external-identity-filter - dev-user-job-title: - type: string - description: Job title of the Dev User. - enum: - - customer_success_manager - - cxo - - designer - - developer - - head_of_support - - operations - - others - - product_manager - - qa - - revenue_leader - - support - - tech_lead - dev-user-summary: - allOf: - - $ref: '#/components/schemas/user-base-summary' - title: dev-user-summary - dev-users-get-request: - type: object - description: A request to get a Dev user's information. - properties: - id: + to: type: string - description: User ID of the requested Dev user. - format: id + description: | + Date (exclusive) on which the interval ends. If omitted, it is a + single day interval. + example: "2023-01-01T12:00:00.000Z" + format: date-time required: - - id - title: dev-users-get-request - dev-users-get-response: + - from + - name + title: create-org-schedule-interval + create-weekly-org-schedule-interval: type: object - description: The response to getting the information for the Dev user. properties: - dev_user: - $ref: '#/components/schemas/dev-user' + from: + type: integer + description: | + Duration in minutes of the week when the interval starts. 0 is + Sunday midnight, when Sunday ends and Monday begins. + format: int64 + to: + type: integer + description: | + Duration in minutes of the week when the interval ends (must be + larger than 'from'). 0 is Sunday midnight, when Sunday ends and + Monday begins. + format: int64 required: - - dev_user - title: dev-users-get-response - x-go-name: DevUsersGetResponseBody - dev-users-list-request: + - from + - to + title: create-weekly-org-schedule-interval + custom-schema-spec: type: object - description: A request to get the list of Dev user's information. + description: | + Custom schemas described using identifiers. Each custom field in the + request must have the corresponding schema specified; omission results + in a Bad Request error. If a custom schema is not included in the + specifier, it remains unchanged. For surfaces with human interactors, + it is recommended to provide tenant_fragment: true and + validate_required_fields: true. properties: - created_date: - $ref: '#/components/schemas/date-filter' - cursor: - type: string - description: | - The cursor to resume iteration from. If not provided, then - iteration starts from the beginning. - format: text - email: + apps: type: array - description: Filters Dev users based on email addresses. + description: List of apps. items: type: string format: text - external_identity: - type: array - description: Filters Dev users based on external identity. - items: - $ref: '#/components/schemas/dev-user-external-identity-filter' - limit: - type: integer - description: | - The maximum number of Dev users to return. The default is '50'. - format: int32 - mode: - $ref: '#/components/schemas/list-mode' - modified_date: - $ref: '#/components/schemas/date-filter' - sort_by: - type: array - description: | - Fields to sort the Dev users by and the direction to sort them. - items: - type: string - format: sort-by - state: - type: array - description: Filters Dev users based on state. - items: - $ref: '#/components/schemas/user-state' - title: dev-users-list-request - dev-users-list-response: + subtype: + type: string + description: Name of the subtype. + format: text + tenant_fragment: + type: boolean + description: Whether the tenant schema is requested. + validate_required_fields: + type: boolean + description: Whether to enforce required fields validation. + title: custom-schema-spec + dashboard: + allOf: + - $ref: '#/components/schemas/atom-base' + title: dashboard + date-filter: type: object - description: The response to listing the Dev users. + description: Provides ways to specify date ranges on objects. + discriminator: + mapping: + preset: '#/components/schemas/date-time-preset' + range: '#/components/schemas/date-time-filter' + propertyName: type + oneOf: + - $ref: '#/components/schemas/date-time-filter' + - $ref: '#/components/schemas/date-time-preset' properties: - dev_users: - type: array - description: The list of Dev users. - items: - $ref: '#/components/schemas/dev-user' - next_cursor: + type: + $ref: '#/components/schemas/date-filter-type' + required: + - type + title: date-filter + date-filter-type: + type: string + description: Type of date filter. + enum: + - preset + - range + date-time-filter: + type: object + properties: + after: type: string description: | - The cursor used to iterate subsequent results in accordance to the - sort order. If not set, then no later elements exist. - format: text - prev_cursor: + Filters for objects created after the provided timestamp + (inclusive). + example: "2023-01-01T12:00:00.000Z" + format: date-time + before: type: string description: | - The cursor used to iterate preceding results in accordance to the - sort order. If not set, then no prior elements exist. - format: text + Filters for objects created before the provided timestamp + (inclusive). + example: "2023-01-01T12:00:00.000Z" + format: date-time + title: date-time-filter + date-time-preset: + type: object + description: Provides preset types for date filter. + discriminator: + mapping: + last_n_days: '#/components/schemas/date-time-preset-last-n-days' + next_n_days: '#/components/schemas/date-time-preset-next-n-days' + propertyName: preset_type + oneOf: + - $ref: '#/components/schemas/date-time-preset-last-n-days' + - $ref: '#/components/schemas/date-time-preset-next-n-days' + properties: + preset_type: + $ref: '#/components/schemas/date-time-preset-type' required: - - dev_users - title: dev-users-list-response - x-go-name: DevUsersListResponseBody - dev-users-self-request: + - preset_type + title: date-time-preset + date-time-preset-last-n-days: type: object - additionalProperties: false - description: A request to get the authenticated user's information. - title: dev-users-self-request - dev-users-self-response: + properties: + days: + type: integer + description: | + The range starts from the current timestamp and continues for the + past n days. + maximum: 4294967295 + minimum: 0 + required: + - days + title: date-time-preset-last-n-days + date-time-preset-next-n-days: type: object - description: | - The response to getting the information for the authenticated user. properties: - dev_user: - $ref: '#/components/schemas/dev-user' + days: + type: integer + description: | + The range starts from the current timestamp and continues for the + next n days. + maximum: 4294967295 + minimum: 0 required: - - dev_user - title: dev-users-self-response - x-go-name: DevUsersSelfResponseBody - dev-users-self-update-request: + - days + title: date-time-preset-next-n-days + date-time-preset-type: + type: string + description: Type of date preset. + enum: + - last_n_days + - next_n_days + definedness: + type: string + description: Indicates whether this evaluation can change in the future. + enum: + - immutable + - mutable + - undefined + dev-org: + allOf: + - $ref: '#/components/schemas/org-base' + title: dev-org + dev-org-auth-connections-create-request: type: object description: | - A request to update the user's information for the authenticated Dev - user. + Request to create a new enterprise authentication connection. + discriminator: + mapping: + google_apps: '#/components/schemas/dev-org-auth-connections-create-request-google-apps-options' + oidc: '#/components/schemas/dev-org-auth-connections-create-request-oidc-options' + okta: '#/components/schemas/dev-org-auth-connections-create-request-okta-options' + samlp: '#/components/schemas/dev-org-auth-connections-create-request-saml-options' + waad: '#/components/schemas/dev-org-auth-connections-create-request-azure-ad-options' + propertyName: type + oneOf: + - $ref: '#/components/schemas/dev-org-auth-connections-create-request-azure-ad-options' + - $ref: '#/components/schemas/dev-org-auth-connections-create-request-google-apps-options' + - $ref: '#/components/schemas/dev-org-auth-connections-create-request-oidc-options' + - $ref: '#/components/schemas/dev-org-auth-connections-create-request-okta-options' + - $ref: '#/components/schemas/dev-org-auth-connections-create-request-saml-options' properties: - custom_fields: - type: object - description: Application-defined custom fields. - custom_schema_spec: - $ref: '#/components/schemas/custom-schema-spec' + type: + $ref: '#/components/schemas/dev-org-auth-connections-create-request-type' display_name: type: string - description: The updated display name of the Dev user. - format: text - experience_start_date: - type: string - description: Start date of Dev user's experience. - example: "2023-01-01T12:00:00.000Z" - format: date-time - full_name: - type: string - description: The updated full name of the Dev user. + description: | + Display name of the authentication connection. This name will be + visible to all the users when they sign in to this Dev + organization. For example, if the display_name is 'abclogin', then + it would appear on the login button as 'Log in to abclogin'. format: text - job_history: - type: array - description: Job history of the Dev user. - items: - $ref: '#/components/schemas/dev-users-update-job-history-item' - job_title: - $ref: '#/components/schemas/dev-user-job-title' - title: dev-users-self-update-request - dev-users-update-job-history-item: + maxLength: 128 + minLength: 1 + required: + - type + title: dev-org-auth-connections-create-request + dev-org-auth-connections-create-request-azure-ad-options: type: object + deprecated: true + description: | + Object encapsulating the configuration parameters for an Azure AD + authentication connection. properties: - employment_status: - type: integer - description: Enum for the employment status of the user. - format: int64 - end_date: - type: string - description: End date of the job. - example: "2023-01-01T12:00:00.000Z" - format: date-time - is_current: - type: boolean - description: Is this the current active job for the user. - location: + client_id: type: string - description: The job location for the user. + description: Client ID for the Azure authentication connection. format: text - start_date: + client_secret: type: string - description: Start date of the job. - example: "2023-01-01T12:00:00.000Z" - format: date-time - title: + description: Client secret for the Azure authentication connection. + format: text + domain: type: string - description: The job title for the user. + description: Domain URL of the Azure authentication connection. format: text - title: dev-users-update-job-history-item - dev-users-update-request: + required: + - client_id + - client_secret + - domain + title: dev-org-auth-connections-create-request-azure-ad-options + dev-org-auth-connections-create-request-google-apps-options: type: object + deprecated: true description: | - A request to update the user's information corresponding to the - provided Dev user. + Object encapsulating the configuration parameters for a Google Apps + authentication connection. properties: - custom_fields: - type: object - description: Application-defined custom fields. - custom_schema_spec: - $ref: '#/components/schemas/custom-schema-spec' - display_name: + client_id: type: string - description: The updated display name of the Dev user. + description: Client ID for the Google Apps authentication connection. format: text - experience_start_date: - type: string - description: Start date of Dev user's experience. - example: "2023-01-01T12:00:00.000Z" - format: date-time - full_name: + client_secret: type: string - description: The updated full name of the Dev user. + description: | + Client secret for the Google Apps authentication connection. format: text - id: + tenant_domain: type: string - description: The ID for the Dev user to be updated. - format: id - job_history: - type: array - description: Job history of the Dev user. - items: - $ref: '#/components/schemas/dev-users-update-job-history-item' - job_title: - $ref: '#/components/schemas/dev-user-job-title' - required: - - id - title: dev-users-update-request - dev-users-update-response: - type: object - description: The response to update a Dev user. - properties: - dev_user: - $ref: '#/components/schemas/dev-user' + description: | + Tenant domain URL of the Google Apps authentication connection. + format: text required: - - dev_user - title: dev-users-update-response - x-go-name: DevUsersUpdateResponseBody - directory-summary: - allOf: - - $ref: '#/components/schemas/atom-base-summary' - title: directory-summary - dynamic-group-info: - type: object - additionalProperties: false - description: Information to define dynamic groups. - title: dynamic-group-info - empty: - type: object - additionalProperties: false - title: empty - enhancement: - allOf: - - $ref: '#/components/schemas/part-base' - - type: object - properties: - actual_close_date: - type: string - description: Actual close date for the object. - example: "2023-01-01T12:00:00.000Z" - format: date-time - actual_start_date: - type: string - description: Actual start date for the object. - example: "2023-01-01T12:00:00.000Z" - format: date-time - stage_v2: - $ref: '#/components/schemas/stage' - state_v2: - type: string - description: State of the object based upon the stage. - format: text - target_close_date: - type: string - description: Target close date for the object. - example: "2023-01-01T12:00:00.000Z" - format: date-time - target_start_date: - type: string - description: Target start date for the object. - example: "2023-01-01T12:00:00.000Z" - format: date-time - title: enhancement - enhancement-summary: - allOf: - - $ref: '#/components/schemas/part-base-summary' - title: enhancement-summary - enum-value: + - client_id + - client_secret + - tenant_domain + title: dev-org-auth-connections-create-request-google-apps-options + dev-org-auth-connections-create-request-oidc-options: type: object - description: The properties of an enum value. + description: | + Object encapsulating the configuration parameters for an OIDC + authentication connection. properties: - id: - type: integer - description: The unique ID of the enum value. - format: int64 - label: + client_id: type: string - description: The display label of the enum value. + description: Client ID for the OIDC authentication connection. + format: text + client_secret: + type: string + description: Client secret for the OIDC authentication connection. + format: text + issuer: + type: string + description: Issuer URL of the OIDC authentication connection. format: text - ordinal: - type: integer - description: | - Used for determining the relative order of the enum value. - format: int64 - value: - description: The actual value of the enum value. required: - - id - - label - - ordinal - title: enum-value - enum-value-summary: + - client_id + - client_secret + - issuer + title: dev-org-auth-connections-create-request-oidc-options + dev-org-auth-connections-create-request-okta-options: type: object - description: The properties of an enum value. + deprecated: true + description: | + Object encapsulating the configuration parameters for an Okta + authentication connection. properties: - id: - type: integer - description: The unique ID of the enum value. - format: int64 - label: + client_id: type: string - description: The display label of the enum value. + description: Client ID for the Okta authentication connection. + format: text + client_secret: + type: string + description: Client secret for the Okta authentication connection. + format: text + domain: + type: string + description: Domain URL of the Okta authentication connection. format: text - ordinal: - type: integer - description: | - Used for determining the relative order of the enum value. - format: int64 required: - - id - - label - - ordinal - title: enum-value-summary - error: + - client_id + - client_secret + - domain + title: dev-org-auth-connections-create-request-okta-options + dev-org-auth-connections-create-request-saml-options: type: object + description: | + Object encapsulating the configuration parameters for a SAML + authentication connection. properties: - type: + connection_name: type: string - description: The error type. + description: | + Connection name for the SAML authentication connection. Must match + the `connection` query parameter specified in the sign on URL + during SAML configuration in your identity provider. format: text - message: + maxLength: 128 + minLength: 1 + fields_map: + $ref: '#/components/schemas/saml-connection-fields-map' + sign_in_endpoint: type: string - description: Information about the error. + description: Sign In endpoint for the SAML authentication connection. format: text - status: - type: integer - description: The corresponding HTTP status code. - format: int32 - required: - - message - - status - title: error - error-bad-request: - allOf: - - $ref: '#/components/schemas/error-base' - - type: object - discriminator: - mapping: - artifact_already_attached_to_a_parent: '#/components/schemas/error-bad-request-artifact-already-attached-to-a-parent' - bad_request: '#/components/schemas/error-bad-request-bad-request' - customization_validation_error: '#/components/schemas/error-bad-request-customization-validation-error' - invalid_api_version: '#/components/schemas/error-bad-request-invalid-api-version' - invalid_enum_value: '#/components/schemas/error-bad-request-invalid-enum-value' - invalid_field: '#/components/schemas/error-bad-request-invalid-field' - invalid_id: '#/components/schemas/error-bad-request-invalid-id' - merge_works_error: '#/components/schemas/error-bad-request-merge-works-error' - missing_dependency: '#/components/schemas/error-bad-request-missing-dependency' - missing_required_field: '#/components/schemas/error-bad-request-missing-required-field' - parse_error: '#/components/schemas/error-bad-request-parse-error' - stale_schema_fragments: '#/components/schemas/error-bad-request-stale-schema-fragments' - unexpected_id_type: '#/components/schemas/error-bad-request-unexpected-id-type' - unexpected_json_type: '#/components/schemas/error-bad-request-unexpected-json-type' - value_not_permitted: '#/components/schemas/error-bad-request-value-not-permitted' - workflow_component_validation_errors: '#/components/schemas/error-bad-request-workflow-component-validation-errors' - propertyName: type - oneOf: - - $ref: '#/components/schemas/error-bad-request-artifact-already-attached-to-a-parent' - - $ref: '#/components/schemas/error-bad-request-bad-request' - - $ref: '#/components/schemas/error-bad-request-customization-validation-error' - - $ref: '#/components/schemas/error-bad-request-invalid-api-version' - - $ref: '#/components/schemas/error-bad-request-invalid-enum-value' - - $ref: '#/components/schemas/error-bad-request-invalid-field' - - $ref: '#/components/schemas/error-bad-request-invalid-id' - - $ref: '#/components/schemas/error-bad-request-merge-works-error' - - $ref: '#/components/schemas/error-bad-request-missing-dependency' - - $ref: '#/components/schemas/error-bad-request-missing-required-field' - - $ref: '#/components/schemas/error-bad-request-parse-error' - - $ref: '#/components/schemas/error-bad-request-stale-schema-fragments' - - $ref: '#/components/schemas/error-bad-request-unexpected-id-type' - - $ref: '#/components/schemas/error-bad-request-unexpected-json-type' - - $ref: '#/components/schemas/error-bad-request-value-not-permitted' - - $ref: '#/components/schemas/error-bad-request-workflow-component-validation-errors' - properties: - type: - $ref: '#/components/schemas/error-bad-request-type' - required: - - type - description: Describes a error due to a bad request by the client. - title: error-bad-request - error-bad-request-artifact-already-attached-to-a-parent: + signing_cert: + type: string + description: | + Signing certificate for the SAML authentication connection. + format: text + required: + - sign_in_endpoint + - signing_cert + title: dev-org-auth-connections-create-request-saml-options + dev-org-auth-connections-create-request-type: + type: string + description: | + Defines the type for the authentication connection. Different types of + authentication connections have different configuration parameters. + enum: + - google_apps + - oidc + - okta + - samlp + - waad + dev-org-auth-connections-create-response: type: object + description: | + Response for the request to create a new enterprise authentication + connection. properties: - existing_parent: + auth_connection: + $ref: '#/components/schemas/auth-connection' + required: + - auth_connection + title: dev-org-auth-connections-create-response + x-go-name: DevOrgAuthConnectionsCreateResponseBody + dev-org-auth-connections-delete-request: + type: object + description: | + Request to delete an enterprise authentication connection for a Dev + organization. A default connection and a connection which is currently + enabled cannot be deleted. + properties: + id: type: string - description: The existing parent attached to the artifact. - format: id - is_same: - type: boolean + description: ID of the authentication connection to be deleted. + format: text + required: + - id + title: dev-org-auth-connections-delete-request + dev-org-auth-connections-get-request: + type: object + description: | + Request to get configuration details of organization's authentication + Connection. + properties: + id: + type: string + description: ID of the authentication connection. + format: text + required: + - id + title: dev-org-auth-connections-get-request + dev-org-auth-connections-get-response: + type: object + description: | + Response object encapsulating the configuration details of an + authentication connection. + properties: + auth_connection: + $ref: '#/components/schemas/auth-connection' + required: + - auth_connection + title: dev-org-auth-connections-get-response + x-go-name: DevOrgAuthConnectionsGetResponseBody + dev-org-auth-connections-list-response: + type: object + description: | + Response object for the request to list all the social and enterprise + authentication connections configured for a Dev organization. + properties: + auth_connections: + type: array description: | - Whether the existing parent is the same as the new parent. + List of all the authentication connections currently configured for + a Dev organization. + items: + $ref: '#/components/schemas/auth-connection' required: - - existing_parent - - is_same - title: error-bad-request-artifact-already-attached-to-a-parent - error-bad-request-bad-request: + - auth_connections + title: dev-org-auth-connections-list-response + x-go-name: DevOrgAuthConnectionsListResponseBody + dev-org-auth-connections-toggle-request: type: object - additionalProperties: false - title: error-bad-request-bad-request - error-bad-request-customization-validation-error: + description: | + Request to enable or disable an authentication connection for a Dev + organization. + properties: + id: + type: string + description: ID of the authentication connection to be toggled. + format: text + toggle: + $ref: '#/components/schemas/auth-connection-toggle' + required: + - id + title: dev-org-auth-connections-toggle-request + dev-org-auth-connections-update-request: type: object description: | - Describes an error encountered during customization validation. + Request to update an enterprise authentication connection for a Dev + organization. discriminator: mapping: - bad_id_type: '#/components/schemas/error-bad-request-customization-validation-error-bad-id-type' - date_parse_error: '#/components/schemas/error-bad-request-customization-validation-error-date-parse-error' - enum_out_of_range: '#/components/schemas/error-bad-request-customization-validation-error-enum-out-of-range' - expression_parse_error: '#/components/schemas/error-bad-request-customization-validation-error-expression-parse-error' - field_dropped: '#/components/schemas/error-bad-request-customization-validation-error-field-dropped' - field_immutable: '#/components/schemas/error-bad-request-customization-validation-error-field-immutable' - field_not_in_schema: '#/components/schemas/error-bad-request-customization-validation-error-field-not-in-schema' - field_required: '#/components/schemas/error-bad-request-customization-validation-error-field-required' - fragment_not_found: '#/components/schemas/error-bad-request-customization-validation-error-fragment-not-found' - id_parse_error: '#/components/schemas/error-bad-request-customization-validation-error-id-parse-error' - id_type_not_allowed: '#/components/schemas/error-bad-request-customization-validation-error-id-type-not-allowed' - invalid_argument: '#/components/schemas/error-bad-request-customization-validation-error-invalid-argument' - timestamp_parse_error: '#/components/schemas/error-bad-request-customization-validation-error-timestamp-parse-error' - unknown_error: '#/components/schemas/error-bad-request-customization-validation-error-unknown-error' - unsupported_type: '#/components/schemas/error-bad-request-customization-validation-error-unsupported-type' - wrong_type: '#/components/schemas/error-bad-request-customization-validation-error-wrong-type' - propertyName: subtype + google_apps: '#/components/schemas/dev-org-auth-connections-update-request-google-apps-options' + none: '#/components/schemas/empty' + oidc: '#/components/schemas/dev-org-auth-connections-update-request-oidc-options' + okta: '#/components/schemas/dev-org-auth-connections-update-request-okta-options' + samlp: '#/components/schemas/dev-org-auth-connections-update-request-saml-options' + waad: '#/components/schemas/dev-org-auth-connections-update-request-azure-ad-options' + propertyName: type oneOf: - - $ref: '#/components/schemas/error-bad-request-customization-validation-error-bad-id-type' - - $ref: '#/components/schemas/error-bad-request-customization-validation-error-date-parse-error' - - $ref: '#/components/schemas/error-bad-request-customization-validation-error-enum-out-of-range' - - $ref: '#/components/schemas/error-bad-request-customization-validation-error-expression-parse-error' - - $ref: '#/components/schemas/error-bad-request-customization-validation-error-field-dropped' - - $ref: '#/components/schemas/error-bad-request-customization-validation-error-field-immutable' - - $ref: '#/components/schemas/error-bad-request-customization-validation-error-field-not-in-schema' - - $ref: '#/components/schemas/error-bad-request-customization-validation-error-field-required' - - $ref: '#/components/schemas/error-bad-request-customization-validation-error-fragment-not-found' - - $ref: '#/components/schemas/error-bad-request-customization-validation-error-id-parse-error' - - $ref: '#/components/schemas/error-bad-request-customization-validation-error-id-type-not-allowed' - - $ref: '#/components/schemas/error-bad-request-customization-validation-error-invalid-argument' - - $ref: '#/components/schemas/error-bad-request-customization-validation-error-timestamp-parse-error' - - $ref: '#/components/schemas/error-bad-request-customization-validation-error-unknown-error' - - $ref: '#/components/schemas/error-bad-request-customization-validation-error-unsupported-type' - - $ref: '#/components/schemas/error-bad-request-customization-validation-error-wrong-type' + - $ref: '#/components/schemas/dev-org-auth-connections-update-request-azure-ad-options' + - $ref: '#/components/schemas/dev-org-auth-connections-update-request-google-apps-options' + - $ref: '#/components/schemas/dev-org-auth-connections-update-request-oidc-options' + - $ref: '#/components/schemas/dev-org-auth-connections-update-request-okta-options' + - $ref: '#/components/schemas/dev-org-auth-connections-update-request-saml-options' + - $ref: '#/components/schemas/empty' properties: - field_name: + type: + $ref: '#/components/schemas/dev-org-auth-connections-update-request-type' + display_name: type: string - description: The name of the invalid field. + description: | + New display name of the authentication connection. This name will + be visible to all the users when they sign in to this Dev + organization. For example, if the display_name is 'abclogin', then + it would appear on the login button as 'Log in to abclogin'. format: text - reason: + id: type: string - description: The reason given for the error. + description: | + ID of the authentication connection which is to be updated. format: text - subtype: - $ref: '#/components/schemas/error-bad-request-customization-validation-error-subtype' required: - - subtype - title: error-bad-request-customization-validation-error - error-bad-request-customization-validation-error-bad-id-type: + - id + title: dev-org-auth-connections-update-request + dev-org-auth-connections-update-request-azure-ad-options: type: object - additionalProperties: false - title: error-bad-request-customization-validation-error-bad-id-type - error-bad-request-customization-validation-error-date-parse-error: - type: object - additionalProperties: false - title: error-bad-request-customization-validation-error-date-parse-error - error-bad-request-customization-validation-error-enum-out-of-range: - type: object - additionalProperties: false - title: error-bad-request-customization-validation-error-enum-out-of-range - error-bad-request-customization-validation-error-expression-parse-error: - type: object - additionalProperties: false - title: error-bad-request-customization-validation-error-expression-parse-error - error-bad-request-customization-validation-error-field-dropped: - type: object - additionalProperties: false - title: error-bad-request-customization-validation-error-field-dropped - error-bad-request-customization-validation-error-field-immutable: - type: object - additionalProperties: false - title: error-bad-request-customization-validation-error-field-immutable - error-bad-request-customization-validation-error-field-not-in-schema: - type: object - additionalProperties: false - title: error-bad-request-customization-validation-error-field-not-in-schema - error-bad-request-customization-validation-error-field-required: - type: object - additionalProperties: false - title: error-bad-request-customization-validation-error-field-required - error-bad-request-customization-validation-error-fragment-not-found: - type: object - additionalProperties: false - title: error-bad-request-customization-validation-error-fragment-not-found - error-bad-request-customization-validation-error-id-parse-error: - type: object - additionalProperties: false - title: error-bad-request-customization-validation-error-id-parse-error - error-bad-request-customization-validation-error-id-type-not-allowed: - type: object - additionalProperties: false - title: error-bad-request-customization-validation-error-id-type-not-allowed - error-bad-request-customization-validation-error-invalid-argument: - type: object - additionalProperties: false - title: error-bad-request-customization-validation-error-invalid-argument - error-bad-request-customization-validation-error-subtype: - type: string - enum: - - bad_id_type - - date_parse_error - - enum_out_of_range - - expression_parse_error - - field_dropped - - field_immutable - - field_not_in_schema - - field_required - - fragment_not_found - - id_parse_error - - id_type_not_allowed - - invalid_argument - - timestamp_parse_error - - unknown_error - - unsupported_type - - wrong_type - error-bad-request-customization-validation-error-timestamp-parse-error: - type: object - additionalProperties: false - title: error-bad-request-customization-validation-error-timestamp-parse-error - error-bad-request-customization-validation-error-unknown-error: - type: object - additionalProperties: false - title: error-bad-request-customization-validation-error-unknown-error - error-bad-request-customization-validation-error-unsupported-type: - type: object - additionalProperties: false - title: error-bad-request-customization-validation-error-unsupported-type - error-bad-request-customization-validation-error-wrong-type: - type: object - additionalProperties: false - title: error-bad-request-customization-validation-error-wrong-type - error-bad-request-invalid-api-version: + deprecated: true + description: | + Object encapsulating the configuration parameters for an Azure AD + authentication connection. + properties: + client_id: + type: string + description: Client ID for the Azure authentication connection. + format: text + client_secret: + type: string + description: Client secret for the Azure authentication connection. + format: text + domain: + type: string + description: Domain URL of the Azure authentication connection. + format: text + title: dev-org-auth-connections-update-request-azure-ad-options + dev-org-auth-connections-update-request-google-apps-options: type: object + deprecated: true + description: | + Object encapsulating the configuration parameters for a Google Apps + authentication connection. properties: - value: + client_id: type: string - description: The provided API version. + description: Client ID for the Google Apps authentication connection. format: text - required: - - value - title: error-bad-request-invalid-api-version - error-bad-request-invalid-enum-value: - type: object - properties: - allowed_values: - type: array - description: The allowed values for the field. - items: - type: string - format: text - field_name: + client_secret: type: string - description: The field whose enum value is invalid. + description: | + Client secret for the Google Apps authentication connection. format: text - value: + tenant_domain: type: string - description: The value that was received. + description: | + Tenant domain URL of the Google Apps authentication connection. format: text - required: - - allowed_values - - field_name - - value - title: error-bad-request-invalid-enum-value - error-bad-request-invalid-field: + title: dev-org-auth-connections-update-request-google-apps-options + dev-org-auth-connections-update-request-oidc-options: type: object + description: | + Object encapsulating the configuration parameters for an OIDC + authentication connection. properties: - field_name: + client_id: type: string - description: The field name that's invalid. + description: Client ID for the OIDC authentication connection. format: text - required: - - field_name - title: error-bad-request-invalid-field - error-bad-request-invalid-id: - type: object - properties: - field_name: + client_secret: type: string - description: The field whose ID is invalid. + description: Client secret for the OIDC authentication connection. format: text - required: - - field_name - title: error-bad-request-invalid-id - error-bad-request-merge-works-error: - type: object - properties: - errors: - type: array - description: | - The errors encountered during the validation of the merge. - items: - $ref: '#/components/schemas/error-bad-request-merge-works-error-error' - title: error-bad-request-merge-works-error - error-bad-request-merge-works-error-error: + issuer: + type: string + description: Issuer URL of the OIDC authentication connection. + format: text + title: dev-org-auth-connections-update-request-oidc-options + dev-org-auth-connections-update-request-okta-options: type: object + description: | + Object encapsulating the configuration parameters for an Okta + authentication connection. properties: - already_merged: - $ref: '#/components/schemas/error-bad-request-merge-works-error-error-already-merged' - closed: - $ref: '#/components/schemas/error-bad-request-merge-works-error-error-closed' - details: + client_id: type: string - description: The details of the error. + description: Client ID for the Okta authentication connection. format: text - different_reporters: - $ref: '#/components/schemas/error-bad-request-merge-works-error-error-different-reporters' - different_workspace: - $ref: '#/components/schemas/error-bad-request-merge-works-error-error-different-workspace' - invalid_stage_transition: - $ref: '#/components/schemas/error-bad-request-merge-works-error-error-invalid-stage-transition' - locked: - $ref: '#/components/schemas/error-bad-request-merge-works-error-error-locked' - stage_not_found_for_subtype: - $ref: '#/components/schemas/error-bad-request-merge-works-error-error-stage-not-found-for-subtype' - subtype: + client_secret: type: string - enum: - - already_merged - - closed - - different_reporters - - different_workspace - - invalid_stage_transition - - locked - - stage_not_found_for_subtype - work: + description: Client secret for the Okta authentication connection. + format: text + domain: type: string - description: The ID of the work which failed the validation. - format: id - required: - - details - - work - title: error-bad-request-merge-works-error-error - error-bad-request-merge-works-error-error-already-merged: + description: Domain URL of the Okta authentication connection. + format: text + title: dev-org-auth-connections-update-request-okta-options + dev-org-auth-connections-update-request-saml-options: type: object + description: | + Object encapsulating the configuration parameters for a SAML + authentication connection. properties: - merged_into: + fields_map: + $ref: '#/components/schemas/saml-connection-fields-map' + sign_in_endpoint: type: string - description: ID of the work into which the work was merged. - format: id + description: Sign In endpoint for the SAML authentication connection. + format: text + signing_cert: + type: string + description: | + Signing certificate for the SAML authentication connection. + format: text + title: dev-org-auth-connections-update-request-saml-options + dev-org-auth-connections-update-request-type: + type: string + description: | + Specifies the type for the authentication connection. Different types + of authentication connections have different configuration parameters + that can be updated. + enum: + - google_apps + - none + - oidc + - okta + - samlp + - waad + dev-org-auth-connections-update-response: + type: object + description: | + Response for the request to update an enterprise authentication + connection. + properties: + auth_connection: + $ref: '#/components/schemas/auth-connection' required: - - merged_into - title: error-bad-request-merge-works-error-error-already-merged - error-bad-request-merge-works-error-error-closed: + - auth_connection + title: dev-org-auth-connections-update-response + x-go-name: DevOrgAuthConnectionsUpdateResponseBody + dev-orgs-get-request: type: object additionalProperties: false - title: error-bad-request-merge-works-error-error-closed - error-bad-request-merge-works-error-error-different-reporters: + description: A request to get a Dev organization's information. + title: dev-orgs-get-request + dev-orgs-get-response: type: object + description: The response to get a Dev organization's information. properties: - primary_reporters: - type: array - description: The reporters of the primary work. - items: - type: string - format: id - secondary_reporters: - type: array - description: The reporters of the secondary work. - items: - type: string - format: id - title: error-bad-request-merge-works-error-error-different-reporters - error-bad-request-merge-works-error-error-different-workspace: + dev_org: + $ref: '#/components/schemas/dev-org' + required: + - dev_org + title: dev-orgs-get-response + x-go-name: DevOrgsGetResponseBody + dev-user: + allOf: + - $ref: '#/components/schemas/user-base' + - type: object + properties: + experience_start_date: + type: string + description: Start date of the user's employment. + example: "2023-01-01T12:00:00.000Z" + format: date-time + external_identities: + type: array + description: IDs of the Dev User outside the DevRev SOR. + items: + $ref: '#/components/schemas/external-identity' + job_history: + type: array + description: Job history of the user. + items: + $ref: '#/components/schemas/job-history-item' + skills: + type: array + description: Array of skills of the user. + items: + $ref: '#/components/schemas/user-skill' + title: dev-user + dev-user-external-identity-filter: type: object properties: - primary_workspace: + id: type: string - description: The workspace of the primary work. - format: id - secondary_workspace: + description: Unique ID of the user in the external source. + format: text + issuer: type: string - description: The workspace of the secondary work. - format: id - title: error-bad-request-merge-works-error-error-different-workspace - error-bad-request-merge-works-error-error-invalid-stage-transition: + description: Issuer of the external identity of the user. + format: text + title: dev-user-external-identity-filter + dev-user-job-title: + type: string + description: Job title of the Dev User. + enum: + - customer_success_manager + - cxo + - designer + - developer + - head_of_support + - operations + - others + - product_manager + - qa + - revenue_leader + - support + - tech_lead + dev-user-summary: + allOf: + - $ref: '#/components/schemas/user-base-summary' + title: dev-user-summary + dev-users-activate-request: type: object + description: A request to activate the Dev user. properties: - current_stage: - type: string - description: The current stage of the work. - format: id - requested_stage: + groups: + type: array + description: IDs of the groups assigned to user during activation. + items: + type: string + format: id + id: type: string - description: The stage to which the transition isn't allowed. + description: The ID for the Dev user. format: id required: - - current_stage - - requested_stage - title: error-bad-request-merge-works-error-error-invalid-stage-transition - error-bad-request-merge-works-error-error-locked: - type: object - additionalProperties: false - title: error-bad-request-merge-works-error-error-locked - error-bad-request-merge-works-error-error-stage-not-found-for-subtype: + - id + title: dev-users-activate-request + dev-users-activate-response: type: object + description: The response to activate the Dev user. properties: - subtype: - type: string - description: | - The subtype of the work for which stage is not configured. - format: text - title: error-bad-request-merge-works-error-error-stage-not-found-for-subtype - error-bad-request-missing-dependency: + invite_sent: + type: boolean + description: Whether an invitation has been sent to the Dev user. + required: + - invite_sent + title: dev-users-activate-response + x-go-name: DevUsersActivateResponseBody + dev-users-create-request: type: object + description: | + Request object to create a new Dev user for a Dev organization. properties: - dependencies: - type: array - description: The dependent fields. - items: - $ref: '#/components/schemas/error-bad-request-missing-dependency-dependency' - dependent_field_name: - type: string - description: The field on which the value depends. - format: text - dependent_field_value: + custom_fields: + type: object + description: Application-defined custom fields. + custom_schema_spec: + $ref: '#/components/schemas/custom-schema-spec' + email: type: string - description: The value which needs to be set of the dependent field. + description: Email of the Dev user. format: text - provided_field_name: + full_name: type: string - description: The field whose value was received. + description: Full name of the Dev user. format: text - provided_field_value: + reports_to: type: string - description: The value that was received. - format: text - title: error-bad-request-missing-dependency - error-bad-request-missing-dependency-dependency: + description: The ID of the user that the user reports to. + format: id + state: + $ref: '#/components/schemas/dev-users-create-request-state-enum-value' + required: + - email + - state + title: dev-users-create-request + dev-users-create-request-state-enum-value: + type: string + enum: + - shadow + dev-users-create-response: type: object + description: | + Response object for request to create a new Dev user for a Dev + organization. properties: - field_name: - type: string - description: The dependent field name. - format: text - field_value: - type: string - description: The dependent field value. - format: text + dev_user: + $ref: '#/components/schemas/dev-user' required: - - field_name - - field_value - title: error-bad-request-missing-dependency-dependency - error-bad-request-missing-required-field: + - dev_user + title: dev-users-create-response + x-go-name: DevUsersCreateResponseBody + dev-users-deactivate-request: type: object + description: A request to deactivate the Dev user. properties: - field_name: + id: type: string - description: The missing field's name. - format: text + description: The ID for the Dev user. + format: id required: - - field_name - title: error-bad-request-missing-required-field - error-bad-request-parse-error: - type: object - additionalProperties: false - title: error-bad-request-parse-error - error-bad-request-stale-schema-fragments: + - id + title: dev-users-deactivate-request + dev-users-deactivate-response: type: object additionalProperties: false - description: | - Error indicating that the request contained one or more stale schema - fragments, which are schema fragments that have been replaced by a - newer version and are therefore considered deprecated schema fragments. - The caller should refresh and use the latest schema fragments in their - request. - title: error-bad-request-stale-schema-fragments - error-bad-request-type: - type: string - enum: - - artifact_already_attached_to_a_parent - - bad_request - - customization_validation_error - - invalid_api_version - - invalid_enum_value - - invalid_field - - invalid_id - - merge_works_error - - missing_dependency - - missing_required_field - - parse_error - - stale_schema_fragments - - unexpected_id_type - - unexpected_json_type - - value_not_permitted - - workflow_component_validation_errors - error-bad-request-unexpected-id-type: + description: The response to deactivate the Dev user. + title: dev-users-deactivate-response + x-go-name: DevUsersDeactivateResponseBody + dev-users-get-request: type: object + description: A request to get a Dev user's information. properties: - field_name: + id: type: string - description: The field whose ID type is unexpected. - format: text + description: User ID of the requested Dev user. + format: id required: - - field_name - title: error-bad-request-unexpected-id-type - error-bad-request-unexpected-json-type: + - id + title: dev-users-get-request + dev-users-get-response: type: object + description: The response to getting the information for the Dev user. properties: - actual: - $ref: '#/components/schemas/error-bad-request-unexpected-json-type-type' - expected: - $ref: '#/components/schemas/error-bad-request-unexpected-json-type-type' - field_name: - type: string - description: The field name that's invalid. - format: text + dev_user: + $ref: '#/components/schemas/dev-user' required: - - actual - - expected - - field_name - title: error-bad-request-unexpected-json-type - error-bad-request-unexpected-json-type-type: - type: string - enum: - - array - - bool - - "null" - - number - - object - - string - error-bad-request-value-not-permitted: + - dev_user + title: dev-users-get-response + x-go-name: DevUsersGetResponseBody + dev-users-identities-link-request: type: object + description: Request to link external identity to a Dev user. properties: - allowed_values: - type: array - description: The allowed values for the field. - items: - type: string - format: text - field_name: + dev_user: type: string - description: The field whose value is not permitted. + description: The ID of the Dev user to link the external identity to. + format: id + display_name: + type: string + description: Display name of the Dev user in the external source. format: text - reason: + id: type: string - description: The reason the value isn't permitted. + description: Unique ID of the Dev user in the external source. + format: text + issuer: + type: string + description: Issuer of the external identity of the Dev user. format: text required: - - field_name - title: error-bad-request-value-not-permitted - error-bad-request-workflow-component-validation-error: + - dev_user + - id + - issuer + title: dev-users-identities-link-request + dev-users-identities-link-response: type: object description: | - Error indicating that one or more workflow components failed - validation. + Response for the request to link an external identity to a Dev user. properties: - code: - type: string - description: Error code uniquely identifying the validation issue. - format: text - maxLength: 16 - field: - $ref: '#/components/schemas/error-bad-request-workflow-component-validation-error-field' - location: - $ref: '#/components/schemas/error-bad-request-workflow-component-validation-error-workflow-component-validation-location-type' - message: + dev_user: + $ref: '#/components/schemas/dev-user' + required: + - dev_user + title: dev-users-identities-link-response + x-go-name: DevUsersIdentitiesLinkResponseBody + dev-users-identities-unlink-request: + type: object + description: Request to unlink an external identity from a Dev user. + properties: + dev_user: type: string - description: Human-readable message describing the issue. + description: | + The ID of the Dev user to unlink the external identity from. + format: id + issuer: + type: string + description: Issuer that needs to be unlinked from a Dev user. format: text - maxLength: 512 - operation: - $ref: '#/components/schemas/error-bad-request-workflow-component-validation-error-operation' - workflow: - $ref: '#/components/schemas/error-bad-request-workflow-component-validation-error-workflow' - workflow_step: - $ref: '#/components/schemas/error-bad-request-workflow-component-validation-error-workflow-step' required: - - code - - message - title: error-bad-request-workflow-component-validation-error - error-bad-request-workflow-component-validation-error-field: + - dev_user + - issuer + title: dev-users-identities-unlink-request + dev-users-identities-unlink-response: type: object - description: Represents a field with a violation. + description: | + Response for the request to unlink an external identity from a Dev + user. properties: - field_path: + dev_user: + $ref: '#/components/schemas/dev-user' + required: + - dev_user + title: dev-users-identities-unlink-response + x-go-name: DevUsersIdentitiesUnlinkResponseBody + dev-users-list-request: + type: object + description: A request to get the list of Dev user's information. + properties: + created_date: + $ref: '#/components/schemas/date-filter' + cursor: type: string - description: Path to the field with dot notation. + description: | + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. format: text - parent_id: - type: string - description: The parent object containing the field. - format: id - required: - - field_path - - parent_id - title: error-bad-request-workflow-component-validation-error-field - error-bad-request-workflow-component-validation-error-operation: + email: + type: array + description: Filters Dev users based on email addresses. + items: + type: string + format: text + external_identity: + type: array + description: Filters Dev users based on external identity. + items: + $ref: '#/components/schemas/dev-user-external-identity-filter' + limit: + type: integer + description: | + The maximum number of Dev users to return. The default is '50'. + format: int32 + mode: + $ref: '#/components/schemas/list-mode' + modified_date: + $ref: '#/components/schemas/date-filter' + sort_by: + type: array + description: | + Fields to sort the Dev users by and the direction to sort them. + items: + type: string + format: sort-by + state: + type: array + description: Filters Dev users based on state. + items: + $ref: '#/components/schemas/user-state' + title: dev-users-list-request + dev-users-list-response: type: object - description: Represents an operation with a violation. + description: The response to listing the Dev users. properties: - id: + dev_users: + type: array + description: The list of Dev users. + items: + $ref: '#/components/schemas/dev-user' + next_cursor: type: string - description: The ID of the operation with the error. - format: id + description: | + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. + format: text + prev_cursor: + type: string + description: | + The cursor used to iterate preceding results in accordance to the + sort order. If not set, then no prior elements exist. + format: text required: - - id - title: error-bad-request-workflow-component-validation-error-operation - error-bad-request-workflow-component-validation-error-workflow: + - dev_users + title: dev-users-list-response + x-go-name: DevUsersListResponseBody + dev-users-merge-request: type: object - description: Represents a workflow with a violation. + description: Request object for merging Dev users. properties: - id: + primary_user: type: string - description: The ID of the workflow with the error. + description: The unique ID of the primary user. + format: id + secondary_user: + type: string + description: The unique ID of the secondary user. format: id required: - - id - title: error-bad-request-workflow-component-validation-error-workflow - error-bad-request-workflow-component-validation-error-workflow-component-validation-location-type: - type: string - enum: - - field - - operation - - workflow - - workflow_step - error-bad-request-workflow-component-validation-error-workflow-step: + - primary_user + - secondary_user + title: dev-users-merge-request + dev-users-merge-response: type: object - description: Represents a workflow step with a violation. + additionalProperties: false + description: Response object for request to merge Dev users. + title: dev-users-merge-response + x-go-name: DevUsersMergeResponseBody + dev-users-self-request: + type: object + additionalProperties: false + description: A request to get the authenticated user's information. + title: dev-users-self-request + dev-users-self-response: + type: object + description: | + The response to getting the information for the authenticated user. properties: - id: - type: string - description: The ID of the workflow step with the error. - format: id + dev_user: + $ref: '#/components/schemas/dev-user' required: - - id - title: error-bad-request-workflow-component-validation-error-workflow-step - error-bad-request-workflow-component-validation-errors: + - dev_user + title: dev-users-self-response + x-go-name: DevUsersSelfResponseBody + dev-users-self-update-request: type: object + description: | + A request to update the user's information for the authenticated Dev + user. properties: - errors: + custom_fields: + type: object + description: Application-defined custom fields. + custom_schema_spec: + $ref: '#/components/schemas/custom-schema-spec' + display_name: + type: string + description: The updated display name of the Dev user. + format: text + experience_start_date: + type: string + description: Start date of Dev user's experience. + example: "2023-01-01T12:00:00.000Z" + format: date-time + full_name: + type: string + description: The updated full name of the Dev user. + format: text + job_history: type: array - description: Nested validation errors. + description: Job history of the Dev user. items: - $ref: '#/components/schemas/error-bad-request-workflow-component-validation-error' - title: error-bad-request-workflow-component-validation-errors - error-base: + $ref: '#/components/schemas/dev-users-update-job-history-item' + job_title: + $ref: '#/components/schemas/dev-user-job-title' + title: dev-users-self-update-request + dev-users-update-job-history-item: type: object properties: - detail: + employment_status: + type: integer + description: Enum for the employment status of the user. + format: int64 + end_date: type: string - description: Error detail information. + description: End date of the job. + example: "2023-01-01T12:00:00.000Z" + format: date-time + is_current: + type: boolean + description: Is this the current active job for the user. + location: + type: string + description: The job location for the user. format: text - message: + start_date: type: string - description: The message associated with the error. + description: Start date of the job. + example: "2023-01-01T12:00:00.000Z" + format: date-time + title: + type: string + description: The job title for the user. format: text - title: error-base - error-conflict: - allOf: - - $ref: '#/components/schemas/error-base' - - type: object - discriminator: - mapping: - conflict: '#/components/schemas/error-conflict-conflict' - propertyName: type - oneOf: - - $ref: '#/components/schemas/error-conflict-conflict' - properties: - type: - $ref: '#/components/schemas/error-conflict-type' - required: - - type - title: error-conflict - error-conflict-conflict: + title: dev-users-update-job-history-item + dev-users-update-request: type: object - additionalProperties: false - title: error-conflict-conflict - error-conflict-type: - type: string - enum: - - conflict - error-forbidden: - allOf: - - $ref: '#/components/schemas/error-base' - - type: object - discriminator: - mapping: - forbidden: '#/components/schemas/error-forbidden-forbidden' - propertyName: type - oneOf: - - $ref: '#/components/schemas/error-forbidden-forbidden' - properties: - type: - $ref: '#/components/schemas/error-forbidden-type' - required: - - type - title: error-forbidden - error-forbidden-forbidden: - type: object - additionalProperties: false - title: error-forbidden-forbidden - error-forbidden-type: - type: string - enum: - - forbidden - error-internal-server-error: - allOf: - - $ref: '#/components/schemas/error-base' - - type: object - discriminator: - mapping: - internal_error: '#/components/schemas/error-internal-server-error-internal-error' - propertyName: type - oneOf: - - $ref: '#/components/schemas/error-internal-server-error-internal-error' - properties: - type: - $ref: '#/components/schemas/error-internal-server-error-type' - reference_id: - type: string - description: | - A unique ID that's generated for the error that can be used for - inquiry. - format: text - required: - - type - title: error-internal-server-error - error-internal-server-error-internal-error: - type: object - additionalProperties: false - title: error-internal-server-error-internal-error - error-internal-server-error-type: - type: string - enum: - - internal_error - error-not-found: - allOf: - - $ref: '#/components/schemas/error-base' - - type: object - discriminator: - mapping: - not_found: '#/components/schemas/error-not-found-not-found' - propertyName: type - oneOf: - - $ref: '#/components/schemas/error-not-found-not-found' - properties: - type: - $ref: '#/components/schemas/error-not-found-type' - required: - - type - title: error-not-found - error-not-found-not-found: + description: | + A request to update the user's information corresponding to the + provided Dev user. + properties: + custom_fields: + type: object + description: Application-defined custom fields. + custom_schema_spec: + $ref: '#/components/schemas/custom-schema-spec' + display_name: + type: string + description: The updated display name of the Dev user. + format: text + experience_start_date: + type: string + description: Start date of Dev user's experience. + example: "2023-01-01T12:00:00.000Z" + format: date-time + full_name: + type: string + description: The updated full name of the Dev user. + format: text + id: + type: string + description: The ID for the Dev user to be updated. + format: id + job_history: + type: array + description: Job history of the Dev user. + items: + $ref: '#/components/schemas/dev-users-update-job-history-item' + job_title: + $ref: '#/components/schemas/dev-user-job-title' + required: + - id + title: dev-users-update-request + dev-users-update-response: type: object - additionalProperties: false - title: error-not-found-not-found - error-not-found-type: - type: string - enum: - - not_found - error-service-unavailable: - allOf: - - $ref: '#/components/schemas/error-base' - - type: object - discriminator: - mapping: - service_unavailable: '#/components/schemas/error-service-unavailable-service-unavailable' - propertyName: type - oneOf: - - $ref: '#/components/schemas/error-service-unavailable-service-unavailable' - properties: - type: - $ref: '#/components/schemas/error-service-unavailable-type' - required: - - type - title: error-service-unavailable - error-service-unavailable-service-unavailable: + description: The response to update a Dev user. + properties: + dev_user: + $ref: '#/components/schemas/dev-user' + required: + - dev_user + title: dev-users-update-response + x-go-name: DevUsersUpdateResponseBody + directories-count-request: type: object - additionalProperties: false - title: error-service-unavailable-service-unavailable - error-service-unavailable-type: - type: string - enum: - - service_unavailable - error-too-many-requests: - allOf: - - $ref: '#/components/schemas/error-base' - - type: object - discriminator: - mapping: - too_many_requests: '#/components/schemas/error-too-many-requests-too-many-requests' - propertyName: type - oneOf: - - $ref: '#/components/schemas/error-too-many-requests-too-many-requests' - properties: - type: - $ref: '#/components/schemas/error-too-many-requests-type' - retry_after: - type: integer - description: | - The number of seconds after which the client should retry. - format: int64 - required: - - type - title: error-too-many-requests - error-too-many-requests-too-many-requests: + properties: + created_by: + type: array + description: | + Filters for directories created by any of the provided users. + example: + - DEVU-12345 + items: + type: string + format: id + modified_by: + type: array + description: | + Filters for directories modified by any of the provided users. + example: + - DEVU-12345 + items: + type: string + format: id + title: directories-count-request + directories-count-response: type: object - additionalProperties: false - title: error-too-many-requests-too-many-requests - error-too-many-requests-type: - type: string - enum: - - too_many_requests - error-unauthorized: - allOf: - - $ref: '#/components/schemas/error-base' - - type: object - discriminator: - mapping: - unauthenticated: '#/components/schemas/error-unauthorized-unauthenticated' - propertyName: type - oneOf: - - $ref: '#/components/schemas/error-unauthorized-unauthenticated' - properties: - type: - $ref: '#/components/schemas/error-unauthorized-type' - required: - - type - title: error-unauthorized - error-unauthorized-type: - type: string - enum: - - unauthenticated - error-unauthorized-unauthenticated: + properties: + count: + type: integer + description: The total number of directories matching the filter. + format: int32 + required: + - count + title: directories-count-response + x-go-name: DirectoriesCountResponseBody + directories-create-request: type: object - additionalProperties: false - title: error-unauthorized-unauthenticated - event-account-created: + description: The request to create a directory. + properties: + description: + type: string + description: Description for the directory. + format: text + icon: + type: string + description: Icon for the directory. + format: text + language: + type: string + description: Language of the directory. + format: text + parent: + type: string + description: Parent directory of the directory. + format: id + published: + type: boolean + description: Whether the directory is published. + tags: + type: array + description: Tags associated with the directory. + items: + $ref: '#/components/schemas/set-tag-with-value' + thumbnail: + type: string + description: ID of the thumbnail artifact. + example: ARTIFACT-12345 + format: id + title: + type: string + description: Title of the directory. + format: text + required: + - title + title: directories-create-request + directories-create-response: type: object + description: Create directory response. properties: - account: - $ref: '#/components/schemas/account' + directory: + $ref: '#/components/schemas/directory' required: - - account - title: event-account-created - event-account-deleted: + - directory + title: directories-create-response + x-go-name: DirectoriesCreateResponseBody + directories-delete-request: type: object + description: The request to delete a directory. properties: id: type: string - description: The ID of the account that was deleted. - example: ACC-12345 + description: The ID of the directory to delete. format: id - old_account: - $ref: '#/components/schemas/account' required: - id - title: event-account-deleted - event-account-updated: + title: directories-delete-request + directories-delete-response: type: object - properties: - account: - $ref: '#/components/schemas/account' - old_account: - $ref: '#/components/schemas/account' - required: - - account - title: event-account-updated - event-ai-agent-response: + additionalProperties: false + title: directories-delete-response + x-go-name: DirectoriesDeleteResponseBody + directories-get-request: type: object + description: The request to get a directory. properties: - agent: + dev_org: type: string - description: The ID of the AI agent that consumed the event. + description: Optional Dev Org ID for the unauthenticated user. + example: DEV-AbCdEfGh format: id - agent_response: + id: type: string - enum: - - error - - message - - message_generation_started - - progress - client_metadata: - type: object + description: The ID of the requested directory. + format: id + required: + - id + title: directories-get-request + directories-get-response: + type: object + description: Get directory response. + properties: + directory: + $ref: '#/components/schemas/directory' + required: + - directory + title: directories-get-response + x-go-name: DirectoriesGetResponseBody + directories-list-request: + type: object + description: The request to list directories. + properties: + created_by: + type: array description: | - The metadata given by client to be passed to the event source. - error: - $ref: '#/components/schemas/ai-agent-event-execute-error' - message: + Filters for directories created by any of the provided users. + example: + - DEVU-12345 + items: + type: string + format: id + cursor: type: string description: | - The final response of asynchronous agent events execution. + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. format: text - message_generation_started: - $ref: '#/components/schemas/ai-agent-message-generation-started' - progress: - $ref: '#/components/schemas/ai-agent-event-execute-progress' - session: + dev_org: type: string - description: | - The agent session ID to track the asynchronous execution of this - session. + description: Optional Dev Org ID for the unauthenticated user. + example: DEV-AbCdEfGh format: id - session_object: - type: string - description: An identifier of the session with the AI agent. - format: text - required: - - agent - - session - - session_object - title: event-ai-agent-response - x-go-name: EventAiAgentResponseBody - event-conversation-created: + limit: + type: integer + description: | + The maximum number of directories to return. The default is '50'. + format: int32 + mode: + $ref: '#/components/schemas/list-mode' + modified_by: + type: array + description: | + Filters for directories modified by any of the provided users. + example: + - DEVU-12345 + items: + type: string + format: id + title: directories-list-request + directories-list-response: type: object + description: List directory response. properties: - conversation: - $ref: '#/components/schemas/conversation' + directories: + type: array + description: The list of directories. + items: + $ref: '#/components/schemas/directory' + next_cursor: + type: string + description: | + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. + format: text + prev_cursor: + type: string + description: | + The cursor used to iterate preceding results in accordance to the + sort order. If not set, then no prior elements exist. + format: text required: - - conversation - title: event-conversation-created - event-conversation-deleted: + - directories + title: directories-list-response + x-go-name: DirectoriesListResponseBody + directories-update-request: type: object + description: The request to update a directory. properties: + description: + type: string + description: The updated description for the directory. + format: text + icon: + type: string + description: The updated icon for the directory. + format: text id: type: string - description: The ID of the conversation that was deleted. + description: The ID of the directory to update. format: id - old_conversation: - $ref: '#/components/schemas/conversation' + parent: + type: string + description: The updated parent directory for the directory. + format: id + nullable: true + published: + type: boolean + description: Whether the directory is published. + reorder: + $ref: '#/components/schemas/directories-update-request-reorder' + tags: + $ref: '#/components/schemas/directories-update-request-tags' + thumbnail: + type: string + description: The updated thumbnail for the directory. + example: ARTIFACT-12345 + format: id + nullable: true + title: + type: string + description: The updated title for the directory. + format: text required: - id - title: event-conversation-deleted - event-conversation-updated: - type: object - properties: - conversation: - $ref: '#/components/schemas/conversation' - old_conversation: - $ref: '#/components/schemas/conversation' - required: - - conversation - title: event-conversation-updated - event-dashboard-created: - type: object - properties: - dashboard: - $ref: '#/components/schemas/dashboard' - required: - - dashboard - title: event-dashboard-created - event-dashboard-deleted: + title: directories-update-request + directories-update-request-reorder: type: object properties: - id: + after: type: string - description: The ID of the dashboard that was deleted. + description: | + The directory after which the reordered directory is placed. format: id - old_dashboard: - $ref: '#/components/schemas/dashboard' - required: - - id - title: event-dashboard-deleted - event-dashboard-updated: + before: + type: string + description: | + The directory before which the reordered directory is placed. + format: id + title: directories-update-request-reorder + directories-update-request-tags: type: object properties: - dashboard: - $ref: '#/components/schemas/dashboard' - old_dashboard: - $ref: '#/components/schemas/dashboard' - required: - - dashboard - title: event-dashboard-updated - event-dev-user-created: + set: + type: array + description: Sets the provided tags on the directory. + items: + $ref: '#/components/schemas/set-tag-with-value' + title: directories-update-request-tags + directories-update-response: type: object + description: Update directory response. properties: - dev_user: - $ref: '#/components/schemas/dev-user' + directory: + $ref: '#/components/schemas/directory' required: - - dev_user - title: event-dev-user-created - event-dev-user-deleted: + - directory + title: directories-update-response + x-go-name: DirectoriesUpdateResponseBody + directory: + allOf: + - $ref: '#/components/schemas/atom-base' + - type: object + properties: + body: + $ref: '#/components/schemas/artifact-summary' + description: + type: string + description: Description of the directory. + format: text + icon: + type: string + description: Icon of the directory. + format: text + parent: + $ref: '#/components/schemas/directory-summary' + published: + type: boolean + description: Whether the directory is published. + rank: + type: string + description: Rank of the directory. + format: text + tags: + type: array + description: Tags associated with the directory. + items: + $ref: '#/components/schemas/tag-with-value' + thumbnail: + $ref: '#/components/schemas/artifact-summary' + title: + type: string + description: Title of the directory. + format: text + title: directory + directory-summary: + allOf: + - $ref: '#/components/schemas/atom-base-summary' + title: directory-summary + dynamic-group-info: + type: object + additionalProperties: false + description: Information to define dynamic groups. + title: dynamic-group-info + empty: + type: object + additionalProperties: false + title: empty + enhancement: + allOf: + - $ref: '#/components/schemas/part-base' + - type: object + properties: + actual_close_date: + type: string + description: Actual close date for the object. + example: "2023-01-01T12:00:00.000Z" + format: date-time + actual_start_date: + type: string + description: Actual start date for the object. + example: "2023-01-01T12:00:00.000Z" + format: date-time + stage_v2: + $ref: '#/components/schemas/stage' + state_v2: + type: string + description: State of the object based upon the stage. + format: text + target_close_date: + type: string + description: Target close date for the object. + example: "2023-01-01T12:00:00.000Z" + format: date-time + target_start_date: + type: string + description: Target start date for the object. + example: "2023-01-01T12:00:00.000Z" + format: date-time + title: enhancement + enhancement-summary: + allOf: + - $ref: '#/components/schemas/part-base-summary' + title: enhancement-summary + enum-value: type: object + description: The properties of an enum value. properties: id: + type: integer + description: The unique ID of the enum value. + format: int64 + label: type: string - description: The ID of the Dev user that was deleted. - format: id - old_dev_user: - $ref: '#/components/schemas/dev-user' + description: The display label of the enum value. + format: text + ordinal: + type: integer + description: | + Used for determining the relative order of the enum value. + format: int64 + value: + description: The actual value of the enum value. required: - id - title: event-dev-user-deleted - event-dev-user-updated: - type: object - properties: - dev_user: - $ref: '#/components/schemas/dev-user' - old_dev_user: - $ref: '#/components/schemas/dev-user' - required: - - dev_user - title: event-dev-user-updated - event-fetched-result: - type: string - enum: - - forbidden - - not_found - - ok - event-group-created: - type: object - properties: - group: - $ref: '#/components/schemas/group' - required: - - group - title: event-group-created - event-group-deleted: + - label + - ordinal + title: enum-value + enum-value-summary: type: object + description: The properties of an enum value. properties: id: + type: integer + description: The unique ID of the enum value. + format: int64 + label: type: string - description: The ID of the group that was deleted. - format: id - old_group: - $ref: '#/components/schemas/group' + description: The display label of the enum value. + format: text + ordinal: + type: integer + description: | + Used for determining the relative order of the enum value. + format: int64 required: - id - title: event-group-deleted - event-group-member-added: - type: object - properties: - group: - $ref: '#/components/schemas/group-summary' - member: - $ref: '#/components/schemas/user-summary' - required: - - group - - member - title: event-group-member-added - event-group-member-removed: - type: object - properties: - group: - $ref: '#/components/schemas/group-summary' - member: - $ref: '#/components/schemas/user-summary' - required: - - group - - member - title: event-group-member-removed - event-group-updated: - type: object - properties: - group: - $ref: '#/components/schemas/group' - old_group: - $ref: '#/components/schemas/group' - required: - - group - title: event-group-updated - event-incident-created: + - label + - ordinal + title: enum-value-summary + error: type: object properties: - incident: - $ref: '#/components/schemas/incident' + type: + type: string + description: The error type. + format: text + message: + type: string + description: Information about the error. + format: text + status: + type: integer + description: The corresponding HTTP status code. + format: int32 required: - - incident - title: event-incident-created - event-incident-deleted: + - message + - status + title: error + error-bad-request: + allOf: + - $ref: '#/components/schemas/error-base' + - type: object + discriminator: + mapping: + artifact_already_attached_to_a_parent: '#/components/schemas/error-bad-request-artifact-already-attached-to-a-parent' + bad_request: '#/components/schemas/error-bad-request-bad-request' + customization_validation_error: '#/components/schemas/error-bad-request-customization-validation-error' + invalid_api_version: '#/components/schemas/error-bad-request-invalid-api-version' + invalid_enum_value: '#/components/schemas/error-bad-request-invalid-enum-value' + invalid_field: '#/components/schemas/error-bad-request-invalid-field' + invalid_id: '#/components/schemas/error-bad-request-invalid-id' + merge_works_error: '#/components/schemas/error-bad-request-merge-works-error' + missing_dependency: '#/components/schemas/error-bad-request-missing-dependency' + missing_required_field: '#/components/schemas/error-bad-request-missing-required-field' + parse_error: '#/components/schemas/error-bad-request-parse-error' + stale_schema_fragments: '#/components/schemas/error-bad-request-stale-schema-fragments' + unexpected_id_type: '#/components/schemas/error-bad-request-unexpected-id-type' + unexpected_json_type: '#/components/schemas/error-bad-request-unexpected-json-type' + value_not_permitted: '#/components/schemas/error-bad-request-value-not-permitted' + workflow_component_validation_errors: '#/components/schemas/error-bad-request-workflow-component-validation-errors' + propertyName: type + oneOf: + - $ref: '#/components/schemas/error-bad-request-artifact-already-attached-to-a-parent' + - $ref: '#/components/schemas/error-bad-request-bad-request' + - $ref: '#/components/schemas/error-bad-request-customization-validation-error' + - $ref: '#/components/schemas/error-bad-request-invalid-api-version' + - $ref: '#/components/schemas/error-bad-request-invalid-enum-value' + - $ref: '#/components/schemas/error-bad-request-invalid-field' + - $ref: '#/components/schemas/error-bad-request-invalid-id' + - $ref: '#/components/schemas/error-bad-request-merge-works-error' + - $ref: '#/components/schemas/error-bad-request-missing-dependency' + - $ref: '#/components/schemas/error-bad-request-missing-required-field' + - $ref: '#/components/schemas/error-bad-request-parse-error' + - $ref: '#/components/schemas/error-bad-request-stale-schema-fragments' + - $ref: '#/components/schemas/error-bad-request-unexpected-id-type' + - $ref: '#/components/schemas/error-bad-request-unexpected-json-type' + - $ref: '#/components/schemas/error-bad-request-value-not-permitted' + - $ref: '#/components/schemas/error-bad-request-workflow-component-validation-errors' + properties: + type: + $ref: '#/components/schemas/error-bad-request-type' + required: + - type + description: Describes a error due to a bad request by the client. + title: error-bad-request + error-bad-request-artifact-already-attached-to-a-parent: type: object properties: - id: + existing_parent: type: string - description: The ID of the incident that was deleted. + description: The existing parent attached to the artifact. format: id - old_incident: - $ref: '#/components/schemas/incident' - required: - - id - title: event-incident-deleted - event-incident-updated: - type: object - properties: - incident: - $ref: '#/components/schemas/incident' - old_incident: - $ref: '#/components/schemas/incident' + is_same: + type: boolean + description: | + Whether the existing parent is the same as the new parent. required: - - incident - title: event-incident-updated - event-link-created: + - existing_parent + - is_same + title: error-bad-request-artifact-already-attached-to-a-parent + error-bad-request-bad-request: type: object - properties: - link: - $ref: '#/components/schemas/link' - required: - - link - title: event-link-created - event-link-deleted: + additionalProperties: false + title: error-bad-request-bad-request + error-bad-request-customization-validation-error: type: object + description: | + Describes an error encountered during customization validation. + discriminator: + mapping: + bad_id_type: '#/components/schemas/error-bad-request-customization-validation-error-bad-id-type' + date_parse_error: '#/components/schemas/error-bad-request-customization-validation-error-date-parse-error' + enum_out_of_range: '#/components/schemas/error-bad-request-customization-validation-error-enum-out-of-range' + expression_parse_error: '#/components/schemas/error-bad-request-customization-validation-error-expression-parse-error' + field_dropped: '#/components/schemas/error-bad-request-customization-validation-error-field-dropped' + field_immutable: '#/components/schemas/error-bad-request-customization-validation-error-field-immutable' + field_not_in_schema: '#/components/schemas/error-bad-request-customization-validation-error-field-not-in-schema' + field_required: '#/components/schemas/error-bad-request-customization-validation-error-field-required' + fragment_not_found: '#/components/schemas/error-bad-request-customization-validation-error-fragment-not-found' + id_parse_error: '#/components/schemas/error-bad-request-customization-validation-error-id-parse-error' + id_type_not_allowed: '#/components/schemas/error-bad-request-customization-validation-error-id-type-not-allowed' + invalid_argument: '#/components/schemas/error-bad-request-customization-validation-error-invalid-argument' + timestamp_parse_error: '#/components/schemas/error-bad-request-customization-validation-error-timestamp-parse-error' + unknown_error: '#/components/schemas/error-bad-request-customization-validation-error-unknown-error' + unsupported_type: '#/components/schemas/error-bad-request-customization-validation-error-unsupported-type' + wrong_type: '#/components/schemas/error-bad-request-customization-validation-error-wrong-type' + propertyName: subtype + oneOf: + - $ref: '#/components/schemas/error-bad-request-customization-validation-error-bad-id-type' + - $ref: '#/components/schemas/error-bad-request-customization-validation-error-date-parse-error' + - $ref: '#/components/schemas/error-bad-request-customization-validation-error-enum-out-of-range' + - $ref: '#/components/schemas/error-bad-request-customization-validation-error-expression-parse-error' + - $ref: '#/components/schemas/error-bad-request-customization-validation-error-field-dropped' + - $ref: '#/components/schemas/error-bad-request-customization-validation-error-field-immutable' + - $ref: '#/components/schemas/error-bad-request-customization-validation-error-field-not-in-schema' + - $ref: '#/components/schemas/error-bad-request-customization-validation-error-field-required' + - $ref: '#/components/schemas/error-bad-request-customization-validation-error-fragment-not-found' + - $ref: '#/components/schemas/error-bad-request-customization-validation-error-id-parse-error' + - $ref: '#/components/schemas/error-bad-request-customization-validation-error-id-type-not-allowed' + - $ref: '#/components/schemas/error-bad-request-customization-validation-error-invalid-argument' + - $ref: '#/components/schemas/error-bad-request-customization-validation-error-timestamp-parse-error' + - $ref: '#/components/schemas/error-bad-request-customization-validation-error-unknown-error' + - $ref: '#/components/schemas/error-bad-request-customization-validation-error-unsupported-type' + - $ref: '#/components/schemas/error-bad-request-customization-validation-error-wrong-type' properties: - id: + field_name: type: string - description: The ID of the link that was deleted. - format: id + description: The name of the invalid field. + format: text + reason: + type: string + description: The reason given for the error. + format: text + subtype: + $ref: '#/components/schemas/error-bad-request-customization-validation-error-subtype' required: - - id - title: event-link-deleted - event-link-updated: + - subtype + title: error-bad-request-customization-validation-error + error-bad-request-customization-validation-error-bad-id-type: type: object - properties: - link: - $ref: '#/components/schemas/link' - old_link: - $ref: '#/components/schemas/link' - required: - - link - title: event-link-updated - event-part-created: + additionalProperties: false + title: error-bad-request-customization-validation-error-bad-id-type + error-bad-request-customization-validation-error-date-parse-error: type: object - properties: - part: - $ref: '#/components/schemas/part' - required: - - part - title: event-part-created - event-part-deleted: + additionalProperties: false + title: error-bad-request-customization-validation-error-date-parse-error + error-bad-request-customization-validation-error-enum-out-of-range: + type: object + additionalProperties: false + title: error-bad-request-customization-validation-error-enum-out-of-range + error-bad-request-customization-validation-error-expression-parse-error: + type: object + additionalProperties: false + title: error-bad-request-customization-validation-error-expression-parse-error + error-bad-request-customization-validation-error-field-dropped: + type: object + additionalProperties: false + title: error-bad-request-customization-validation-error-field-dropped + error-bad-request-customization-validation-error-field-immutable: + type: object + additionalProperties: false + title: error-bad-request-customization-validation-error-field-immutable + error-bad-request-customization-validation-error-field-not-in-schema: + type: object + additionalProperties: false + title: error-bad-request-customization-validation-error-field-not-in-schema + error-bad-request-customization-validation-error-field-required: + type: object + additionalProperties: false + title: error-bad-request-customization-validation-error-field-required + error-bad-request-customization-validation-error-fragment-not-found: + type: object + additionalProperties: false + title: error-bad-request-customization-validation-error-fragment-not-found + error-bad-request-customization-validation-error-id-parse-error: + type: object + additionalProperties: false + title: error-bad-request-customization-validation-error-id-parse-error + error-bad-request-customization-validation-error-id-type-not-allowed: + type: object + additionalProperties: false + title: error-bad-request-customization-validation-error-id-type-not-allowed + error-bad-request-customization-validation-error-invalid-argument: + type: object + additionalProperties: false + title: error-bad-request-customization-validation-error-invalid-argument + error-bad-request-customization-validation-error-subtype: + type: string + enum: + - bad_id_type + - date_parse_error + - enum_out_of_range + - expression_parse_error + - field_dropped + - field_immutable + - field_not_in_schema + - field_required + - fragment_not_found + - id_parse_error + - id_type_not_allowed + - invalid_argument + - timestamp_parse_error + - unknown_error + - unsupported_type + - wrong_type + error-bad-request-customization-validation-error-timestamp-parse-error: + type: object + additionalProperties: false + title: error-bad-request-customization-validation-error-timestamp-parse-error + error-bad-request-customization-validation-error-unknown-error: + type: object + additionalProperties: false + title: error-bad-request-customization-validation-error-unknown-error + error-bad-request-customization-validation-error-unsupported-type: + type: object + additionalProperties: false + title: error-bad-request-customization-validation-error-unsupported-type + error-bad-request-customization-validation-error-wrong-type: + type: object + additionalProperties: false + title: error-bad-request-customization-validation-error-wrong-type + error-bad-request-invalid-api-version: type: object properties: - id: + value: type: string - description: The ID of the part that was deleted. - example: PROD-12345 - format: id - old_part: - $ref: '#/components/schemas/part' + description: The provided API version. + format: text required: - - id - title: event-part-deleted - event-part-updated: + - value + title: error-bad-request-invalid-api-version + error-bad-request-invalid-enum-value: type: object properties: - old_part: - $ref: '#/components/schemas/part' - part: - $ref: '#/components/schemas/part' + allowed_values: + type: array + description: The allowed values for the field. + items: + type: string + format: text + field_name: + type: string + description: The field whose enum value is invalid. + format: text + value: + type: string + description: The value that was received. + format: text required: - - part - title: event-part-updated - event-question-answer-created: + - allowed_values + - field_name + - value + title: error-bad-request-invalid-enum-value + error-bad-request-invalid-field: type: object properties: - question_answer: - $ref: '#/components/schemas/question-answer' + field_name: + type: string + description: The field name that's invalid. + format: text required: - - question_answer - title: event-question-answer-created - event-question-answer-deleted: + - field_name + title: error-bad-request-invalid-field + error-bad-request-invalid-id: type: object properties: - id: + field_name: type: string - description: The ID of the question-answer that was deleted. - format: id - old_question_answer: - $ref: '#/components/schemas/question-answer' + description: The field whose ID is invalid. + format: text required: - - id - title: event-question-answer-deleted - event-question-answer-updated: + - field_name + title: error-bad-request-invalid-id + error-bad-request-merge-works-error: type: object properties: - old_question_answer: - $ref: '#/components/schemas/question-answer' - question_answer: - $ref: '#/components/schemas/question-answer' - required: - - question_answer - title: event-question-answer-updated - event-rev-org-created: + errors: + type: array + description: | + The errors encountered during the validation of the merge. + items: + $ref: '#/components/schemas/error-bad-request-merge-works-error-error' + title: error-bad-request-merge-works-error + error-bad-request-merge-works-error-error: type: object properties: - rev_org: - $ref: '#/components/schemas/rev-org' + already_merged: + $ref: '#/components/schemas/error-bad-request-merge-works-error-error-already-merged' + closed: + $ref: '#/components/schemas/error-bad-request-merge-works-error-error-closed' + details: + type: string + description: The details of the error. + format: text + different_reporters: + $ref: '#/components/schemas/error-bad-request-merge-works-error-error-different-reporters' + different_workspace: + $ref: '#/components/schemas/error-bad-request-merge-works-error-error-different-workspace' + invalid_stage_transition: + $ref: '#/components/schemas/error-bad-request-merge-works-error-error-invalid-stage-transition' + locked: + $ref: '#/components/schemas/error-bad-request-merge-works-error-error-locked' + stage_not_found_for_subtype: + $ref: '#/components/schemas/error-bad-request-merge-works-error-error-stage-not-found-for-subtype' + subtype: + type: string + enum: + - already_merged + - closed + - different_reporters + - different_workspace + - invalid_stage_transition + - locked + - stage_not_found_for_subtype + work: + type: string + description: The ID of the work which failed the validation. + format: id required: - - rev_org - title: event-rev-org-created - event-rev-org-deleted: + - details + - work + title: error-bad-request-merge-works-error-error + error-bad-request-merge-works-error-error-already-merged: type: object properties: - id: + merged_into: type: string - description: The ID of the Rev organization that was deleted. - example: REV-AbCdEfGh + description: ID of the work into which the work was merged. format: id - old_rev_org: - $ref: '#/components/schemas/rev-org' required: - - id - title: event-rev-org-deleted - event-rev-org-updated: + - merged_into + title: error-bad-request-merge-works-error-error-already-merged + error-bad-request-merge-works-error-error-closed: type: object - properties: - old_rev_org: - $ref: '#/components/schemas/rev-org' - rev_org: - $ref: '#/components/schemas/rev-org' - required: - - rev_org - title: event-rev-org-updated - event-rev-user-created: + additionalProperties: false + title: error-bad-request-merge-works-error-error-closed + error-bad-request-merge-works-error-error-different-reporters: type: object properties: - rev_user: - $ref: '#/components/schemas/rev-user' - required: - - rev_user - title: event-rev-user-created - event-rev-user-deleted: + primary_reporters: + type: array + description: The reporters of the primary work. + items: + type: string + format: id + secondary_reporters: + type: array + description: The reporters of the secondary work. + items: + type: string + format: id + title: error-bad-request-merge-works-error-error-different-reporters + error-bad-request-merge-works-error-error-different-workspace: type: object properties: - id: + primary_workspace: type: string - description: The ID of the Rev user that was deleted. + description: The workspace of the primary work. format: id - old_rev_user: - $ref: '#/components/schemas/rev-user' - required: - - id - title: event-rev-user-deleted - event-rev-user-updated: - type: object - properties: - old_rev_user: - $ref: '#/components/schemas/rev-user' - rev_user: - $ref: '#/components/schemas/rev-user' - required: - - rev_user - title: event-rev-user-updated - event-sla-tracker-created: - type: object - properties: - sla_tracker: - $ref: '#/components/schemas/sla-tracker' - required: - - sla_tracker - title: event-sla-tracker-created - event-sla-tracker-deleted: - type: object - properties: - id: + secondary_workspace: type: string - description: The ID of the SLA tracker that was deleted. + description: The workspace of the secondary work. format: id - old_sla_tracker: - $ref: '#/components/schemas/sla-tracker' - required: - - id - title: event-sla-tracker-deleted - event-sla-tracker-fetched: + title: error-bad-request-merge-works-error-error-different-workspace + error-bad-request-merge-works-error-error-invalid-stage-transition: type: object - discriminator: - mapping: - forbidden: '#/components/schemas/empty' - not_found: '#/components/schemas/empty' - ok: '#/components/schemas/event-sla-tracker-fetched-ok' - propertyName: result - oneOf: - - $ref: '#/components/schemas/empty' - - $ref: '#/components/schemas/event-sla-tracker-fetched-ok' properties: - id: + current_stage: type: string - description: The ID of the SLA tracker that was fetched. + description: The current stage of the work. + format: id + requested_stage: + type: string + description: The stage to which the transition isn't allowed. format: id - result: - $ref: '#/components/schemas/event-fetched-result' - required: - - id - - result - title: event-sla-tracker-fetched - event-sla-tracker-fetched-ok: - type: object - properties: - sla_tracker: - $ref: '#/components/schemas/sla-tracker' - title: event-sla-tracker-fetched-ok - event-sla-tracker-updated: - type: object - properties: - old_sla_tracker: - $ref: '#/components/schemas/sla-tracker' - sla_tracker: - $ref: '#/components/schemas/sla-tracker' required: - - sla_tracker - title: event-sla-tracker-updated - event-survey-created: + - current_stage + - requested_stage + title: error-bad-request-merge-works-error-error-invalid-stage-transition + error-bad-request-merge-works-error-error-locked: type: object - properties: - survey: - $ref: '#/components/schemas/survey' - required: - - survey - title: event-survey-created - event-survey-deleted: + additionalProperties: false + title: error-bad-request-merge-works-error-error-locked + error-bad-request-merge-works-error-error-stage-not-found-for-subtype: type: object properties: - id: + subtype: type: string - description: The ID of the survey that was deleted. - format: id - old_survey: - $ref: '#/components/schemas/survey' - required: - - id - title: event-survey-deleted - event-survey-response-created: + description: | + The subtype of the work for which stage is not configured. + format: text + title: error-bad-request-merge-works-error-error-stage-not-found-for-subtype + error-bad-request-missing-dependency: type: object properties: - survey_response: - $ref: '#/components/schemas/survey-response' - required: - - survey_response - title: event-survey-response-created - event-survey-response-deleted: + dependencies: + type: array + description: The dependent fields. + items: + $ref: '#/components/schemas/error-bad-request-missing-dependency-dependency' + dependent_field_name: + type: string + description: The field on which the value depends. + format: text + dependent_field_value: + type: string + description: The value which needs to be set of the dependent field. + format: text + provided_field_name: + type: string + description: The field whose value was received. + format: text + provided_field_value: + type: string + description: The value that was received. + format: text + title: error-bad-request-missing-dependency + error-bad-request-missing-dependency-dependency: type: object properties: - id: + field_name: type: string - description: The ID of the survey response that was deleted. - format: id - old_survey_response: - $ref: '#/components/schemas/survey-response' + description: The dependent field name. + format: text + field_value: + type: string + description: The dependent field value. + format: text required: - - id - title: event-survey-response-deleted - event-survey-response-updated: + - field_name + - field_value + title: error-bad-request-missing-dependency-dependency + error-bad-request-missing-required-field: type: object properties: - old_survey_response: - $ref: '#/components/schemas/survey-response' - survey_response: - $ref: '#/components/schemas/survey-response' + field_name: + type: string + description: The missing field's name. + format: text required: - - survey_response - title: event-survey-response-updated - event-survey-updated: + - field_name + title: error-bad-request-missing-required-field + error-bad-request-parse-error: type: object - properties: - old_survey: - $ref: '#/components/schemas/survey' - survey: - $ref: '#/components/schemas/survey' - required: - - survey - title: event-survey-updated - event-sync-history-created: + additionalProperties: false + title: error-bad-request-parse-error + error-bad-request-stale-schema-fragments: type: object - properties: - sync_history: - $ref: '#/components/schemas/sync-history' - required: - - sync_history - title: event-sync-history-created - event-sync-history-deleted: + additionalProperties: false + description: | + Error indicating that the request contained one or more stale schema + fragments, which are schema fragments that have been replaced by a + newer version and are therefore considered deprecated schema fragments. + The caller should refresh and use the latest schema fragments in their + request. + title: error-bad-request-stale-schema-fragments + error-bad-request-type: + type: string + enum: + - artifact_already_attached_to_a_parent + - bad_request + - customization_validation_error + - invalid_api_version + - invalid_enum_value + - invalid_field + - invalid_id + - merge_works_error + - missing_dependency + - missing_required_field + - parse_error + - stale_schema_fragments + - unexpected_id_type + - unexpected_json_type + - value_not_permitted + - workflow_component_validation_errors + error-bad-request-unexpected-id-type: type: object properties: - id: + field_name: type: string - description: The ID of the sync history that was deleted. - format: id + description: The field whose ID type is unexpected. + format: text required: - - id - title: event-sync-history-deleted - event-sync-history-updated: + - field_name + title: error-bad-request-unexpected-id-type + error-bad-request-unexpected-json-type: type: object properties: - old_sync_history: - $ref: '#/components/schemas/sync-history' - sync_history: - $ref: '#/components/schemas/sync-history' + actual: + $ref: '#/components/schemas/error-bad-request-unexpected-json-type-type' + expected: + $ref: '#/components/schemas/error-bad-request-unexpected-json-type-type' + field_name: + type: string + description: The field name that's invalid. + format: text required: - - sync_history - title: event-sync-history-updated - event-tag-created: + - actual + - expected + - field_name + title: error-bad-request-unexpected-json-type + error-bad-request-unexpected-json-type-type: + type: string + enum: + - array + - bool + - "null" + - number + - object + - string + error-bad-request-value-not-permitted: type: object properties: - tag: - $ref: '#/components/schemas/tag' - required: - - tag - title: event-tag-created - event-tag-deleted: - type: object - properties: - id: - type: string - description: The ID of the tag that was deleted. - example: TAG-12345 - format: id - old_tag: - $ref: '#/components/schemas/tag' - required: - - id - title: event-tag-deleted - event-tag-updated: - type: object - properties: - old_tag: - $ref: '#/components/schemas/tag' - tag: - $ref: '#/components/schemas/tag' - required: - - tag - title: event-tag-updated - event-timeline-entry-created: - type: object - properties: - entry: - $ref: '#/components/schemas/timeline-entry' - required: - - entry - title: event-timeline-entry-created - event-timeline-entry-deleted: - type: object - properties: - id: - type: string - description: The ID of the timeline entry that was deleted. - example: don:core:dvrv-us-1:devo/example:ticket/123:comment/comment-id - format: id - old_entry: - $ref: '#/components/schemas/timeline-entry' - required: - - id - title: event-timeline-entry-deleted - event-timeline-entry-updated: - type: object - properties: - entry: - $ref: '#/components/schemas/timeline-entry' - old_entry: - $ref: '#/components/schemas/timeline-entry' - reactions: + allowed_values: type: array - description: The reactions that were performed. + description: The allowed values for the field. items: - $ref: '#/components/schemas/event-timeline-entry-updated-reaction' - maxItems: 16 - required: - - entry - title: event-timeline-entry-updated - event-timeline-entry-updated-reaction: - type: object - properties: - action: - $ref: '#/components/schemas/event-timeline-entry-updated-reaction-action' - emoji: + type: string + format: text + field_name: type: string - description: The emoji for the reaction. + description: The field whose value is not permitted. + format: text + reason: + type: string + description: The reason the value isn't permitted. format: text - reactor: - $ref: '#/components/schemas/user-summary' required: - - action - - emoji - title: event-timeline-entry-updated-reaction - event-timeline-entry-updated-reaction-action: - type: string - enum: - - added - - removed - event-webhook-created: + - field_name + title: error-bad-request-value-not-permitted + error-bad-request-workflow-component-validation-error: type: object + description: | + Error indicating that one or more workflow components failed + validation. properties: - webhook: - $ref: '#/components/schemas/webhook' + code: + type: string + description: Error code uniquely identifying the validation issue. + format: text + maxLength: 16 + field: + $ref: '#/components/schemas/error-bad-request-workflow-component-validation-error-field' + location: + $ref: '#/components/schemas/error-bad-request-workflow-component-validation-error-workflow-component-validation-location-type' + message: + type: string + description: Human-readable message describing the issue. + format: text + maxLength: 512 + operation: + $ref: '#/components/schemas/error-bad-request-workflow-component-validation-error-operation' + workflow: + $ref: '#/components/schemas/error-bad-request-workflow-component-validation-error-workflow' + workflow_step: + $ref: '#/components/schemas/error-bad-request-workflow-component-validation-error-workflow-step' required: - - webhook - title: event-webhook-created - event-webhook-deleted: + - code + - message + title: error-bad-request-workflow-component-validation-error + error-bad-request-workflow-component-validation-error-field: type: object + description: Represents a field with a violation. properties: - id: + field_path: type: string - description: The ID of the webhook that was deleted. - example: don:integration:dvrv-us-1:devo/example:webhook/webhook-id + description: Path to the field with dot notation. + format: text + parent_id: + type: string + description: The parent object containing the field. format: id required: - - id - title: event-webhook-deleted - event-webhook-updated: - type: object - properties: - webhook: - $ref: '#/components/schemas/webhook' - required: - - webhook - title: event-webhook-updated - event-widget-created: - type: object - properties: - widget: - $ref: '#/components/schemas/widget' - required: - - widget - title: event-widget-created - event-widget-deleted: + - field_path + - parent_id + title: error-bad-request-workflow-component-validation-error-field + error-bad-request-workflow-component-validation-error-operation: type: object + description: Represents an operation with a violation. properties: id: type: string - description: The ID of the widget that was deleted. + description: The ID of the operation with the error. format: id - old_widget: - $ref: '#/components/schemas/widget' required: - id - title: event-widget-deleted - event-widget-updated: - type: object - properties: - old_widget: - $ref: '#/components/schemas/widget' - widget: - $ref: '#/components/schemas/widget' - required: - - widget - title: event-widget-updated - event-work-created: - type: object - properties: - work: - $ref: '#/components/schemas/work' - required: - - work - title: event-work-created - event-work-deleted: + title: error-bad-request-workflow-component-validation-error-operation + error-bad-request-workflow-component-validation-error-workflow: type: object + description: Represents a workflow with a violation. properties: id: type: string - description: The ID of the work that was deleted. - example: ISS-12345 + description: The ID of the workflow with the error. format: id - old_work: - $ref: '#/components/schemas/work' required: - id - title: event-work-deleted - event-work-fetched: + title: error-bad-request-workflow-component-validation-error-workflow + error-bad-request-workflow-component-validation-error-workflow-component-validation-location-type: + type: string + enum: + - field + - operation + - workflow + - workflow_step + error-bad-request-workflow-component-validation-error-workflow-step: type: object - discriminator: - mapping: - forbidden: '#/components/schemas/empty' - not_found: '#/components/schemas/empty' - ok: '#/components/schemas/event-work-fetched-ok' - propertyName: result - oneOf: - - $ref: '#/components/schemas/empty' - - $ref: '#/components/schemas/event-work-fetched-ok' + description: Represents a workflow step with a violation. properties: id: type: string - description: The ID of the work that was fetched. - example: ISS-12345 + description: The ID of the workflow step with the error. format: id - result: - $ref: '#/components/schemas/event-fetched-result' required: - id - - result - title: event-work-fetched - event-work-fetched-ok: - type: object - properties: - work: - $ref: '#/components/schemas/work' - title: event-work-fetched-ok - event-work-updated: + title: error-bad-request-workflow-component-validation-error-workflow-step + error-bad-request-workflow-component-validation-errors: type: object properties: - old_work: - $ref: '#/components/schemas/work' - work: - $ref: '#/components/schemas/work' - required: - - work - title: event-work-updated - external-communication-channel-summary: - allOf: - - $ref: '#/components/schemas/atom-base-summary' - title: external-communication-channel-summary - external-identity: + errors: + type: array + description: Nested validation errors. + items: + $ref: '#/components/schemas/error-bad-request-workflow-component-validation-error' + title: error-bad-request-workflow-component-validation-errors + error-base: type: object - description: External identity of a user. properties: - display_name: + detail: type: string - description: Display name of the user in the external source. + description: Error detail information. format: text - id: + message: type: string - description: Unique ID of the user in the external source. + description: The message associated with the error. format: text - is_verified: - type: boolean - description: Whether the external identity is verified or not. - issuer: - type: string - description: Issuer of the external identity of the user. - format: text - title: external-identity - feature: + title: error-base + error-conflict: allOf: - - $ref: '#/components/schemas/part-base' - title: feature - feature-summary: + - $ref: '#/components/schemas/error-base' + - type: object + discriminator: + mapping: + conflict: '#/components/schemas/error-conflict-conflict' + propertyName: type + oneOf: + - $ref: '#/components/schemas/error-conflict-conflict' + properties: + type: + $ref: '#/components/schemas/error-conflict-type' + required: + - type + title: error-conflict + error-conflict-conflict: + type: object + additionalProperties: false + title: error-conflict-conflict + error-conflict-type: + type: string + enum: + - conflict + error-forbidden: allOf: - - $ref: '#/components/schemas/part-base-summary' - title: feature-summary - group: + - $ref: '#/components/schemas/error-base' + - type: object + discriminator: + mapping: + forbidden: '#/components/schemas/error-forbidden-forbidden' + propertyName: type + oneOf: + - $ref: '#/components/schemas/error-forbidden-forbidden' + properties: + type: + $ref: '#/components/schemas/error-forbidden-type' + required: + - type + title: error-forbidden + error-forbidden-forbidden: + type: object + additionalProperties: false + title: error-forbidden-forbidden + error-forbidden-type: + type: string + enum: + - forbidden + error-internal-server-error: allOf: - - $ref: '#/components/schemas/atom-base' - title: group - group-ingestion-source: + - $ref: '#/components/schemas/error-base' + - type: object + discriminator: + mapping: + internal_error: '#/components/schemas/error-internal-server-error-internal-error' + propertyName: type + oneOf: + - $ref: '#/components/schemas/error-internal-server-error-internal-error' + properties: + type: + $ref: '#/components/schemas/error-internal-server-error-type' + reference_id: + type: string + description: | + A unique ID that's generated for the error that can be used for + inquiry. + format: text + required: + - type + title: error-internal-server-error + error-internal-server-error-internal-error: + type: object + additionalProperties: false + title: error-internal-server-error-internal-error + error-internal-server-error-type: type: string - description: Creation source of the group. enum: - - airdrop - - scim - group-member-type: + - internal_error + error-not-found: + allOf: + - $ref: '#/components/schemas/error-base' + - type: object + discriminator: + mapping: + not_found: '#/components/schemas/error-not-found-not-found' + propertyName: type + oneOf: + - $ref: '#/components/schemas/error-not-found-not-found' + properties: + type: + $ref: '#/components/schemas/error-not-found-type' + required: + - type + title: error-not-found + error-not-found-not-found: + type: object + additionalProperties: false + title: error-not-found-not-found + error-not-found-type: type: string - description: Type of the members in the group. enum: - - dev_user - - rev_user - group-members-add-request: + - not_found + error-service-unavailable: + allOf: + - $ref: '#/components/schemas/error-base' + - type: object + discriminator: + mapping: + service_unavailable: '#/components/schemas/error-service-unavailable-service-unavailable' + propertyName: type + oneOf: + - $ref: '#/components/schemas/error-service-unavailable-service-unavailable' + properties: + type: + $ref: '#/components/schemas/error-service-unavailable-type' + required: + - type + title: error-service-unavailable + error-service-unavailable-service-unavailable: + type: object + additionalProperties: false + title: error-service-unavailable-service-unavailable + error-service-unavailable-type: + type: string + enum: + - service_unavailable + error-too-many-requests: + allOf: + - $ref: '#/components/schemas/error-base' + - type: object + discriminator: + mapping: + too_many_requests: '#/components/schemas/error-too-many-requests-too-many-requests' + propertyName: type + oneOf: + - $ref: '#/components/schemas/error-too-many-requests-too-many-requests' + properties: + type: + $ref: '#/components/schemas/error-too-many-requests-type' + retry_after: + type: integer + description: | + The number of seconds after which the client should retry. + format: int64 + required: + - type + title: error-too-many-requests + error-too-many-requests-too-many-requests: + type: object + additionalProperties: false + title: error-too-many-requests-too-many-requests + error-too-many-requests-type: + type: string + enum: + - too_many_requests + error-unauthorized: + allOf: + - $ref: '#/components/schemas/error-base' + - type: object + discriminator: + mapping: + unauthenticated: '#/components/schemas/error-unauthorized-unauthenticated' + propertyName: type + oneOf: + - $ref: '#/components/schemas/error-unauthorized-unauthenticated' + properties: + type: + $ref: '#/components/schemas/error-unauthorized-type' + required: + - type + title: error-unauthorized + error-unauthorized-type: + type: string + enum: + - unauthenticated + error-unauthorized-unauthenticated: + type: object + additionalProperties: false + title: error-unauthorized-unauthenticated + event-account-created: type: object - description: A request to add a new member to a group. properties: - group: - type: string - description: ID of the group where the member is being added. - format: id - member: - type: string - description: ID of the member to be added. - example: DEVU-12345 - format: id - member_rev_org: + account: + $ref: '#/components/schemas/account' + required: + - account + title: event-account-created + event-account-deleted: + type: object + properties: + id: type: string - description: | - Rev org of the rev user to be added. This should be specified only - if the member is a rev user - example: REV-AbCdEfGh + description: The ID of the account that was deleted. + example: ACC-12345 format: id + old_account: + $ref: '#/components/schemas/account' required: - - group - - member - title: group-members-add-request - group-members-add-response: + - id + title: event-account-deleted + event-account-updated: type: object - additionalProperties: false - title: group-members-add-response - x-go-name: GroupMembersAddResponseBody - group-members-list-request: + properties: + account: + $ref: '#/components/schemas/account' + old_account: + $ref: '#/components/schemas/account' + required: + - account + title: event-account-updated + event-ai-agent-response: type: object - description: A request to list group members. properties: - cursor: - type: string - description: | - The cursor to resume iteration from. If not provided, then - iteration starts from the beginning. - format: text - group: + agent: type: string - description: ID of the group for which to list members. + description: The ID of the AI agent that consumed the event. format: id - limit: - type: integer + agent_response: + type: string + enum: + - error + - message + - message_generation_started + - progress + - suggestions + client_metadata: + type: object description: | - The maximum number of members to return. If not set, then the - default is '50'. - format: int32 - mode: - $ref: '#/components/schemas/list-mode' - required: - - group - title: group-members-list-request - group-members-list-response: - type: object - description: List of group members. - properties: - members: - type: array - description: List of members. - items: - $ref: '#/components/schemas/group-members-list-response-member' - next_cursor: + The metadata given by client to be passed to the event source. + error: + $ref: '#/components/schemas/ai-agent-event-execute-error' + message: type: string description: | - The cursor used to iterate subsequent results in accordance to the - sort order. If not set, then no later elements exist. + The final response of asynchronous agent events execution. format: text - prev_cursor: + message_generation_started: + $ref: '#/components/schemas/ai-agent-message-generation-started' + progress: + $ref: '#/components/schemas/ai-agent-event-execute-progress' + session: type: string description: | - The cursor used to iterate preceding results in accordance to the - sort order. If not set, then no prior elements exist. + The agent session ID to track the asynchronous execution of this + session. + format: id + session_object: + type: string + description: An identifier of the session with the AI agent. format: text + suggestions: + $ref: '#/components/schemas/ai-agent-event-suggestions' required: - - members - title: group-members-list-response - x-go-name: GroupMembersListResponseBody - group-members-list-response-member: + - agent + - session + - session_object + title: event-ai-agent-response + x-go-name: EventAiAgentResponseBody + event-conversation-created: type: object - description: A group member. properties: - member: - $ref: '#/components/schemas/member-summary' - member_rev_org: - $ref: '#/components/schemas/rev-org-summary' + conversation: + $ref: '#/components/schemas/conversation' required: - - member - title: group-members-list-response-member - group-members-remove-request: + - conversation + title: event-conversation-created + event-conversation-deleted: type: object - description: A request to remove a group member. properties: - group: - type: string - description: ID of the group where the member is being removed. - format: id - member: + id: type: string - description: ID of the member to be removed. - example: DEVU-12345 + description: The ID of the conversation that was deleted. format: id - member_rev_org: + old_conversation: + $ref: '#/components/schemas/conversation' + required: + - id + title: event-conversation-deleted + event-conversation-updated: + type: object + properties: + conversation: + $ref: '#/components/schemas/conversation' + old_conversation: + $ref: '#/components/schemas/conversation' + required: + - conversation + title: event-conversation-updated + event-dashboard-created: + type: object + properties: + dashboard: + $ref: '#/components/schemas/dashboard' + required: + - dashboard + title: event-dashboard-created + event-dashboard-deleted: + type: object + properties: + id: type: string - description: | - Rev org of the rev user to be removed. This should be specified - only if the member is a rev user - example: REV-AbCdEfGh + description: The ID of the dashboard that was deleted. format: id + old_dashboard: + $ref: '#/components/schemas/dashboard' required: - - group - - member - title: group-members-remove-request - group-members-remove-response: + - id + title: event-dashboard-deleted + event-dashboard-updated: type: object - additionalProperties: false - title: group-members-remove-response - x-go-name: GroupMembersRemoveResponseBody - group-summary: - allOf: - - $ref: '#/components/schemas/atom-base-summary' - title: group-summary - group-type: - type: string - description: Type of the group. - enum: - - dynamic - - static - groups-create-request: + properties: + dashboard: + $ref: '#/components/schemas/dashboard' + old_dashboard: + $ref: '#/components/schemas/dashboard' + required: + - dashboard + title: event-dashboard-updated + event-dev-user-created: type: object - description: A request to create a new group. properties: - type: - $ref: '#/components/schemas/group-type' - description: - type: string - description: Description of the group. - format: text - dynamic_group_info: - $ref: '#/components/schemas/dynamic-group-info' - member_type: - $ref: '#/components/schemas/group-member-type' - name: - type: string - description: Unique name of the group. - format: text - owner: + dev_user: + $ref: '#/components/schemas/dev-user' + required: + - dev_user + title: event-dev-user-created + event-dev-user-deleted: + type: object + properties: + id: type: string - description: Owner of the group. + description: The ID of the Dev user that was deleted. format: id + old_dev_user: + $ref: '#/components/schemas/dev-user' required: - - description - - name - title: groups-create-request - groups-create-response: + - id + title: event-dev-user-deleted + event-dev-user-updated: + type: object + properties: + dev_user: + $ref: '#/components/schemas/dev-user' + old_dev_user: + $ref: '#/components/schemas/dev-user' + required: + - dev_user + title: event-dev-user-updated + event-fetched-result: + type: string + enum: + - forbidden + - not_found + - ok + event-group-created: type: object - description: The response to group creation. properties: group: $ref: '#/components/schemas/group' required: - group - title: groups-create-response - x-go-name: GroupsCreateResponseBody - groups-get-request: + title: event-group-created + event-group-deleted: type: object - description: A request to get information about a group. properties: id: type: string - description: The ID of the group to get. + description: The ID of the group that was deleted. format: id + old_group: + $ref: '#/components/schemas/group' required: - id - title: groups-get-request - groups-get-response: + title: event-group-deleted + event-group-member-added: + type: object + properties: + group: + $ref: '#/components/schemas/group-summary' + member: + $ref: '#/components/schemas/user-summary' + required: + - group + - member + title: event-group-member-added + event-group-member-removed: + type: object + properties: + group: + $ref: '#/components/schemas/group-summary' + member: + $ref: '#/components/schemas/user-summary' + required: + - group + - member + title: event-group-member-removed + event-group-updated: type: object - description: The response to getting the group. properties: group: $ref: '#/components/schemas/group' + old_group: + $ref: '#/components/schemas/group' required: - group - title: groups-get-response - x-go-name: GroupsGetResponseBody - groups-list-request: + title: event-group-updated + event-incident-created: type: object - description: A request to get information about a list of groups. properties: - created_by: - type: array - description: Filters the groups on the basis of creator. - items: - type: string - format: id - cursor: - type: string - description: | - The cursor to resume iteration from. If not provided, then - iteration starts from the beginning. - format: text - group_type: - type: array - description: Filters the groups based on the group type. - items: - $ref: '#/components/schemas/group-type' - ingestion_source: - type: array - description: Filter groups by ingestion source(s). - items: - $ref: '#/components/schemas/group-ingestion-source' - is_default: - type: boolean - description: Whether to fetch default or custom groups. - limit: - type: integer - description: | - The maximum number of groups to return. The default is '50'. - format: int32 - member_type: - type: array - description: Filters the groups on basis of member type. - items: - $ref: '#/components/schemas/group-member-type' - mode: - $ref: '#/components/schemas/list-mode' - name: - type: array - description: Filters the groups on the basis of group name. - items: - type: string - format: text - sort_by: - type: array - description: Comma-separated fields to sort the groups by. - items: - type: string - format: sort-by - sync_metadata: - $ref: '#/components/schemas/sync-metadata-filter' - title: groups-list-request - groups-list-response: + incident: + $ref: '#/components/schemas/incident' + required: + - incident + title: event-incident-created + event-incident-deleted: type: object - description: The response to listing the groups. properties: - groups: - type: array - description: The list of groups. - items: - $ref: '#/components/schemas/group' - next_cursor: + id: type: string - description: | - The cursor used to iterate subsequent results in accordance to the - sort order. If not set, then no later elements exist. - format: text - prev_cursor: + description: The ID of the incident that was deleted. + format: id + old_incident: + $ref: '#/components/schemas/incident' + required: + - id + title: event-incident-deleted + event-incident-updated: + type: object + properties: + incident: + $ref: '#/components/schemas/incident' + old_incident: + $ref: '#/components/schemas/incident' + required: + - incident + title: event-incident-updated + event-link-created: + type: object + properties: + link: + $ref: '#/components/schemas/link' + required: + - link + title: event-link-created + event-link-deleted: + type: object + properties: + id: type: string - description: | - The cursor used to iterate preceding results in accordance to the - sort order. If not set, then no prior elements exist. - format: text + description: The ID of the link that was deleted. + format: id required: - - groups - title: groups-list-response - x-go-name: GroupsListResponseBody - groups-update-request: + - id + title: event-link-deleted + event-link-updated: type: object - description: A request to update a group. properties: - description: + link: + $ref: '#/components/schemas/link' + old_link: + $ref: '#/components/schemas/link' + required: + - link + title: event-link-updated + event-part-created: + type: object + properties: + part: + $ref: '#/components/schemas/part' + required: + - part + title: event-part-created + event-part-deleted: + type: object + properties: + id: type: string - description: The updated group's description. - format: text - dynamic_group_info: - $ref: '#/components/schemas/groups-update-request-dynamic-group-info' + description: The ID of the part that was deleted. + example: PROD-12345 + format: id + old_part: + $ref: '#/components/schemas/part' + required: + - id + title: event-part-deleted + event-part-updated: + type: object + properties: + old_part: + $ref: '#/components/schemas/part' + part: + $ref: '#/components/schemas/part' + required: + - part + title: event-part-updated + event-question-answer-created: + type: object + properties: + question_answer: + $ref: '#/components/schemas/question-answer' + required: + - question_answer + title: event-question-answer-created + event-question-answer-deleted: + type: object + properties: id: type: string - description: The ID of the group to update. + description: The ID of the question-answer that was deleted. format: id - name: + old_question_answer: + $ref: '#/components/schemas/question-answer' + required: + - id + title: event-question-answer-deleted + event-question-answer-updated: + type: object + properties: + old_question_answer: + $ref: '#/components/schemas/question-answer' + question_answer: + $ref: '#/components/schemas/question-answer' + required: + - question_answer + title: event-question-answer-updated + event-rev-org-created: + type: object + properties: + rev_org: + $ref: '#/components/schemas/rev-org' + required: + - rev_org + title: event-rev-org-created + event-rev-org-deleted: + type: object + properties: + id: type: string - description: The updated group's name. - format: text - owner: + description: The ID of the Rev organization that was deleted. + example: REV-AbCdEfGh + format: id + old_rev_org: + $ref: '#/components/schemas/rev-org' + required: + - id + title: event-rev-org-deleted + event-rev-org-updated: + type: object + properties: + old_rev_org: + $ref: '#/components/schemas/rev-org' + rev_org: + $ref: '#/components/schemas/rev-org' + required: + - rev_org + title: event-rev-org-updated + event-rev-user-created: + type: object + properties: + rev_user: + $ref: '#/components/schemas/rev-user' + required: + - rev_user + title: event-rev-user-created + event-rev-user-deleted: + type: object + properties: + id: type: string - description: The updated group's owner. + description: The ID of the Rev user that was deleted. format: id - nullable: true + old_rev_user: + $ref: '#/components/schemas/rev-user' required: - id - title: groups-update-request - groups-update-request-dynamic-group-info: + title: event-rev-user-deleted + event-rev-user-updated: type: object properties: - membership_expression: - $ref: '#/components/schemas/boolean-expression' + old_rev_user: + $ref: '#/components/schemas/rev-user' + rev_user: + $ref: '#/components/schemas/rev-user' required: - - membership_expression - title: groups-update-request-dynamic-group-info - groups-update-response: + - rev_user + title: event-rev-user-updated + event-sla-tracker-created: type: object - description: The response to group update. properties: - group: - $ref: '#/components/schemas/group' + sla_tracker: + $ref: '#/components/schemas/sla-tracker' required: - - group - title: groups-update-response - x-go-name: GroupsUpdateResponseBody - impacted-customer-details: + - sla_tracker + title: event-sla-tracker-created + event-sla-tracker-deleted: type: object - description: Details of the impact due to the incident. properties: - count: - $ref: '#/components/schemas/enum-value' - customer_ids: - type: array - description: List of customers impacted due to the incident. - items: - $ref: '#/components/schemas/account-summary' - title: impacted-customer-details - incident: - allOf: - - $ref: '#/components/schemas/atom-base' - - type: object - properties: - acknowledged_date: - type: string - description: Timestamp when the incident was acknowledged. - example: "2023-01-01T12:00:00.000Z" - format: date-time - applies_to_parts: - type: array - description: Parts to which the incident is applicable to. - items: - $ref: '#/components/schemas/part-summary' - artifacts: - type: array - description: Artifacts attached to the incident. - items: - $ref: '#/components/schemas/artifact-summary' - body: - type: string - description: Body of the incident. - format: text - identified_date: - type: string - description: Time when the incident was identified/reported. - example: "2023-01-01T12:00:00.000Z" - format: date-time - impact: - $ref: '#/components/schemas/impacted-customer-details' - mitigated_date: - type: string - description: Timestamp when the incident was mitigated. - example: "2023-01-01T12:00:00.000Z" - format: date-time - owned_by: - type: array - description: The users that own the incident. - items: - $ref: '#/components/schemas/user-summary' - reported_by: - $ref: '#/components/schemas/enum-value' - severity: - $ref: '#/components/schemas/enum-value' - source: - $ref: '#/components/schemas/enum-value' - stage: - $ref: '#/components/schemas/stage' - tags: - type: array - description: Tags associated with the object. - items: - $ref: '#/components/schemas/tag-with-value' - target_close_date: - type: string - description: Timestamp when the incident is expected to be resolved. - example: "2023-01-01T12:00:00.000Z" - format: date-time - title: - type: string - description: Title of the incident. - format: text - required: - - title - title: incident - issue: - allOf: - - $ref: '#/components/schemas/work-base' - - type: object - properties: - developed_with: - type: array - description: Parts associated based on git events. - items: - $ref: '#/components/schemas/part-summary' - priority: - $ref: '#/components/schemas/issue-priority' - priority_v2: - $ref: '#/components/schemas/enum-value' - sla_summary: - $ref: '#/components/schemas/archetype-sla-summary' - sla_tracker: - $ref: '#/components/schemas/sla-tracker-summary' - sprint: - $ref: '#/components/schemas/vista-group-item-summary' - target_start_date: - type: string - description: Target start date for the object. - example: "2023-01-01T12:00:00.000Z" - format: date-time - title: issue - issue-priority: - type: string - description: Priority of the work based upon impact and criticality. - enum: - - p0 - - p1 - - p2 - - p3 - issue-summary: - allOf: - - $ref: '#/components/schemas/work-base-summary' - - type: object - properties: - priority: - $ref: '#/components/schemas/issue-priority' - priority_v2: - $ref: '#/components/schemas/enum-value-summary' - sprint: - $ref: '#/components/schemas/vista-group-item-summary' - title: issue-summary - job-history-item: + id: + type: string + description: The ID of the SLA tracker that was deleted. + format: id + old_sla_tracker: + $ref: '#/components/schemas/sla-tracker' + required: + - id + title: event-sla-tracker-deleted + event-sla-tracker-fetched: type: object - description: Defines a job history line item. + discriminator: + mapping: + forbidden: '#/components/schemas/empty' + not_found: '#/components/schemas/empty' + ok: '#/components/schemas/event-sla-tracker-fetched-ok' + propertyName: result + oneOf: + - $ref: '#/components/schemas/empty' + - $ref: '#/components/schemas/event-sla-tracker-fetched-ok' properties: - employment_status: - $ref: '#/components/schemas/enum-value' - end_date: - type: string - description: The end date of the job, or not specified if current. - example: "2023-01-01T12:00:00.000Z" - format: date-time - is_current: - type: boolean - description: Is this the current active job for the user. - location: - type: string - description: The job location for the user. - format: text - start_date: - type: string - description: The start date of the job. - example: "2023-01-01T12:00:00.000Z" - format: date-time - title: + id: type: string - description: The job title for the user. - format: text - title: job-history-item - keyrings-create-callback-request: + description: The ID of the SLA tracker that was fetched. + format: id + result: + $ref: '#/components/schemas/event-fetched-result' + required: + - id + - result + title: event-sla-tracker-fetched + event-sla-tracker-fetched-ok: type: object properties: - code: - type: string - description: Code to exchange for an access token. - format: text - state: - type: string - description: State value given to the authorization request. - format: text + sla_tracker: + $ref: '#/components/schemas/sla-tracker' + title: event-sla-tracker-fetched-ok + event-sla-tracker-updated: + type: object + properties: + old_sla_tracker: + $ref: '#/components/schemas/sla-tracker' + sla_tracker: + $ref: '#/components/schemas/sla-tracker' required: - - code - - state - title: keyrings-create-callback-request - legacy-stage: + - sla_tracker + title: event-sla-tracker-updated + event-survey-created: type: object - description: Describes the current stage of a work item. properties: - name: - type: string - description: Current stage name of the work item. - format: text + survey: + $ref: '#/components/schemas/survey' required: - - name - title: legacy-stage - legacy-stage-summary: + - survey + title: event-survey-created + event-survey-deleted: type: object - description: Describes the current stage of a work item. properties: - name: + id: type: string - description: Current stage name of the work item. - format: text + description: The ID of the survey that was deleted. + format: id + old_survey: + $ref: '#/components/schemas/survey' required: - - name - title: legacy-stage-summary - link: - allOf: - - $ref: '#/components/schemas/atom-base' - - type: object - properties: - link_type: - $ref: '#/components/schemas/link-type' - source: - $ref: '#/components/schemas/link-endpoint-summary' - target: - $ref: '#/components/schemas/link-endpoint-summary' - required: - - link_type - - source - - target - title: link - link-endpoint-summary: + - id + title: event-survey-deleted + event-survey-response-created: type: object - discriminator: - mapping: - capability: '#/components/schemas/capability-summary' - conversation: '#/components/schemas/conversation-summary' - dev_user: '#/components/schemas/dev-user-summary' - enhancement: '#/components/schemas/enhancement-summary' - feature: '#/components/schemas/feature-summary' - issue: '#/components/schemas/issue-summary' - product: '#/components/schemas/product-summary' - rev_org: '#/components/schemas/rev-org-summary' - rev_user: '#/components/schemas/rev-user-summary' - ticket: '#/components/schemas/ticket-summary' - propertyName: type - oneOf: - - $ref: '#/components/schemas/capability-summary' - - $ref: '#/components/schemas/conversation-summary' - - $ref: '#/components/schemas/dev-user-summary' - - $ref: '#/components/schemas/enhancement-summary' - - $ref: '#/components/schemas/feature-summary' - - $ref: '#/components/schemas/issue-summary' - - $ref: '#/components/schemas/product-summary' - - $ref: '#/components/schemas/rev-org-summary' - - $ref: '#/components/schemas/rev-user-summary' - - $ref: '#/components/schemas/ticket-summary' properties: - type: - $ref: '#/components/schemas/link-endpoint-type' + survey_response: + $ref: '#/components/schemas/survey-response' required: - - type - title: link-endpoint-summary - link-endpoint-type: - type: string - enum: - - capability - - conversation - - dev_user - - enhancement - - feature - - issue - - product - - rev_org - - rev_user - - ticket - link-summary: - allOf: - - $ref: '#/components/schemas/atom-base-summary' - - type: object - properties: - link_type: - $ref: '#/components/schemas/link-type' - source: - $ref: '#/components/schemas/link-endpoint-summary' - target: - $ref: '#/components/schemas/link-endpoint-summary' - required: - - link_type - - source - - target - title: link-summary - link-type: - type: string - description: Type of link used to define the relationship. - enum: - - custom_link - - developed_with - - imports - - is_analyzed_by - - is_converted_to - - is_dependent_on - - is_duplicate_of - - is_follow_up_of - - is_merged_into - - is_parent_of - - is_part_of - - is_related_to - - serves - links-create-request: + - survey_response + title: event-survey-response-created + event-survey-response-deleted: type: object - description: The request to create a new link. properties: - link_type: - $ref: '#/components/schemas/link-type' - source: - type: string - description: The ID of the source object. - format: id - target: + id: type: string - description: The ID of the target object. + description: The ID of the survey response that was deleted. format: id + old_survey_response: + $ref: '#/components/schemas/survey-response' required: - - link_type - - source - - target - title: links-create-request - links-create-response: + - id + title: event-survey-response-deleted + event-survey-response-updated: type: object - description: The response to creating a new link. properties: - link: - $ref: '#/components/schemas/link' + old_survey_response: + $ref: '#/components/schemas/survey-response' + survey_response: + $ref: '#/components/schemas/survey-response' required: - - link - title: links-create-response - x-go-name: LinksCreateResponseBody - links-delete-request: + - survey_response + title: event-survey-response-updated + event-survey-updated: + type: object + properties: + old_survey: + $ref: '#/components/schemas/survey' + survey: + $ref: '#/components/schemas/survey' + required: + - survey + title: event-survey-updated + event-sync-history-created: + type: object + properties: + sync_history: + $ref: '#/components/schemas/sync-history' + required: + - sync_history + title: event-sync-history-created + event-sync-history-deleted: type: object - description: The request to delete a link. properties: id: type: string - description: The ID of the link to delete. + description: The ID of the sync history that was deleted. format: id required: - id - title: links-delete-request - links-delete-response: + title: event-sync-history-deleted + event-sync-history-updated: type: object - additionalProperties: false - description: The response for deleting a link. - title: links-delete-response - x-go-name: LinksDeleteResponseBody - links-direction: - type: string - description: | - The direction of link, which can either be outbound such that the - object is the source of the link, otherwise inbound where the object is - the target of the link. - enum: - - is_source - - is_target - links-get-request: + properties: + old_sync_history: + $ref: '#/components/schemas/sync-history' + sync_history: + $ref: '#/components/schemas/sync-history' + required: + - sync_history + title: event-sync-history-updated + event-tag-created: + type: object + properties: + tag: + $ref: '#/components/schemas/tag' + required: + - tag + title: event-tag-created + event-tag-deleted: type: object - description: The request to get a link's information. properties: id: type: string - description: The requested link's ID. + description: The ID of the tag that was deleted. + example: TAG-12345 format: id + old_tag: + $ref: '#/components/schemas/tag' required: - id - title: links-get-request - links-get-response: + title: event-tag-deleted + event-tag-updated: type: object - description: The response to getting a link's information. properties: - link: - $ref: '#/components/schemas/link' + old_tag: + $ref: '#/components/schemas/tag' + tag: + $ref: '#/components/schemas/tag' required: - - link - title: links-get-response - x-go-name: LinksGetResponseBody - links-list-request: + - tag + title: event-tag-updated + event-timeline-entry-created: type: object - description: The request to get information about a list of links. properties: - cursor: - type: string - description: | - The cursor to resume iteration from. If not provided, then - iteration starts from the beginning. - format: text - direction: - $ref: '#/components/schemas/links-direction' - limit: - type: integer - description: | - The maximum number of links to return. If not set, then the default - is '50'. - format: int32 - link_type: - type: array - description: | - The link type(s) to filter for, otherwise if not present, all link - types are included. - items: - $ref: '#/components/schemas/link-type' - mode: - $ref: '#/components/schemas/list-mode' - object: + entry: + $ref: '#/components/schemas/timeline-entry' + required: + - entry + title: event-timeline-entry-created + event-timeline-entry-deleted: + type: object + properties: + id: type: string - description: The ID of the object to list the links for. + description: The ID of the timeline entry that was deleted. + example: don:core:dvrv-us-1:devo/example:ticket/123:comment/comment-id format: id - object_types: - type: array - description: | - The object types to filter for, otherwise if not present, all - object types are included. - items: - $ref: '#/components/schemas/link-endpoint-type' - types: - type: array - deprecated: true - description: | - The link types to filter for, otherwise if not present, all link - types are included. - items: - $ref: '#/components/schemas/link-type' + old_entry: + $ref: '#/components/schemas/timeline-entry' required: - - object - title: links-list-request - links-list-response: + - id + title: event-timeline-entry-deleted + event-timeline-entry-updated: type: object - description: The response to listing the links. properties: - links: + entry: + $ref: '#/components/schemas/timeline-entry' + old_entry: + $ref: '#/components/schemas/timeline-entry' + reactions: type: array - description: The list of links. + description: The reactions that were performed. items: - $ref: '#/components/schemas/link' - next_cursor: - type: string - description: | - The cursor used to iterate subsequent results in accordance to the - sort order. If not set, then no later elements exist. - format: text - prev_cursor: + $ref: '#/components/schemas/event-timeline-entry-updated-reaction' + maxItems: 16 + required: + - entry + title: event-timeline-entry-updated + event-timeline-entry-updated-reaction: + type: object + properties: + action: + $ref: '#/components/schemas/event-timeline-entry-updated-reaction-action' + emoji: type: string - description: | - The cursor used to iterate preceding results in accordance to the - sort order. If not set, then no prior elements exist. + description: The emoji for the reaction. format: text + reactor: + $ref: '#/components/schemas/user-summary' required: - - links - title: links-list-response - x-go-name: LinksListResponseBody - links-replace-request: + - action + - emoji + title: event-timeline-entry-updated-reaction + event-timeline-entry-updated-reaction-action: + type: string + enum: + - added + - removed + event-webhook-created: + type: object + properties: + webhook: + $ref: '#/components/schemas/webhook' + required: + - webhook + title: event-webhook-created + event-webhook-deleted: type: object - description: The request to replace a link. properties: id: type: string - description: The ID of the link to be replaced. - format: id - link_type: - $ref: '#/components/schemas/link-type' - source: - type: string - description: The ID of the source object. - format: id - target: - type: string - description: The ID of the target object. + description: The ID of the webhook that was deleted. + example: don:integration:dvrv-us-1:devo/example:webhook/webhook-id format: id required: - id - - link_type - - source - - target - title: links-replace-request - links-replace-response: + title: event-webhook-deleted + event-webhook-updated: type: object - description: The response to replacing a link. properties: - link: - $ref: '#/components/schemas/link' + webhook: + $ref: '#/components/schemas/webhook' required: - - link - title: links-replace-response - x-go-name: LinksReplaceResponseBody - list-mode: - type: string - description: | - The iteration mode to use. If "after", then entries after the provided - cursor will be returned, or if no cursor is provided, then from the - beginning. If "before", then entries before the provided cursor will be - returned, or if no cursor is provided, then from the end. Entries will - always be returned in the specified sort-by order. - enum: - - after - - before - member-summary: + - webhook + title: event-webhook-updated + event-widget-created: type: object - discriminator: - mapping: - dev_user: '#/components/schemas/dev-user-summary' - group: '#/components/schemas/group-summary' - rev_user: '#/components/schemas/rev-user-summary' - sys_user: '#/components/schemas/sys-user-summary' - propertyName: type - oneOf: - - $ref: '#/components/schemas/dev-user-summary' - - $ref: '#/components/schemas/group-summary' - - $ref: '#/components/schemas/rev-user-summary' - - $ref: '#/components/schemas/sys-user-summary' properties: - type: - $ref: '#/components/schemas/member-type' + widget: + $ref: '#/components/schemas/widget' required: - - type - title: member-summary - member-type: - type: string - enum: - - dev_user - - group - - rev_user - - sys_user - metric-definition: - allOf: - - $ref: '#/components/schemas/atom-base' - - type: object - properties: - name: - type: string - description: Human readable name of the metric. - format: text - title: metric-definition - metric-definition-applies-to: - type: string - description: The list of item types on which the metric might be applied. - enum: - - conversation - - issue - - ticket - metric-definition-metric-type: - type: string - description: | - The type of the metric. 'time' metrics track the time spent in some - state, supporting operations like 'start', 'stop', 'pause', 'resume'. - 'value' metrics track a value, supporting operations like 'set', - 'increment', 'decrement'. - enum: - - time - - value - metric-definition-status: - type: string - description: | - The status of the metric. 'active' metrics can be used to create new - SLAs, while 'inactive' metrics can not be used in new SLAs. Metrics can - be updated between 'active' and 'inactive' states. - enum: - - active - - inactive - metric-definition-summary: - allOf: - - $ref: '#/components/schemas/atom-base-summary' - - type: object - properties: - name: - type: string - description: Human readable name of the metric. - format: text - title: metric-definition-summary - metric-definitions-list-request: + - widget + title: event-widget-created + event-widget-deleted: type: object properties: - type: - type: array - description: The type of metric definitions sought. - items: - $ref: '#/components/schemas/metric-definition-metric-type' - applies_to_type: - type: array - description: The type of objects the metric definition applies to. - items: - $ref: '#/components/schemas/metric-definition-applies-to' - cursor: + id: type: string - description: | - The cursor to resume iteration from. If not provided, then - iteration starts from the beginning. - format: text - include_custom_metrics: - type: boolean - description: | - Whether to include custom metrics in the response. If not set, then - custom metrics are excluded. - limit: - type: integer - description: | - The maximum number of records to return. The default is '50'. - format: int32 - mode: - $ref: '#/components/schemas/list-mode' - sort_by: - type: array - description: | - Fields to sort the records by and the direction to sort them. - items: - type: string - format: sort-by - status: - type: array - description: The status of the metric definition. - items: - $ref: '#/components/schemas/metric-definition-status' - title: metric-definitions-list-request - metric-definitions-list-response: + description: The ID of the widget that was deleted. + format: id + old_widget: + $ref: '#/components/schemas/widget' + required: + - id + title: event-widget-deleted + event-widget-updated: type: object properties: - metric_definitions: - type: array - description: The list of metric definitions. - items: - $ref: '#/components/schemas/metric-definition' - next_cursor: - type: string - description: | - The cursor used to iterate subsequent results in accordance to the - sort order. If not set, then no later elements exist. - format: text - prev_cursor: - type: string - description: | - The cursor used to iterate preceding results in accordance to the - sort order. If not set, then no prior elements exist. - format: text + old_widget: + $ref: '#/components/schemas/widget' + widget: + $ref: '#/components/schemas/widget' required: - - metric_definitions - title: metric-definitions-list-response - x-go-name: MetricDefinitionsListResponseBody - metric-tracker: + - widget + title: event-widget-updated + event-work-created: type: object - discriminator: - propertyName: type properties: - type: - $ref: '#/components/schemas/metric-tracker-type' + work: + $ref: '#/components/schemas/work' required: - - type - title: metric-tracker - metric-tracker-type: - type: string - metric-trackers-get-request: + - work + title: event-work-created + event-work-deleted: type: object properties: - metric: + id: type: string - description: The ID of the metric that is being tracked. - format: id - object: + description: The ID of the work that was deleted. + example: ISS-12345 + format: id + old_work: + $ref: '#/components/schemas/work' + required: + - id + title: event-work-deleted + event-work-fetched: + type: object + discriminator: + mapping: + forbidden: '#/components/schemas/empty' + not_found: '#/components/schemas/empty' + ok: '#/components/schemas/event-work-fetched-ok' + propertyName: result + oneOf: + - $ref: '#/components/schemas/empty' + - $ref: '#/components/schemas/event-work-fetched-ok' + properties: + id: type: string - description: | - The ID of the underlying object on which the metric is being - tracked. + description: The ID of the work that was fetched. + example: ISS-12345 format: id + result: + $ref: '#/components/schemas/event-fetched-result' required: - - metric - - object - title: metric-trackers-get-request - metric-trackers-get-response: + - id + - result + title: event-work-fetched + event-work-fetched-ok: type: object properties: - metric_tracker: - $ref: '#/components/schemas/metric-tracker' + work: + $ref: '#/components/schemas/work' + title: event-work-fetched-ok + event-work-updated: + type: object + properties: + old_work: + $ref: '#/components/schemas/work' + work: + $ref: '#/components/schemas/work' required: - - metric_tracker - title: metric-trackers-get-response - x-go-name: MetricTrackersGetResponseBody - org-base: - allOf: - - $ref: '#/components/schemas/atom-base' - - type: object - properties: - display_name: - type: string - description: Name of the Organization. - format: text - title: org-base - org-base-summary: + - work + title: event-work-updated + external-communication-channel-summary: allOf: - $ref: '#/components/schemas/atom-base-summary' - - type: object - properties: - display_name: - type: string - description: Name of the Organization. - format: text - title: org-base-summary - org-environment: + title: external-communication-channel-summary + external-identity: + type: object + description: External identity of a user. + properties: + display_name: + type: string + description: Display name of the user in the external source. + format: text + id: + type: string + description: Unique ID of the user in the external source. + format: text + is_verified: + type: boolean + description: Whether the external identity is verified or not. + issuer: + type: string + description: Issuer of the external identity of the user. + format: text + title: external-identity + feature: + allOf: + - $ref: '#/components/schemas/part-base' + title: feature + feature-summary: + allOf: + - $ref: '#/components/schemas/part-base-summary' + title: feature-summary + field-descriptor: + type: object + additionalProperties: false + description: Set of field attributes. + title: field-descriptor + group: + allOf: + - $ref: '#/components/schemas/atom-base' + title: group + group-ingestion-source: type: string - description: | - The environment of the Org. Defaults to 'production' if not specified. + description: Creation source of the group. enum: - - production - - staging - - test - org-schedule-status: + - airdrop + - scim + group-member-type: type: string - description: | - Status determines how an item can be used. In 'draft' status an item - can be edited but can't be used. When 'published' the item can longer - be edited but can be used. 'Archived' is read-only. + description: Type of the members in the group. enum: - - archived - - draft - - published - org-schedule-summary: - allOf: - - $ref: '#/components/schemas/atom-base-summary' - - type: object - properties: - name: - type: string - description: Human-readable name. - format: text - status: - $ref: '#/components/schemas/org-schedule-status' - timezone: - type: string - description: | - Timezone in which this is defined. Only organization schedules in - the same timezone can be directly combined. - format: text - valid_until: - type: string - description: | - Derived field indicating when a valid organization schedule will - become invalid. If omitted, the schedule is already invalid. A - schedule is valid if it has a weekly schedule for all named periods - for all its schedule fragments, and if it has a schedule fragment - for the time period in question. - example: "2023-01-01T12:00:00.000Z" - format: date-time - required: - - status - title: org-schedule-summary - org-summary: + - dev_user + - rev_user + group-members-add-request: type: object - discriminator: - mapping: - rev_org: '#/components/schemas/rev-org-summary' - propertyName: type - oneOf: - - $ref: '#/components/schemas/rev-org-summary' + description: A request to add a new member to a group. properties: - type: - $ref: '#/components/schemas/org-type' + group: + type: string + description: ID of the group where the member is being added. + format: id + member: + type: string + description: ID of the member to be added. + example: DEVU-12345 + format: id + member_rev_org: + type: string + description: | + Rev org of the rev user to be added. This should be specified only + if the member is a rev user + example: REV-AbCdEfGh + format: id required: - - type - title: org-summary - org-type: - type: string - enum: - - rev_org - parent-part-filter: + - group + - member + title: group-members-add-request + group-members-add-response: type: object - description: The filter for specifying parent part. + additionalProperties: false + title: group-members-add-response + x-go-name: GroupMembersAddResponseBody + group-members-list-request: + type: object + description: A request to list group members. properties: - level: + cursor: + type: string + description: | + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. + format: text + group: + type: string + description: ID of the group for which to list members. + format: id + limit: type: integer - description: Number of levels to fetch the part hierarchy up to. + description: | + The maximum number of members to return. If not set, then the + default is '50'. format: int32 - minimum: 1 - parts: - type: array - description: Part IDs to fetch the hierarchy for. - example: - - PROD-12345 - items: - type: string - format: id - minItems: 1 + mode: + $ref: '#/components/schemas/list-mode' required: - - parts - title: parent-part-filter - part: + - group + title: group-members-list-request + group-members-list-response: type: object - discriminator: - mapping: - capability: '#/components/schemas/capability' - enhancement: '#/components/schemas/enhancement' - feature: '#/components/schemas/feature' - product: '#/components/schemas/product' - propertyName: type - oneOf: - - $ref: '#/components/schemas/capability' - - $ref: '#/components/schemas/enhancement' - - $ref: '#/components/schemas/feature' - - $ref: '#/components/schemas/product' + description: List of group members. properties: - type: - $ref: '#/components/schemas/part-type' - required: - - type - title: part - part-base: - allOf: - - $ref: '#/components/schemas/atom-base' - - type: object - properties: - artifacts: - type: array - description: The attached artifacts. - items: - $ref: '#/components/schemas/artifact-summary' - description: - type: string - description: Description of the part. - format: text - name: - type: string - description: Name of the part. - format: text - owned_by: - type: array - description: The users that own the part. - items: - $ref: '#/components/schemas/user-summary' - tags: - type: array - description: Tags associated with the object. - items: - $ref: '#/components/schemas/tag-with-value' - required: - - name - - owned_by - title: part-base - part-base-summary: - allOf: - - $ref: '#/components/schemas/atom-base-summary' - - type: object - properties: - name: - type: string - description: Name of the part. - format: text - owned_by: - type: array - description: The users that own the part. - items: - $ref: '#/components/schemas/user-summary' - required: - - name - - owned_by - title: part-base-summary - part-summary: + members: + type: array + description: List of members. + items: + $ref: '#/components/schemas/group-members-list-response-member' + next_cursor: + type: string + description: | + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. + format: text + prev_cursor: + type: string + description: | + The cursor used to iterate preceding results in accordance to the + sort order. If not set, then no prior elements exist. + format: text + required: + - members + title: group-members-list-response + x-go-name: GroupMembersListResponseBody + group-members-list-response-member: type: object - discriminator: - mapping: - capability: '#/components/schemas/capability-summary' - enhancement: '#/components/schemas/enhancement-summary' - feature: '#/components/schemas/feature-summary' - product: '#/components/schemas/product-summary' - propertyName: type - oneOf: - - $ref: '#/components/schemas/capability-summary' - - $ref: '#/components/schemas/enhancement-summary' - - $ref: '#/components/schemas/feature-summary' - - $ref: '#/components/schemas/product-summary' + description: A group member. properties: - type: - $ref: '#/components/schemas/part-type' + member: + $ref: '#/components/schemas/member-summary' + member_rev_org: + $ref: '#/components/schemas/rev-org-summary' required: - - type - title: part-summary - part-type: + - member + title: group-members-list-response-member + group-members-remove-request: + type: object + description: A request to remove a group member. + properties: + group: + type: string + description: ID of the group where the member is being removed. + format: id + member: + type: string + description: ID of the member to be removed. + example: DEVU-12345 + format: id + member_rev_org: + type: string + description: | + Rev org of the rev user to be removed. This should be specified + only if the member is a rev user + example: REV-AbCdEfGh + format: id + required: + - group + - member + title: group-members-remove-request + group-members-remove-response: + type: object + additionalProperties: false + title: group-members-remove-response + x-go-name: GroupMembersRemoveResponseBody + group-summary: + allOf: + - $ref: '#/components/schemas/atom-base-summary' + title: group-summary + group-type: type: string + description: Type of the group. enum: - - capability - - enhancement - - feature - - product - parts-create-request: + - dynamic + - static + groups-create-request: type: object - discriminator: - mapping: - capability: '#/components/schemas/parts-create-request-capability' - enhancement: '#/components/schemas/parts-create-request-enhancement' - feature: '#/components/schemas/parts-create-request-feature' - product: '#/components/schemas/parts-create-request-product' - propertyName: type - oneOf: - - $ref: '#/components/schemas/parts-create-request-capability' - - $ref: '#/components/schemas/parts-create-request-enhancement' - - $ref: '#/components/schemas/parts-create-request-feature' - - $ref: '#/components/schemas/parts-create-request-product' + description: A request to create a new group. properties: type: - $ref: '#/components/schemas/part-type' - artifacts: - type: array - description: The IDs of the artifacts. - example: - - ARTIFACT-12345 - items: - type: string - format: id + $ref: '#/components/schemas/group-type' description: type: string - description: Description of the part. + description: Description of the group. format: text + dynamic_group_info: + $ref: '#/components/schemas/dynamic-group-info' + member_type: + $ref: '#/components/schemas/group-member-type' name: type: string - description: Name of the part. + description: Unique name of the group. format: text - owned_by: - type: array - description: The users that own the part. - example: - - DEVU-12345 - items: - type: string - format: id - tags: - type: array - description: Tags associated with the part. - items: - $ref: '#/components/schemas/set-tag-with-value' + owner: + type: string + description: Owner of the group. + format: id required: + - description - name - - owned_by - - type - title: parts-create-request - parts-create-request-capability: + title: groups-create-request + groups-create-response: type: object + description: The response to group creation. properties: - parent_part: - type: array - description: ID of the parent product for the capability. - example: - - PROD-12345 - items: - type: string - format: id - maxItems: 1 + group: + $ref: '#/components/schemas/group' required: - - parent_part - title: parts-create-request-capability - parts-create-request-enhancement: + - group + title: groups-create-response + x-go-name: GroupsCreateResponseBody + groups-get-request: type: object + description: A request to get information about a group. properties: - parent_part: + id: + type: string + description: The ID of the group to get. + format: id + required: + - id + title: groups-get-request + groups-get-response: + type: object + description: The response to getting the group. + properties: + group: + $ref: '#/components/schemas/group' + required: + - group + title: groups-get-response + x-go-name: GroupsGetResponseBody + groups-list-request: + type: object + description: A request to get information about a list of groups. + properties: + created_by: type: array - description: | - ID of the parent part on which the enhancement is to be created. - example: - - PROD-12345 + description: Filters the groups on the basis of creator. items: type: string format: id - maxItems: 1 - target_close_date: - type: string - description: | - Target close date by which enhancement is expected to be closed. - example: "2023-01-01T12:00:00.000Z" - format: date-time - target_start_date: + cursor: type: string description: | - Target start date by which enhancement is expected to be started. - Example Date Format: 2000-11-01T01:01:01Z - example: "2023-01-01T12:00:00.000Z" - format: date-time - required: - - parent_part - title: parts-create-request-enhancement - parts-create-request-feature: - type: object - properties: - parent_part: - type: array - description: ID of the parent capability/feature for the feature. - example: - - PROD-12345 - items: - type: string - format: id - maxItems: 1 - required: - - parent_part - title: parts-create-request-feature - parts-create-request-product: - type: object - additionalProperties: false - title: parts-create-request-product - parts-create-response: - type: object - properties: - part: - $ref: '#/components/schemas/part' - required: - - part - title: parts-create-response - x-go-name: PartsCreateResponseBody - parts-delete-request: - type: object - properties: - id: - type: string - description: The ID of the part to delete. - example: PROD-12345 - format: id - required: - - id - title: parts-delete-request - parts-delete-response: - type: object - additionalProperties: false - title: parts-delete-response - x-go-name: PartsDeleteResponseBody - parts-get-request: - type: object - properties: - id: - type: string - description: The ID of the part to retrieve. - example: PROD-12345 - format: id - required: - - id - title: parts-get-request - parts-get-response: - type: object - properties: - part: - $ref: '#/components/schemas/part' - required: - - part - title: parts-get-response - x-go-name: PartsGetResponseBody - parts-list-request: - type: object - properties: - type: + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. + format: text + group_type: type: array - description: Filters for parts of the provided type(s). + description: Filters the groups based on the group type. items: - $ref: '#/components/schemas/part-type' - created_by: + $ref: '#/components/schemas/group-type' + ingestion_source: type: array - description: Filters for parts created by any of these users. - example: - - DEVU-12345 + description: Filter groups by ingestion source(s). items: - type: string - format: id - cursor: - type: string - description: | - The cursor to resume iteration from. If not provided, then - iteration starts from the beginning. - format: text + $ref: '#/components/schemas/group-ingestion-source' + is_default: + type: boolean + description: Whether to fetch default or custom groups. limit: type: integer description: | - The maximum number of parts to return. The default is '50'. + The maximum number of groups to return. The default is '50'. format: int32 + member_type: + type: array + description: Filters the groups on basis of member type. + items: + $ref: '#/components/schemas/group-member-type' mode: $ref: '#/components/schemas/list-mode' name: type: array - description: Filters for parts of the provided name(s). + description: Filters the groups on the basis of group name. items: type: string format: text - owned_by: - type: array - description: Filters for parts owned by any of these users. - example: - - DEVU-12345 - items: - type: string - format: id - parent_part: - $ref: '#/components/schemas/parent-part-filter' - tags: + sort_by: type: array - description: Filters for part with any of the provided tags. - example: - - TAG-12345 + description: Comma-separated fields to sort the groups by. items: type: string - format: id - title: parts-list-request - parts-list-response: + format: sort-by + sync_metadata: + $ref: '#/components/schemas/sync-metadata-filter' + title: groups-list-request + groups-list-response: type: object + description: The response to listing the groups. properties: + groups: + type: array + description: The list of groups. + items: + $ref: '#/components/schemas/group' next_cursor: type: string description: | The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist. format: text - parts: - type: array - description: The list of parts. - items: - $ref: '#/components/schemas/part' prev_cursor: type: string description: | @@ -6967,396 +7385,521 @@ components: sort order. If not set, then no prior elements exist. format: text required: - - parts - title: parts-list-response - x-go-name: PartsListResponseBody - parts-update-request: + - groups + title: groups-list-response + x-go-name: GroupsListResponseBody + groups-update-request: type: object - discriminator: - mapping: - capability: '#/components/schemas/parts-update-request-capability' - enhancement: '#/components/schemas/parts-update-request-enhancement' - feature: '#/components/schemas/parts-update-request-feature' - none: '#/components/schemas/empty' - product: '#/components/schemas/parts-update-request-product' - propertyName: type - oneOf: - - $ref: '#/components/schemas/empty' - - $ref: '#/components/schemas/parts-update-request-capability' - - $ref: '#/components/schemas/parts-update-request-enhancement' - - $ref: '#/components/schemas/parts-update-request-feature' - - $ref: '#/components/schemas/parts-update-request-product' + description: A request to update a group. properties: - type: - $ref: '#/components/schemas/part-type' - artifacts: - $ref: '#/components/schemas/parts-update-request-artifacts' description: type: string - description: The updated description of the part. + description: The updated group's description. format: text + dynamic_group_info: + $ref: '#/components/schemas/groups-update-request-dynamic-group-info' id: type: string - description: The ID of the part to update. - example: PROD-12345 + description: The ID of the group to update. format: id name: type: string - description: The updated name of the part. + description: The updated group's name. format: text - owned_by: - $ref: '#/components/schemas/parts-update-request-owned-by' - tags: - $ref: '#/components/schemas/parts-update-request-tags' + owner: + type: string + description: The updated group's owner. + format: id + nullable: true required: - id - title: parts-update-request - parts-update-request-artifacts: + title: groups-update-request + groups-update-request-dynamic-group-info: type: object properties: - set: - type: array - description: Sets the artifacts to the provided IDs. - example: - - ARTIFACT-12345 - items: - type: string - format: id - title: parts-update-request-artifacts - parts-update-request-capability: - type: object - additionalProperties: false - title: parts-update-request-capability - parts-update-request-enhancement: + membership_expression: + $ref: '#/components/schemas/boolean-expression' + required: + - membership_expression + title: groups-update-request-dynamic-group-info + groups-update-response: type: object + description: The response to group update. properties: - target_close_date: - type: string - description: Updates the target close date of the enhancement. - example: "2023-01-01T12:00:00.000Z" - format: date-time - nullable: true - target_start_date: - type: string - description: | - Updates the target start date of the enhancement. Example Date - Format: 2000-11-01T01:01:01Z - example: "2023-01-01T12:00:00.000Z" - format: date-time - nullable: true - title: parts-update-request-enhancement - parts-update-request-feature: - type: object - additionalProperties: false - title: parts-update-request-feature - parts-update-request-owned-by: + group: + $ref: '#/components/schemas/group' + required: + - group + title: groups-update-response + x-go-name: GroupsUpdateResponseBody + impacted-customer-details: type: object + description: Details of the impact due to the incident. properties: - set: + count: + $ref: '#/components/schemas/enum-value' + customer_ids: type: array - description: | - Sets the owner IDs to the provided user IDs. This must not be - empty. - example: - - DEVU-12345 + description: List of customers impacted due to the incident. items: - type: string - format: id - title: parts-update-request-owned-by - parts-update-request-product: - type: object - additionalProperties: false - title: parts-update-request-product - parts-update-request-tags: - type: object - properties: - set: - type: array - description: Sets the tags to the provided tags. - items: - $ref: '#/components/schemas/set-tag-with-value' - title: parts-update-request-tags - parts-update-response: - type: object - properties: - part: - $ref: '#/components/schemas/part' - required: - - part - title: parts-update-response - x-go-name: PartsUpdateResponseBody - product: - allOf: - - $ref: '#/components/schemas/part-base' - title: product - product-summary: - allOf: - - $ref: '#/components/schemas/part-base-summary' - title: product-summary - question-answer: + $ref: '#/components/schemas/account-summary' + title: impacted-customer-details + incident: allOf: - $ref: '#/components/schemas/atom-base' - type: object properties: - answer: + acknowledged_date: type: string - description: The Answer. - format: text + description: Timestamp when the incident was acknowledged. + example: "2023-01-01T12:00:00.000Z" + format: date-time applies_to_parts: type: array - description: Details of the parts relevant to the question_answer. + description: Parts to which the incident is applicable to. items: $ref: '#/components/schemas/part-summary' - question: + artifacts: + type: array + description: Artifacts attached to the incident. + items: + $ref: '#/components/schemas/artifact-summary' + body: type: string - description: The Question. + description: Body of the incident. format: text - sources: + identified_date: + type: string + description: Time when the incident was identified/reported. + example: "2023-01-01T12:00:00.000Z" + format: date-time + impact: + $ref: '#/components/schemas/impacted-customer-details' + mitigated_date: + type: string + description: Timestamp when the incident was mitigated. + example: "2023-01-01T12:00:00.000Z" + format: date-time + owned_by: type: array - description: | - Details of the sources from which the question answer was - generated. + description: The users that own the incident. items: - $ref: '#/components/schemas/atom-summary' - status: - $ref: '#/components/schemas/question-answer-status' - suggested_answer: + $ref: '#/components/schemas/user-summary' + reported_by: + $ref: '#/components/schemas/enum-value' + severity: + $ref: '#/components/schemas/enum-value' + source: + $ref: '#/components/schemas/enum-value' + stage: + $ref: '#/components/schemas/stage' + tags: + type: array + description: Tags associated with the object. + items: + $ref: '#/components/schemas/tag-with-value' + target_close_date: type: string - description: | - An alternative answer suggested by the Q/A generation algorithm. - format: text - suggested_for_deletion: - type: boolean - description: | - Whether the Q/A was marked for deletion by the Q/A generation - algorithm. - topic: + description: Timestamp when the incident is expected to be resolved. + example: "2023-01-01T12:00:00.000Z" + format: date-time + title: type: string - description: The topic to which the QA belongs. + description: Title of the incident. format: text - verified: - type: boolean - description: Whether the Q/A was verified. - title: question-answer - question-answer-status: - type: string - description: Status of the question answer. - enum: - - archived - - discarded - - draft - - published - - review_needed - remove-tag-with-value: + required: + - title + title: incident + instant-evaluation: type: object properties: - id: + at: type: string - description: The ID of the tag. - example: TAG-12345 - format: id - required: - - id - title: remove-tag-with-value - removed-sla-metric-history: - type: object - additionalProperties: false - description: Information about removed metrics. - title: removed-sla-metric-history - resource: - type: object - description: Resource details. - properties: - artifacts: - type: array + description: The time instant evaluated. + example: "2023-01-01T12:00:00.000Z" + format: date-time + definedness: + $ref: '#/components/schemas/definedness' + is_active: + type: boolean description: | - Artifacts of the resource (relevant only for type artifact). - items: - $ref: '#/components/schemas/artifact-summary' - url: + Active state of the organization schedule at the time instant. + next_transition: type: string - description: URL of the resource (relevant only for type url). - format: text - title: resource - rev-org: + description: | + Next instant at which the active state of the organization schedule + changes, for example, if the schedule is currently off, the next + instant at which it will be on. + example: "2023-01-01T12:00:00.000Z" + format: date-time + required: + - at + - definedness + title: instant-evaluation + issue: allOf: - - $ref: '#/components/schemas/org-base' + - $ref: '#/components/schemas/work-base' - type: object properties: - description: - type: string - description: Description of the Rev organization. - format: text - domain: - type: string - deprecated: true - description: Company's domain name. Example - 'devrev.ai'. - format: text - external_ref: + developed_with: + type: array + description: Parts associated based on git events. + items: + $ref: '#/components/schemas/part-summary' + priority: + $ref: '#/components/schemas/issue-priority' + priority_v2: + $ref: '#/components/schemas/enum-value' + sla_summary: + $ref: '#/components/schemas/archetype-sla-summary' + sla_tracker: + $ref: '#/components/schemas/sla-tracker-summary' + sprint: + $ref: '#/components/schemas/vista-group-item-summary' + target_start_date: type: string - description: | - External ref is a unique identifier for the Rev (customer) - organization from your primary customer system of records. If none - is specified, a system-generated identifier will be assigned to the - organization. - format: text - title: rev-org - rev-org-summary: + description: Target start date for the object. + example: "2023-01-01T12:00:00.000Z" + format: date-time + title: issue + issue-priority: + type: string + description: Priority of the work based upon impact and criticality. + enum: + - p0 + - p1 + - p2 + - p3 + issue-summary: allOf: - - $ref: '#/components/schemas/org-base-summary' - title: rev-org-summary - rev-orgs-create-request: + - $ref: '#/components/schemas/work-base-summary' + - type: object + properties: + priority: + $ref: '#/components/schemas/issue-priority' + priority_v2: + $ref: '#/components/schemas/enum-value-summary' + sprint: + $ref: '#/components/schemas/vista-group-item-summary' + title: issue-summary + job-history-item: type: object - description: | - Request object to create a new Rev organization in the Dev - organization. + description: Defines a job history line item. properties: - account: + employment_status: + $ref: '#/components/schemas/enum-value' + end_date: type: string - description: Account Id to associate with this Rev organization. - example: ACC-12345 - format: id - description: + description: The end date of the job, or not specified if current. + example: "2023-01-01T12:00:00.000Z" + format: date-time + is_current: + type: boolean + description: Is this the current active job for the user. + location: type: string - description: Description of the Rev organization. + description: The job location for the user. format: text - display_name: + start_date: type: string - description: Name of the Rev organization. + description: The start date of the job. + example: "2023-01-01T12:00:00.000Z" + format: date-time + title: + type: string + description: The job title for the user. format: text - domain: + title: job-history-item + keyrings-create-callback-request: + type: object + properties: + code: type: string - deprecated: true - description: Company's domain name. Example - 'devrev.ai'. + description: Code to exchange for an access token. format: text - environment: - $ref: '#/components/schemas/org-environment' - external_ref: + state: type: string - description: | - External ref is a custom unique identifier which is a reference to - an unique id for this organization's data in some system of - records. + description: State value given to the authorization request. format: text - tier: + required: + - code + - state + title: keyrings-create-callback-request + legacy-stage: + type: object + description: Describes the current stage of a work item. + properties: + name: type: string - description: The tier of the RevOrg. + description: Current stage name of the work item. format: text required: - - account - - display_name - title: rev-orgs-create-request - rev-orgs-create-response: + - name + title: legacy-stage + legacy-stage-summary: type: object - description: | - Response object for request to create a new Rev organization. + description: Describes the current stage of a work item. properties: - rev_org: - $ref: '#/components/schemas/rev-org' + name: + type: string + description: Current stage name of the work item. + format: text + required: + - name + title: legacy-stage-summary + lines-of-code: + type: object + description: Details of lines of code in this code change. + properties: + file_count: + type: integer + description: Count of files involved in this code change. + format: int64 + lines_added: + type: integer + description: Number of new lines added in this code change. + format: int64 + lines_deleted: + type: integer + description: Number of lines deleted in this code change. + format: int64 + lines_modified: + type: integer + description: Number of lines modified in this code change. + format: int64 + title: lines-of-code + link: + allOf: + - $ref: '#/components/schemas/atom-base' + - type: object + properties: + link_type: + $ref: '#/components/schemas/link-type' + source: + $ref: '#/components/schemas/link-endpoint-summary' + target: + $ref: '#/components/schemas/link-endpoint-summary' + required: + - link_type + - source + - target + title: link + link-endpoint-summary: + type: object + discriminator: + mapping: + capability: '#/components/schemas/capability-summary' + conversation: '#/components/schemas/conversation-summary' + dev_user: '#/components/schemas/dev-user-summary' + enhancement: '#/components/schemas/enhancement-summary' + feature: '#/components/schemas/feature-summary' + issue: '#/components/schemas/issue-summary' + product: '#/components/schemas/product-summary' + rev_org: '#/components/schemas/rev-org-summary' + rev_user: '#/components/schemas/rev-user-summary' + ticket: '#/components/schemas/ticket-summary' + propertyName: type + oneOf: + - $ref: '#/components/schemas/capability-summary' + - $ref: '#/components/schemas/conversation-summary' + - $ref: '#/components/schemas/dev-user-summary' + - $ref: '#/components/schemas/enhancement-summary' + - $ref: '#/components/schemas/feature-summary' + - $ref: '#/components/schemas/issue-summary' + - $ref: '#/components/schemas/product-summary' + - $ref: '#/components/schemas/rev-org-summary' + - $ref: '#/components/schemas/rev-user-summary' + - $ref: '#/components/schemas/ticket-summary' + properties: + type: + $ref: '#/components/schemas/link-endpoint-type' required: + - type + title: link-endpoint-summary + link-endpoint-type: + type: string + enum: + - capability + - conversation + - dev_user + - enhancement + - feature + - issue + - product - rev_org - title: rev-orgs-create-response - x-go-name: RevOrgsCreateResponseBody - rev-orgs-delete-request: + - rev_user + - ticket + link-summary: + allOf: + - $ref: '#/components/schemas/atom-base-summary' + - type: object + properties: + link_type: + $ref: '#/components/schemas/link-type' + source: + $ref: '#/components/schemas/link-endpoint-summary' + target: + $ref: '#/components/schemas/link-endpoint-summary' + required: + - link_type + - source + - target + title: link-summary + link-type: + type: string + description: Type of link used to define the relationship. + enum: + - custom_link + - developed_with + - imports + - is_analyzed_by + - is_converted_to + - is_dependent_on + - is_duplicate_of + - is_follow_up_of + - is_merged_into + - is_parent_of + - is_part_of + - is_related_to + - serves + links-create-request: type: object - description: Request object to delete a Rev organization. + description: The request to create a new link. + properties: + custom_link_type: + type: string + description: The ID of the custom link type. + format: id + link_type: + $ref: '#/components/schemas/link-type' + source: + type: string + description: The ID of the source object. + format: id + target: + type: string + description: The ID of the target object. + format: id + required: + - link_type + - source + - target + title: links-create-request + links-create-response: + type: object + description: The response to creating a new link. + properties: + link: + $ref: '#/components/schemas/link' + required: + - link + title: links-create-response + x-go-name: LinksCreateResponseBody + links-delete-request: + type: object + description: The request to delete a link. properties: id: type: string - description: The ID of Rev organization to delete. - example: REV-AbCdEfGh + description: The ID of the link to delete. format: id required: - id - title: rev-orgs-delete-request - rev-orgs-delete-response: + title: links-delete-request + links-delete-response: type: object additionalProperties: false - description: The response to deleting a Rev organization. - title: rev-orgs-delete-response - x-go-name: RevOrgsDeleteResponseBody - rev-orgs-get-request: + description: The response for deleting a link. + title: links-delete-response + x-go-name: LinksDeleteResponseBody + links-direction: + type: string + description: | + The direction of link, which can either be outbound such that the + object is the source of the link, otherwise inbound where the object is + the target of the link. + enum: + - is_source + - is_target + links-get-request: type: object - description: Request object to get Rev organization's information. + description: The request to get a link's information. properties: - account: - type: string - description: | - The ID of account for which default Rev organization is to be - fetched. - example: ACC-12345 - format: id id: type: string - description: The ID of the required Rev organization. - example: REV-AbCdEfGh + description: The requested link's ID. format: id - title: rev-orgs-get-request - rev-orgs-get-response: + required: + - id + title: links-get-request + links-get-response: type: object - description: The response to getting a Rev organization's information. + description: The response to getting a link's information. properties: - rev_org: - $ref: '#/components/schemas/rev-org' + link: + $ref: '#/components/schemas/link' required: - - rev_org - title: rev-orgs-get-response - x-go-name: RevOrgsGetResponseBody - rev-orgs-list-request: + - link + title: links-get-response + x-go-name: LinksGetResponseBody + links-list-request: type: object - description: | - A request to get the list of Rev organizations for the authenticated - user's Dev organization. + description: The request to get information about a list of links. properties: - created_by: - type: array - description: Filters by creator. - items: - type: string - format: id - created_date: - $ref: '#/components/schemas/date-time-filter' cursor: type: string description: | The cursor to resume iteration from. If not provided, then iteration starts from the beginning. format: text - display_name: + direction: + $ref: '#/components/schemas/links-direction' + limit: + type: integer + description: | + The maximum number of links to return. If not set, then the default + is '50'. + format: int32 + link_type: type: array - description: Array of display names of Rev orgs to be filtered. - items: - type: string - format: text - external_ref: - type: array - description: List of external refs to filter Rev organizations for. - items: - type: string - format: text - limit: - type: integer description: | - The maximum number of Rev organizations to be retrieved per page. - format: int32 + The link type(s) to filter for, otherwise if not present, all link + types are included. + items: + $ref: '#/components/schemas/link-type' mode: $ref: '#/components/schemas/list-mode' - modified_date: - $ref: '#/components/schemas/date-time-filter' - sort_by: + object: + type: string + description: The ID of the object to list the links for. + format: id + object_types: type: array description: | - Fields to sort the Rev organizations by and the direction to sort - them. + The object types to filter for, otherwise if not present, all + object types are included. items: - type: string - format: sort-by - title: rev-orgs-list-request - rev-orgs-list-response: + $ref: '#/components/schemas/link-endpoint-type' + types: + type: array + deprecated: true + description: | + The link types to filter for, otherwise if not present, all link + types are included. + items: + $ref: '#/components/schemas/link-type' + required: + - object + title: links-list-request + links-list-response: type: object - description: | - The response to getting a list of Rev organizations' information. + description: The response to listing the links. properties: + links: + type: array + description: The list of links. + items: + $ref: '#/components/schemas/link' next_cursor: type: string description: | @@ -7369,289 +7912,379 @@ components: The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. format: text - rev_orgs: - type: array - description: List with all of the Rev organizations' information. - items: - $ref: '#/components/schemas/rev-org' required: - - rev_orgs - title: rev-orgs-list-response - x-go-name: RevOrgsListResponseBody - rev-orgs-update-request: + - links + title: links-list-response + x-go-name: LinksListResponseBody + links-replace-request: type: object - description: | - Request object to update information of the Rev organization. + description: The request to replace a link. properties: - description: - type: string - description: Description of the Rev organization. - format: text - display_name: - type: string - description: Customer chosen name for the Rev organization. - format: text - domain: - type: string - deprecated: true - description: Company's domain name. Example - 'devrev.ai'. - format: text - environment: - $ref: '#/components/schemas/org-environment' - external_ref: - type: string - description: | - External ref is a custom unique identifier which is a reference to - an unique id for this organization's data in some system of - records. - format: text id: type: string - description: The ID of Rev organization to update. - example: REV-AbCdEfGh + description: The ID of the link to be replaced. format: id - tier: + link_type: + $ref: '#/components/schemas/link-type' + source: type: string - description: The tier of the RevOrg. - format: text + description: The ID of the source object. + format: id + target: + type: string + description: The ID of the target object. + format: id required: - id - title: rev-orgs-update-request - rev-orgs-update-response: + - link_type + - source + - target + title: links-replace-request + links-replace-response: type: object - description: Response object to updating Rev organization's information. + description: The response to replacing a link. properties: - rev_org: - $ref: '#/components/schemas/rev-org' + link: + $ref: '#/components/schemas/link' required: - - rev_org - title: rev-orgs-update-response - x-go-name: RevOrgsUpdateResponseBody - rev-user: - allOf: - - $ref: '#/components/schemas/user-base' - - type: object - properties: - description: - type: string - description: Description of the Rev user. - format: text - external_ref: - type: string - description: | - 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. - format: text - rev_org: - $ref: '#/components/schemas/org-summary' - title: rev-user - rev-user-summary: + - link + title: links-replace-response + x-go-name: LinksReplaceResponseBody + list-mode: + type: string + description: | + The iteration mode to use. If "after", then entries after the provided + cursor will be returned, or if no cursor is provided, then from the + beginning. If "before", then entries before the provided cursor will be + returned, or if no cursor is provided, then from the end. Entries will + always be returned in the specified sort-by order. + enum: + - after + - before + meeting: allOf: - - $ref: '#/components/schemas/user-base-summary' - - type: object - properties: - external_ref: - type: string - description: | - 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. - format: text - rev_org: - $ref: '#/components/schemas/org-summary' - title: rev-user-summary - rev-users-create-request: + - $ref: '#/components/schemas/atom-base' + title: meeting + meeting-channel: + type: string + description: The channel of meeting. + enum: + - amazon_connect + - google_meet + - offline + - other + - teams + - zoom + meeting-state: + type: string + description: The state of meeting. + enum: + - canceled + - completed + - no_show + - ongoing + - rejected + - rescheduled + - scheduled + - waiting + meetings-count-request: type: object - description: | - Request object to create a new Rev user for a Rev organization. properties: - custom_schema_fragments: + channel: + type: array + description: Filters for meeting on specified channels. + items: + $ref: '#/components/schemas/meeting-channel' + created_by: + type: array + description: Filters for meetings created by the specified user(s). + items: + type: string + format: id + created_date: + $ref: '#/components/schemas/date-filter' + ended_date: + $ref: '#/components/schemas/date-filter' + external_ref: + type: array + description: Filters for meetings with the provided external_ref(s). + items: + type: string + format: text + links: + type: array + description: Filters for links associated with the meeting. + items: + $ref: '#/components/schemas/meetings-filter-link-summary-filter' + members: + type: array + description: Filter for meeting on specified Member Ids. + items: + type: string + format: id + modified_date: + $ref: '#/components/schemas/date-filter' + organizer: + type: array + description: Filter for meeting on specified organizers. + items: + type: string + format: id + parent: type: array deprecated: true - description: The schema fragment IDs associated with the Rev user. + description: Filters for meetings with the provided parent. example: - - don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id + - ACC-12345 items: type: string format: id + scheduled_date: + $ref: '#/components/schemas/date-filter' + state: + type: array + description: Filters for meeting on specified state or outcomes. + items: + $ref: '#/components/schemas/meeting-state' + title: meetings-count-request + meetings-count-response: + type: object + properties: + count: + type: integer + description: The number of meetings matching the filter. + format: int64 + required: + - count + title: meetings-count-response + x-go-name: MeetingsCountResponseBody + meetings-create-request: + type: object + properties: + channel: + $ref: '#/components/schemas/meeting-channel' + custom_fields: + type: object + description: Application-defined custom fields. custom_schema_spec: $ref: '#/components/schemas/custom-schema-spec' description: type: string - description: Description of the Rev user. - format: text - display_name: - type: string - description: | - The user's display name. The name is non-unique and mutable. + description: The description of the meeting. format: text - display_picture: + ended_date: type: string - description: Artifact ID of a Rev user's display picture. - example: ARTIFACT-12345 - format: id - email: + description: Time at which meeting ended. + example: "2023-01-01T12:00:00.000Z" + format: date-time + external_ref: type: string - description: Email address of the Rev user. + description: External reference for the meeting. format: text - external_ref: + external_url: type: string - description: | - External ref is a mutable unique identifier for a user within the - Dev 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. + description: External URL for the meeting. format: text - phone_numbers: + members: type: array - description: Phone numbers, in E.164 format, of the Rev user. + description: IDs of the users that were part of the meeting. + example: + - DEVU-12345 items: type: string - format: text - rev_org: + format: id + maxItems: 800 + minItems: 1 + organizer: type: string description: | - The ID of the Rev organization to which the created Rev user is - associated. - example: REV-AbCdEfGh + The ID of the user who organized the meeting. If not provided, the + creator is set as the organizer. + example: DEVU-12345 format: id - title: rev-users-create-request - rev-users-create-response: + parent: + type: string + deprecated: true + description: The parent object ID in which the meeting was created. + example: ACC-12345 + format: id + recording_url: + type: string + description: The recording URL of the meeting. + format: text + scheduled_date: + type: string + description: The date and time when the meeting was scheduled. + example: "2023-01-01T12:00:00.000Z" + format: date-time + state: + $ref: '#/components/schemas/meeting-state' + tags: + type: array + description: Tags associated with the meeting. + items: + $ref: '#/components/schemas/set-tag-with-value' + title: + type: string + description: The title of the meeting. + format: text + required: + - channel + - members + - state + - title + title: meetings-create-request + meetings-create-response: type: object - description: | - Response object for creating a new Rev user for Rev organization. properties: - rev_user: - $ref: '#/components/schemas/rev-user' + meeting: + $ref: '#/components/schemas/meeting' required: - - rev_user - title: rev-users-create-response - x-go-name: RevUsersCreateResponseBody - rev-users-delete-request: + - meeting + title: meetings-create-response + x-go-name: MeetingsCreateResponseBody + meetings-delete-request: type: object - description: Request object to delete a Rev user. properties: id: type: string - description: The ID of Rev user to delete. + description: The meeting's ID. format: id required: - id - title: rev-users-delete-request - rev-users-delete-response: + title: meetings-delete-request + meetings-delete-response: type: object additionalProperties: false - description: The response to deleting a Rev user of a Rev organization. - title: rev-users-delete-response - x-go-name: RevUsersDeleteResponseBody - rev-users-get-request: + title: meetings-delete-response + x-go-name: MeetingsDeleteResponseBody + meetings-filter-link-summary-filter: + type: object + description: The filter for the link summary. + properties: + link_type: + type: string + description: | + Filters for link type in links associated with the meeting. + format: text + target: + type: string + description: | + Filters for target id in links associated with the meeting. + format: id + target_object_type: + type: string + description: | + Filters for target object type in links associated with the + meeting. + format: text + title: meetings-filter-link-summary-filter + meetings-get-request: type: object - description: Request object to get a Rev user. properties: id: type: string - description: The ID of Rev user to be retrieved. + description: The meeting's ID. format: id required: - id - title: rev-users-get-request - rev-users-get-response: + title: meetings-get-request + meetings-get-response: type: object - description: The returned Rev user. properties: - rev_user: - $ref: '#/components/schemas/rev-user' + meeting: + $ref: '#/components/schemas/meeting' required: - - rev_user - title: rev-users-get-response - x-go-name: RevUsersGetResponseBody - rev-users-list-request: + - meeting + title: meetings-get-response + x-go-name: MeetingsGetResponseBody + meetings-list-request: type: object - description: | - Gets the list of Rev users belonging to the authenticated user's Dev - organization which the user is also authorized to access. properties: - associations: + channel: type: array - description: | - Filters for Rev users with specified associations - (account/workspace). + description: Filters for meeting on specified channels. items: - type: string - format: id + $ref: '#/components/schemas/meeting-channel' created_by: type: array - description: | - Filters for Rev users that were created by the specified user(s). + description: Filters for meetings created by the specified user(s). items: type: string format: id created_date: - $ref: '#/components/schemas/date-time-filter' + $ref: '#/components/schemas/date-filter' cursor: type: string description: | The cursor to resume iteration from. If not provided, then iteration starts from the beginning. format: text - email: - type: array - description: List of emails of Rev users to be filtered. - items: - type: string - format: text + ended_date: + $ref: '#/components/schemas/date-filter' external_ref: type: array - description: List of external refs to filter Rev users for. + description: Filters for meetings with the provided external_ref(s). items: type: string format: text - is_verified: - type: boolean - description: Value of is_verified field to filter the Rev users. limit: type: integer - description: | - The maximum number of Rev users to return. The default is '50'. + description: The maximum number of meetings to return. format: int32 + links: + type: array + description: Filters for links associated with the meeting. + items: + $ref: '#/components/schemas/meetings-filter-link-summary-filter' + members: + type: array + description: Filter for meeting on specified Member Ids. + items: + type: string + format: id mode: $ref: '#/components/schemas/list-mode' modified_date: - $ref: '#/components/schemas/date-time-filter' - phone_numbers: + $ref: '#/components/schemas/date-filter' + organizer: type: array - description: | - List of phone numbers, in E.164 format, to filter Rev users on. + description: Filter for meeting on specified organizers. items: type: string - format: text - rev_org: + format: id + parent: type: array - description: List of IDs of Rev organizations to be filtered. + deprecated: true + description: Filters for meetings with the provided parent. example: - - REV-AbCdEfGh + - ACC-12345 items: type: string format: id + scheduled_date: + $ref: '#/components/schemas/date-filter' sort_by: type: array description: | - Fields to sort the Rev users by and the direction to sort them. + Fields to sort the meetings by and the direction to sort them. items: type: string format: sort-by - title: rev-users-list-request - rev-users-list-response: + state: + type: array + description: Filters for meeting on specified state or outcomes. + items: + $ref: '#/components/schemas/meeting-state' + title: meetings-list-request + meetings-list-response: type: object - description: | - The response to listing all Rev users matching the filter criteria. properties: + meetings: + type: array + description: The list of meetings. + items: + $ref: '#/components/schemas/meeting' next_cursor: type: string description: | @@ -7664,1390 +8297,1779 @@ components: The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. format: text - rev_users: - type: array - description: List containing all the Rev users. - items: - $ref: '#/components/schemas/rev-user' required: - - rev_users - title: rev-users-list-response - x-go-name: RevUsersListResponseBody - rev-users-update-request: + - meetings + title: meetings-list-response + x-go-name: MeetingsListResponseBody + meetings-update-request: type: object - description: Request to update details of a Rev user. properties: + channel: + $ref: '#/components/schemas/meeting-channel' custom_fields: type: object description: Application-defined custom fields. - custom_schema_fragments: - $ref: '#/components/schemas/rev-users-update-request-custom-schema-fragments' custom_schema_spec: $ref: '#/components/schemas/custom-schema-spec' description: type: string - description: Updated description of the Rev user. + description: The description of the meeting. format: text - display_name: + ended_date: type: string - description: Updated display name of the Rev user. + description: Updates the date and time when the meeting ended. + example: "2023-01-01T12:00:00.000Z" + format: date-time + nullable: true + external_ref: + type: string + description: External Reference for the meeting. format: text - display_picture: + external_url: type: string - description: Artifact ID of a Rev user's updated display picture. + description: External URL for the meeting. + format: text + id: + type: string + description: The meetings ID. + format: id + members: + $ref: '#/components/schemas/meetings-update-request-members' + organizer: + type: string + description: The ID of the user who organized the meeting. + example: DEVU-12345 + format: id + recording: + type: string + description: The ID of the meeting's recording artifact. example: ARTIFACT-12345 format: id nullable: true - email: + recording_url: type: string - description: Updated email address of the Rev user. + description: The recording URL of the meeting. format: text - external_ref: + scheduled_date: type: string - description: Updated external ref value of the Rev user. + description: | + Updates the date and time when the meeting was scheduled. + example: "2023-01-01T12:00:00.000Z" + format: date-time + nullable: true + state: + $ref: '#/components/schemas/meeting-state' + tags: + $ref: '#/components/schemas/meetings-update-request-tags' + title: + type: string + description: The title of the meeting. format: text - id: + transcript: type: string - description: The ID of Rev user to update. + description: | + The ID of the artifact for the transcript of the meeting. + example: ARTIFACT-12345 format: id - phone_numbers: - type: array - description: The phone numbers, in E.164 format, of the Rev user. - items: - type: string - format: text required: - id - title: rev-users-update-request - rev-users-update-request-custom-schema-fragments: + title: meetings-update-request + meetings-update-request-members: type: object properties: set: type: array - description: Sets the IDs to the provided schema fragment IDs. + description: | + Sets the members to the provided user IDs. This must not be empty. example: - - don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id + - DEVU-12345 items: type: string format: id - title: rev-users-update-request-custom-schema-fragments - rev-users-update-response: + title: meetings-update-request-members + meetings-update-request-tags: type: object - description: Updated Rev user object. properties: - rev_user: - $ref: '#/components/schemas/rev-user' + set: + type: array + description: Sets the provided tags on the meeting item. + items: + $ref: '#/components/schemas/set-tag-with-value' + title: meetings-update-request-tags + meetings-update-response: + type: object + properties: + meeting: + $ref: '#/components/schemas/meeting' + required: + - meeting + title: meetings-update-response + x-go-name: MeetingsUpdateResponseBody + member-summary: + type: object + discriminator: + mapping: + dev_user: '#/components/schemas/dev-user-summary' + group: '#/components/schemas/group-summary' + rev_user: '#/components/schemas/rev-user-summary' + sys_user: '#/components/schemas/sys-user-summary' + propertyName: type + oneOf: + - $ref: '#/components/schemas/dev-user-summary' + - $ref: '#/components/schemas/group-summary' + - $ref: '#/components/schemas/rev-user-summary' + - $ref: '#/components/schemas/sys-user-summary' + properties: + type: + $ref: '#/components/schemas/member-type' required: + - type + title: member-summary + member-type: + type: string + enum: + - dev_user + - group - rev_user - title: rev-users-update-response - x-go-name: RevUsersUpdateResponseBody - saml-connection-fields-map: + - sys_user + metric-action-execute-request: type: object properties: - email: + action: + $ref: '#/components/schemas/metric-action-execute-request-action' + event_date: + type: string + description: Timestamp of the event. + example: "2023-01-01T12:00:00.000Z" + format: date-time + metric: type: string description: | - Claims in the SAML assertion returned by the identity provider that - map to the email address of the user. - format: text - user_id: + The metric's ID for which the metric action is to be executed. + format: id + object: type: string description: | - Claims in the SAML assertion returned by the identity provider that - map to the user ID of the user. - format: text - title: saml-connection-fields-map - schema-bool-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - default_value: - type: boolean - description: Default value. - title: schema-bool-field-descriptor - schema-bool-list-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - default_value: - type: array - description: Default value. - items: - type: boolean - title: schema-bool-list-field-descriptor - schema-composite-field-descriptor: + The underlying object's ID on which the metric action is to be + executed. + format: id + required: + - action + - event_date + - metric + - object + title: metric-action-execute-request + metric-action-execute-request-action: + type: string + enum: + - complete + - pause + - restart + - resume + - start + metric-action-execute-response: + type: object + additionalProperties: false + title: metric-action-execute-response + x-go-name: MetricActionExecuteResponseBody + metric-definition: allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' + - $ref: '#/components/schemas/atom-base' - type: object properties: - composite_type: + name: type: string - description: Composite type. Required when field type is composite. + description: Human readable name of the metric. format: text - title: schema-composite-field-descriptor - schema-composite-list-field-descriptor: + title: metric-definition + metric-definition-applies-to: + type: string + description: The list of item types on which the metric might be applied. + enum: + - conversation + - issue + - ticket + metric-definition-metric-type: + type: string + description: | + The type of the metric. 'time' metrics track the time spent in some + state, supporting operations like 'start', 'stop', 'pause', 'resume'. + 'value' metrics track a value, supporting operations like 'set', + 'increment', 'decrement'. + enum: + - time + - value + metric-definition-status: + type: string + description: | + The status of the metric. 'active' metrics can be used to create new + SLAs, while 'inactive' metrics can not be used in new SLAs. Metrics can + be updated between 'active' and 'inactive' states. + enum: + - active + - inactive + metric-definition-summary: allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' + - $ref: '#/components/schemas/atom-base-summary' - type: object properties: - composite_type: + name: type: string - description: Composite type. Required when field type is composite. + description: Human readable name of the metric. format: text - title: schema-composite-list-field-descriptor - schema-date-field-descriptor: + title: metric-definition-summary + metric-definitions-create-request: + type: object + properties: + applies_to: + type: array + description: | + The list of object types on which the metric can be applied. + items: + $ref: '#/components/schemas/metric-definition-applies-to' + description: + type: string + description: Description of the purpose and operation of the metric. + format: text + maxLength: 1024 + name: + type: string + description: A unique human readable name of the metric. + format: text + maxLength: 64 + minLength: 1 + required: + - applies_to + - name + title: metric-definitions-create-request + metric-definitions-create-response: + type: object + properties: + metric_definition: + $ref: '#/components/schemas/metric-definition' + required: + - metric_definition + title: metric-definitions-create-response + x-go-name: MetricDefinitionsCreateResponseBody + metric-definitions-delete-request: + type: object + properties: + id: + type: string + description: The ID of the metric definition to be deleted. + format: id + required: + - id + title: metric-definitions-delete-request + metric-definitions-delete-response: + type: object + additionalProperties: false + description: The response to deleting a metric definition. + title: metric-definitions-delete-response + x-go-name: MetricDefinitionsDeleteResponseBody + metric-definitions-get-request: + type: object + properties: + id: + type: string + description: The ID of the metric definition to get. + format: id + name: + type: string + description: The unique human readable name of the metric. + format: text + maxLength: 64 + minLength: 1 + title: metric-definitions-get-request + metric-definitions-get-response: + type: object + properties: + metric_definition: + $ref: '#/components/schemas/metric-definition' + required: + - metric_definition + title: metric-definitions-get-response + x-go-name: MetricDefinitionsGetResponseBody + metric-definitions-list-request: + type: object + properties: + type: + type: array + description: The type of metric definitions sought. + items: + $ref: '#/components/schemas/metric-definition-metric-type' + applies_to_type: + type: array + description: The type of objects the metric definition applies to. + items: + $ref: '#/components/schemas/metric-definition-applies-to' + cursor: + type: string + description: | + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. + format: text + include_custom_metrics: + type: boolean + description: | + Whether to include custom metrics in the response. If not set, then + custom metrics are excluded. + limit: + type: integer + description: | + The maximum number of records to return. The default is '50'. + format: int32 + mode: + $ref: '#/components/schemas/list-mode' + sort_by: + type: array + description: | + Fields to sort the records by and the direction to sort them. + items: + type: string + format: sort-by + status: + type: array + description: The status of the metric definition. + items: + $ref: '#/components/schemas/metric-definition-status' + title: metric-definitions-list-request + metric-definitions-list-response: + type: object + properties: + metric_definitions: + type: array + description: The list of metric definitions. + items: + $ref: '#/components/schemas/metric-definition' + next_cursor: + type: string + description: | + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. + format: text + prev_cursor: + type: string + description: | + The cursor used to iterate preceding results in accordance to the + sort order. If not set, then no prior elements exist. + format: text + required: + - metric_definitions + title: metric-definitions-list-response + x-go-name: MetricDefinitionsListResponseBody + metric-definitions-update-request: + type: object + properties: + description: + type: string + description: | + The updated description of the purpose and operation of the metric. + format: text + maxLength: 1024 + id: + type: string + description: The ID of the metric definition to update. + format: id + name: + type: string + description: The updated unique human readable name of the metric. + format: text + maxLength: 64 + minLength: 1 + status: + $ref: '#/components/schemas/metric-definition-status' + required: + - id + title: metric-definitions-update-request + metric-definitions-update-response: + type: object + properties: + metric_definition: + $ref: '#/components/schemas/metric-definition' + required: + - metric_definition + title: metric-definitions-update-response + x-go-name: MetricDefinitionsUpdateResponseBody + metric-tracker: + type: object + discriminator: + propertyName: type + properties: + type: + $ref: '#/components/schemas/metric-tracker-type' + required: + - type + title: metric-tracker + metric-tracker-type: + type: string + metric-trackers-get-request: + type: object + properties: + metric: + type: string + description: The ID of the metric that is being tracked. + format: id + object: + type: string + description: | + The ID of the underlying object on which the metric is being + tracked. + format: id + required: + - metric + - object + title: metric-trackers-get-request + metric-trackers-get-response: + type: object + properties: + metric_tracker: + $ref: '#/components/schemas/metric-tracker' + required: + - metric_tracker + title: metric-trackers-get-response + x-go-name: MetricTrackersGetResponseBody + org-base: allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' + - $ref: '#/components/schemas/atom-base' - type: object properties: - default_value: + display_name: type: string - description: Default value. + description: Name of the Organization. format: text - title: schema-date-field-descriptor - schema-date-list-field-descriptor: + title: org-base + org-base-summary: allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' + - $ref: '#/components/schemas/atom-base-summary' - type: object properties: - default_value: - type: array - description: Default value. - items: - type: string - format: text - title: schema-date-list-field-descriptor - schema-double-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - default_value: - type: number - description: Default value. - format: double - title: schema-double-field-descriptor - schema-double-list-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - default_value: - type: array - description: Default value. - items: - type: number - format: double - title: schema-double-list-field-descriptor - schema-enum-field-descriptor: + display_name: + type: string + description: Name of the Organization. + format: text + title: org-base-summary + org-environment: + type: string + description: | + The environment of the Org. Defaults to 'production' if not specified. + enum: + - production + - staging + - test + org-schedule: allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' + - $ref: '#/components/schemas/atom-base' - type: object properties: - allowed_values: + default_weekly_org_schedule: + $ref: '#/components/schemas/weekly-org-schedule' + min_valid_days: + type: integer + description: | + The schedule must be valid and well-defined for at least this many + days in the future, otherwise a warning notification is generated. + Default is 0 if not specified. + format: int32 + name: + type: string + description: Human-readable name. + format: text + org_schedule_fragments: type: array - description: Allowed values for the field. + description: | + The list of schedule fragments. It must be an ordered list of + contiguous fragments (the next starting when the previous one + ends), updates in a published schedule are only allowed to add new + ones to the future. items: - type: string - format: text - default_value: + $ref: '#/components/schemas/org-schedule-fragment-overview' + status: + $ref: '#/components/schemas/org-schedule-status' + timezone: type: string - description: Default value. + description: | + Timezone in which this is defined. Only organization schedules in + the same timezone can be directly combined. format: text - is_overridable: - type: boolean - description: Whether the enum is overridable. - translated_values: - type: object - additionalProperties: - type: string - format: text - description: Translations for allowed_values field. + valid_until: + type: string + description: | + Derived field indicating when a valid organization schedule will + become invalid. If omitted, the schedule is already invalid. A + schedule is valid if it has a weekly schedule for all named periods + for all its schedule fragments, and if it has a schedule fragment + for the time period in question. + example: "2023-01-01T12:00:00.000Z" + format: date-time + weekly_org_schedules: + type: array + description: | + If the organization schedule fragment specifies that the given day + belongs to a named period, a weekly schedule from this list with + the matching name will be selected. + items: + $ref: '#/components/schemas/weekly-org-schedule' required: - - allowed_values - title: schema-enum-field-descriptor - schema-enum-list-field-descriptor: + - status + title: org-schedule + org-schedule-fragment: allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' + - $ref: '#/components/schemas/atom-base' - type: object properties: - allowed_values: + from: + type: string + description: | + The date (inclusive) on which the organization schedule fragment + begins. + example: "2023-01-01T12:00:00.000Z" + format: date-time + intervals: type: array - description: Allowed values for the field. + description: | + Periods during which the schedule is considered to be 'off' or to + be in some specific named period. items: - type: string - format: text - default_value: + $ref: '#/components/schemas/org-schedule-interval' + name: + type: string + description: | + Human-readable name, indicating the purpose of the schedule. + format: text + region_codes: type: array - description: Default value. + description: | + CLDR region code of the countries/regions it is meant to be valid + for. Does not drive logic, serves only for easier filtering and + organization. items: type: string format: text - is_overridable: - type: boolean - description: Whether the enum is overridable. - translated_values: - type: object - additionalProperties: - type: string - format: text - description: Translations for allowed_values field. + status: + $ref: '#/components/schemas/org-schedule-fragment-status' + to: + type: string + description: | + The date (exclusive) on which the organization schedule fragment's + validity ends. + example: "2023-01-01T12:00:00.000Z" + format: date-time required: - - allowed_values - title: schema-enum-list-field-descriptor - schema-field-descriptor: - type: object - description: Set of field attributes. - discriminator: - mapping: - array: '#/components/schemas/schema-field-descriptor-array-type' - bool: '#/components/schemas/schema-bool-field-descriptor' - composite: '#/components/schemas/schema-composite-field-descriptor' - date: '#/components/schemas/schema-date-field-descriptor' - double: '#/components/schemas/schema-double-field-descriptor' - enum: '#/components/schemas/schema-enum-field-descriptor' - id: '#/components/schemas/schema-id-field-descriptor' - int: '#/components/schemas/schema-int-field-descriptor' - json_value: '#/components/schemas/schema-json-value-field-descriptor' - rich_text: '#/components/schemas/schema-rich-text-field-descriptor' - struct: '#/components/schemas/schema-struct-field-descriptor' - text: '#/components/schemas/schema-text-field-descriptor' - timestamp: '#/components/schemas/schema-timestamp-field-descriptor' - tokens: '#/components/schemas/schema-tokens-field-descriptor' - uenum: '#/components/schemas/schema-uenum-field-descriptor' - unknown: '#/components/schemas/schema-unknown-field-descriptor' - propertyName: field_type - oneOf: - - $ref: '#/components/schemas/schema-bool-field-descriptor' - - $ref: '#/components/schemas/schema-composite-field-descriptor' - - $ref: '#/components/schemas/schema-date-field-descriptor' - - $ref: '#/components/schemas/schema-double-field-descriptor' - - $ref: '#/components/schemas/schema-enum-field-descriptor' - - $ref: '#/components/schemas/schema-field-descriptor-array-type' - - $ref: '#/components/schemas/schema-id-field-descriptor' - - $ref: '#/components/schemas/schema-int-field-descriptor' - - $ref: '#/components/schemas/schema-json-value-field-descriptor' - - $ref: '#/components/schemas/schema-rich-text-field-descriptor' - - $ref: '#/components/schemas/schema-struct-field-descriptor' - - $ref: '#/components/schemas/schema-text-field-descriptor' - - $ref: '#/components/schemas/schema-timestamp-field-descriptor' - - $ref: '#/components/schemas/schema-tokens-field-descriptor' - - $ref: '#/components/schemas/schema-uenum-field-descriptor' - - $ref: '#/components/schemas/schema-unknown-field-descriptor' - properties: - field_type: - $ref: '#/components/schemas/schema-field-descriptor-field-type' - required: - - field_type - title: schema-field-descriptor - schema-field-descriptor-array-type: + - status + title: org-schedule-fragment + org-schedule-fragment-overview: type: object - discriminator: - mapping: - bool: '#/components/schemas/schema-bool-list-field-descriptor' - composite: '#/components/schemas/schema-composite-list-field-descriptor' - date: '#/components/schemas/schema-date-list-field-descriptor' - double: '#/components/schemas/schema-double-list-field-descriptor' - enum: '#/components/schemas/schema-enum-list-field-descriptor' - id: '#/components/schemas/schema-id-list-field-descriptor' - int: '#/components/schemas/schema-int-list-field-descriptor' - json_value: '#/components/schemas/schema-json-value-list-field-descriptor' - rich_text: '#/components/schemas/schema-rich-text-list-field-descriptor' - struct: '#/components/schemas/schema-struct-list-field-descriptor' - text: '#/components/schemas/schema-text-list-field-descriptor' - timestamp: '#/components/schemas/schema-timestamp-list-field-descriptor' - tokens: '#/components/schemas/schema-tokens-list-field-descriptor' - uenum: '#/components/schemas/schema-uenum-list-field-descriptor' - propertyName: base_type - oneOf: - - $ref: '#/components/schemas/schema-bool-list-field-descriptor' - - $ref: '#/components/schemas/schema-composite-list-field-descriptor' - - $ref: '#/components/schemas/schema-date-list-field-descriptor' - - $ref: '#/components/schemas/schema-double-list-field-descriptor' - - $ref: '#/components/schemas/schema-enum-list-field-descriptor' - - $ref: '#/components/schemas/schema-id-list-field-descriptor' - - $ref: '#/components/schemas/schema-int-list-field-descriptor' - - $ref: '#/components/schemas/schema-json-value-list-field-descriptor' - - $ref: '#/components/schemas/schema-rich-text-list-field-descriptor' - - $ref: '#/components/schemas/schema-struct-list-field-descriptor' - - $ref: '#/components/schemas/schema-text-list-field-descriptor' - - $ref: '#/components/schemas/schema-timestamp-list-field-descriptor' - - $ref: '#/components/schemas/schema-tokens-list-field-descriptor' - - $ref: '#/components/schemas/schema-uenum-list-field-descriptor' - properties: - base_type: - $ref: '#/components/schemas/schema-field-descriptor-array-type-base-type' - eq_items: - type: integer - description: The exact array length. - format: int64 - max_items: - type: integer - description: The maximum array length. - format: int64 - min_items: - type: integer - description: The minimum array length. - format: int64 - required: - - base_type - title: schema-field-descriptor-array-type - schema-field-descriptor-array-type-base-type: + additionalProperties: false + description: | + The representation of the organization schedule fragment embedded + inside a organization schedule, used to quickly look up the schedule + fragment for the right period. + title: org-schedule-fragment-overview + org-schedule-fragment-status: type: string + description: | + Status determines how an item can be used. In 'draft' status an item + can be edited but can't be used. When 'published' the item can longer + be edited but can be used. 'Archived' is read-only. enum: - - bool - - composite - - date - - double - - enum - - id - - int - - json_value - - rich_text - - struct - - text - - timestamp - - tokens - - uenum - schema-field-descriptor-base: + - archived + - draft + - published + org-schedule-fragments-create-request: type: object properties: - description: + from: type: string - description: Description of the field. - format: text - is_filterable: - type: boolean description: | - Whether this field is filterable, groupable and sortable. - is_immutable: - type: boolean - description: Whether this field is immutable or not. - is_pii: - type: boolean - description: | - Whether this field can hold Personally Identifiable Information - (PII). - is_required: - type: boolean - description: Whether this field is required or not. - mfz: - $ref: '#/components/schemas/schema-field-mfz-metadata' + Date (inclusive) on which the organization schedule fragment + begins. + example: "2023-01-01T12:00:00.000Z" + format: date-time + intervals: + type: array + description: The intervals that comprise the schedule fragment. + items: + $ref: '#/components/schemas/create-org-schedule-interval' name: type: string - description: Name of the field. + description: Name of the organization schedule fragment. format: text - oasis: - $ref: '#/components/schemas/schema-field-oasis-metadata' - origin: + region_codes: + type: array + description: | + CLDR region code of the countries/regions it is meant to be valid + for. Does not drive logic, serves only for easier filtering and + organization. + items: + type: string + format: text + to: type: string - description: Type this field is from. - format: text - ui: - $ref: '#/components/schemas/schema-field-ui-metadata' + description: | + Date (exclusive) on which the organization schedule fragment's + validity ends. + example: "2023-01-01T12:00:00.000Z" + format: date-time required: + - from + - intervals - name - title: schema-field-descriptor-base - schema-field-descriptor-field-type: - type: string - enum: - - array - - bool - - composite - - date - - double - - enum + - to + title: org-schedule-fragments-create-request + org-schedule-fragments-create-response: + type: object + properties: + org_schedule_fragment: + $ref: '#/components/schemas/org-schedule-fragment' + required: + - org_schedule_fragment + title: org-schedule-fragments-create-response + x-go-name: OrgScheduleFragmentsCreateResponseBody + org-schedule-fragments-get-request: + type: object + properties: + id: + type: string + description: Organization schedule Fragment ID. + format: id + required: - id - - int - - json_value - - rich_text - - struct - - text - - timestamp - - tokens - - uenum - - unknown - schema-field-mfz-metadata: + title: org-schedule-fragments-get-request + org-schedule-fragments-get-response: type: object - additionalProperties: false - description: The schema of MFZ specific fields. - title: schema-field-mfz-metadata - schema-field-oasis-metadata: + properties: + org_schedule_fragment: + $ref: '#/components/schemas/org-schedule-fragment' + required: + - org_schedule_fragment + title: org-schedule-fragments-get-response + x-go-name: OrgScheduleFragmentsGetResponseBody + org-schedule-fragments-transition-request: type: object - additionalProperties: false - description: The schema of oasis specific fields. - title: schema-field-oasis-metadata - schema-field-uenum-value: + properties: + id: + type: string + description: Organization schedule Fragment ID. + format: id + status: + $ref: '#/components/schemas/org-schedule-fragment-status' + required: + - id + - status + title: org-schedule-fragments-transition-request + org-schedule-fragments-transition-response: type: object - additionalProperties: false - description: A unified enum value. - title: schema-field-uenum-value - schema-field-ui-metadata: + properties: + org_schedule_fragment: + $ref: '#/components/schemas/org-schedule-fragment' + required: + - org_schedule_fragment + title: org-schedule-fragments-transition-response + x-go-name: OrgScheduleFragmentsTransitionResponseBody + org-schedule-interval: type: object additionalProperties: false - description: The schema of ui specific fields. - title: schema-field-ui-metadata - schema-id-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - default_value: - type: string - description: Default value. - format: id - id_type: - type: array - description: Object ID types. Required when field type is ID. - items: - type: string - format: text - title: schema-id-field-descriptor - schema-id-list-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - default_value: - type: array - description: Default value. - items: - type: string - format: id - id_type: - type: array - description: Object ID types. Required when field type is ID. - items: - type: string - format: text - title: schema-id-list-field-descriptor - schema-int-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - default_value: - type: integer - description: Default value. - format: int64 - gt: - type: integer - description: The minimum value for the integer (exclusive). - format: int64 - gte: - type: integer - description: The minimum value for the integer (inclusive). - format: int64 - lt: - type: integer - description: The maximum value for the integer (exclusive). - format: int64 - lte: - type: integer - description: The maximum value for the integer (inclusive). - format: int64 - title: schema-int-field-descriptor - schema-int-list-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - default_value: - type: array - description: Default value. - items: - type: integer - format: int64 - gt: - type: integer - description: The minimum value for the integer (exclusive). - format: int64 - gte: - type: integer - description: The minimum value for the integer (inclusive). - format: int64 - lt: - type: integer - description: The maximum value for the integer (exclusive). - format: int64 - lte: - type: integer - description: The maximum value for the integer (inclusive). - format: int64 - title: schema-int-list-field-descriptor - schema-json-value-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - default_value: - description: Default value. - title: schema-json-value-field-descriptor - schema-json-value-list-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - default_value: - type: array - description: Default value. - items: {} - title: schema-json-value-list-field-descriptor - schema-rich-text-field-descriptor: + description: An optionally named period on day granularity. + title: org-schedule-interval + org-schedule-status: + type: string + description: | + Status determines how an item can be used. In 'draft' status an item + can be edited but can't be used. When 'published' the item can longer + be edited but can be used. 'Archived' is read-only. + enum: + - archived + - draft + - published + org-schedule-summary: allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' + - $ref: '#/components/schemas/atom-base-summary' - type: object properties: - contains: - type: string - description: The contained substring. - format: text - default_value: - type: string - description: Default value. - format: text - eq_len: - type: integer - description: The exact string length. - format: int64 - max_len: - type: integer - description: The maximum string length. - format: int64 - min_len: - type: integer - description: The minimum string length. - format: int64 - pattern: - type: string - description: The string pattern (regular expression). - format: text - prefix: + name: type: string - description: The string prefix. + description: Human-readable name. format: text - suffix: + status: + $ref: '#/components/schemas/org-schedule-status' + timezone: type: string - description: The string suffix. + description: | + Timezone in which this is defined. Only organization schedules in + the same timezone can be directly combined. format: text - title: schema-rich-text-field-descriptor - schema-rich-text-list-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - contains: + valid_until: type: string - description: The contained substring. - format: text - default_value: - type: array - description: Default value. - items: - type: string - format: text - eq_len: - type: integer - description: The exact string length. - format: int64 - max_len: - type: integer - description: The maximum string length. - format: int64 - min_len: - type: integer - description: The minimum string length. - format: int64 - pattern: - type: string - description: The string pattern (regular expression). - format: text - prefix: - type: string - description: The string prefix. - format: text - suffix: - type: string - description: The string suffix. - format: text - title: schema-rich-text-list-field-descriptor - schema-struct-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - default_value: - type: object - description: Default value. - title: schema-struct-field-descriptor - schema-struct-list-field-descriptor: + description: | + Derived field indicating when a valid organization schedule will + become invalid. If omitted, the schedule is already invalid. A + schedule is valid if it has a weekly schedule for all named periods + for all its schedule fragments, and if it has a schedule fragment + for the time period in question. + example: "2023-01-01T12:00:00.000Z" + format: date-time + required: + - status + title: org-schedule-summary + org-schedules-create-request: + type: object + properties: + default_weekly_org_schedule: + $ref: '#/components/schemas/set-weekly-org-schedule' + min_valid_days: + type: integer + description: | + Organization schedule must be valid for at least this many days in + the future. Meaning organization schedule fragments must cover this + period. 0 if omitted. + format: int64 + name: + type: string + description: Human-readable name. + format: text + org_schedule_fragments: + type: array + description: | + List of organization schedule fragments with no overlaps or gaps. + items: + $ref: '#/components/schemas/set-org-schedule-fragment-summary' + timezone: + type: string + description: | + Timezone in which the organization schedule applies. Expected to be + a valid IANA time zone name such as America/New_York. + format: text + weekly_org_schedules: + type: array + description: | + If this day belongs to a named period according to the currently + active organization schedule fragment, a weekly organization + schedule from this list with the corresponding name will apply. + items: + $ref: '#/components/schemas/set-weekly-org-schedule' + required: + - name + - timezone + title: org-schedules-create-request + org-schedules-create-response: + type: object + properties: + org_schedule: + $ref: '#/components/schemas/org-schedule' + required: + - org_schedule + title: org-schedules-create-response + x-go-name: OrgSchedulesCreateResponseBody + org-schedules-evaluate-request: + type: object + properties: + id: + type: string + description: Organization schedule ID. + format: id + instants: + type: array + description: Time instants to evaluate the organization schedule for. + example: + - "2023-01-01T12:00:00.000Z" + items: + type: string + format: date-time + minItems: 1 + required: + - id + - instants + title: org-schedules-evaluate-request + org-schedules-evaluate-response: + type: object + properties: + instant_evaluations: + type: array + description: | + The evaluations for the given time instants in the requested order. + items: + $ref: '#/components/schemas/instant-evaluation' + required: + - instant_evaluations + title: org-schedules-evaluate-response + x-go-name: OrgSchedulesEvaluateResponseBody + org-schedules-get-request: + type: object + properties: + id: + type: string + description: Organization schedule ID. + format: id + required: + - id + title: org-schedules-get-request + org-schedules-get-response: + type: object + properties: + org_schedule: + $ref: '#/components/schemas/org-schedule' + required: + - org_schedule + title: org-schedules-get-response + x-go-name: OrgSchedulesGetResponseBody + org-schedules-list-request: + type: object + properties: + created_by_id: + type: array + description: Creator ID the filter matches. + items: + type: string + format: id + cursor: + type: string + description: | + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. + format: text + limit: + type: integer + description: | + Max number of organization schedules returned in a page. Default is + 50. + format: int32 + mode: + $ref: '#/components/schemas/list-mode' + status: + type: array + description: The organization schedule statuses the filter matches. + items: + $ref: '#/components/schemas/org-schedule-status' + valid_until: + $ref: '#/components/schemas/date-filter' + title: org-schedules-list-request + org-schedules-list-response: + type: object + properties: + next_cursor: + type: string + description: | + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. + format: text + org_schedules: + type: array + description: The list of organization schedules. + items: + $ref: '#/components/schemas/org-schedule' + prev_cursor: + type: string + description: | + The cursor used to iterate preceding results in accordance to the + sort order. If not set, then no prior elements exist. + format: text + required: + - org_schedules + title: org-schedules-list-response + x-go-name: OrgSchedulesListResponseBody + org-schedules-set-future-request: + type: object + properties: + id: + type: string + description: Organization schedule ID. + format: id + org_schedule_fragment_id: + type: string + description: Organization schedule Fragment ID. + format: id + required: + - id + - org_schedule_fragment_id + title: org-schedules-set-future-request + org-schedules-set-future-response: + type: object + properties: + org_schedule: + $ref: '#/components/schemas/org-schedule' + required: + - org_schedule + title: org-schedules-set-future-response + x-go-name: OrgSchedulesSetFutureResponseBody + org-schedules-transition-request: + type: object + properties: + id: + type: string + description: Organization schedule ID. + format: id + status: + $ref: '#/components/schemas/org-schedule-status' + required: + - id + - status + title: org-schedules-transition-request + org-schedules-transition-response: + type: object + properties: + org_schedule: + $ref: '#/components/schemas/org-schedule' + required: + - org_schedule + title: org-schedules-transition-response + x-go-name: OrgSchedulesTransitionResponseBody + org-schedules-update-request: + type: object + properties: + default_weekly_org_schedule: + $ref: '#/components/schemas/set-weekly-org-schedule' + id: + type: string + description: Organization schedule ID. + format: id + min_valid_days: + type: integer + description: | + Organization schedule must be valid for at least this many days in + the future. Meaning organization schedule fragments must cover this + period. 0 if omitted. + format: int64 + name: + type: string + description: Human-readable name. + format: text + org_schedule_fragments: + type: array + description: | + List of organization schedule fragments with no overlaps or gaps. + items: + $ref: '#/components/schemas/set-org-schedule-fragment-summary' + timezone: + type: string + description: | + Timezone in which the organization schedule applies. Expected to be + a valid IANA time zone name such as America/New_York. + format: text + weekly_org_schedules: + type: array + description: | + If this day belongs to a named period according to the currently + active organization schedule fragment, a weekly organization + schedule from this list with the corresponding name will apply. + items: + $ref: '#/components/schemas/set-weekly-org-schedule' + required: + - id + title: org-schedules-update-request + org-schedules-update-response: + type: object + properties: + org_schedule: + $ref: '#/components/schemas/org-schedule' + required: + - org_schedule + title: org-schedules-update-response + x-go-name: OrgSchedulesUpdateResponseBody + org-summary: + type: object + discriminator: + mapping: + rev_org: '#/components/schemas/rev-org-summary' + propertyName: type + oneOf: + - $ref: '#/components/schemas/rev-org-summary' + properties: + type: + $ref: '#/components/schemas/org-type' + required: + - type + title: org-summary + org-type: + type: string + enum: + - rev_org + parent-part-filter: + type: object + description: The filter for specifying parent part. + properties: + level: + type: integer + description: Number of levels to fetch the part hierarchy up to. + format: int32 + minimum: 1 + parts: + type: array + description: Part IDs to fetch the hierarchy for. + example: + - PROD-12345 + items: + type: string + format: id + minItems: 1 + required: + - parts + title: parent-part-filter + part: + type: object + discriminator: + mapping: + capability: '#/components/schemas/capability' + enhancement: '#/components/schemas/enhancement' + feature: '#/components/schemas/feature' + product: '#/components/schemas/product' + propertyName: type + oneOf: + - $ref: '#/components/schemas/capability' + - $ref: '#/components/schemas/enhancement' + - $ref: '#/components/schemas/feature' + - $ref: '#/components/schemas/product' + properties: + type: + $ref: '#/components/schemas/part-type' + required: + - type + title: part + part-base: allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' + - $ref: '#/components/schemas/atom-base' - type: object properties: - default_value: + artifacts: type: array - description: Default value. + description: The attached artifacts. items: - type: object - title: schema-struct-list-field-descriptor - schema-text-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - contains: - type: string - description: The contained substring. - format: text - default_value: - type: string - description: Default value. - format: text - eq_len: - type: integer - description: The exact string length. - format: int64 - max_len: - type: integer - description: The maximum string length. - format: int64 - min_len: - type: integer - description: The minimum string length. - format: int64 - pattern: - type: string - description: The string pattern (regular expression). - format: text - prefix: - type: string - description: The string prefix. - format: text - suffix: + $ref: '#/components/schemas/artifact-summary' + description: type: string - description: The string suffix. + description: Description of the part. format: text - title: schema-text-field-descriptor - schema-text-list-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - contains: + name: type: string - description: The contained substring. + description: Name of the part. format: text - default_value: + owned_by: type: array - description: Default value. + description: The users that own the part. items: - type: string - format: text - eq_len: - type: integer - description: The exact string length. - format: int64 - max_len: - type: integer - description: The maximum string length. - format: int64 - min_len: - type: integer - description: The minimum string length. - format: int64 - pattern: - type: string - description: The string pattern (regular expression). - format: text - prefix: - type: string - description: The string prefix. - format: text - suffix: - type: string - description: The string suffix. - format: text - title: schema-text-list-field-descriptor - schema-timestamp-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - default_value: - type: string - description: Default value. - format: text - title: schema-timestamp-field-descriptor - schema-timestamp-list-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - default_value: + $ref: '#/components/schemas/user-summary' + tags: type: array - description: Default value. + description: Tags associated with the object. items: - type: string - format: text - title: schema-timestamp-list-field-descriptor - schema-tokens-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - contains: - type: string - description: The contained substring. - format: text - default_value: - type: string - description: Default value. - format: text - eq_len: - type: integer - description: The exact string length. - format: int64 - max_len: - type: integer - description: The maximum string length. - format: int64 - min_len: - type: integer - description: The minimum string length. - format: int64 - pattern: - type: string - description: The string pattern (regular expression). - format: text - prefix: - type: string - description: The string prefix. - format: text - suffix: - type: string - description: The string suffix. - format: text - title: schema-tokens-field-descriptor - schema-tokens-list-field-descriptor: + $ref: '#/components/schemas/tag-with-value' + required: + - name + - owned_by + title: part-base + part-base-summary: allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' + - $ref: '#/components/schemas/atom-base-summary' - type: object properties: - contains: - type: string - description: The contained substring. - format: text - default_value: - type: array - description: Default value. - items: - type: string - format: text - eq_len: - type: integer - description: The exact string length. - format: int64 - max_len: - type: integer - description: The maximum string length. - format: int64 - min_len: - type: integer - description: The minimum string length. - format: int64 - pattern: - type: string - description: The string pattern (regular expression). - format: text - prefix: - type: string - description: The string prefix. - format: text - suffix: + name: type: string - description: The string suffix. + description: Name of the part. format: text - title: schema-tokens-list-field-descriptor - schema-uenum-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - allowed_values: - type: array - description: Allowed values for the field. - items: - $ref: '#/components/schemas/schema-field-uenum-value' - default_value: - type: integer - description: Default value. - format: int64 - required: - - allowed_values - title: schema-uenum-field-descriptor - schema-uenum-list-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - - type: object - properties: - allowed_values: - type: array - description: Allowed values for the field. - items: - $ref: '#/components/schemas/schema-field-uenum-value' - default_value: + owned_by: type: array - description: Default value. + description: The users that own the part. items: - type: integer - format: int64 + $ref: '#/components/schemas/user-summary' required: - - allowed_values - title: schema-uenum-list-field-descriptor - schema-unknown-field-descriptor: - allOf: - - $ref: '#/components/schemas/schema-field-descriptor-base' - title: schema-unknown-field-descriptor - service-account: - allOf: - - $ref: '#/components/schemas/user-base' - title: service-account - service-account-summary: - allOf: - - $ref: '#/components/schemas/user-base-summary' - title: service-account-summary - service-accounts-create-request: + - name + - owned_by + title: part-base-summary + part-summary: type: object - description: The request object to create a new service account. + discriminator: + mapping: + capability: '#/components/schemas/capability-summary' + enhancement: '#/components/schemas/enhancement-summary' + feature: '#/components/schemas/feature-summary' + product: '#/components/schemas/product-summary' + propertyName: type + oneOf: + - $ref: '#/components/schemas/capability-summary' + - $ref: '#/components/schemas/enhancement-summary' + - $ref: '#/components/schemas/feature-summary' + - $ref: '#/components/schemas/product-summary' properties: - display_name: - type: string - description: | - The service account's display name. A unique, human readable name - to identify a service account. + type: + $ref: '#/components/schemas/part-type' + required: + - type + title: part-summary + part-type: + type: string + enum: + - capability + - enhancement + - feature + - product + parts-create-request: + type: object + discriminator: + mapping: + capability: '#/components/schemas/parts-create-request-capability' + enhancement: '#/components/schemas/parts-create-request-enhancement' + feature: '#/components/schemas/parts-create-request-feature' + product: '#/components/schemas/parts-create-request-product' + propertyName: type + oneOf: + - $ref: '#/components/schemas/parts-create-request-capability' + - $ref: '#/components/schemas/parts-create-request-enhancement' + - $ref: '#/components/schemas/parts-create-request-feature' + - $ref: '#/components/schemas/parts-create-request-product' + properties: + type: + $ref: '#/components/schemas/part-type' + artifacts: + type: array + description: The IDs of the artifacts. + example: + - ARTIFACT-12345 + items: + type: string + format: id + description: + type: string + description: Description of the part. format: text - gen_keyring: - type: boolean + name: + type: string + description: Name of the part. + format: text + owned_by: + type: array + description: The users that own the part. + example: + - DEVU-12345 + items: + type: string + format: id + tags: + type: array + description: Tags associated with the part. + items: + $ref: '#/components/schemas/set-tag-with-value' + required: + - name + - owned_by + - type + title: parts-create-request + parts-create-request-capability: + type: object + properties: + parent_part: + type: array + description: ID of the parent product for the capability. + example: + - PROD-12345 + items: + type: string + format: id + maxItems: 1 + required: + - parent_part + title: parts-create-request-capability + parts-create-request-enhancement: + type: object + properties: + parent_part: + type: array description: | - Indicates whether to generate a keyring along with the new service - account. The default is false. + ID of the parent part on which the enhancement is to be created. + example: + - PROD-12345 + items: + type: string + format: id + maxItems: 1 + target_close_date: + type: string + description: | + Target close date by which enhancement is expected to be closed. + example: "2023-01-01T12:00:00.000Z" + format: date-time + target_start_date: + type: string + description: | + Target start date by which enhancement is expected to be started. + Example Date Format: 2000-11-01T01:01:01Z + example: "2023-01-01T12:00:00.000Z" + format: date-time required: - - display_name - title: service-accounts-create-request - service-accounts-create-response: + - parent_part + title: parts-create-request-enhancement + parts-create-request-feature: type: object - description: | - The response object to the corresponding create service account - request. properties: - service_account: - $ref: '#/components/schemas/service-account' + parent_part: + type: array + description: ID of the parent capability/feature for the feature. + example: + - PROD-12345 + items: + type: string + format: id + maxItems: 1 required: - - service_account - title: service-accounts-create-response - x-go-name: ServiceAccountsCreateResponseBody - service-accounts-get-request: + - parent_part + title: parts-create-request-feature + parts-create-request-product: + type: object + additionalProperties: false + title: parts-create-request-product + parts-create-response: + type: object + properties: + part: + $ref: '#/components/schemas/part' + required: + - part + title: parts-create-response + x-go-name: PartsCreateResponseBody + parts-delete-request: type: object - description: The request object to get a service account's information. properties: id: type: string - description: The ID of the requested service account. + description: The ID of the part to delete. + example: PROD-12345 format: id required: - id - title: service-accounts-get-request - service-accounts-get-response: + title: parts-delete-request + parts-delete-response: + type: object + additionalProperties: false + title: parts-delete-response + x-go-name: PartsDeleteResponseBody + parts-get-request: type: object - description: | - The response object that carries the service account's information - corresponding to the request. properties: - service_account: - $ref: '#/components/schemas/service-account' + id: + type: string + description: The ID of the part to retrieve. + example: PROD-12345 + format: id required: - - service_account - title: service-accounts-get-response - x-go-name: ServiceAccountsGetResponseBody - set-issue-selector: + - id + title: parts-get-request + parts-get-response: type: object properties: - custom_fields: - type: object - description: | - Custom fields on the issue with their fully qualified names and the - associated with their exact allowed values. The SLA policy applies - to issues where all named custom fields have exactly the specified - values. - owners: + part: + $ref: '#/components/schemas/part' + required: + - part + title: parts-get-response + x-go-name: PartsGetResponseBody + parts-list-request: + type: object + properties: + type: type: array - description: The SLA policy applies to the issues of these owners. + description: Filters for parts of the provided type(s). items: - type: string - format: id - parts: + $ref: '#/components/schemas/part-type' + created_by: type: array - description: The SLA policy applies to the issues of these parts. + description: Filters for parts created by any of these users. example: - - PROD-12345 + - DEVU-12345 items: type: string format: id - rev_orgs: + cursor: + type: string + description: | + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. + format: text + limit: + type: integer + description: | + The maximum number of parts to return. The default is '50'. + format: int32 + mode: + $ref: '#/components/schemas/list-mode' + modified_by: type: array - description: The SLA policy applies to the issues of these revorgs. + description: Filters for parts modified by any of these users. example: - - REV-AbCdEfGh + - DEVU-12345 items: type: string format: id - stage_name: + name: type: array - description: The SLA policy applies to issues with these stages. + description: Filters for parts of the provided name(s). items: type: string format: text - subtype: + owned_by: type: array - description: The issue subtype for which the SLA policy applies. + description: Filters for parts owned by any of these users. + example: + - DEVU-12345 items: type: string - format: text + format: id + parent_part: + $ref: '#/components/schemas/parent-part-filter' tags: type: array - description: | - The SLA policy applies to issues with these tags. If empty, the tag - filter isn't applied. + description: Filters for part with any of the provided tags. example: - TAG-12345 items: type: string format: id - title: set-issue-selector - set-shared-with-membership: + title: parts-list-request + parts-list-response: type: object - description: | - Information about the role the member receives due to the share. properties: - member: - type: string - description: ID of the member the object is shared with. - format: id - role: + next_cursor: type: string description: | - ID of the role that describes what privileges the membership - entails. - format: id - title: set-shared-with-membership - set-sla-policy: - type: object - properties: - metrics: + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. + format: text + parts: type: array - description: Metrics to apply to the selected items. + description: The list of parts. items: - $ref: '#/components/schemas/set-support-metric-target' + $ref: '#/components/schemas/part' + prev_cursor: + type: string + description: | + The cursor used to iterate preceding results in accordance to the + sort order. If not set, then no prior elements exist. + format: text + required: + - parts + title: parts-list-response + x-go-name: PartsListResponseBody + parts-update-request: + type: object + discriminator: + mapping: + capability: '#/components/schemas/parts-update-request-capability' + enhancement: '#/components/schemas/parts-update-request-enhancement' + feature: '#/components/schemas/parts-update-request-feature' + none: '#/components/schemas/empty' + product: '#/components/schemas/parts-update-request-product' + propertyName: type + oneOf: + - $ref: '#/components/schemas/empty' + - $ref: '#/components/schemas/parts-update-request-capability' + - $ref: '#/components/schemas/parts-update-request-enhancement' + - $ref: '#/components/schemas/parts-update-request-feature' + - $ref: '#/components/schemas/parts-update-request-product' + properties: + type: + $ref: '#/components/schemas/part-type' + artifacts: + $ref: '#/components/schemas/parts-update-request-artifacts' + description: + type: string + description: The updated description of the part. + format: text + id: + type: string + description: The ID of the part to update. + example: PROD-12345 + format: id name: type: string - description: Human-readable name. + description: The updated name of the part. format: text - selector: - $ref: '#/components/schemas/set-sla-selector' + owned_by: + $ref: '#/components/schemas/parts-update-request-owned-by' + tags: + $ref: '#/components/schemas/parts-update-request-tags' required: - - name - - selector - title: set-sla-policy - set-sla-selector: + - id + title: parts-update-request + parts-update-request-artifacts: type: object properties: - applies_to: - $ref: '#/components/schemas/sla-selector-applies-to' - custom_fields: - type: object - description: | - Custom fields with their fully qualified names and associated with - their exact allowed values. The SLA policy applies to records where - all named custom fields have exactly the specified values. If the - value is null, the field must have null value or not be present. - groups: - type: array - description: | - The SLA policy applies to the tickets or conversations of these - groups. - items: - type: string - format: id - issue_selector: - $ref: '#/components/schemas/set-issue-selector' - owners: - type: array - description: | - The SLA policy applies to the tickets or conversations of these - owners. - items: - type: string - format: id - parts: + set: type: array - description: The SLA policy applies to the tickets of these parts. + description: Sets the artifacts to the provided IDs. example: - - PROD-12345 + - ARTIFACT-12345 items: type: string format: id - priority: - type: array + title: parts-update-request-artifacts + parts-update-request-capability: + type: object + additionalProperties: false + title: parts-update-request-capability + parts-update-request-enhancement: + type: object + properties: + target_close_date: + type: string + description: Updates the target close date of the enhancement. + example: "2023-01-01T12:00:00.000Z" + format: date-time + nullable: true + target_start_date: + type: string description: | - The SLA policy applies to conversations with these priorities. - items: - $ref: '#/components/schemas/sla-selector-priority' - severity: - type: array - description: The SLA policy applies to tickets with these severities. - items: - $ref: '#/components/schemas/sla-selector-severity' - source_channel: + Updates the target start date of the enhancement. Example Date + Format: 2000-11-01T01:01:01Z + example: "2023-01-01T12:00:00.000Z" + format: date-time + nullable: true + title: parts-update-request-enhancement + parts-update-request-feature: + type: object + additionalProperties: false + title: parts-update-request-feature + parts-update-request-owned-by: + type: object + properties: + set: type: array description: | - The SLA policy applies to conversations with these sources. - items: - type: string - format: text - subtype: - type: array - description: The SLA policy applies to tickets with these subtypes. - items: - type: string - format: text - tags: - type: array - description: The SLA policy applies to items with these tags. + Sets the owner IDs to the provided user IDs. This must not be + empty. example: - - TAG-12345 + - DEVU-12345 items: type: string format: id - ticket_source_channel: - type: array - description: | - The SLA policy applies to tickets with these source channels. - items: - type: string - format: text - required: - - applies_to - title: set-sla-selector - set-support-metric-target: + title: parts-update-request-owned-by + parts-update-request-product: type: object - properties: - metric: - type: string - description: The metric to apply. - format: id - org_schedule_id: - type: string - description: | - The organization schedule controlling this metrics calculation. - Time based metrics don't consume time while their schedule is off. - format: id - performance: - type: number - description: | - The percentage of instances for which this metric's target must not - be breached, in order to avoid breaching the overall SLA policy. - format: double - target: - type: integer - description: | - The target value to be achieved, for example the time in which to - do something, or the maximum allowed number of message pairs. The - units and interpretation of the value is controlled by the - properties of the referenced metric. - format: int32 - warning_target: - type: integer - description: | - The threshold in the same units as target where the metric is - considered to be 'at risk'. - format: int32 - required: - - metric - - target - title: set-support-metric-target - set-tag-with-value: + additionalProperties: false + title: parts-update-request-product + parts-update-request-tags: type: object properties: - id: - type: string - description: The ID of the tag. - example: TAG-12345 - format: id - value: - type: string - description: | - The value for the object's association with the tag. If specified, - the value must be one that's specified in the tag's allowed values. - format: text - required: - - id - title: set-tag-with-value - shared-with-membership-filter: + set: + type: array + description: Sets the tags to the provided tags. + items: + $ref: '#/components/schemas/set-tag-with-value' + title: parts-update-request-tags + parts-update-response: type: object - description: Filter on target item based on intended audience. properties: - member: - type: string - description: ID of the group/member with whom the item is shared. - format: id - role: - type: string - description: | - Role ID of the group/member with whom the item is shared. - format: id - title: shared-with-membership-filter - sla: + part: + $ref: '#/components/schemas/part' + required: + - part + title: parts-update-response + x-go-name: PartsUpdateResponseBody + product: allOf: - - $ref: '#/components/schemas/atom-base' + - $ref: '#/components/schemas/part-base' + title: product + product-summary: + allOf: + - $ref: '#/components/schemas/part-base-summary' + title: product-summary + question-answer: + allOf: + - $ref: '#/components/schemas/atom-base' - type: object properties: - account_filter: - type: object - description: | - A set of account attributes that must be satisfied for the SLA to - apply. AND applies between each field. - compensation: - $ref: '#/components/schemas/sla-compensation' - description: + answer: type: string - description: Description of the purpose and capabilities of the SLA. + description: The Answer. format: text - evaluation_period: - $ref: '#/components/schemas/sla-evaluation-period' - name: + applies_to_parts: + type: array + description: Details of the parts relevant to the question_answer. + items: + $ref: '#/components/schemas/part-summary' + question: type: string - description: Human-readable name. + description: The Question. format: text - policies: + sources: type: array description: | - The policies encompassed by this SLA, ordered in decreasing - priority. + Details of the sources from which the question answer was + generated. items: - $ref: '#/components/schemas/sla-policy' - sla_type: - $ref: '#/components/schemas/sla-type' + $ref: '#/components/schemas/atom-summary' status: - $ref: '#/components/schemas/sla-status' - required: - - name - - status - title: sla - sla-applies-to: + $ref: '#/components/schemas/question-answer-status' + suggested_answer: + type: string + description: | + An alternative answer suggested by the Q/A generation algorithm. + format: text + suggested_for_deletion: + type: boolean + description: | + Whether the Q/A was marked for deletion by the Q/A generation + algorithm. + topic: + type: string + description: The topic to which the QA belongs. + format: text + verified: + type: boolean + description: Whether the Q/A was verified. + title: question-answer + question-answer-status: type: string - description: | - The object types on which the SLA applies. An external SLA can apply to - multiple object types, but an internal SLA can apply to only one object - type. + description: Status of the question answer. enum: - - conversation - - issue - - ticket - sla-assign-result: + - archived + - discarded + - draft + - published + - review_needed + reactions-list-request: type: object properties: - error: - $ref: '#/components/schemas/error' - rev_org: - $ref: '#/components/schemas/rev-org-summary' + cursor: + type: string + description: | + The cursor to resume iteration from, otherwise if not provided, + then iteration starts from the beginning. + format: text + emoji: + type: string + description: | + The emoji to list the reactors for. This can be the short name of + the emoji (e.g. "joy"), or the code point (e.g. "1f602"). + format: text + limit: + type: integer + description: The maximum number of reactors to return. + format: int32 + object: + type: string + description: The ID of the object to list reactors for. + example: don:core:dvrv-us-1:devo/example:ticket/123:comment/comment-id + format: id required: - - rev_org - title: sla-assign-result - sla-compensation: + - emoji + - object + title: reactions-list-request + reactions-list-response: type: object - additionalProperties: false - description: | - Describes the compensation to be provided in case of SLA breach. It is - not 'self-executing', it is the responsibility of the organization - providing the SLA to actually transfer the promised credit, resource or - other payment. - title: sla-compensation - sla-evaluation-period: + properties: + next_cursor: + type: string + description: | + The cursor that should be used to iterate the next sequence of + results, otherwise if not set, then no elements exist after. + format: text + reactors: + type: array + description: The users that have reacted. + items: + $ref: '#/components/schemas/user-summary' + required: + - reactors + title: reactions-list-response + x-go-name: ReactionsListResponseBody + reactions-update-request: + type: object + properties: + action: + $ref: '#/components/schemas/reactions-update-request-action' + emoji: + type: string + description: | + The emoji for the reaction. This can be the short name of the emoji + (e.g. "joy"), or the code point (e.g. "1f602"). + format: text + object: + type: string + description: The object to update the reaction for. + example: don:core:dvrv-us-1:devo/example:ticket/123:comment/comment-id + format: id + required: + - action + - emoji + - object + title: reactions-update-request + reactions-update-request-action: type: string - description: | - Specifies the frequency of when the contractually-meaningful evaluation - of the SLA happens. The organization for their own information might - evaluate the various metrics contained in the policy as often as we can - make it feasible for them, but only the evaluation at the end of the - evaluation period triggers a compensation and needs to be shared with - the customer. enum: - - monthly - - quarterly - - weekly - - yearly - sla-policy: + - add + - remove + reactions-update-response: type: object additionalProperties: false - description: A policy that represents a promise to your revs. - title: sla-policy - sla-selector-applies-to: - type: string - description: The item type for which the SLA policy applies. - enum: - - conversation - - issue - - ticket - sla-selector-priority: - type: string - description: | - The SLA policy applies to conversations with these priorities. - enum: - - p0 - - p1 - - p2 - sla-selector-severity: - type: string - description: The SLA policy applies to tickets with these severities. - enum: - - blocker - - high - - low - - medium - sla-status: - type: string - description: | - Status determines how an item can be used. In 'draft' status an item - can be edited but can't be used. When 'published' the item can longer - be edited but can be used. 'Archived' is read-only. - enum: - - archived - - draft - - published - sla-summary: - allOf: - - $ref: '#/components/schemas/atom-base-summary' - - type: object - properties: - name: - type: string - description: Human-readable name. - format: text - sla_type: - $ref: '#/components/schemas/sla-type' - status: - $ref: '#/components/schemas/sla-status' - required: - - name - - status - title: sla-summary - sla-summary-filter: + title: reactions-update-response + x-go-name: ReactionsUpdateResponseBody + remove-tag-with-value: type: object - description: The filter for SLA summary. properties: - stage: + id: + type: string + description: The ID of the tag. + example: TAG-12345 + format: id + required: + - id + title: remove-tag-with-value + removed-sla-metric-history: + type: object + additionalProperties: false + description: Information about removed metrics. + title: removed-sla-metric-history + resource: + type: object + description: Resource details. + properties: + artifacts: type: array - description: Filters for records with any of the provided SLA stages. + description: | + Artifacts of the resource (relevant only for type artifact). items: - $ref: '#/components/schemas/sla-summary-stage' - target_time: - $ref: '#/components/schemas/date-filter' - title: sla-summary-filter - sla-summary-stage: - type: string - description: | - The stage of the SLA. This is the metric stage which is closest to - breach. - enum: - - breached - - completed - - paused - - running - - warning - sla-tracker: + $ref: '#/components/schemas/artifact-summary' + url: + type: string + description: URL of the resource (relevant only for type url). + format: text + title: resource + rev-org: allOf: - - $ref: '#/components/schemas/atom-base' + - $ref: '#/components/schemas/org-base' - type: object properties: - applies_to_id: + description: type: string - description: Details of the object on which the SLA is being tracked. - format: id - applies_to_type: - $ref: '#/components/schemas/sla-tracker-applies-to-type' - metric_target_summaries: - type: array - description: | - Summary of the metrics target being tracked in the SLA tracker. - items: - $ref: '#/components/schemas/archetype-metric-target' - removed_sla_metric_history: - type: array - description: Information about removed metrics. - items: - $ref: '#/components/schemas/removed-sla-metric-history' - sla: - $ref: '#/components/schemas/sla-summary' - sla_policy_id: - type: string - description: | - Details of the applicable SLA policy. Can be omitted if no sla - applies, or if no policy of the sla applies at the moment. - format: id - stage: + description: Description of the Rev organization. + format: text + domain: type: string - description: SLA stage of the object being tracked. + deprecated: true + description: Company's domain name. Example - 'devrev.ai'. format: text - status: + external_ref: type: string description: | - It is an indicator of whether the SLA has ever been breached - (missed). If not, it shows whether the SLA is completed, in - progress, or nil - if no policy is applied. + External ref is a unique identifier for the Rev (customer) + organization from your primary customer system of records. If none + is specified, a system-generated identifier will be assigned to the + organization. format: text - required: - - metric_target_summaries - title: sla-tracker - sla-tracker-applies-to-type: - type: string - description: The type of the object on which the SLA is being tracked. - enum: - - conversation - - issue - - ticket - sla-tracker-summary: + primary_rev_org: + $ref: '#/components/schemas/org-summary' + title: rev-org + rev-org-summary: allOf: - - $ref: '#/components/schemas/atom-base-summary' - - type: object - properties: - applies_to_type: - $ref: '#/components/schemas/sla-tracker-applies-to-type' - title: sla-tracker-summary - sla-trackers-get-request: + - $ref: '#/components/schemas/org-base-summary' + title: rev-org-summary + rev-orgs-create-request: + type: object + description: | + Request object to create a new Rev organization in the Dev + organization. + properties: + account: + type: string + description: Account Id to associate with this Rev organization. + example: ACC-12345 + format: id + description: + type: string + description: Description of the Rev organization. + format: text + display_name: + type: string + description: Name of the Rev organization. + format: text + domain: + type: string + deprecated: true + description: Company's domain name. Example - 'devrev.ai'. + format: text + environment: + $ref: '#/components/schemas/org-environment' + external_ref: + type: string + description: | + External ref is a custom unique identifier which is a reference to + an unique id for this organization's data in some system of + records. + format: text + tier: + type: string + description: The tier of the RevOrg. + format: text + required: + - account + - display_name + title: rev-orgs-create-request + rev-orgs-create-response: + type: object + description: | + Response object for request to create a new Rev organization. + properties: + rev_org: + $ref: '#/components/schemas/rev-org' + required: + - rev_org + title: rev-orgs-create-response + x-go-name: RevOrgsCreateResponseBody + rev-orgs-delete-request: type: object + description: Request object to delete a Rev organization. properties: id: type: string - description: The ID of the SLA tracker to get. + description: The ID of Rev organization to delete. + example: REV-AbCdEfGh format: id required: - id - title: sla-trackers-get-request - sla-trackers-get-response: + title: rev-orgs-delete-request + rev-orgs-delete-response: + type: object + additionalProperties: false + description: The response to deleting a Rev organization. + title: rev-orgs-delete-response + x-go-name: RevOrgsDeleteResponseBody + rev-orgs-get-request: type: object + description: Request object to get Rev organization's information. properties: - sla_tracker: - $ref: '#/components/schemas/sla-tracker' + account: + type: string + description: | + The ID of account for which default Rev organization is to be + fetched. + example: ACC-12345 + format: id + id: + type: string + description: The ID of the required Rev organization. + example: REV-AbCdEfGh + format: id + title: rev-orgs-get-request + rev-orgs-get-response: + type: object + description: The response to getting a Rev organization's information. + properties: + rev_org: + $ref: '#/components/schemas/rev-org' required: - - sla_tracker - title: sla-trackers-get-response - x-go-name: SlaTrackersGetResponseBody - sla-trackers-list-request: + - rev_org + title: rev-orgs-get-response + x-go-name: RevOrgsGetResponseBody + rev-orgs-list-request: type: object + description: | + A request to get the list of Rev organizations for the authenticated + user's Dev organization. properties: + created_by: + type: array + description: Filters by creator. + items: + type: string + format: id created_date: $ref: '#/components/schemas/date-time-filter' cursor: @@ -9056,10 +10078,22 @@ components: The cursor to resume iteration from. If not provided, then iteration starts from the beginning. format: text + display_name: + type: array + description: Array of display names of Rev orgs to be filtered. + items: + type: string + format: text + external_ref: + type: array + description: List of external refs to filter Rev organizations for. + items: + type: string + format: text limit: type: integer description: | - The maximum number of SLA trackers to return. The default is '50'. + The maximum number of Rev organizations to be retrieved per page. format: int32 mode: $ref: '#/components/schemas/list-mode' @@ -9068,25 +10102,16 @@ components: sort_by: type: array description: | - Fields to sort the SLA Trackers by and the direction to sort them. + Fields to sort the Rev organizations by and the direction to sort + them. items: type: string format: sort-by - stage: - type: array - description: The SLA tracker stages the filter matches. - items: - type: string - format: text - status: - type: array - description: The SLA tracker statuses the filter matches. - items: - type: string - format: text - title: sla-trackers-list-request - sla-trackers-list-response: + title: rev-orgs-list-request + rev-orgs-list-response: type: object + description: | + The response to getting a list of Rev organizations' information. properties: next_cursor: type: string @@ -9100,163 +10125,289 @@ components: The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. format: text - sla_trackers: + rev_orgs: type: array - description: The list of SLA trackers. + description: List with all of the Rev organizations' information. items: - $ref: '#/components/schemas/sla-tracker' + $ref: '#/components/schemas/rev-org' required: - - sla_trackers - title: sla-trackers-list-response - x-go-name: SlaTrackersListResponseBody - sla-type: - type: string - description: Type of the SLA. - enum: - - external - - internal - slas-assign-request: + - rev_orgs + title: rev-orgs-list-response + x-go-name: RevOrgsListResponseBody + rev-orgs-update-request: type: object + description: | + Request object to update information of the Rev organization. properties: - id: + description: + type: string + description: Description of the Rev organization. + format: text + display_name: + type: string + description: Customer chosen name for the Rev organization. + format: text + domain: + type: string + deprecated: true + description: Company's domain name. Example - 'devrev.ai'. + format: text + environment: + $ref: '#/components/schemas/org-environment' + external_ref: type: string description: | - The SLA which would be assigned to the Rev organizations. If - omitted, the SLA of all the rev organizations referenced will be - unset. + External ref is a custom unique identifier which is a reference to + an unique id for this organization's data in some system of + records. + format: text + id: + type: string + description: The ID of Rev organization to update. + example: REV-AbCdEfGh format: id - rev_orgs: - type: array - description: The Rev organizations to apply the SLA to. - example: - - REV-AbCdEfGh - items: - type: string - format: id + tier: + type: string + description: The tier of the RevOrg. + format: text required: - - rev_orgs - title: slas-assign-request - slas-assign-response: + - id + title: rev-orgs-update-request + rev-orgs-update-response: type: object + description: Response object to updating Rev organization's information. properties: - results: - type: array - description: The list of outcomes for each Rev organization. - items: - $ref: '#/components/schemas/sla-assign-result' + rev_org: + $ref: '#/components/schemas/rev-org' required: - - results - title: slas-assign-response - x-go-name: SlasAssignResponseBody - slas-create-request: + - rev_org + title: rev-orgs-update-response + x-go-name: RevOrgsUpdateResponseBody + rev-user: + allOf: + - $ref: '#/components/schemas/user-base' + - type: object + properties: + description: + type: string + description: Description of the Rev user. + format: text + external_ref: + type: string + description: | + 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. + format: text + rev_org: + $ref: '#/components/schemas/org-summary' + title: rev-user + rev-user-summary: + allOf: + - $ref: '#/components/schemas/user-base-summary' + - type: object + properties: + external_ref: + type: string + description: | + 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. + format: text + rev_org: + $ref: '#/components/schemas/org-summary' + title: rev-user-summary + rev-users-create-request: type: object + description: | + Request object to create a new Rev user for a Rev organization. properties: - account_selector: - $ref: '#/components/schemas/accounts-filters' - applies_to: + custom_schema_fragments: type: array - description: The object types this SLA can apply to. + deprecated: true + description: The schema fragment IDs associated with the Rev user. + example: + - don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id items: - $ref: '#/components/schemas/sla-applies-to' + type: string + format: id + custom_schema_spec: + $ref: '#/components/schemas/custom-schema-spec' description: type: string - description: Description of the purpose and capabilities of the SLA. + description: Description of the Rev user. format: text - evaluation_period: - $ref: '#/components/schemas/sla-evaluation-period' - name: + display_name: type: string - description: Human-readable name. + description: | + The user's display name. The name is non-unique and mutable. format: text - policies: - type: array + display_picture: + type: string + description: Artifact ID of a Rev user's display picture. + example: ARTIFACT-12345 + format: id + email: + type: string + description: Email address of the Rev user. + format: text + external_ref: + type: string description: | - The policies encompassed by this SLA, ordered in decreasing - priority. + External ref is a mutable unique identifier for a user within the + Dev 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. + format: text + phone_numbers: + type: array + description: Phone numbers, in E.164 format, of the Rev user. items: - $ref: '#/components/schemas/set-sla-policy' - sla_type: - $ref: '#/components/schemas/sla-type' + type: string + format: text + rev_org: + type: string + description: | + The ID of the Rev organization to which the created Rev user is + associated. + example: REV-AbCdEfGh + format: id + title: rev-users-create-request + rev-users-create-response: + type: object + description: | + Response object for creating a new Rev user for Rev organization. + properties: + rev_user: + $ref: '#/components/schemas/rev-user' required: - - name - title: slas-create-request - slas-create-response: + - rev_user + title: rev-users-create-response + x-go-name: RevUsersCreateResponseBody + rev-users-delete-request: type: object + description: Request object to delete a Rev user. properties: - sla: - $ref: '#/components/schemas/sla' + id: + type: string + description: The ID of Rev user to delete. + format: id required: - - sla - title: slas-create-response - x-go-name: SlasCreateResponseBody - slas-filter-applies-to-operator-type: - type: string - enum: - - all - - any - slas-get-request: + - id + title: rev-users-delete-request + rev-users-delete-response: type: object + additionalProperties: false + description: The response to deleting a Rev user of a Rev organization. + title: rev-users-delete-response + x-go-name: RevUsersDeleteResponseBody + rev-users-get-request: + type: object + description: Request object to get a Rev user. properties: id: type: string - description: The ID of the SLA to get. + description: The ID of Rev user to be retrieved. format: id required: - id - title: slas-get-request - slas-get-response: + title: rev-users-get-request + rev-users-get-response: type: object + description: The returned Rev user. properties: - sla: - $ref: '#/components/schemas/sla' + rev_user: + $ref: '#/components/schemas/rev-user' required: - - sla - title: slas-get-response - x-go-name: SlasGetResponseBody - slas-list-request: + - rev_user + title: rev-users-get-response + x-go-name: RevUsersGetResponseBody + rev-users-list-request: type: object + description: | + Gets the list of Rev users belonging to the authenticated user's Dev + organization which the user is also authorized to access. properties: - applies_to: + associations: type: array - description: The object types the SLA applies to. + description: | + Filters for Rev users with specified associations + (account/workspace). items: - $ref: '#/components/schemas/sla-applies-to' - applies_to_op: - $ref: '#/components/schemas/slas-filter-applies-to-operator-type' + type: string + format: id + created_by: + type: array + description: | + Filters for Rev users that were created by the specified user(s). + items: + type: string + format: id + created_date: + $ref: '#/components/schemas/date-time-filter' cursor: type: string description: | The cursor to resume iteration from. If not provided, then iteration starts from the beginning. format: text + email: + type: array + description: List of emails of Rev users to be filtered. + items: + type: string + format: text + external_ref: + type: array + description: List of external refs to filter Rev users for. + items: + type: string + format: text + is_verified: + type: boolean + description: Value of is_verified field to filter the Rev users. limit: type: integer description: | - The maximum number of SLAs to return. The default is '50'. + The maximum number of Rev users to return. The default is '50'. format: int32 mode: $ref: '#/components/schemas/list-mode' - sla_type: + modified_date: + $ref: '#/components/schemas/date-time-filter' + phone_numbers: type: array - description: The SLA types the filter matches. + description: | + List of phone numbers, in E.164 format, to filter Rev users on. items: - $ref: '#/components/schemas/sla-type' + type: string + format: text + rev_org: + type: array + description: List of IDs of Rev organizations to be filtered. + example: + - REV-AbCdEfGh + items: + type: string + format: id sort_by: type: array description: | - Fields to sort the SLAs by and the direction to sort them. + Fields to sort the Rev users by and the direction to sort them. items: type: string format: sort-by - status: - type: array - description: The SLA statuses the filter matches. - items: - $ref: '#/components/schemas/sla-status' - title: slas-list-request - slas-list-response: + title: rev-users-list-request + rev-users-list-response: type: object - properties: + description: | + The response to listing all Rev users matching the filter criteria. + properties: next_cursor: type: string description: | @@ -9269,2601 +10420,2292 @@ components: The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. format: text - slas: + rev_users: type: array - description: The list of SLAs. + description: List containing all the Rev users. items: - $ref: '#/components/schemas/sla' + $ref: '#/components/schemas/rev-user' required: - - slas - title: slas-list-response - x-go-name: SlasListResponseBody - slas-transition-request: + - rev_users + title: rev-users-list-response + x-go-name: RevUsersListResponseBody + rev-users-merge-request: type: object + description: Request to merge two Rev users, retaining the primary user. properties: - id: + primary_user: type: string - description: The updated SLA. + description: The ID of the primary Rev user, which will be retained. + format: id + secondary_user: + type: string + description: | + The ID of the secondary Rev user, which will be merged into the + Primary Rev user. format: id - status: - $ref: '#/components/schemas/sla-status' required: - - id - - status - title: slas-transition-request - slas-transition-response: + - primary_user + - secondary_user + title: rev-users-merge-request + rev-users-merge-response: type: object - properties: - sla: - $ref: '#/components/schemas/sla' - required: - - sla - title: slas-transition-response - x-go-name: SlasTransitionResponseBody - slas-update-request: + additionalProperties: false + description: | + Acknowledgment response indicating that the merge request has been + received for processing asynchronously. + title: rev-users-merge-response + x-go-name: RevUsersMergeResponseBody + rev-users-scan-request: type: object + description: Scans the list of Rev users. properties: - account_selector: - $ref: '#/components/schemas/accounts-filters' - description: - type: string - description: Description of the purpose and capabilities of the SLA. - format: text - evaluation_period: - $ref: '#/components/schemas/sla-evaluation-period' - id: - type: string - description: The SLA's ID. - format: id - name: + associations: + type: array + description: | + Filters for Rev users with specified associations + (account/workspace). + items: + type: string + format: id + created_by: + type: array + description: | + Filters for Rev users that were created by the specified user(s). + items: + type: string + format: id + created_date: + $ref: '#/components/schemas/date-time-filter' + cursor: type: string - description: Human-readable name. + description: | + The cursor to resume iteration, otherwise the beginning if not + provided. format: text - policies: + email: + type: array + description: List of emails of Rev users to be filtered. + items: + type: string + format: text + external_ref: + type: array + description: List of external refs to filter Rev users for. + items: + type: string + format: text + is_verified: + type: boolean + description: Value of is_verified field to filter the Rev users. + modified_date: + $ref: '#/components/schemas/date-time-filter' + phone_numbers: type: array description: | - The policies encompassed by this SLA, ordered in decreasing - priority, the whole array will be overwritten by the contents of - this array. + List of phone numbers, in E.164 format, to filter Rev users on. items: - $ref: '#/components/schemas/set-sla-policy' - required: - - id - title: slas-update-request - slas-update-response: - type: object - properties: - sla: - $ref: '#/components/schemas/sla' - required: - - sla - title: slas-update-response - x-go-name: SlasUpdateResponseBody - snap-kit-action-execute-deferred-request: + type: string + format: text + rev_org: + type: array + description: List of IDs of Rev organizations to be filtered. + example: + - REV-AbCdEfGh + items: + type: string + format: id + title: rev-users-scan-request + rev-users-scan-response: type: object + description: The response to scanning Rev users. properties: - actions: + next_cursor: + type: string + description: | + The cursor that should be used to resume iteration, otherwise if + not provided, then iteration has completed. + format: text + rev_users: type: array - description: List of actions triggered in the request. + description: The iterated Rev users. items: - $ref: '#/components/schemas/snap-kit-action-request' - maxItems: 5 - id: - type: string - description: ID of the deferred snap-kit action to be executed. - format: id + $ref: '#/components/schemas/rev-user' required: - - actions - - id - title: snap-kit-action-execute-deferred-request - snap-kit-action-execute-deferred-response: - type: object - additionalProperties: false - title: snap-kit-action-execute-deferred-response - x-go-name: SnapKitActionExecuteDeferredResponseBody - snap-kit-action-request: + - rev_users + title: rev-users-scan-response + x-go-name: RevUsersScanResponseBody + rev-users-update-request: type: object - discriminator: - mapping: - button: '#/components/schemas/snap-kit-action-request-button' - form: '#/components/schemas/snap-kit-action-request-form' - propertyName: type - oneOf: - - $ref: '#/components/schemas/snap-kit-action-request-button' - - $ref: '#/components/schemas/snap-kit-action-request-form' + description: Request to update details of a Rev user. properties: - type: - $ref: '#/components/schemas/snap-kit-action-request-element-type-value' - action_id: + custom_fields: + type: object + description: Application-defined custom fields. + custom_schema_fragments: + $ref: '#/components/schemas/rev-users-update-request-custom-schema-fragments' + custom_schema_spec: + $ref: '#/components/schemas/custom-schema-spec' + description: type: string - description: | - Id of the interactive element specified by developer in a snap-kit - object. + description: Updated description of the Rev user. format: text - action_type: + display_name: type: string - description: Action interaction type. + description: Updated display name of the Rev user. format: text - block_id: + display_picture: type: string - description: | - Id of the block within the surface which is the container for the - interactive element. - format: text - timestamp: + description: Artifact ID of a Rev user's updated display picture. + example: ARTIFACT-12345 + format: id + nullable: true + email: type: string - description: Timestamp when the action was originated. - example: "2023-01-01T12:00:00.000Z" - format: date-time - required: - - action_id - - timestamp - - type - title: snap-kit-action-request - snap-kit-action-request-button: - type: object - properties: - value: + description: Updated email address of the Rev user. + format: text + external_ref: type: string - description: Value for the button interactive element. + description: Updated external ref value of the Rev user. format: text + id: + type: string + description: The ID of Rev user to update. + format: id + phone_numbers: + type: array + description: The phone numbers, in E.164 format, of the Rev user. + items: + type: string + format: text required: - - value - title: snap-kit-action-request-button - snap-kit-action-request-element-type-value: - type: string - enum: - - button - - form - snap-kit-action-request-form: + - id + title: rev-users-update-request + rev-users-update-request-custom-schema-fragments: type: object properties: - value: - type: object - description: Value for the form interactive element. - required: - - value - title: snap-kit-action-request-form - snap-widget: + set: + type: array + description: Sets the IDs to the provided schema fragment IDs. + example: + - don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id + items: + type: string + format: id + title: rev-users-update-request-custom-schema-fragments + rev-users-update-response: type: object - discriminator: - propertyName: type + description: Updated Rev user object. properties: - type: - $ref: '#/components/schemas/snap-widget-type' + rev_user: + $ref: '#/components/schemas/rev-user' required: - - type - title: snap-widget - snap-widget-type: - type: string - stage: + - rev_user + title: rev-users-update-response + x-go-name: RevUsersUpdateResponseBody + role-summary: + allOf: + - $ref: '#/components/schemas/atom-base-summary' + title: role-summary + saml-connection-fields-map: type: object - additionalProperties: false - description: Describes the current stage of a object. - title: stage - stage-filter: - type: object - description: The filter for stages. - properties: - name: - type: array - description: Filters for records in the provided stage(s) by name. - items: - type: string - format: text - title: stage-filter - stage-init: - type: object - description: Sets an object's initial stage. properties: - name: + email: type: string - description: The name of the stage. + description: | + Claims in the SAML assertion returned by the identity provider that + map to the email address of the user. format: text - title: stage-init - stage-update: - type: object - description: Updates an object's stage. - properties: - name: + user_id: type: string description: | - The updated name of the stage, otherwise unchanged if not set. + Claims in the SAML assertion returned by the identity provider that + map to the user ID of the user. format: text - title: stage-update - stage-validation-option-for-create: - type: string - description: Type of stage validation options when creating an object. - enum: - - allow_non_start - stage-validation-option-for-update: - type: string - description: | - Type of state validation options when updating the stage of an object. - enum: - - allow_invalid_transition - staged-info-filter: - type: object - properties: - is_staged: - type: boolean - description: Filters for issues that are staged. - title: staged-info-filter - survey: + title: saml-connection-fields-map + schema-bool-field-descriptor: allOf: - - $ref: '#/components/schemas/atom-base' + - $ref: '#/components/schemas/schema-field-descriptor-base' - type: object properties: - description: - type: string - description: Description of the survey. - format: text - header: - type: string - description: Header of the survey. - format: text - introductory_text: + default_value: + type: boolean + description: Default value. + title: schema-bool-field-descriptor + schema-bool-list-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + default_value: + type: array + description: Default value. + items: + type: boolean + title: schema-bool-list-field-descriptor + schema-composite-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + composite_type: type: string - description: | - Text posted when introducing the survey to the responder. + description: Composite type. Required when field type is composite. format: text - name: + title: schema-composite-field-descriptor + schema-composite-list-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + composite_type: type: string - description: | - Survey name associated with schema. This name would be unique per - dev org. + description: Composite type. Required when field type is composite. format: text - response_text: + title: schema-composite-list-field-descriptor + schema-date-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + default_value: type: string - description: Text posted after the response is collected. + description: Default value. format: text - schema: + title: schema-date-field-descriptor + schema-date-list-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + default_value: type: array - description: List of all fields in the schema. + description: Default value. items: - $ref: '#/components/schemas/schema-field-descriptor' - schema_with_metadata: + type: string + format: text + title: schema-date-list-field-descriptor + schema-double-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + default_value: + type: number + description: Default value. + format: double + title: schema-double-field-descriptor + schema-double-list-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + default_value: type: array - description: | - List of all the fields and their respective metadata in the schema. + description: Default value. items: - $ref: '#/components/schemas/survey-field-with-metadata' - title: + type: number + format: double + title: schema-double-list-field-descriptor + schema-enum-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + allowed_values: + type: array + description: Allowed values for the field. + items: + type: string + format: text + default_value: type: string - description: Title of the survey. + description: Default value. format: text - title: survey - survey-aggregation-filter: - type: object - additionalProperties: false - description: The filter for survey aggregation. - title: survey-aggregation-filter - survey-field-with-metadata: - type: object - description: Field descriptors with additional metadata for surveys. - properties: - field: - $ref: '#/components/schemas/schema-field-descriptor' - metadata: - type: object - description: Additional metadata for the input field. - question: - type: string - description: The question linked to the input field. - format: text - title: survey-field-with-metadata - survey-response: + is_overridable: + type: boolean + description: Whether the enum is overridable. + translated_values: + type: object + additionalProperties: + type: string + format: text + description: Translations for allowed_values field. + required: + - allowed_values + title: schema-enum-field-descriptor + schema-enum-list-field-descriptor: allOf: - - $ref: '#/components/schemas/atom-base' + - $ref: '#/components/schemas/schema-field-descriptor-base' - type: object properties: - dispatch_id: - type: string - description: The unique ID associated with the dispatched survey. - format: id - dispatched_channels: + allowed_values: type: array - description: | - Source channels on which the survey is sent. Stock allowed values: - ``` - { - "id": 1, - "label": "plug", - "ordinal": 1, - "overridable": false - }, - { - "id": 2, - "label": "portal", - "ordinal": 2, - "overridable": false - }, - { - "id": 3, - "label": "email", - "ordinal": 3, - "overridable": false - }, - { - "id": 4, - "label": "slack", - "ordinal": 4, - "overridable": false - } - ``` + description: Allowed values for the field. items: - $ref: '#/components/schemas/enum-value' - object: - type: string - description: The ID of the object for which survey is taken. - format: id - recipient: - $ref: '#/components/schemas/user-summary' - response: + type: string + format: text + default_value: + type: array + description: Default value. + items: + type: string + format: text + is_overridable: + type: boolean + description: Whether the enum is overridable. + translated_values: type: object - description: Response for the survey. - response_channel: - $ref: '#/components/schemas/enum-value' - stage: - $ref: '#/components/schemas/enum-value' - survey: - type: string - description: The ID of the survey for which response is taken. - format: id - title: survey-response - surveys-responses-list-request: - type: object - properties: - created_by: - type: array - description: | - Filters for survey responses created by any of these users. - example: - - DEVU-12345 - items: - type: string - format: id - created_date: - $ref: '#/components/schemas/date-filter' - cursor: - type: string - description: | - The cursor to resume iteration from. If not provided, then - iteration starts from the beginning. - format: text - dispatch_ids: - type: array - description: | - Filters for survey responses associated with these unique IDs. - items: - type: string - format: id - limit: - type: integer - description: | - The maximum number of survey responses to return. If not set, then - the default is '50'. - format: int32 - mode: - $ref: '#/components/schemas/list-mode' - modified_date: - $ref: '#/components/schemas/date-filter' - objects: - type: array - description: Filters for survey responses created for the objects. - example: - - ACC-12345 - items: - type: string - format: id - recipient: - type: array - description: | - Filters for survey responses dispatched to any of these users. - example: - - DEVU-12345 - items: - type: string - format: id - sort_by: - type: array - description: | - Fields to sort the survey responses by and the direction to sort - them. - items: - type: string - format: sort-by - stages: - type: array - description: Filters for survey response stages. - items: - type: integer - format: int64 - surveys: - type: array - description: | - Filters for survey responses for the provided survey IDs. - items: - type: string - format: id - title: surveys-responses-list-request - surveys-responses-list-response: + additionalProperties: + type: string + format: text + description: Translations for allowed_values field. + required: + - allowed_values + title: schema-enum-list-field-descriptor + schema-field-descriptor: type: object + description: Set of field attributes. + discriminator: + mapping: + array: '#/components/schemas/schema-field-descriptor-array-type' + bool: '#/components/schemas/schema-bool-field-descriptor' + composite: '#/components/schemas/schema-composite-field-descriptor' + date: '#/components/schemas/schema-date-field-descriptor' + double: '#/components/schemas/schema-double-field-descriptor' + enum: '#/components/schemas/schema-enum-field-descriptor' + id: '#/components/schemas/schema-id-field-descriptor' + int: '#/components/schemas/schema-int-field-descriptor' + json_value: '#/components/schemas/schema-json-value-field-descriptor' + rich_text: '#/components/schemas/schema-rich-text-field-descriptor' + struct: '#/components/schemas/schema-struct-field-descriptor' + text: '#/components/schemas/schema-text-field-descriptor' + timestamp: '#/components/schemas/schema-timestamp-field-descriptor' + tokens: '#/components/schemas/schema-tokens-field-descriptor' + uenum: '#/components/schemas/schema-uenum-field-descriptor' + unknown: '#/components/schemas/schema-unknown-field-descriptor' + propertyName: field_type + oneOf: + - $ref: '#/components/schemas/schema-bool-field-descriptor' + - $ref: '#/components/schemas/schema-composite-field-descriptor' + - $ref: '#/components/schemas/schema-date-field-descriptor' + - $ref: '#/components/schemas/schema-double-field-descriptor' + - $ref: '#/components/schemas/schema-enum-field-descriptor' + - $ref: '#/components/schemas/schema-field-descriptor-array-type' + - $ref: '#/components/schemas/schema-id-field-descriptor' + - $ref: '#/components/schemas/schema-int-field-descriptor' + - $ref: '#/components/schemas/schema-json-value-field-descriptor' + - $ref: '#/components/schemas/schema-rich-text-field-descriptor' + - $ref: '#/components/schemas/schema-struct-field-descriptor' + - $ref: '#/components/schemas/schema-text-field-descriptor' + - $ref: '#/components/schemas/schema-timestamp-field-descriptor' + - $ref: '#/components/schemas/schema-tokens-field-descriptor' + - $ref: '#/components/schemas/schema-uenum-field-descriptor' + - $ref: '#/components/schemas/schema-unknown-field-descriptor' properties: - next_cursor: - type: string - description: | - The cursor used to iterate subsequent results in accordance to the - sort order. If not set, then no later elements exist. - format: text - prev_cursor: - type: string - description: | - The cursor used to iterate preceding results in accordance to the - sort order. If not set, then no prior elements exist. - format: text - survey_responses: - type: array - description: The list of the survey responses. - items: - $ref: '#/components/schemas/survey-response' + field_type: + $ref: '#/components/schemas/schema-field-descriptor-field-type' required: - - survey_responses - title: surveys-responses-list-response - x-go-name: SurveysResponsesListResponseBody - surveys-responses-update-request: + - field_type + title: schema-field-descriptor + schema-field-descriptor-array-type: type: object + discriminator: + mapping: + bool: '#/components/schemas/schema-bool-list-field-descriptor' + composite: '#/components/schemas/schema-composite-list-field-descriptor' + date: '#/components/schemas/schema-date-list-field-descriptor' + double: '#/components/schemas/schema-double-list-field-descriptor' + enum: '#/components/schemas/schema-enum-list-field-descriptor' + id: '#/components/schemas/schema-id-list-field-descriptor' + int: '#/components/schemas/schema-int-list-field-descriptor' + json_value: '#/components/schemas/schema-json-value-list-field-descriptor' + rich_text: '#/components/schemas/schema-rich-text-list-field-descriptor' + struct: '#/components/schemas/schema-struct-list-field-descriptor' + text: '#/components/schemas/schema-text-list-field-descriptor' + timestamp: '#/components/schemas/schema-timestamp-list-field-descriptor' + tokens: '#/components/schemas/schema-tokens-list-field-descriptor' + uenum: '#/components/schemas/schema-uenum-list-field-descriptor' + propertyName: base_type + oneOf: + - $ref: '#/components/schemas/schema-bool-list-field-descriptor' + - $ref: '#/components/schemas/schema-composite-list-field-descriptor' + - $ref: '#/components/schemas/schema-date-list-field-descriptor' + - $ref: '#/components/schemas/schema-double-list-field-descriptor' + - $ref: '#/components/schemas/schema-enum-list-field-descriptor' + - $ref: '#/components/schemas/schema-id-list-field-descriptor' + - $ref: '#/components/schemas/schema-int-list-field-descriptor' + - $ref: '#/components/schemas/schema-json-value-list-field-descriptor' + - $ref: '#/components/schemas/schema-rich-text-list-field-descriptor' + - $ref: '#/components/schemas/schema-struct-list-field-descriptor' + - $ref: '#/components/schemas/schema-text-list-field-descriptor' + - $ref: '#/components/schemas/schema-timestamp-list-field-descriptor' + - $ref: '#/components/schemas/schema-tokens-list-field-descriptor' + - $ref: '#/components/schemas/schema-uenum-list-field-descriptor' properties: - dispatch_id: - type: string - description: The unique ID associated with the dispatched survey. - format: id - response: - type: object - description: Survey response submitted for the object. - response_channel: + base_type: + $ref: '#/components/schemas/schema-field-descriptor-array-type-base-type' + eq_items: type: integer - description: | - The source channel ordinal which recorded the survey response. + description: The exact array length. format: int64 - response_score: + max_items: type: integer - description: | - The response score for the survey. Only applicable for CSAT and - NPS. - format: int32 - maximum: 10 - minimum: 1 - stage: + description: The maximum array length. + format: int64 + min_items: type: integer - description: The stage ordinal of the survey response object. + description: The minimum array length. format: int64 required: - - dispatch_id - title: surveys-responses-update-request - surveys-responses-update-response: + - base_type + title: schema-field-descriptor-array-type + schema-field-descriptor-array-type-base-type: + type: string + enum: + - bool + - composite + - date + - double + - enum + - id + - int + - json_value + - rich_text + - struct + - text + - timestamp + - tokens + - uenum + schema-field-descriptor-base: type: object - additionalProperties: false - title: surveys-responses-update-response - x-go-name: SurveysResponsesUpdateResponseBody - sync-history: - allOf: - - $ref: '#/components/schemas/atom-base' - - type: object - properties: - sync_run: - $ref: '#/components/schemas/sync-run' - sync_unit: - type: string - description: SyncUnit ID associated with this historical entry. - format: id - title: sync-history - sync-metadata-filter: - type: object - properties: - external_reference: - type: array - description: | - Filters for issues with this specific external reference. - items: - type: string - format: text - last_sync_in: - $ref: '#/components/schemas/sync-metadata-filter-sync-in-filter' - last_sync_out: - $ref: '#/components/schemas/sync-metadata-filter-sync-out-filter' - origin_system: - type: array - description: | - Filters for issues synced from this specific origin system. - items: - type: string - format: text - title: sync-metadata-filter - sync-metadata-filter-sync-in-filter: - type: object - properties: - status: - type: array - description: Filters for works with selected sync statuses. - items: - $ref: '#/components/schemas/sync-metadata-filter-sync-in-filter-status' - sync_date: - $ref: '#/components/schemas/date-filter' - sync_history: - type: array - description: Filters for works modified with selected sync history. - items: - type: string - format: id - sync_unit: - type: array - description: Filters for works modified with selected sync units. - items: - type: string - format: id - title: sync-metadata-filter-sync-in-filter - sync-metadata-filter-sync-in-filter-status: - type: string - enum: - - failed - - modified - - staged - - succeeded - sync-metadata-filter-sync-out-filter: - type: object - properties: - status: - type: array - description: Filters for works with selected sync statuses. - items: - $ref: '#/components/schemas/sync-metadata-filter-sync-out-filter-status' - sync_date: - $ref: '#/components/schemas/date-filter' - sync_history: - type: array - description: Filters for works modified with selected sync history. - items: - type: string - format: id - sync_unit: - type: array - description: Filters for works modified with selected sync units. - items: - type: string - format: id - title: sync-metadata-filter-sync-out-filter - sync-metadata-filter-sync-out-filter-status: - type: string - enum: - - failed - - modified - - succeeded - sync-progress: - type: object - description: Progress. - properties: - state: - $ref: '#/components/schemas/sync-progress-state' - title: sync-progress - sync-progress-state: - type: string - description: The state of a sync progress. - enum: - - completed - - delete_in_progress - - deleted - - deletion_error - - extract_attachments - - extract_attachments_error - - extraction - - extraction_error - - loading - - loading_attachments - - loading_attachments_error - - loading_error - - recipe_discovery - - recipe_discovery_error - - recipe_discovery_waiting_for_user_input - - starting - - transformation - - transformation_error - sync-run: - type: object - description: Object for holding run-specific data. - properties: - ended_at: - type: string - description: The time when a sync was ended. - example: "2023-01-01T12:00:00.000Z" - format: date-time - mode: - $ref: '#/components/schemas/sync-run-mode' - progress: - $ref: '#/components/schemas/sync-progress' - started_at: - type: string - description: The time when a sync was started. - example: "2023-01-01T12:00:00.000Z" - format: date-time - title: sync-run - sync-run-mode: - type: string - description: The direction/mode of a sync run. - enum: - - initial - - sync_from_devrev - - sync_to_devrev - sys-user: - allOf: - - $ref: '#/components/schemas/user-base' - title: sys-user - sys-user-summary: - allOf: - - $ref: '#/components/schemas/user-base-summary' - title: sys-user-summary - sys-users-list-request: - type: object - description: A request to get the list of system user's information. properties: - cursor: + description: type: string - description: | - The cursor to resume iteration from. If not provided, then - iteration starts from the beginning. + description: Description of the field. format: text - limit: - type: integer - description: | - The maximum number of system users to return. Value can range from - '1' to '100', with a default of '50'. - format: int32 - mode: - $ref: '#/components/schemas/list-mode' - sort_by: - type: array - description: | - Fields to sort the system users by and the direction to sort them. - items: - type: string - format: sort-by - title: sys-users-list-request - sys-users-list-response: - type: object - description: The response to listing the system users. - properties: - next_cursor: - type: string + is_filterable: + type: boolean description: | - The cursor used to iterate subsequent results in accordance to the - sort order. If not set, then no later elements exist. - format: text - prev_cursor: - type: string + Whether this field is filterable, groupable and sortable. + is_immutable: + type: boolean + description: Whether this field is immutable or not. + is_pii: + type: boolean description: | - The cursor used to iterate preceding results in accordance to the - sort order. If not set, then no prior elements exist. - format: text - sys_users: - type: array - description: The list of system users. - items: - $ref: '#/components/schemas/sys-user' - required: - - sys_users - title: sys-users-list-response - x-go-name: SysUsersListResponseBody - sys-users-update-request: - type: object - description: Request to update information of the system user. - properties: - display_name: + Whether this field can hold Personally Identifiable Information + (PII). + is_required: + type: boolean + description: Whether this field is required or not. + mfz: + $ref: '#/components/schemas/schema-field-mfz-metadata' + name: type: string - description: Updated display name for the system user. + description: Name of the field. format: text - display_picture: - type: string - description: Artifact ID of the system user's new display picture. - example: ARTIFACT-12345 - format: id - nullable: true - full_name: + oasis: + $ref: '#/components/schemas/schema-field-oasis-metadata' + origin: type: string - description: Updated full name for the system user. + description: Type this field is from. format: text - id: - type: string - description: The ID of system user to update. - format: id + ui: + $ref: '#/components/schemas/schema-field-ui-metadata' required: + - name + title: schema-field-descriptor-base + schema-field-descriptor-field-type: + type: string + enum: + - array + - bool + - composite + - date + - double + - enum - id - title: sys-users-update-request - sys-users-update-response: + - int + - json_value + - rich_text + - struct + - text + - timestamp + - tokens + - uenum + - unknown + schema-field-mfz-metadata: type: object - description: Updated Sys user object. - properties: - sys_user: - $ref: '#/components/schemas/sys-user' - required: - - sys_user - title: sys-users-update-response - x-go-name: SysUsersUpdateResponseBody - tag: + additionalProperties: false + description: The schema of MFZ specific fields. + title: schema-field-mfz-metadata + schema-field-oasis-metadata: + type: object + additionalProperties: false + description: The schema of oasis specific fields. + title: schema-field-oasis-metadata + schema-field-uenum-value: + type: object + additionalProperties: false + description: A unified enum value. + title: schema-field-uenum-value + schema-field-ui-metadata: + type: object + additionalProperties: false + description: The schema of ui specific fields. + title: schema-field-ui-metadata + schema-id-field-descriptor: allOf: - - $ref: '#/components/schemas/atom-base' + - $ref: '#/components/schemas/schema-field-descriptor-base' - type: object properties: - allowed_values: + default_value: + type: string + description: Default value. + format: id + id_type: type: array - description: | - The allowed values for the tag, where a value is provided when a - tag is associated with an object. If empty, then no value should be - provided when the association is made. + description: Object ID types. Required when field type is ID. items: type: string format: text - description: + title: schema-id-field-descriptor + schema-id-list-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + default_value: + type: array + description: Default value. + items: + type: string + format: id + id_type: + type: array + description: Object ID types. Required when field type is ID. + items: + type: string + format: text + title: schema-id-list-field-descriptor + schema-int-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + default_value: + type: integer + description: Default value. + format: int64 + gt: + type: integer + description: The minimum value for the integer (exclusive). + format: int64 + gte: + type: integer + description: The minimum value for the integer (inclusive). + format: int64 + lt: + type: integer + description: The maximum value for the integer (exclusive). + format: int64 + lte: + type: integer + description: The maximum value for the integer (inclusive). + format: int64 + title: schema-int-field-descriptor + schema-int-list-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + default_value: + type: array + description: Default value. + items: + type: integer + format: int64 + gt: + type: integer + description: The minimum value for the integer (exclusive). + format: int64 + gte: + type: integer + description: The minimum value for the integer (inclusive). + format: int64 + lt: + type: integer + description: The maximum value for the integer (exclusive). + format: int64 + lte: + type: integer + description: The maximum value for the integer (inclusive). + format: int64 + title: schema-int-list-field-descriptor + schema-json-value-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + default_value: + description: Default value. + title: schema-json-value-field-descriptor + schema-json-value-list-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + default_value: + type: array + description: Default value. + items: {} + title: schema-json-value-list-field-descriptor + schema-rich-text-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + contains: type: string - description: | - An informative description for the tag that should provide context - on the tag's purpose and usage. + description: The contained substring. format: text - name: + default_value: type: string - description: | - The name of the tag, which denotes the logical concept by which all - tagged objects will be associated. The name is guaranteed to be - unique. + description: Default value. format: text - required: - - name - title: tag - tag-summary: + eq_len: + type: integer + description: The exact string length. + format: int64 + max_len: + type: integer + description: The maximum string length. + format: int64 + min_len: + type: integer + description: The minimum string length. + format: int64 + pattern: + type: string + description: The string pattern (regular expression). + format: text + prefix: + type: string + description: The string prefix. + format: text + suffix: + type: string + description: The string suffix. + format: text + title: schema-rich-text-field-descriptor + schema-rich-text-list-field-descriptor: allOf: - - $ref: '#/components/schemas/atom-base-summary' + - $ref: '#/components/schemas/schema-field-descriptor-base' - type: object properties: - name: + contains: type: string - description: | - The name of the tag, which denotes the logical concept by which all - tagged objects will be associated. The name is guaranteed to be - unique. + description: The contained substring. format: text - required: - - name - title: tag-summary - tag-with-value: - type: object - properties: - tag: - $ref: '#/components/schemas/tag-summary' - value: - type: string - description: The value for the object's association with the tag. - format: text - required: - - tag - title: tag-with-value - tag-with-value-filter: - type: object - properties: - id: - type: string - description: The ID of the tag. - example: TAG-12345 - format: id - value: - type: string - description: | - The value for the object's association with the tag. If specified, - the value must be one that's specified in the tag's allowed values. - format: text - title: tag-with-value-filter - tags-create-request: - type: object - description: The request to create a new tag. - properties: - allowed_values: - type: array - description: | - The allowed values for the tag, or empty if no values are - permitted. - items: - type: string - format: text - description: - type: string - description: The description for the tag. - format: text - name: - type: string - description: | - The name for the tag, which must be unique across all tags. - format: text - required: - - name - title: tags-create-request - tags-create-response: - type: object - description: The response to creating a new tag. - properties: - tag: - $ref: '#/components/schemas/tag' - required: - - tag - title: tags-create-response - x-go-name: TagsCreateResponseBody - tags-delete-request: - type: object - description: The request to delete a tag. - properties: - id: - type: string - description: The ID of the tag to delete. - example: TAG-12345 - format: id - required: - - id - title: tags-delete-request - tags-delete-response: - type: object - additionalProperties: false - description: The response for deleting a tag. - title: tags-delete-response - x-go-name: TagsDeleteResponseBody - tags-get-request: - type: object - description: The request to get a tag's information. - properties: - id: - type: string - description: The requested tag's ID. - example: TAG-12345 - format: id - required: - - id - title: tags-get-request - tags-get-response: - type: object - description: The response to getting a tag's information. - properties: - tag: - $ref: '#/components/schemas/tag' - required: - - tag - title: tags-get-response - x-go-name: TagsGetResponseBody - tags-list-request: - type: object - description: The request to get information about a list of tags. - properties: - cursor: - type: string - description: | - The cursor to resume iteration from. If not provided, then - iteration starts from the beginning. - format: text - limit: - type: integer - description: | - The maximum number of tags to return. The default is '50'. - format: int32 - mode: - $ref: '#/components/schemas/list-mode' - name: - type: array - description: Filters for tags with the provided names. - items: - type: string - format: text - sort_by: - type: array - description: Fields to sort tags by and the direction to sort them. - items: - type: string - format: sort-by - title: tags-list-request - tags-list-response: - type: object - description: The response to listing the tags. - properties: - next_cursor: - type: string - description: | - The cursor used to iterate subsequent results in accordance to the - sort order. If not set, then no later elements exist. - format: text - prev_cursor: - type: string - description: | - The cursor used to iterate preceding results in accordance to the - sort order. If not set, then no prior elements exist. - format: text - tags: - type: array - description: The list of tags. - items: - $ref: '#/components/schemas/tag' - required: - - tags - title: tags-list-response - x-go-name: TagsListResponseBody - tags-update-allowed-values: - type: object - description: Specifies an update to a tag's allowed values. - properties: - set: - type: array - description: Sets the allowed values for the tag. - items: - type: string - format: text - title: tags-update-allowed-values - tags-update-request: - type: object - description: The request to update a tag. - properties: - allowed_values: - $ref: '#/components/schemas/tags-update-allowed-values' - description: - type: string - description: The updated description of the tag. - format: text - id: - type: string - description: The ID of the tag to update. - example: TAG-12345 - format: id - name: - type: string - description: | - The updated name of the tag. The name must be unique across all - tags. - format: text - required: - - id - title: tags-update-request - tags-update-response: - type: object - description: The response for updating a tag. - properties: - tag: - $ref: '#/components/schemas/tag' - required: - - tag - title: tags-update-response - x-go-name: TagsUpdateResponseBody - ticket: - allOf: - - $ref: '#/components/schemas/work-base' - - type: object - properties: - account: - $ref: '#/components/schemas/account-summary' - channels: - type: array - description: Channels of the ticket. - items: - $ref: '#/components/schemas/ticket-channels' - channels_v2: + default_value: type: array - description: Channel IDs of the ticket. + description: Default value. items: - $ref: '#/components/schemas/external-communication-channel-summary' - group: - $ref: '#/components/schemas/group-summary' - needs_response: - type: boolean - description: Whether the ticket needs a response. - rev_org: - $ref: '#/components/schemas/org-summary' - sentiment: - $ref: '#/components/schemas/enum-value' - sentiment_modified_date: + type: string + format: text + eq_len: + type: integer + description: The exact string length. + format: int64 + max_len: + type: integer + description: The maximum string length. + format: int64 + min_len: + type: integer + description: The minimum string length. + format: int64 + pattern: type: string - description: Timestamp when the sentiment was last modified. - example: "2023-01-01T12:00:00.000Z" - format: date-time - sentiment_summary: + description: The string pattern (regular expression). + format: text + prefix: type: string - description: Summary justifying the sentiment. + description: The string prefix. format: text - severity: - $ref: '#/components/schemas/ticket-severity' - sla_summary: - $ref: '#/components/schemas/archetype-sla-summary' - sla_tracker: - $ref: '#/components/schemas/sla-tracker-summary' - source_channel: + suffix: type: string - description: Source channel of the ticket. + description: The string suffix. format: text - source_channel_v2: - $ref: '#/components/schemas/external-communication-channel-summary' - visibility: - $ref: '#/components/schemas/enum-value' - title: ticket - ticket-channels: - type: string - description: Channels of the ticket. - enum: - - email - - plug - - slack - - twilio - - twilio_sms - ticket-severity: - type: string - description: Severity of the ticket. - enum: - - blocker - - high - - low - - medium - ticket-summary: + title: schema-rich-text-list-field-descriptor + schema-struct-field-descriptor: allOf: - - $ref: '#/components/schemas/work-base-summary' + - $ref: '#/components/schemas/schema-field-descriptor-base' - type: object properties: - account: - $ref: '#/components/schemas/account-summary' - rev_org: - $ref: '#/components/schemas/org-summary' - severity: - $ref: '#/components/schemas/ticket-severity' - title: ticket-summary - timeline-comment: + default_value: + type: object + description: Default value. + title: schema-struct-field-descriptor + schema-struct-list-field-descriptor: allOf: - - $ref: '#/components/schemas/timeline-entry-base' + - $ref: '#/components/schemas/schema-field-descriptor-base' - type: object properties: - artifacts: + default_value: type: array - description: The artifacts for the comment. + description: Default value. items: - $ref: '#/components/schemas/artifact-summary' - body: + type: object + title: schema-struct-list-field-descriptor + schema-text-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + contains: type: string - description: | - The comment's body. If the comment has been deleted, then no body - will appear in the response. + description: The contained substring. format: text - body_type: - $ref: '#/components/schemas/timeline-comment-body-type' - references: + default_value: + type: string + description: Default value. + format: text + eq_len: + type: integer + description: The exact string length. + format: int64 + max_len: + type: integer + description: The maximum string length. + format: int64 + min_len: + type: integer + description: The minimum string length. + format: int64 + pattern: + type: string + description: The string pattern (regular expression). + format: text + prefix: + type: string + description: The string prefix. + format: text + suffix: + type: string + description: The string suffix. + format: text + title: schema-text-field-descriptor + schema-text-list-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + contains: + type: string + description: The contained substring. + format: text + default_value: type: array - description: | - Summary information about objects that are referenced in the - comment. + description: Default value. items: - $ref: '#/components/schemas/atom-summary' - snap_kit_body: - $ref: '#/components/schemas/timeline-snap-kit-body' - snap_widget_body: + type: string + format: text + eq_len: + type: integer + description: The exact string length. + format: int64 + max_len: + type: integer + description: The maximum string length. + format: int64 + min_len: + type: integer + description: The minimum string length. + format: int64 + pattern: + type: string + description: The string pattern (regular expression). + format: text + prefix: + type: string + description: The string prefix. + format: text + suffix: + type: string + description: The string suffix. + format: text + title: schema-text-list-field-descriptor + schema-timestamp-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + default_value: + type: string + description: Default value. + format: text + title: schema-timestamp-field-descriptor + schema-timestamp-list-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + default_value: type: array - description: The snap widget body of the comment. + description: Default value. items: - $ref: '#/components/schemas/snap-widget' - title: timeline-comment - timeline-comment-body-type: - type: string - description: The type of the body to use for the comment. - enum: - - data - - snap_kit - - snap_widget - - text - timeline-comment-summary: + type: string + format: text + title: schema-timestamp-list-field-descriptor + schema-tokens-field-descriptor: allOf: - - $ref: '#/components/schemas/timeline-entry-base-summary' - title: timeline-comment-summary - timeline-entries-create-request: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + contains: + type: string + description: The contained substring. + format: text + default_value: + type: string + description: Default value. + format: text + eq_len: + type: integer + description: The exact string length. + format: int64 + max_len: + type: integer + description: The maximum string length. + format: int64 + min_len: + type: integer + description: The minimum string length. + format: int64 + pattern: + type: string + description: The string pattern (regular expression). + format: text + prefix: + type: string + description: The string prefix. + format: text + suffix: + type: string + description: The string suffix. + format: text + title: schema-tokens-field-descriptor + schema-tokens-list-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + contains: + type: string + description: The contained substring. + format: text + default_value: + type: array + description: Default value. + items: + type: string + format: text + eq_len: + type: integer + description: The exact string length. + format: int64 + max_len: + type: integer + description: The maximum string length. + format: int64 + min_len: + type: integer + description: The minimum string length. + format: int64 + pattern: + type: string + description: The string pattern (regular expression). + format: text + prefix: + type: string + description: The string prefix. + format: text + suffix: + type: string + description: The string suffix. + format: text + title: schema-tokens-list-field-descriptor + schema-uenum-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + allowed_values: + type: array + description: Allowed values for the field. + items: + $ref: '#/components/schemas/schema-field-uenum-value' + default_value: + type: integer + description: Default value. + format: int64 + required: + - allowed_values + title: schema-uenum-field-descriptor + schema-uenum-list-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + - type: object + properties: + allowed_values: + type: array + description: Allowed values for the field. + items: + $ref: '#/components/schemas/schema-field-uenum-value' + default_value: + type: array + description: Default value. + items: + type: integer + format: int64 + required: + - allowed_values + title: schema-uenum-list-field-descriptor + schema-unknown-field-descriptor: + allOf: + - $ref: '#/components/schemas/schema-field-descriptor-base' + title: schema-unknown-field-descriptor + service-account: + allOf: + - $ref: '#/components/schemas/user-base' + title: service-account + service-account-summary: + allOf: + - $ref: '#/components/schemas/user-base-summary' + title: service-account-summary + service-accounts-create-request: type: object - description: The request to create a timeline entry for an object. - discriminator: - mapping: - timeline_comment: '#/components/schemas/timeline-entries-create-request-timeline-comment' - propertyName: type - oneOf: - - $ref: '#/components/schemas/timeline-entries-create-request-timeline-comment' + description: The request object to create a new service account. properties: - type: - $ref: '#/components/schemas/timeline-entries-create-request-type' - expires_at: + display_name: type: string description: | - If set, then the entry is ephemeral and will be deleted after the - provided time. The minimum value should be at least a minute more - than the current timestamp. - example: "2023-01-01T12:00:00.000Z" - format: date-time - object: - type: string - description: The ID of the object to create the timeline entry for. - example: PROD-12345 - format: id - private_to: - type: array - description: | - If the visibility of the entry is private, this specifies the users - that the entry is private to. Note the creator is always implicitly - included in this list. - example: - - DEVU-12345 - items: - type: string - format: id - visibility: - $ref: '#/components/schemas/timeline-entry-visibility' - required: - - object - - type - title: timeline-entries-create-request - timeline-entries-create-request-timeline-comment: - type: object - properties: - artifacts: - type: array - description: The IDs of the artifacts attached to the comment. - example: - - ARTIFACT-12345 - items: - type: string - format: id - maxItems: 50 - body: - type: string - description: The comment's body. + The service account's display name. A unique, human readable name + to identify a service account. format: text - body_type: - $ref: '#/components/schemas/timeline-comment-body-type' - snap_kit_body: - $ref: '#/components/schemas/timeline-snap-kit-body' - title: timeline-entries-create-request-timeline-comment - timeline-entries-create-request-type: - type: string - enum: - - timeline_comment - timeline-entries-create-response: - type: object - description: The response to creating a timeline entry for an object. - properties: - timeline_entry: - $ref: '#/components/schemas/timeline-entry' + gen_keyring: + type: boolean + description: | + Indicates whether to generate a keyring along with the new service + account. The default is false. required: - - timeline_entry - title: timeline-entries-create-response - x-go-name: TimelineEntriesCreateResponseBody - timeline-entries-delete-request: + - display_name + title: service-accounts-create-request + service-accounts-create-response: type: object - description: The request to delete a timeline entry from an object. + description: | + The response object to the corresponding create service account + request. properties: - id: - type: string - description: The ID of the timeline entry to delete. - example: don:core:dvrv-us-1:devo/example:ticket/123:comment/comment-id - format: id + service_account: + $ref: '#/components/schemas/service-account' required: - - id - title: timeline-entries-delete-request - timeline-entries-delete-response: - type: object - additionalProperties: false - description: The response to deleting a timeline entry from an object. - title: timeline-entries-delete-response - x-go-name: TimelineEntriesDeleteResponseBody - timeline-entries-get-request: + - service_account + title: service-accounts-create-response + x-go-name: ServiceAccountsCreateResponseBody + service-accounts-get-request: type: object - description: The request to get a timeline entry. + description: The request object to get a service account's information. properties: id: type: string - description: The ID of the timeline entry to get. - example: don:core:dvrv-us-1:devo/example:ticket/123:comment/comment-id + description: The ID of the requested service account. format: id required: - id - title: timeline-entries-get-request - timeline-entries-get-response: - type: object - description: The request to getting a timeline entry. - properties: - timeline_entry: - $ref: '#/components/schemas/timeline-entry' - required: - - timeline_entry - title: timeline-entries-get-response - x-go-name: TimelineEntriesGetResponseBody - timeline-entries-list-request: + title: service-accounts-get-request + service-accounts-get-response: type: object - description: The request to list timeline entries for an object. + description: | + The response object that carries the service account's information + corresponding to the request. properties: - cursor: - type: string - description: | - The cursor to resume iteration from. If not provided, then - iteration starts from the beginning. - format: text - limit: - type: integer - description: | - The maximum number of entries to return. If not set, then this - defaults to `50`. - format: int32 - mode: - $ref: '#/components/schemas/list-mode' - object: - type: string - description: The ID of the object to list timeline entries for. - example: PROD-12345 - format: id - visibility: - type: array - description: | - The visibility of the timeline entries to filter for. Note this is - a strict filter, such that only entries with the exact visibilities - specified will be returned. - items: - $ref: '#/components/schemas/timeline-entry-visibility' + service_account: + $ref: '#/components/schemas/service-account' required: - - object - title: timeline-entries-list-request - timeline-entries-list-response: + - service_account + title: service-accounts-get-response + x-go-name: ServiceAccountsGetResponseBody + set-issue-selector: type: object - description: The response to listing timeline entries for an object. properties: - next_cursor: - type: string - description: | - The cursor used to iterate subsequent results in accordance to the - sort order. If not set, then no later elements exist. - format: text - prev_cursor: - type: string + custom_fields: + type: object description: | - The cursor used to iterate preceding results in accordance to the - sort order. If not set, then no prior elements exist. - format: text - timeline_entries: + Custom fields on the issue with their fully qualified names and the + associated with their exact allowed values. The SLA policy applies + to issues where all named custom fields have exactly the specified + values. + owners: type: array - description: The timeline entries for the object. + description: The SLA policy applies to the issues of these owners. items: - $ref: '#/components/schemas/timeline-entry' - required: - - timeline_entries - title: timeline-entries-list-response - x-go-name: TimelineEntriesListResponseBody - timeline-entries-update-request: - type: object - description: The request to update a timeline entry. - discriminator: - mapping: - timeline_comment: '#/components/schemas/timeline-entries-update-request-timeline-comment' - propertyName: type - oneOf: - - $ref: '#/components/schemas/timeline-entries-update-request-timeline-comment' - properties: - type: - $ref: '#/components/schemas/timeline-entries-update-request-type' - id: - type: string - description: The ID of the timeline entry to update. - example: don:core:dvrv-us-1:devo/example:ticket/123:comment/comment-id - format: id - required: - - id - - type - title: timeline-entries-update-request - timeline-entries-update-request-timeline-comment: - type: object - properties: - artifacts: - $ref: '#/components/schemas/timeline-entries-update-request-timeline-comment-artifacts' - body: - type: string - description: The updated comment's body. - format: text - body_type: - $ref: '#/components/schemas/timeline-comment-body-type' - snap_kit_body: - $ref: '#/components/schemas/timeline-snap-kit-body' - title: timeline-entries-update-request-timeline-comment - timeline-entries-update-request-timeline-comment-artifacts: - type: object - properties: - add: + type: string + format: id + parts: type: array - description: | - Adds the provided artifacts to the comment. An artifact cannot be - added more than once, i.e. nothing is done if the artifact is - already attached. Mutually exclusive with `set`. + description: The SLA policy applies to the issues of these parts. example: - - ARTIFACT-12345 + - PROD-12345 items: type: string format: id - maxItems: 10 - remove: + rev_orgs: type: array - description: | - Removes the provided artifacts from the comment. If an artifact is - not present, then it's ignored. Mututally exclusive with `set`. + description: The SLA policy applies to the issues of these revorgs. example: - - ARTIFACT-12345 + - REV-AbCdEfGh items: type: string format: id - maxItems: 10 - set: + stage_name: type: array - description: Sets the field to the provided artifacts. + description: The SLA policy applies to issues with these stages. + items: + type: string + format: text + subtype: + type: array + description: The issue subtype for which the SLA policy applies. + items: + type: string + format: text + tags: + type: array + description: | + The SLA policy applies to issues with these tags. If empty, the tag + filter isn't applied. example: - - ARTIFACT-12345 + - TAG-12345 items: type: string format: id - maxItems: 50 - title: timeline-entries-update-request-timeline-comment-artifacts - timeline-entries-update-request-type: - type: string - enum: - - timeline_comment - timeline-entries-update-response: + title: set-issue-selector + set-org-schedule-fragment-summary: type: object - description: The response to updating a timeline entry. properties: - timeline_entry: - $ref: '#/components/schemas/timeline-entry' + id: + type: string + description: Organization schedule fragment ID. + format: id required: - - timeline_entry - title: timeline-entries-update-response - x-go-name: TimelineEntriesUpdateResponseBody - timeline-entry: + - id + title: set-org-schedule-fragment-summary + set-shared-with-membership: type: object - discriminator: - mapping: - timeline_comment: '#/components/schemas/timeline-comment' - propertyName: type - oneOf: - - $ref: '#/components/schemas/timeline-comment' - properties: - type: - $ref: '#/components/schemas/timeline-entry-type' - required: - - type - title: timeline-entry - timeline-entry-base: - allOf: - - $ref: '#/components/schemas/atom-base' - - type: object - properties: - object: - type: string - description: The object that the Timeline entry belongs to. - format: id - object_display_id: - type: string - description: | - The display ID of the object that the Timeline entry belongs to. - format: text - object_type: - $ref: '#/components/schemas/timeline-entry-object-type' - visibility: - $ref: '#/components/schemas/timeline-entry-visibility' - required: - - object - - object_display_id - title: timeline-entry-base - timeline-entry-base-summary: - allOf: - - $ref: '#/components/schemas/atom-base-summary' - title: timeline-entry-base-summary - timeline-entry-object-type: - type: string - description: The type of object that the Timeline entry belongs to. - enum: - - capability - - conversation - - enhancement - - feature - - issue - - product - - rev_org - - rev_user - - ticket - - timeline_comment - timeline-entry-type: - type: string - enum: - - timeline_comment - timeline-entry-visibility: - type: string description: | - The visibility of the entry. If 'private', then the entry is only - visible to the creator, 'internal' is visible with the Dev - organization, 'external' is visible to the Dev organzation and Rev - users, and 'public' is visible to all. If not set, then the default - visibility is 'external'. - enum: - - external - - internal - - private - - public - timeline-snap-kit-body: - type: object - description: Snap Kit Body of the comment. + Information about the role the member receives due to the share. properties: - body: - type: object - description: The JSON body of the SnapKit. - snap_in_action_name: + member: type: string - description: | - The name of an action defined in the SnapIn. The combination of - snap_in_id and snap_in_action_name uniquely identifies the - interaction object which is to be called when actions on a snapkit - element is taken. - format: text - snap_in_id: + description: ID of the member the object is shared with. + format: id + role: type: string - description: ID of the snap-in which created the SnapKit. - format: text - title: timeline-snap-kit-body - user-base: - allOf: - - $ref: '#/components/schemas/atom-base' - - type: object - properties: - display_name: - type: string - description: | - The user's display name. The name is non-unique and mutable. - format: text - display_picture: - $ref: '#/components/schemas/artifact-summary' - email: - type: string - description: Email address of the user. - format: text - full_name: - type: string - description: Full name of the user. - format: text - phone_numbers: - type: array - description: Phone numbers of the user. - items: - type: string - format: text - state: - $ref: '#/components/schemas/user-state' - title: user-base - user-base-summary: - allOf: - - $ref: '#/components/schemas/atom-base-summary' - - type: object - properties: - display_name: - type: string - description: | - The user's display name. The name is non-unique and mutable. - format: text - display_picture: - $ref: '#/components/schemas/artifact-summary' - email: - type: string - description: Email address of the user. - format: text - full_name: - type: string - description: Full name of the user. - format: text - state: - $ref: '#/components/schemas/user-state' - title: user-base-summary - user-skill: + description: | + ID of the role that describes what privileges the membership + entails. + format: id + title: set-shared-with-membership + set-sla-policy: type: object - description: Skill associated with the user. properties: + metrics: + type: array + description: Metrics to apply to the selected items. + items: + $ref: '#/components/schemas/set-support-metric-target' name: type: string - description: Name of the skill. + description: Human-readable name. format: text - title: user-skill - user-state: - type: string - description: State of the user. - enum: - - active - - deactivated - - deleted - - locked - - shadow - - unassigned - user-summary: - type: object - discriminator: - mapping: - dev_user: '#/components/schemas/dev-user-summary' - rev_user: '#/components/schemas/rev-user-summary' - service_account: '#/components/schemas/service-account-summary' - sys_user: '#/components/schemas/sys-user-summary' - propertyName: type - oneOf: - - $ref: '#/components/schemas/dev-user-summary' - - $ref: '#/components/schemas/rev-user-summary' - - $ref: '#/components/schemas/service-account-summary' - - $ref: '#/components/schemas/sys-user-summary' - properties: - type: - $ref: '#/components/schemas/user-type' + selector: + $ref: '#/components/schemas/set-sla-selector' required: - - type - title: user-summary - user-type: - type: string - enum: - - dev_user - - rev_user - - service_account - - sys_user - vista-group-item-state: - type: string - description: Defines the state of the group item. - enum: - - active - - completed - - planned - vista-group-item-summary: + - name + - selector + title: set-sla-policy + set-sla-selector: type: object - description: Vista group item. properties: - type: - $ref: '#/components/schemas/vista-group-item-type' - end_date: - type: string - description: Timestamp when the vista ends. - example: "2023-01-01T12:00:00.000Z" - format: date-time - id: - type: string - description: ID of the group item in don v2 format. - format: id - name: - type: string - description: Name of the group. - format: text - start_date: - type: string - description: Timestamp when the vista starts. - example: "2023-01-01T12:00:00.000Z" - format: date-time - state: - $ref: '#/components/schemas/vista-group-item-state' - required: - - id - - name - - type - title: vista-group-item-summary - vista-group-item-type: - type: string - description: Type of the group object. - enum: - - curated - - dynamic - webhook: + applies_to: + $ref: '#/components/schemas/sla-selector-applies-to' + custom_fields: + type: object + description: | + Custom fields with their fully qualified names and associated with + their exact allowed values. The SLA policy applies to records where + all named custom fields have exactly the specified values. If the + value is null, the field must have null value or not be present. + groups: + type: array + description: | + The SLA policy applies to the tickets or conversations of these + groups. + items: + type: string + format: id + issue_selector: + $ref: '#/components/schemas/set-issue-selector' + owners: + type: array + description: | + The SLA policy applies to the tickets or conversations of these + owners. + items: + type: string + format: id + parts: + type: array + description: The SLA policy applies to the tickets of these parts. + example: + - PROD-12345 + items: + type: string + format: id + priority: + type: array + description: | + The SLA policy applies to conversations with these priorities. + items: + $ref: '#/components/schemas/sla-selector-priority' + severity: + type: array + description: The SLA policy applies to tickets with these severities. + items: + $ref: '#/components/schemas/sla-selector-severity' + source_channel: + type: array + description: | + The SLA policy applies to conversations with these sources. + items: + type: string + format: text + subtype: + type: array + description: The SLA policy applies to tickets with these subtypes. + items: + type: string + format: text + tags: + type: array + description: The SLA policy applies to items with these tags. + example: + - TAG-12345 + items: + type: string + format: id + ticket_source_channel: + type: array + description: | + The SLA policy applies to tickets with these source channels. + items: + type: string + format: text + required: + - applies_to + title: set-sla-selector + set-support-metric-target: + type: object + properties: + metric: + type: string + description: The metric to apply. + format: id + org_schedule_id: + type: string + description: | + The organization schedule controlling this metrics calculation. + Time based metrics don't consume time while their schedule is off. + format: id + performance: + type: number + description: | + The percentage of instances for which this metric's target must not + be breached, in order to avoid breaching the overall SLA policy. + format: double + target: + type: integer + description: | + The target value to be achieved, for example the time in which to + do something, or the maximum allowed number of message pairs. The + units and interpretation of the value is controlled by the + properties of the referenced metric. + format: int32 + warning_target: + type: integer + description: | + The threshold in the same units as target where the metric is + considered to be 'at risk'. + format: int32 + required: + - metric + - target + title: set-support-metric-target + set-tag-with-value: + type: object + properties: + id: + type: string + description: The ID of the tag. + example: TAG-12345 + format: id + value: + type: string + description: | + The value for the object's association with the tag. If specified, + the value must be one that's specified in the tag's allowed values. + format: text + required: + - id + title: set-tag-with-value + set-weekly-org-schedule: + type: object + properties: + intervals: + type: array + description: The 'on' intervals of the week. + items: + $ref: '#/components/schemas/create-weekly-org-schedule-interval' + period_name: + type: string + description: | + The name of the period during which the organization schedule + applies. + format: text + required: + - intervals + - period_name + title: set-weekly-org-schedule + shared-with-membership: + type: object + description: | + Information about the role the member receives due to the share. + properties: + member: + $ref: '#/components/schemas/member-summary' + role: + $ref: '#/components/schemas/role-summary' + title: shared-with-membership + shared-with-membership-filter: + type: object + description: Filter on target item based on intended audience. + properties: + member: + type: string + description: ID of the group/member with whom the item is shared. + format: id + role: + type: string + description: | + Role ID of the group/member with whom the item is shared. + format: id + title: shared-with-membership-filter + sla: allOf: - $ref: '#/components/schemas/atom-base' - type: object properties: - event_types: - type: array - description: The event types that the webhook will receive. - items: - $ref: '#/components/schemas/webhook-event-type' - secret: + account_filter: + type: object + description: | + A set of account attributes that must be satisfied for the SLA to + apply. AND applies between each field. + compensation: + $ref: '#/components/schemas/sla-compensation' + description: type: string - description: The secret to use for verifying webhook events. - format: byte - status: - $ref: '#/components/schemas/webhook-status' - url: + description: Description of the purpose and capabilities of the SLA. + format: text + evaluation_period: + $ref: '#/components/schemas/sla-evaluation-period' + name: type: string - description: The URL of the webhook endpoint. + description: Human-readable name. format: text + policies: + type: array + description: | + The policies encompassed by this SLA, ordered in decreasing + priority. + items: + $ref: '#/components/schemas/sla-policy' + sla_type: + $ref: '#/components/schemas/sla-type' + status: + $ref: '#/components/schemas/sla-status' required: - - secret + - name - status - - url - title: webhook - webhook-event-request: + title: sla + sla-applies-to: + type: string + description: | + The object types on which the SLA applies. An external SLA can apply to + multiple object types, but an internal SLA can apply to only one object + type. + enum: + - conversation + - issue + - ticket + sla-assign-result: type: object properties: - type: - $ref: '#/components/schemas/webhook-event-type' - account_created: - $ref: '#/components/schemas/event-account-created' - account_deleted: - $ref: '#/components/schemas/event-account-deleted' - account_updated: - $ref: '#/components/schemas/event-account-updated' - ai_agent_response: - $ref: '#/components/schemas/event-ai-agent-response' - conversation_created: - $ref: '#/components/schemas/event-conversation-created' - conversation_deleted: - $ref: '#/components/schemas/event-conversation-deleted' - conversation_updated: - $ref: '#/components/schemas/event-conversation-updated' - dashboard_created: - $ref: '#/components/schemas/event-dashboard-created' - dashboard_deleted: - $ref: '#/components/schemas/event-dashboard-deleted' - dashboard_updated: - $ref: '#/components/schemas/event-dashboard-updated' - dev_user_created: - $ref: '#/components/schemas/event-dev-user-created' - dev_user_deleted: - $ref: '#/components/schemas/event-dev-user-deleted' - dev_user_updated: - $ref: '#/components/schemas/event-dev-user-updated' - group_created: - $ref: '#/components/schemas/event-group-created' - group_deleted: - $ref: '#/components/schemas/event-group-deleted' - group_member_added: - $ref: '#/components/schemas/event-group-member-added' - group_member_removed: - $ref: '#/components/schemas/event-group-member-removed' - group_updated: - $ref: '#/components/schemas/event-group-updated' - id: - type: string - description: The event's ID. - format: id - incident_created: - $ref: '#/components/schemas/event-incident-created' - incident_deleted: - $ref: '#/components/schemas/event-incident-deleted' - incident_updated: - $ref: '#/components/schemas/event-incident-updated' - link_created: - $ref: '#/components/schemas/event-link-created' - link_deleted: - $ref: '#/components/schemas/event-link-deleted' - link_updated: - $ref: '#/components/schemas/event-link-updated' - part_created: - $ref: '#/components/schemas/event-part-created' - part_deleted: - $ref: '#/components/schemas/event-part-deleted' - part_updated: - $ref: '#/components/schemas/event-part-updated' - question_answer_created: - $ref: '#/components/schemas/event-question-answer-created' - question_answer_deleted: - $ref: '#/components/schemas/event-question-answer-deleted' - question_answer_updated: - $ref: '#/components/schemas/event-question-answer-updated' - rev_org_created: - $ref: '#/components/schemas/event-rev-org-created' - rev_org_deleted: - $ref: '#/components/schemas/event-rev-org-deleted' - rev_org_updated: - $ref: '#/components/schemas/event-rev-org-updated' - rev_user_created: - $ref: '#/components/schemas/event-rev-user-created' - rev_user_deleted: - $ref: '#/components/schemas/event-rev-user-deleted' - rev_user_updated: - $ref: '#/components/schemas/event-rev-user-updated' - sla_tracker_created: - $ref: '#/components/schemas/event-sla-tracker-created' - sla_tracker_deleted: - $ref: '#/components/schemas/event-sla-tracker-deleted' - sla_tracker_fetched: - $ref: '#/components/schemas/event-sla-tracker-fetched' - sla_tracker_updated: - $ref: '#/components/schemas/event-sla-tracker-updated' - survey_created: - $ref: '#/components/schemas/event-survey-created' - survey_deleted: - $ref: '#/components/schemas/event-survey-deleted' - survey_response_created: - $ref: '#/components/schemas/event-survey-response-created' - survey_response_deleted: - $ref: '#/components/schemas/event-survey-response-deleted' - survey_response_updated: - $ref: '#/components/schemas/event-survey-response-updated' - survey_updated: - $ref: '#/components/schemas/event-survey-updated' - sync_history_created: - $ref: '#/components/schemas/event-sync-history-created' - sync_history_deleted: - $ref: '#/components/schemas/event-sync-history-deleted' - sync_history_updated: - $ref: '#/components/schemas/event-sync-history-updated' - tag_created: - $ref: '#/components/schemas/event-tag-created' - tag_deleted: - $ref: '#/components/schemas/event-tag-deleted' - tag_updated: - $ref: '#/components/schemas/event-tag-updated' - timeline_entry_created: - $ref: '#/components/schemas/event-timeline-entry-created' - timeline_entry_deleted: - $ref: '#/components/schemas/event-timeline-entry-deleted' - timeline_entry_updated: - $ref: '#/components/schemas/event-timeline-entry-updated' - timestamp: - type: string - description: | - Timestamp of the webhook's invocation for the event. Note this - should be used to protect against replay attacks, where the event - should only be processed if the timestamp isn't stale by several - seconds. - example: "2023-01-01T12:00:00.000Z" - format: date-time - verify: - $ref: '#/components/schemas/webhook-event-verify' - webhook_created: - $ref: '#/components/schemas/event-webhook-created' - webhook_deleted: - $ref: '#/components/schemas/event-webhook-deleted' - webhook_id: - type: string - description: ID of the webhook for the event. - example: don:integration:dvrv-us-1:devo/example:webhook/webhook-id - format: id - webhook_updated: - $ref: '#/components/schemas/event-webhook-updated' - widget_created: - $ref: '#/components/schemas/event-widget-created' - widget_deleted: - $ref: '#/components/schemas/event-widget-deleted' - widget_updated: - $ref: '#/components/schemas/event-widget-updated' - work_created: - $ref: '#/components/schemas/event-work-created' - work_deleted: - $ref: '#/components/schemas/event-work-deleted' - work_fetched: - $ref: '#/components/schemas/event-work-fetched' - work_updated: - $ref: '#/components/schemas/event-work-updated' + error: + $ref: '#/components/schemas/error' + rev_org: + $ref: '#/components/schemas/rev-org-summary' required: - - id - - webhook_id - title: webhook-event-request - webhook-event-response: + - rev_org + title: sla-assign-result + sla-compensation: type: object - properties: - challenge: - type: string - description: | - The challenge from the "verify" request, otherwise this should not - be set for other request types. - format: byte - title: webhook-event-response - x-go-name: WebhookEventResponseBody - webhook-event-type: + additionalProperties: false + description: | + Describes the compensation to be provided in case of SLA breach. It is + not 'self-executing', it is the responsibility of the organization + providing the SLA to actually transfer the promised credit, resource or + other payment. + title: sla-compensation + sla-evaluation-period: type: string - description: The event types that the webhook will receive. + description: | + Specifies the frequency of when the contractually-meaningful evaluation + of the SLA happens. The organization for their own information might + evaluate the various metrics contained in the policy as often as we can + make it feasible for them, but only the evaluation at the end of the + evaluation period triggers a compensation and needs to be shared with + the customer. enum: - - account_created - - account_deleted - - account_updated - - ai_agent_response - - conversation_created - - conversation_deleted - - conversation_updated - - dashboard_created - - dashboard_deleted - - dashboard_updated - - dev_user_created - - dev_user_deleted - - dev_user_updated - - group_created - - group_deleted - - group_member_added - - group_member_removed - - group_updated - - incident_created - - incident_deleted - - incident_updated - - job_created - - job_deleted - - job_updated - - link_created - - link_deleted - - link_updated - - part_created - - part_deleted - - part_updated - - question_answer_created - - question_answer_deleted - - question_answer_updated - - rev_org_created - - rev_org_deleted - - rev_org_updated - - rev_user_created - - rev_user_deleted - - rev_user_updated - - sla_tracker_created - - sla_tracker_deleted - - sla_tracker_fetched - - sla_tracker_updated - - survey_created - - survey_deleted - - survey_response_created - - survey_response_deleted - - survey_response_updated - - survey_updated - - sync_history_created - - sync_history_deleted - - sync_history_updated - - sync_unit_updated - - tag_created - - tag_deleted - - tag_updated - - timeline_entry_created - - timeline_entry_deleted - - timeline_entry_updated - - verify - - webhook_created - - webhook_deleted - - webhook_updated - - widget_created - - widget_deleted - - widget_updated - - work_created - - work_deleted - - work_fetched - - work_updated - webhook-event-verify: + - monthly + - quarterly + - weekly + - yearly + sla-policy: type: object - properties: - challenge: - type: string - description: The challenge that must be echoed in the response. - format: byte - required: - - challenge - title: webhook-event-verify - webhook-status: + additionalProperties: false + description: A policy that represents a promise to your revs. + title: sla-policy + sla-selector-applies-to: type: string - description: The status of the webhook. + description: The item type for which the SLA policy applies. enum: - - active - - inactive - - unverified - webhook-summary: - allOf: - - $ref: '#/components/schemas/atom-base-summary' - title: webhook-summary - webhooks-create-request: - type: object - description: The request to create a new webhook. + - conversation + - issue + - ticket + sla-selector-priority: + type: string + description: | + The SLA policy applies to conversations with these priorities. + enum: + - p0 + - p1 + - p2 + sla-selector-severity: + type: string + description: The SLA policy applies to tickets with these severities. + enum: + - blocker + - high + - low + - medium + sla-status: + type: string + description: | + Status determines how an item can be used. In 'draft' status an item + can be edited but can't be used. When 'published' the item can longer + be edited but can be used. 'Archived' is read-only. + enum: + - archived + - draft + - published + sla-summary: + allOf: + - $ref: '#/components/schemas/atom-base-summary' + - type: object + properties: + name: + type: string + description: Human-readable name. + format: text + sla_type: + $ref: '#/components/schemas/sla-type' + status: + $ref: '#/components/schemas/sla-status' + required: + - name + - status + title: sla-summary + sla-summary-filter: + type: object + description: The filter for SLA summary. properties: - event_types: + stage: type: array - description: The event types that the webhook endpoint will receive. + description: Filters for records with any of the provided SLA stages. items: - $ref: '#/components/schemas/webhook-event-type' - secret: - type: string - description: | - The secret to use when verifying webhook events. If provided, the - secret must be between 8 and 32 bytes (inclusive). If not set, a - secret will be automatically generated and provided in the - response. - format: byte - url: - type: string - description: The URL of the webhook endpoint. - format: text - required: - - url - title: webhooks-create-request - webhooks-create-response: - type: object - description: The response to creating a new webhook. - properties: - webhook: - $ref: '#/components/schemas/webhook' - required: - - webhook - title: webhooks-create-response - x-go-name: WebhooksCreateResponseBody - webhooks-delete-request: + $ref: '#/components/schemas/sla-summary-stage' + target_time: + $ref: '#/components/schemas/date-filter' + title: sla-summary-filter + sla-summary-stage: + type: string + description: | + The stage of the SLA. This is the metric stage which is closest to + breach. + enum: + - breached + - completed + - paused + - running + - warning + sla-tracker: + allOf: + - $ref: '#/components/schemas/atom-base' + - type: object + properties: + applies_to_id: + type: string + description: Details of the object on which the SLA is being tracked. + format: id + applies_to_type: + $ref: '#/components/schemas/sla-tracker-applies-to-type' + metric_target_summaries: + type: array + description: | + Summary of the metrics target being tracked in the SLA tracker. + items: + $ref: '#/components/schemas/archetype-metric-target' + removed_sla_metric_history: + type: array + description: Information about removed metrics. + items: + $ref: '#/components/schemas/removed-sla-metric-history' + sla: + $ref: '#/components/schemas/sla-summary' + sla_policy_id: + type: string + description: | + Details of the applicable SLA policy. Can be omitted if no sla + applies, or if no policy of the sla applies at the moment. + format: id + stage: + type: string + description: SLA stage of the object being tracked. + format: text + status: + type: string + description: | + It is an indicator of whether the SLA has ever been breached + (missed). If not, it shows whether the SLA is completed, in + progress, or nil - if no policy is applied. + format: text + required: + - metric_target_summaries + title: sla-tracker + sla-tracker-applies-to-type: + type: string + description: The type of the object on which the SLA is being tracked. + enum: + - conversation + - issue + - ticket + sla-tracker-summary: + allOf: + - $ref: '#/components/schemas/atom-base-summary' + - type: object + properties: + applies_to_type: + $ref: '#/components/schemas/sla-tracker-applies-to-type' + title: sla-tracker-summary + sla-trackers-get-request: type: object - description: The request to delete a webhook. properties: id: type: string - description: ID for the webhook. - example: don:integration:dvrv-us-1:devo/example:webhook/webhook-id + description: The ID of the SLA tracker to get. format: id required: - id - title: webhooks-delete-request - webhooks-delete-response: - type: object - additionalProperties: false - description: The response to deleting the webhook. - title: webhooks-delete-response - x-go-name: WebhooksDeleteResponseBody - webhooks-get-request: + title: sla-trackers-get-request + sla-trackers-get-response: type: object - description: The request to get a webhook's information. properties: - id: - type: string - description: ID for the webhook. - example: don:integration:dvrv-us-1:devo/example:webhook/webhook-id - format: id + sla_tracker: + $ref: '#/components/schemas/sla-tracker' required: - - id - title: webhooks-get-request - webhooks-get-response: + - sla_tracker + title: sla-trackers-get-response + x-go-name: SlaTrackersGetResponseBody + sla-trackers-list-request: type: object - description: The response to getting the information for the webhook. properties: - webhook: - $ref: '#/components/schemas/webhook' - required: - - webhook - title: webhooks-get-response - x-go-name: WebhooksGetResponseBody - webhooks-list-request: - type: object - additionalProperties: false - description: The request to list the webhooks. - title: webhooks-list-request - webhooks-list-response: + created_date: + $ref: '#/components/schemas/date-time-filter' + cursor: + type: string + description: | + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. + format: text + limit: + type: integer + description: | + The maximum number of SLA trackers to return. The default is '50'. + format: int32 + mode: + $ref: '#/components/schemas/list-mode' + modified_date: + $ref: '#/components/schemas/date-time-filter' + sort_by: + type: array + description: | + Fields to sort the SLA Trackers by and the direction to sort them. + items: + type: string + format: sort-by + stage: + type: array + description: The SLA tracker stages the filter matches. + items: + type: string + format: text + status: + type: array + description: The SLA tracker statuses the filter matches. + items: + type: string + format: text + title: sla-trackers-list-request + sla-trackers-list-response: type: object - description: The response to listing the webhooks. properties: - webhooks: + next_cursor: + type: string + description: | + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. + format: text + prev_cursor: + type: string + description: | + The cursor used to iterate preceding results in accordance to the + sort order. If not set, then no prior elements exist. + format: text + sla_trackers: type: array - description: The list of webhooks. + description: The list of SLA trackers. items: - $ref: '#/components/schemas/webhook' + $ref: '#/components/schemas/sla-tracker' required: - - webhooks - title: webhooks-list-response - x-go-name: WebhooksListResponseBody - webhooks-update-action: + - sla_trackers + title: sla-trackers-list-response + x-go-name: SlaTrackersListResponseBody + sla-type: type: string - description: The action to update the webhook's status. + description: Type of the SLA. enum: - - activate - - deactivate - webhooks-update-request: + - external + - internal + slas-assign-request: type: object - description: The request to update a webhook. properties: - action: - $ref: '#/components/schemas/webhooks-update-action' - event_types: - $ref: '#/components/schemas/webhooks-update-request-event-types' id: type: string - description: ID for the webhook. - example: don:integration:dvrv-us-1:devo/example:webhook/webhook-id + description: | + The SLA which would be assigned to the Rev organizations. If + omitted, the SLA of all the rev organizations referenced will be + unset. format: id - secret: + rev_orgs: + type: array + description: The Rev organizations to apply the SLA to. + example: + - REV-AbCdEfGh + items: + type: string + format: id + required: + - rev_orgs + title: slas-assign-request + slas-assign-response: + type: object + properties: + results: + type: array + description: The list of outcomes for each Rev organization. + items: + $ref: '#/components/schemas/sla-assign-result' + required: + - results + title: slas-assign-response + x-go-name: SlasAssignResponseBody + slas-create-request: + type: object + properties: + account_selector: + $ref: '#/components/schemas/accounts-filters' + applies_to: + type: array + description: The object types this SLA can apply to. + items: + $ref: '#/components/schemas/sla-applies-to' + description: type: string - description: | - If provided, updates the secret that's used when verifying webhook - events, which must be between 8 and 32 bytes (inclusive). Otherwise - if empty, then a new secret is generated. If the webhook is active, - then its status will transition to the 'unverified' state and it - won't receive any object events until successfully verified. - format: byte - url: + description: Description of the purpose and capabilities of the SLA. + format: text + evaluation_period: + $ref: '#/components/schemas/sla-evaluation-period' + name: type: string - description: | - The webhook's updated URL. If the webhook is active, then the - webhook's status will transition to the 'unverified' state and it - won't receive any object events until successfully verified. + description: Human-readable name. format: text + policies: + type: array + description: | + The policies encompassed by this SLA, ordered in decreasing + priority. + items: + $ref: '#/components/schemas/set-sla-policy' + sla_type: + $ref: '#/components/schemas/sla-type' + required: + - name + title: slas-create-request + slas-create-response: + type: object + properties: + sla: + $ref: '#/components/schemas/sla' + required: + - sla + title: slas-create-response + x-go-name: SlasCreateResponseBody + slas-filter-applies-to-operator-type: + type: string + enum: + - all + - any + slas-get-request: + type: object + properties: + id: + type: string + description: The ID of the SLA to get. + format: id required: - id - title: webhooks-update-request - webhooks-update-request-event-types: + title: slas-get-request + slas-get-response: type: object properties: - add: + sla: + $ref: '#/components/schemas/sla' + required: + - sla + title: slas-get-response + x-go-name: SlasGetResponseBody + slas-list-request: + type: object + properties: + applies_to: type: array + description: The object types the SLA applies to. + items: + $ref: '#/components/schemas/sla-applies-to' + applies_to_op: + $ref: '#/components/schemas/slas-filter-applies-to-operator-type' + cursor: + type: string description: | - The event types to add. If a provided event type is already set for - the webhook, then nothing is done. Note this is mutually exclusive - with 'set'. + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. + format: text + limit: + type: integer + description: | + The maximum number of SLAs to return. The default is '50'. + format: int32 + mode: + $ref: '#/components/schemas/list-mode' + sla_type: + type: array + description: The SLA types the filter matches. items: - $ref: '#/components/schemas/webhook-event-type' - remove: + $ref: '#/components/schemas/sla-type' + sort_by: type: array description: | - The event types to remove. If a provided event type isn't set for - the webhook, then nothing is done. Note this is mutually exclusive - with 'set'. + Fields to sort the SLAs by and the direction to sort them. items: - $ref: '#/components/schemas/webhook-event-type' - set: + type: string + format: sort-by + status: type: array + description: The SLA statuses the filter matches. + items: + $ref: '#/components/schemas/sla-status' + title: slas-list-request + slas-list-response: + type: object + properties: + next_cursor: + type: string description: | - The updated event types, which will replace the webhook's current - event types. Note this is mutually exclusive with 'add' and - 'remove'. + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. + format: text + prev_cursor: + type: string + description: | + The cursor used to iterate preceding results in accordance to the + sort order. If not set, then no prior elements exist. + format: text + slas: + type: array + description: The list of SLAs. items: - $ref: '#/components/schemas/webhook-event-type' - title: webhooks-update-request-event-types - webhooks-update-response: + $ref: '#/components/schemas/sla' + required: + - slas + title: slas-list-response + x-go-name: SlasListResponseBody + slas-transition-request: type: object - description: The response to updating the webhook. properties: - webhook: - $ref: '#/components/schemas/webhook' + id: + type: string + description: The updated SLA. + format: id + status: + $ref: '#/components/schemas/sla-status' required: - - webhook - title: webhooks-update-response - x-go-name: WebhooksUpdateResponseBody - widget: - allOf: - - $ref: '#/components/schemas/atom-base' - title: widget - work: + - id + - status + title: slas-transition-request + slas-transition-response: type: object - discriminator: - mapping: - issue: '#/components/schemas/issue' - ticket: '#/components/schemas/ticket' - propertyName: type - oneOf: - - $ref: '#/components/schemas/issue' - - $ref: '#/components/schemas/ticket' properties: - type: - $ref: '#/components/schemas/work-type' + sla: + $ref: '#/components/schemas/sla' required: - - type - title: work - work-base: - allOf: - - $ref: '#/components/schemas/atom-base' - - type: object - properties: - applies_to_part: - $ref: '#/components/schemas/part-summary' - artifacts: - type: array - description: The artifacts attached to the work item. - items: - $ref: '#/components/schemas/artifact-summary' - body: - type: string - description: Body of the work object. - format: text - owned_by: - type: array - description: The users that own the work. - items: - $ref: '#/components/schemas/user-summary' - reported_by: - type: array - description: Users that reported the work. - items: - $ref: '#/components/schemas/user-summary' - stage: - $ref: '#/components/schemas/legacy-stage' - tags: - type: array - description: Tags associated with the object. - items: - $ref: '#/components/schemas/tag-with-value' - target_close_date: - type: string - description: Timestamp when the work is expected to be complete. - example: "2023-01-01T12:00:00.000Z" - format: date-time - title: - type: string - description: Title of the work object. - format: text - required: - - owned_by - - title - title: work-base - work-base-summary: - allOf: - - $ref: '#/components/schemas/atom-base-summary' - - type: object - properties: - owned_by: - type: array - description: The users that own the work. - items: - $ref: '#/components/schemas/user-summary' - stage: - $ref: '#/components/schemas/legacy-stage-summary' - title: - type: string - description: Title of the work object. - format: text - required: - - owned_by - - title - title: work-base-summary - work-type: - type: string - enum: - - issue - - ticket - workflow-run-summary: - allOf: - - $ref: '#/components/schemas/atom-base-summary' - title: workflow-run-summary - workflow-summary: - allOf: - - $ref: '#/components/schemas/atom-base-summary' - title: workflow-summary - works-create-request: + - sla + title: slas-transition-response + x-go-name: SlasTransitionResponseBody + slas-update-request: + type: object + properties: + account_selector: + $ref: '#/components/schemas/accounts-filters' + description: + type: string + description: Description of the purpose and capabilities of the SLA. + format: text + evaluation_period: + $ref: '#/components/schemas/sla-evaluation-period' + id: + type: string + description: The SLA's ID. + format: id + name: + type: string + description: Human-readable name. + format: text + policies: + type: array + description: | + The policies encompassed by this SLA, ordered in decreasing + priority, the whole array will be overwritten by the contents of + this array. + items: + $ref: '#/components/schemas/set-sla-policy' + required: + - id + title: slas-update-request + slas-update-response: + type: object + properties: + sla: + $ref: '#/components/schemas/sla' + required: + - sla + title: slas-update-response + x-go-name: SlasUpdateResponseBody + snap-kit-action-execute-deferred-request: + type: object + properties: + actions: + type: array + description: List of actions triggered in the request. + items: + $ref: '#/components/schemas/snap-kit-action-request' + maxItems: 5 + id: + type: string + description: ID of the deferred snap-kit action to be executed. + format: id + required: + - actions + - id + title: snap-kit-action-execute-deferred-request + snap-kit-action-execute-deferred-response: + type: object + additionalProperties: false + title: snap-kit-action-execute-deferred-response + x-go-name: SnapKitActionExecuteDeferredResponseBody + snap-kit-action-request: type: object discriminator: mapping: - issue: '#/components/schemas/works-create-request-issue' - ticket: '#/components/schemas/works-create-request-ticket' + button: '#/components/schemas/snap-kit-action-request-button' + form: '#/components/schemas/snap-kit-action-request-form' propertyName: type oneOf: - - $ref: '#/components/schemas/works-create-request-issue' - - $ref: '#/components/schemas/works-create-request-ticket' + - $ref: '#/components/schemas/snap-kit-action-request-button' + - $ref: '#/components/schemas/snap-kit-action-request-form' properties: type: - $ref: '#/components/schemas/work-type' - applies_to_part: + $ref: '#/components/schemas/snap-kit-action-request-element-type-value' + action_id: type: string description: | - The [part](https://devrev.ai/docs/product/parts) that the work - applies to. Specifying a part is required when creating tickets and - issues. - example: PROD-12345 - format: id - artifacts: - type: array - description: | - The IDs of the artifacts to associate with the work item. - example: - - ARTIFACT-12345 - items: - type: string - format: id - body: + Id of the interactive element specified by developer in a snap-kit + object. + format: text + action_type: type: string - description: Body of the work object. + description: Action interaction type. format: text - maxLength: 65536 - owned_by: - type: array - description: The users that own the work. - example: - - DEVU-12345 - items: - type: string - format: id - reported_by: - type: array - description: The users that reported the work. - example: - - DEVU-12345 - items: - type: string - format: id - stage: - $ref: '#/components/schemas/stage-init' - stage_validation_options: - type: array + block_id: + type: string description: | - The type of stage validations options when creating a work item. - items: - $ref: '#/components/schemas/stage-validation-option-for-create' - tags: - type: array - description: Tags associated with the work item. - items: - $ref: '#/components/schemas/set-tag-with-value' - target_close_date: + Id of the block within the surface which is the container for the + interactive element. + format: text + timestamp: type: string - description: Timestamp for when the work is expected to be complete. + description: Timestamp when the action was originated. example: "2023-01-01T12:00:00.000Z" format: date-time - title: + required: + - action_id + - timestamp + - type + title: snap-kit-action-request + snap-kit-action-request-button: + type: object + properties: + value: type: string - description: Title of the work object. + description: Value for the button interactive element. format: text - maxLength: 256 - minLength: 1 required: - - applies_to_part - - owned_by - - title + - value + title: snap-kit-action-request-button + snap-kit-action-request-element-type-value: + type: string + enum: + - button + - form + snap-kit-action-request-form: + type: object + properties: + value: + type: object + description: Value for the form interactive element. + required: + - value + title: snap-kit-action-request-form + snap-widget: + type: object + discriminator: + propertyName: type + properties: + type: + $ref: '#/components/schemas/snap-widget-type' + required: - type - title: works-create-request - works-create-request-issue: + title: snap-widget + snap-widget-type: + type: string + snap-widgets-create-request: type: object + discriminator: + propertyName: type properties: - developed_with: + type: + $ref: '#/components/schemas/snap-widgets-create-request-type' + shared_with: type: array - description: The IDs of the parts associated with issue. - example: - - PROD-12345 + description: Sets the members that the snap widget is shared with. items: - type: string - format: id + $ref: '#/components/schemas/set-shared-with-membership' maxItems: 8 - priority: - $ref: '#/components/schemas/issue-priority' - priority_v2: - type: integer - description: | - Priority enum id of the work based upon impact and criticality. The - allowed ids can be extended by the user. Stock allowed values: - ``` - { - "id": 1, - "label": "P0", - "ordinal": 1, - "overridable": true - }, - { - "id": 2, - "label": "P1", - "ordinal": 2, - "overridable": true - }, - { - "id": 3, - "label": "P2", - "ordinal": 3, - "overridable": true - }, - { - "id": 4, - "label": "P3", - "ordinal": 4, - "overridable": true - } - ``` - format: int64 - x-devrev-uenum-overridable: true - x-devrev-uenum-values: - - id: 1 - label: P0 - ordinal: 1 - overridable: true - - id: 2 - label: P1 - ordinal: 2 - overridable: true - - id: 3 - label: P2 - ordinal: 3 - overridable: true - - id: 4 - label: P3 - ordinal: 4 - overridable: true - sprint: - type: string - description: The sprint that the issue belongs to. - format: id - target_start_date: - type: string - description: Timestamp for when the work is expected to start. - example: "2023-01-01T12:00:00.000Z" - format: date-time - title: works-create-request-issue - works-create-request-ticket: - type: object - properties: - account: - type: string - description: The account that the ticket is associated with. - example: ACC-12345 - format: id - channels: - type: array - description: Channels of the ticket. - items: - $ref: '#/components/schemas/ticket-channels' - channels_v2: - type: array - description: Channel IDs of the ticket. - items: - type: string - format: id - group: - type: string - description: The group that the ticket is associated with. - format: id - is_spam: - type: boolean - description: Whether the ticket is spam. - needs_response: - type: boolean - description: Whether the ticket needs a response. - rev_org: - type: string - description: The Rev organization that the ticket is associated with. - example: REV-AbCdEfGh - format: id - severity: - $ref: '#/components/schemas/ticket-severity' - source_channel: - type: string - description: The source channel of the ticket. - format: text - title: works-create-request-ticket - works-create-response: - type: object - properties: - work: - $ref: '#/components/schemas/work' required: - - work - title: works-create-response - x-go-name: WorksCreateResponseBody - works-delete-request: + - type + title: snap-widgets-create-request + snap-widgets-create-request-type: + type: string + snap-widgets-create-response: type: object properties: - id: - type: string - description: The work's ID. - example: ISS-12345 - format: id + snap_widget: + $ref: '#/components/schemas/snap-widget' required: - - id - title: works-delete-request - works-delete-response: + - snap_widget + title: snap-widgets-create-response + x-go-name: SnapWidgetsCreateResponseBody + stage: type: object additionalProperties: false - title: works-delete-response - x-go-name: WorksDeleteResponseBody - works-export-request: + description: Describes the current stage of a object. + title: stage + stage-filter: type: object + description: The filter for stages. properties: - type: - type: array - description: Filters for work of the provided types. - items: - $ref: '#/components/schemas/work-type' - actual_close_date: - $ref: '#/components/schemas/date-filter' - applies_to_part: - type: array - description: Filters for work belonging to any of the provided parts. - example: - - PROD-12345 - items: - type: string - format: id - created_by: - type: array - description: Filters for work created by any of these users. - example: - - DEVU-12345 - items: - type: string - format: id - created_date: - $ref: '#/components/schemas/date-filter' - first: - type: integer - description: | - The number of work items to return. The default is '50', the - maximum is '5000'. - format: int32 - issue: - $ref: '#/components/schemas/works-filter-issue' - modified_date: - $ref: '#/components/schemas/date-filter' - owned_by: - type: array - description: Filters for work owned by any of these users. - example: - - DEVU-12345 - items: - type: string - format: id - reported_by: - type: array - description: Filters for work reported by any of these users. - example: - - DEVU-12345 - items: - type: string - format: id - stage: - $ref: '#/components/schemas/stage-filter' - staged_info: - $ref: '#/components/schemas/staged-info-filter' - state: + name: type: array - description: Filters for work with any of the provided states. + description: Filters for records in the provided stage(s) by name. items: type: string format: text - sync_metadata: - $ref: '#/components/schemas/sync-metadata-filter' - tags: - type: array - description: Filters for work with any of the provided tags. - example: - - TAG-12345 - items: - type: string - format: id - target_close_date: - $ref: '#/components/schemas/date-filter' - ticket: - $ref: '#/components/schemas/works-filter-ticket' - title: works-export-request - works-export-response: + title: stage-filter + stage-init: type: object + description: Sets an object's initial stage. properties: - works: - type: array - description: The resulting collection of work items. - items: - $ref: '#/components/schemas/work' - required: - - works - title: works-export-response - x-go-name: WorksExportResponseBody - works-filter-issue: + name: + type: string + description: The name of the stage. + format: text + title: stage-init + stage-update: type: object + description: Updates an object's stage. properties: - accounts: - type: array - description: Filters for issues with any of the provided accounts. - example: - - ACC-12345 - items: - type: string - format: id - actual_start_date: - $ref: '#/components/schemas/date-filter' - priority: - type: array - description: Filters for issues with any of the provided priorities. - items: - $ref: '#/components/schemas/issue-priority' - priority_v2: - type: array - description: | - Filters for issues with any of the provided priority enum ids. - items: - type: integer - format: int64 - rev_orgs: - type: array + name: + type: string description: | - Filters for issues with any of the provided Rev organizations. - example: - - REV-AbCdEfGh - items: - type: string - format: id - sla_summary: - $ref: '#/components/schemas/sla-summary-filter' - sprint: - type: array - description: Filters for issues with any of the sprint. - items: - type: string - format: id - target_start_date: - $ref: '#/components/schemas/date-filter' - title: works-filter-issue - works-filter-ticket: + The updated name of the stage, otherwise unchanged if not set. + format: text + title: stage-update + stage-validation-option-for-create: + type: string + description: Type of stage validation options when creating an object. + enum: + - allow_non_start + stage-validation-option-for-update: + type: string + description: | + Type of state validation options when updating the stage of an object. + enum: + - allow_invalid_transition + staged-info-filter: type: object properties: - channels: - type: array - description: Filters for tickets with any of the provided channels. - items: - $ref: '#/components/schemas/ticket-channels' - channels_v2: - type: array - description: | - Filters for tickets that are associated with any of the channels. - items: - type: string - format: id - group: - type: array - description: Filters for tickets belonging to specific groups. - items: - type: string - format: id - is_frozen: - type: boolean - description: Filters for frozen tickets. - is_spam: - type: boolean - description: Filters for tickets that are spam. - needs_response: + is_staged: type: boolean - description: Filters for tickets that need response. - rev_org: - type: array + description: Filters for issues that are staged. + title: staged-info-filter + survey: + allOf: + - $ref: '#/components/schemas/atom-base' + - type: object + properties: + description: + type: string + description: Description of the survey. + format: text + header: + type: string + description: Header of the survey. + format: text + introductory_text: + type: string + description: | + Text posted when introducing the survey to the responder. + format: text + name: + type: string + description: | + Survey name associated with schema. This name would be unique per + dev org. + format: text + response_text: + type: string + description: Text posted after the response is collected. + format: text + schema: + type: array + description: List of all fields in the schema. + items: + $ref: '#/components/schemas/schema-field-descriptor' + schema_with_metadata: + type: array + description: | + List of all the fields and their respective metadata in the schema. + items: + $ref: '#/components/schemas/survey-field-with-metadata' + title: + type: string + description: Title of the survey. + format: text + title: survey + survey-aggregation-filter: + type: object + additionalProperties: false + description: The filter for survey aggregation. + title: survey-aggregation-filter + survey-field-with-metadata: + type: object + description: Field descriptors with additional metadata for surveys. + properties: + field: + $ref: '#/components/schemas/schema-field-descriptor' + metadata: + type: object + description: Additional metadata for the input field. + question: + type: string + description: The question linked to the input field. + format: text + title: survey-field-with-metadata + survey-response: + allOf: + - $ref: '#/components/schemas/atom-base' + - type: object + properties: + dispatch_id: + type: string + description: The unique ID associated with the dispatched survey. + format: id + dispatched_channels: + type: array + description: | + Source channels on which the survey is sent. Stock allowed values: + ``` + { + "id": 1, + "label": "plug", + "ordinal": 1, + "overridable": false + }, + { + "id": 2, + "label": "portal", + "ordinal": 2, + "overridable": false + }, + { + "id": 3, + "label": "email", + "ordinal": 3, + "overridable": false + }, + { + "id": 4, + "label": "slack", + "ordinal": 4, + "overridable": false + } + ``` + items: + $ref: '#/components/schemas/enum-value' + object: + type: string + description: The ID of the object for which survey is taken. + format: id + recipient: + $ref: '#/components/schemas/user-summary' + response: + type: object + description: Response for the survey. + response_channel: + $ref: '#/components/schemas/enum-value' + stage: + $ref: '#/components/schemas/enum-value' + survey: + type: string + description: The ID of the survey for which response is taken. + format: id + title: survey-response + surveys-create-request: + type: object + properties: + description: + type: string + description: Description about the survey. + format: text + maxLength: 1000 + header: + type: string + description: Header of the survey. + format: text + maxLength: 1000 + introductory_text: + type: string description: | - Filters for tickets that are associated with any of the provided - Rev organizations. - example: - - REV-AbCdEfGh - items: - type: string - format: id - severity: + Text posted when introducing the survey to the responder. + format: text + maxLength: 1000 + name: + type: string + description: The survey's name. + format: text + maxLength: 100 + minLength: 1 + response_text: + type: string + description: Text posted after the response is collected. + format: text + maxLength: 1000 + schema: type: array - description: Filters for tickets with any of the provided severities. + description: Schema for the survey. items: - $ref: '#/components/schemas/ticket-severity' - sla_summary: - $ref: '#/components/schemas/sla-summary-filter' - source_channel: + $ref: '#/components/schemas/field-descriptor' + schema_with_metadata: type: array - description: | - Filters for tickets with any of the provided source channels. + description: The schema with metadata for the survey. items: - type: string - format: text - surveys: - $ref: '#/components/schemas/survey-aggregation-filter' - title: works-filter-ticket - works-get-request: + $ref: '#/components/schemas/survey-field-with-metadata' + title: + type: string + description: Title of the survey. + format: text + maxLength: 1000 + required: + - name + title: surveys-create-request + surveys-create-response: + type: object + properties: + survey: + $ref: '#/components/schemas/survey' + required: + - survey + title: surveys-create-response + x-go-name: SurveysCreateResponseBody + surveys-delete-request: type: object properties: id: type: string - description: The work's ID. - example: ISS-12345 + description: ID of the survey being deleted. format: id required: - id - title: works-get-request - works-get-response: + title: surveys-delete-request + surveys-delete-response: + type: object + additionalProperties: false + title: surveys-delete-response + x-go-name: SurveysDeleteResponseBody + surveys-get-request: type: object properties: - work: - $ref: '#/components/schemas/work' + id: + type: string + description: The ID of the survey to get. + format: id required: - - work - title: works-get-response - x-go-name: WorksGetResponseBody - works-list-request: + - id + title: surveys-get-request + surveys-get-response: type: object properties: - type: - type: array - description: Filters for work of the provided types. - items: - $ref: '#/components/schemas/work-type' - actual_close_date: - $ref: '#/components/schemas/date-filter' - applies_to_part: + survey: + $ref: '#/components/schemas/survey' + required: + - survey + title: surveys-get-response + x-go-name: SurveysGetResponseBody + surveys-list-request: + type: object + properties: + created_by: type: array - description: Filters for work belonging to any of the provided parts. + description: Filters for surveys created by any of these users. example: - - PROD-12345 + - DEVU-12345 items: type: string format: id - created_by: - type: array - description: Filters for work created by any of these users. + created_date: + $ref: '#/components/schemas/date-filter' + cursor: + type: string + description: | + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. + format: text + limit: + type: integer + description: | + The maximum number of surveys to return. If not set, then the + default is '50'. + format: int32 + mode: + $ref: '#/components/schemas/list-mode' + modified_date: + $ref: '#/components/schemas/date-filter' + name: + type: array + description: Filters for surveys by name(s). + items: + type: string + format: text + sort_by: + type: array + description: | + Fields to sort the surveys by and the direction to sort them. + items: + type: string + format: sort-by + title: surveys-list-request + surveys-list-response: + type: object + properties: + next_cursor: + type: string + description: | + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. + format: text + prev_cursor: + type: string + description: | + The cursor used to iterate preceding results in accordance to the + sort order. If not set, then no prior elements exist. + format: text + surveys: + type: array + description: The list of the surveys. + items: + $ref: '#/components/schemas/survey' + required: + - surveys + title: surveys-list-response + x-go-name: SurveysListResponseBody + surveys-responses-list-request: + type: object + properties: + created_by: + type: array + description: | + Filters for survey responses created by any of these users. example: - DEVU-12345 items: @@ -11877,59 +12719,63 @@ components: The cursor to resume iteration from. If not provided, then iteration starts from the beginning. format: text - issue: - $ref: '#/components/schemas/works-filter-issue' + dispatch_ids: + type: array + description: | + Filters for survey responses associated with these unique IDs. + items: + type: string + format: id limit: type: integer description: | - The maximum number of works to return. The default is '50'. + The maximum number of survey responses to return. If not set, then + the default is '50'. format: int32 mode: $ref: '#/components/schemas/list-mode' modified_date: $ref: '#/components/schemas/date-filter' - owned_by: + objects: type: array - description: Filters for work owned by any of these users. + description: Filters for survey responses created for the objects. example: - - DEVU-12345 + - ACC-12345 items: type: string format: id - reported_by: + recipient: type: array - description: Filters for work reported by any of these users. + description: | + Filters for survey responses dispatched to any of these users. example: - DEVU-12345 items: type: string format: id - stage: - $ref: '#/components/schemas/stage-filter' - staged_info: - $ref: '#/components/schemas/staged-info-filter' - state: + sort_by: type: array - description: Filters for work with any of the provided states. + description: | + Fields to sort the survey responses by and the direction to sort + them. items: type: string - format: text - sync_metadata: - $ref: '#/components/schemas/sync-metadata-filter' - tags: + format: sort-by + stages: type: array - description: Filters for work with any of the provided tags. - example: - - TAG-12345 + description: Filters for survey response stages. + items: + type: integer + format: int64 + surveys: + type: array + description: | + Filters for survey responses for the provided survey IDs. items: type: string format: id - target_close_date: - $ref: '#/components/schemas/date-filter' - ticket: - $ref: '#/components/schemas/works-filter-ticket' - title: works-list-request - works-list-response: + title: surveys-responses-list-request + surveys-responses-list-response: type: object properties: next_cursor: @@ -11944,475 +12790,6827 @@ components: The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. format: text - works: + survey_responses: type: array - description: The list of works. + description: The list of the survey responses. items: - $ref: '#/components/schemas/work' + $ref: '#/components/schemas/survey-response' required: - - works - title: works-list-response - x-go-name: WorksListResponseBody - works-update-request: + - survey_responses + title: surveys-responses-list-response + x-go-name: SurveysResponsesListResponseBody + surveys-responses-update-request: type: object - discriminator: - mapping: - issue: '#/components/schemas/works-update-request-issue' - none: '#/components/schemas/empty' - ticket: '#/components/schemas/works-update-request-ticket' - propertyName: type - oneOf: - - $ref: '#/components/schemas/empty' - - $ref: '#/components/schemas/works-update-request-issue' - - $ref: '#/components/schemas/works-update-request-ticket' properties: - type: - $ref: '#/components/schemas/work-type' - applies_to_part: + dispatch_id: type: string - description: Updates the part that the work item applies to. - example: PROD-12345 + description: The unique ID associated with the dispatched survey. format: id - artifacts: - $ref: '#/components/schemas/works-update-request-artifacts' + response: + type: object + description: Survey response submitted for the object. + response_channel: + type: integer + description: | + The source channel ordinal which recorded the survey response. + format: int64 + response_score: + type: integer + description: | + The response score for the survey. Only applicable for CSAT and + NPS. + format: int32 + maximum: 10 + minimum: 1 + stage: + type: integer + description: The stage ordinal of the survey response object. + format: int64 + required: + - dispatch_id + title: surveys-responses-update-request + surveys-responses-update-response: + type: object + additionalProperties: false + title: surveys-responses-update-response + x-go-name: SurveysResponsesUpdateResponseBody + surveys-send-request: + type: object + properties: + email: + $ref: '#/components/schemas/surveys-send-request-email' + required: + - email + title: surveys-send-request + surveys-send-request-email: + type: object + properties: body: type: string - description: | - Updated body of the work object, or unchanged if not provided. + description: Message body for a survey email. format: text - maxLength: 65536 - id: - type: string - description: The work's ID. - example: ISS-12345 - format: id - owned_by: - $ref: '#/components/schemas/works-update-request-owned-by' - reported_by: - $ref: '#/components/schemas/works-update-request-reported-by' - stage: - $ref: '#/components/schemas/stage-update' - stage_validation_options: + recipients: type: array - description: | - The type of stage validations options when updating the stage or - the stage diagram of an object. + description: Recipients list for a survey email. items: - $ref: '#/components/schemas/stage-validation-option-for-update' - staged_info: - $ref: '#/components/schemas/works-update-request-staged-info-update' - tags: - $ref: '#/components/schemas/works-update-request-tags' - target_close_date: + type: string + format: text + sender: type: string - description: | - Updates the timestamp for when the work is expected to be complete. - example: "2023-01-01T12:00:00.000Z" - format: date-time - nullable: true - title: + description: Sender email address from which an email is sent. + format: text + subject: type: string - description: | - Updated title of the work object, or unchanged if not provided. + description: Subject for an email where survey is sent. format: text - maxLength: 256 - minLength: 1 required: - - id - title: works-update-request - works-update-request-artifacts: + - body + - recipients + - sender + - subject + title: surveys-send-request-email + surveys-send-response: + type: object + additionalProperties: false + title: surveys-send-response + x-go-name: SurveysSendResponseBody + surveys-submit-request: type: object properties: - add: + dispatch_id: + type: string + description: The unique ID associated with the dispatched survey. + format: id + dispatched_channels: type: array description: | - Adds the provided artifacts (if not already present) to the field. - example: - - ARTIFACT-12345 + The ordinals of the source channels on which the survey is sent. items: - type: string - format: id - maxItems: 50 - remove: - type: array + type: integer + format: int64 + object: + type: string description: | - Removes the provided artifacts (if they exist) from the field. - example: - - ARTIFACT-12345 - items: - type: string - format: id - maxItems: 50 - set: - type: array - description: Sets the field to the provided artifacts. - example: - - ARTIFACT-12345 - items: - type: string - format: id - maxItems: 50 - title: works-update-request-artifacts - works-update-request-issue: - type: object - properties: - developed_with: - $ref: '#/components/schemas/works-update-request-issue-developed-with' - priority: - $ref: '#/components/schemas/issue-priority' - priority_v2: + The ID of the object this survey is on (e.g. ticket, conversation, + etc). + example: ACC-12345 + format: id + recipient: + type: string + description: | + The unique ID associated with the recipient of the survey. + example: DEVU-12345 + format: id + response: + type: object + description: Survey response submitted for the object. + response_score: type: integer description: | - Priority enum id of the work based upon impact and criticality. The - allowed ids can be extended by the user. Stock allowed values: - ``` - { - "id": 1, - "label": "P0", - "ordinal": 1, - "overridable": true - }, - { - "id": 2, - "label": "P1", - "ordinal": 2, - "overridable": true - }, - { - "id": 3, - "label": "P2", - "ordinal": 3, - "overridable": true - }, - { - "id": 4, - "label": "P3", - "ordinal": 4, - "overridable": true - } - ``` + The response score for the survey. Only applicable for CSAT and + NPS. + format: int32 + source_channel: + type: string + description: | + The source channel from which survey response is submitted. + format: text + stage: + type: integer + description: The stage ordinal of the survey response object. format: int64 - x-devrev-uenum-overridable: true - x-devrev-uenum-values: - - id: 1 - label: P0 - ordinal: 1 - overridable: true - - id: 2 - label: P1 - ordinal: 2 - overridable: true - - id: 3 - label: P2 - ordinal: 3 - overridable: true - - id: 4 - label: P3 - ordinal: 4 - overridable: true - sprint: + survey: type: string - description: Updates the sprint that the issue belongs to. + description: The ID of the survey to submit the response to. format: id - nullable: true - target_start_date: - type: string - description: | - Updates the timestamp for when the work is expected to start. - example: "2023-01-01T12:00:00.000Z" - format: date-time - nullable: true - title: works-update-request-issue - works-update-request-issue-developed-with: + required: + - object + - survey + title: surveys-submit-request + surveys-submit-response: + type: object + additionalProperties: false + title: surveys-submit-response + x-go-name: SurveysSubmitResponseBody + surveys-update-request: type: object properties: - set: + description: + type: string + description: The updated description about the survey. + format: text + maxLength: 1000 + header: + type: string + description: Header of the survey. + format: text + maxLength: 1000 + id: + type: string + description: The ID of the survey to update. + format: id + introductory_text: + type: string + description: | + The updated text posted when introducing the survey to the + responder. + format: text + maxLength: 1000 + name: + type: string + description: The survey's updated name. + format: text + maxLength: 100 + minLength: 1 + response_text: + type: string + description: Text posted after the response is collected. + format: text + maxLength: 1000 + schema_with_metadata: type: array - description: Sets the IDs of the parts associated with issue. - example: - - PROD-12345 + description: The updated schema with metadata for the survey. items: - type: string - format: id - maxItems: 8 - title: works-update-request-issue-developed-with - works-update-request-owned-by: + $ref: '#/components/schemas/survey-field-with-metadata' + survey: + type: string + deprecated: true + description: The ID of the survey to update. + format: id + title: + type: string + description: Title of the survey. + format: text + maxLength: 1000 + required: + - id + title: surveys-update-request + surveys-update-response: type: object properties: - set: + survey: + $ref: '#/components/schemas/survey' + required: + - survey + title: surveys-update-response + x-go-name: SurveysUpdateResponseBody + sync-history: + allOf: + - $ref: '#/components/schemas/atom-base' + - type: object + properties: + sync_run: + $ref: '#/components/schemas/sync-run' + sync_unit: + type: string + description: SyncUnit ID associated with this historical entry. + format: id + title: sync-history + sync-metadata-filter: + type: object + properties: + external_reference: type: array description: | - Sets the owner IDs to the provided user IDs. This must not be - empty. - example: - - DEVU-12345 + Filters for issues with this specific external reference. items: type: string - format: id - title: works-update-request-owned-by - works-update-request-reported-by: - type: object - properties: - set: + format: text + last_sync_in: + $ref: '#/components/schemas/sync-metadata-filter-sync-in-filter' + last_sync_out: + $ref: '#/components/schemas/sync-metadata-filter-sync-out-filter' + origin_system: type: array description: | - Sets the users that reported the work to the provided user IDs. - example: - - DEVU-12345 + Filters for issues synced from this specific origin system. items: type: string - format: id - title: works-update-request-reported-by - works-update-request-staged-info-update: + format: text + title: sync-metadata-filter + sync-metadata-filter-sync-in-filter: type: object properties: - sync_in_unresolved_fields: + status: type: array - description: | - Updates the sync in unresolved fields of the staged work. + description: Filters for works with selected sync statuses. items: - $ref: '#/components/schemas/works-update-request-staged-info-update-unresolved-field' - sync_out_unresolved_fields: + $ref: '#/components/schemas/sync-metadata-filter-sync-in-filter-status' + sync_date: + $ref: '#/components/schemas/date-filter' + sync_history: type: array - description: | - Updates the sync out unresolved fields of the staged work. + description: Filters for works modified with selected sync history. items: - $ref: '#/components/schemas/works-update-request-staged-info-update-unresolved-field' - unresolved_fields: + type: string + format: id + sync_unit: type: array - description: Updates the unresolved fields of the staged work. + description: Filters for works modified with selected sync units. items: type: string - format: text - title: works-update-request-staged-info-update - works-update-request-staged-info-update-unresolved-field: - type: object - properties: - devrev_field_name: - type: string - description: DevRev field name of the object's attribute. - format: text - external_display_name: - type: string - description: External field name as seen by the end user. - format: text - external_field_name: - type: string - description: Api name of the external object's field. - format: text - title: works-update-request-staged-info-update-unresolved-field - works-update-request-tags: + format: id + title: sync-metadata-filter-sync-in-filter + sync-metadata-filter-sync-in-filter-status: + type: string + enum: + - failed + - modified + - staged + - succeeded + sync-metadata-filter-sync-out-filter: type: object properties: - set: + status: type: array - description: Sets the provided tags on the work item. + description: Filters for works with selected sync statuses. items: - $ref: '#/components/schemas/set-tag-with-value' - title: works-update-request-tags - works-update-request-ticket: - type: object - properties: - account: - type: string - description: Updates the account that the ticket is associated with. - example: ACC-12345 - format: id - nullable: true - channels: - $ref: '#/components/schemas/works-update-request-ticket-channels' - channels_v2: + $ref: '#/components/schemas/sync-metadata-filter-sync-out-filter-status' + sync_date: + $ref: '#/components/schemas/date-filter' + sync_history: type: array - description: Updates channel IDs of the ticket. + description: Filters for works modified with selected sync history. items: type: string format: id - group: - type: string - description: Updates the group that the ticket is associated with. - format: id - nullable: true - is_archived: - type: boolean - description: Whether the ticket is archived. - is_frozen: - type: boolean - description: Whether the ticket is frozen. - is_spam: - type: boolean - description: Updates whether the ticket is spam. - needs_response: - type: boolean - description: Updates whether the ticket needs a response. - rev_org: + sync_unit: + type: array + description: Filters for works modified with selected sync units. + items: + type: string + format: id + title: sync-metadata-filter-sync-out-filter + sync-metadata-filter-sync-out-filter-status: + type: string + enum: + - failed + - modified + - succeeded + sync-progress: + type: object + description: Progress. + properties: + state: + $ref: '#/components/schemas/sync-progress-state' + title: sync-progress + sync-progress-state: + type: string + description: The state of a sync progress. + enum: + - completed + - delete_in_progress + - deleted + - deletion_error + - extract_attachments + - extract_attachments_error + - extraction + - extraction_error + - loading + - loading_attachments + - loading_attachments_error + - loading_error + - recipe_discovery + - recipe_discovery_error + - recipe_discovery_waiting_for_user_input + - starting + - transformation + - transformation_error + sync-run: + type: object + description: Object for holding run-specific data. + properties: + ended_at: type: string - description: | - Updates the Rev organization that the ticket is associated with. - example: REV-AbCdEfGh - format: id - nullable: true - sentiment: - type: integer - description: | - The enum ID for the sentiment of the ticket. The allowed ids can be - extended by the user. Stock allowed values: - ``` - { - "id": 1, - "label": "Delighted", - "ordinal": 1, - "overridable": true - }, - { - "id": 2, - "label": "Happy", - "ordinal": 2, - "overridable": true - }, - { - "id": 3, - "label": "Neutral", - "ordinal": 3, - "overridable": true - }, - { - "id": 4, - "label": "Unhappy", - "ordinal": 4, - "overridable": true - }, - { - "id": 5, - "label": "Frustrated", - "ordinal": 5, - "overridable": true - } - ``` - format: int64 - x-devrev-uenum-overridable: true - x-devrev-uenum-values: - - id: 1 - label: Delighted - ordinal: 1 - overridable: true - - id: 2 - label: Happy - ordinal: 2 - overridable: true - - id: 3 - label: Neutral - ordinal: 3 - overridable: true - - id: 4 - label: Unhappy - ordinal: 4 - overridable: true - - id: 5 - label: Frustrated - ordinal: 5 - overridable: true - sentiment_modified_date: + description: The time when a sync was ended. + example: "2023-01-01T12:00:00.000Z" + format: date-time + mode: + $ref: '#/components/schemas/sync-run-mode' + progress: + $ref: '#/components/schemas/sync-progress' + started_at: type: string - description: Timestamp at which sentiment was last modified. + description: The time when a sync was started. example: "2023-01-01T12:00:00.000Z" format: date-time - sentiment_summary: + title: sync-run + sync-run-mode: + type: string + description: The direction/mode of a sync run. + enum: + - initial + - sync_from_devrev + - sync_to_devrev + sys-user: + allOf: + - $ref: '#/components/schemas/user-base' + title: sys-user + sys-user-summary: + allOf: + - $ref: '#/components/schemas/user-base-summary' + title: sys-user-summary + sys-users-list-request: + type: object + description: A request to get the list of system user's information. + properties: + cursor: type: string - description: Summary justifying the current sentiment. + description: | + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. format: text - severity: - $ref: '#/components/schemas/ticket-severity' - title: works-update-request-ticket - works-update-request-ticket-channels: + limit: + type: integer + description: | + The maximum number of system users to return. Value can range from + '1' to '100', with a default of '50'. + format: int32 + mode: + $ref: '#/components/schemas/list-mode' + sort_by: + type: array + description: | + Fields to sort the system users by and the direction to sort them. + items: + type: string + format: sort-by + title: sys-users-list-request + sys-users-list-response: type: object + description: The response to listing the system users. properties: - set: + next_cursor: + type: string + description: | + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. + format: text + prev_cursor: + type: string + description: | + The cursor used to iterate preceding results in accordance to the + sort order. If not set, then no prior elements exist. + format: text + sys_users: type: array - description: Sets the channels to the provided channels. + description: The list of system users. items: - $ref: '#/components/schemas/ticket-channels' - title: works-update-request-ticket-channels - works-update-response: + $ref: '#/components/schemas/sys-user' + required: + - sys_users + title: sys-users-list-response + x-go-name: SysUsersListResponseBody + sys-users-update-request: type: object + description: Request to update information of the system user. properties: - work: - $ref: '#/components/schemas/work' + display_name: + type: string + description: Updated display name for the system user. + format: text + display_picture: + type: string + description: Artifact ID of the system user's new display picture. + example: ARTIFACT-12345 + format: id + nullable: true + full_name: + type: string + description: Updated full name for the system user. + format: text + id: + type: string + description: The ID of system user to update. + format: id required: - - work - title: works-update-response - x-go-name: WorksUpdateResponseBody - securitySchemes: - auth-token: - type: http - description: |- - All the DevRev APIs require a token to authenticate the user. Provide `Authorization: ` as a header to every API request. - [How do I find my token?](https://devrev.ai/docs/apis/auth) - scheme: bearer - x-fern-bearer: - env: DEVREV_TOKEN - name: token -info: - description: DevRev's REST API. - title: DevRev REST API - version: "2024-01-24" -openapi: 3.0.3 -paths: - /accounts.create: + - id + title: sys-users-update-request + sys-users-update-response: + type: object + description: Updated Sys user object. + properties: + sys_user: + $ref: '#/components/schemas/sys-user' + required: + - sys_user + title: sys-users-update-response + x-go-name: SysUsersUpdateResponseBody + tag: + allOf: + - $ref: '#/components/schemas/atom-base' + - type: object + properties: + allowed_values: + type: array + description: | + The allowed values for the tag, where a value is provided when a + tag is associated with an object. If empty, then no value should be + provided when the association is made. + items: + type: string + format: text + description: + type: string + description: | + An informative description for the tag that should provide context + on the tag's purpose and usage. + format: text + name: + type: string + description: | + The name of the tag, which denotes the logical concept by which all + tagged objects will be associated. The name is guaranteed to be + unique. + format: text + required: + - name + title: tag + tag-summary: + allOf: + - $ref: '#/components/schemas/atom-base-summary' + - type: object + properties: + name: + type: string + description: | + The name of the tag, which denotes the logical concept by which all + tagged objects will be associated. The name is guaranteed to be + unique. + format: text + required: + - name + title: tag-summary + tag-with-value: + type: object + properties: + tag: + $ref: '#/components/schemas/tag-summary' + value: + type: string + description: The value for the object's association with the tag. + format: text + required: + - tag + title: tag-with-value + tag-with-value-filter: + type: object + properties: + id: + type: string + description: The ID of the tag. + example: TAG-12345 + format: id + value: + type: string + description: | + The value for the object's association with the tag. If specified, + the value must be one that's specified in the tag's allowed values. + format: text + title: tag-with-value-filter + tags-create-request: + type: object + description: The request to create a new tag. + properties: + allowed_values: + type: array + description: | + The allowed values for the tag, or empty if no values are + permitted. + items: + type: string + format: text + description: + type: string + description: The description for the tag. + format: text + name: + type: string + description: | + The name for the tag, which must be unique across all tags. + format: text + required: + - name + title: tags-create-request + tags-create-response: + type: object + description: The response to creating a new tag. + properties: + tag: + $ref: '#/components/schemas/tag' + required: + - tag + title: tags-create-response + x-go-name: TagsCreateResponseBody + tags-delete-request: + type: object + description: The request to delete a tag. + properties: + id: + type: string + description: The ID of the tag to delete. + example: TAG-12345 + format: id + required: + - id + title: tags-delete-request + tags-delete-response: + type: object + additionalProperties: false + description: The response for deleting a tag. + title: tags-delete-response + x-go-name: TagsDeleteResponseBody + tags-get-request: + type: object + description: The request to get a tag's information. + properties: + id: + type: string + description: The requested tag's ID. + example: TAG-12345 + format: id + required: + - id + title: tags-get-request + tags-get-response: + type: object + description: The response to getting a tag's information. + properties: + tag: + $ref: '#/components/schemas/tag' + required: + - tag + title: tags-get-response + x-go-name: TagsGetResponseBody + tags-list-request: + type: object + description: The request to get information about a list of tags. + properties: + cursor: + type: string + description: | + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. + format: text + limit: + type: integer + description: | + The maximum number of tags to return. The default is '50'. + format: int32 + mode: + $ref: '#/components/schemas/list-mode' + name: + type: array + description: Filters for tags with the provided names. + items: + type: string + format: text + sort_by: + type: array + description: Fields to sort tags by and the direction to sort them. + items: + type: string + format: sort-by + title: tags-list-request + tags-list-response: + type: object + description: The response to listing the tags. + properties: + next_cursor: + type: string + description: | + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. + format: text + prev_cursor: + type: string + description: | + The cursor used to iterate preceding results in accordance to the + sort order. If not set, then no prior elements exist. + format: text + tags: + type: array + description: The list of tags. + items: + $ref: '#/components/schemas/tag' + required: + - tags + title: tags-list-response + x-go-name: TagsListResponseBody + tags-update-allowed-values: + type: object + description: Specifies an update to a tag's allowed values. + properties: + set: + type: array + description: Sets the allowed values for the tag. + items: + type: string + format: text + title: tags-update-allowed-values + tags-update-request: + type: object + description: The request to update a tag. + properties: + allowed_values: + $ref: '#/components/schemas/tags-update-allowed-values' + description: + type: string + description: The updated description of the tag. + format: text + id: + type: string + description: The ID of the tag to update. + example: TAG-12345 + format: id + name: + type: string + description: | + The updated name of the tag. The name must be unique across all + tags. + format: text + required: + - id + title: tags-update-request + tags-update-response: + type: object + description: The response for updating a tag. + properties: + tag: + $ref: '#/components/schemas/tag' + required: + - tag + title: tags-update-response + x-go-name: TagsUpdateResponseBody + ticket: + allOf: + - $ref: '#/components/schemas/work-base' + - type: object + properties: + account: + $ref: '#/components/schemas/account-summary' + channels: + type: array + description: Channels of the ticket. + items: + $ref: '#/components/schemas/ticket-channels' + channels_v2: + type: array + description: Channel IDs of the ticket. + items: + $ref: '#/components/schemas/external-communication-channel-summary' + group: + $ref: '#/components/schemas/group-summary' + needs_response: + type: boolean + description: Whether the ticket needs a response. + rev_org: + $ref: '#/components/schemas/org-summary' + sentiment: + $ref: '#/components/schemas/enum-value' + sentiment_modified_date: + type: string + description: Timestamp when the sentiment was last modified. + example: "2023-01-01T12:00:00.000Z" + format: date-time + sentiment_summary: + type: string + description: Summary justifying the sentiment. + format: text + severity: + $ref: '#/components/schemas/ticket-severity' + sla_summary: + $ref: '#/components/schemas/archetype-sla-summary' + sla_tracker: + $ref: '#/components/schemas/sla-tracker-summary' + source_channel: + type: string + description: Source channel of the ticket. + format: text + source_channel_v2: + $ref: '#/components/schemas/external-communication-channel-summary' + visibility: + $ref: '#/components/schemas/enum-value' + title: ticket + ticket-channels: + type: string + description: Channels of the ticket. + enum: + - email + - plug + - slack + - twilio + - twilio_sms + ticket-severity: + type: string + description: Severity of the ticket. + enum: + - blocker + - high + - low + - medium + ticket-summary: + allOf: + - $ref: '#/components/schemas/work-base-summary' + - type: object + properties: + account: + $ref: '#/components/schemas/account-summary' + rev_org: + $ref: '#/components/schemas/org-summary' + severity: + $ref: '#/components/schemas/ticket-severity' + title: ticket-summary + timeline-comment: + allOf: + - $ref: '#/components/schemas/timeline-entry-base' + - type: object + properties: + artifacts: + type: array + description: The artifacts for the comment. + items: + $ref: '#/components/schemas/artifact-summary' + body: + type: string + description: | + The comment's body. If the comment has been deleted, then no body + will appear in the response. + format: text + body_type: + $ref: '#/components/schemas/timeline-comment-body-type' + references: + type: array + description: | + Summary information about objects that are referenced in the + comment. + items: + $ref: '#/components/schemas/atom-summary' + snap_kit_body: + $ref: '#/components/schemas/timeline-snap-kit-body' + snap_widget_body: + type: array + description: The snap widget body of the comment. + items: + $ref: '#/components/schemas/snap-widget' + title: timeline-comment + timeline-comment-body-type: + type: string + description: The type of the body to use for the comment. + enum: + - data + - snap_kit + - snap_widget + - text + timeline-comment-summary: + allOf: + - $ref: '#/components/schemas/timeline-entry-base-summary' + title: timeline-comment-summary + timeline-entries-create-request: + type: object + description: The request to create a timeline entry for an object. + discriminator: + mapping: + timeline_comment: '#/components/schemas/timeline-entries-create-request-timeline-comment' + propertyName: type + oneOf: + - $ref: '#/components/schemas/timeline-entries-create-request-timeline-comment' + properties: + type: + $ref: '#/components/schemas/timeline-entries-create-request-type' + expires_at: + type: string + description: | + If set, then the entry is ephemeral and will be deleted after the + provided time. The minimum value should be at least a minute more + than the current timestamp. + example: "2023-01-01T12:00:00.000Z" + format: date-time + object: + type: string + description: The ID of the object to create the timeline entry for. + example: PROD-12345 + format: id + private_to: + type: array + description: | + If the visibility of the entry is private, this specifies the users + that the entry is private to. Note the creator is always implicitly + included in this list. + example: + - DEVU-12345 + items: + type: string + format: id + visibility: + $ref: '#/components/schemas/timeline-entry-visibility' + required: + - object + - type + title: timeline-entries-create-request + timeline-entries-create-request-timeline-comment: + type: object + properties: + artifacts: + type: array + description: The IDs of the artifacts attached to the comment. + example: + - ARTIFACT-12345 + items: + type: string + format: id + maxItems: 50 + body: + type: string + description: The comment's body. + format: text + body_type: + $ref: '#/components/schemas/timeline-comment-body-type' + snap_kit_body: + $ref: '#/components/schemas/timeline-snap-kit-body' + title: timeline-entries-create-request-timeline-comment + timeline-entries-create-request-type: + type: string + enum: + - timeline_comment + timeline-entries-create-response: + type: object + description: The response to creating a timeline entry for an object. + properties: + timeline_entry: + $ref: '#/components/schemas/timeline-entry' + required: + - timeline_entry + title: timeline-entries-create-response + x-go-name: TimelineEntriesCreateResponseBody + timeline-entries-delete-request: + type: object + description: The request to delete a timeline entry from an object. + properties: + id: + type: string + description: The ID of the timeline entry to delete. + example: don:core:dvrv-us-1:devo/example:ticket/123:comment/comment-id + format: id + required: + - id + title: timeline-entries-delete-request + timeline-entries-delete-response: + type: object + additionalProperties: false + description: The response to deleting a timeline entry from an object. + title: timeline-entries-delete-response + x-go-name: TimelineEntriesDeleteResponseBody + timeline-entries-get-request: + type: object + description: The request to get a timeline entry. + properties: + id: + type: string + description: The ID of the timeline entry to get. + example: don:core:dvrv-us-1:devo/example:ticket/123:comment/comment-id + format: id + required: + - id + title: timeline-entries-get-request + timeline-entries-get-response: + type: object + description: The request to getting a timeline entry. + properties: + timeline_entry: + $ref: '#/components/schemas/timeline-entry' + required: + - timeline_entry + title: timeline-entries-get-response + x-go-name: TimelineEntriesGetResponseBody + timeline-entries-list-request: + type: object + description: The request to list timeline entries for an object. + properties: + cursor: + type: string + description: | + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. + format: text + limit: + type: integer + description: | + The maximum number of entries to return. If not set, then this + defaults to `50`. + format: int32 + mode: + $ref: '#/components/schemas/list-mode' + object: + type: string + description: The ID of the object to list timeline entries for. + example: PROD-12345 + format: id + visibility: + type: array + description: | + The visibility of the timeline entries to filter for. Note this is + a strict filter, such that only entries with the exact visibilities + specified will be returned. + items: + $ref: '#/components/schemas/timeline-entry-visibility' + required: + - object + title: timeline-entries-list-request + timeline-entries-list-response: + type: object + description: The response to listing timeline entries for an object. + properties: + next_cursor: + type: string + description: | + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. + format: text + prev_cursor: + type: string + description: | + The cursor used to iterate preceding results in accordance to the + sort order. If not set, then no prior elements exist. + format: text + timeline_entries: + type: array + description: The timeline entries for the object. + items: + $ref: '#/components/schemas/timeline-entry' + required: + - timeline_entries + title: timeline-entries-list-response + x-go-name: TimelineEntriesListResponseBody + timeline-entries-update-request: + type: object + description: The request to update a timeline entry. + discriminator: + mapping: + timeline_comment: '#/components/schemas/timeline-entries-update-request-timeline-comment' + propertyName: type + oneOf: + - $ref: '#/components/schemas/timeline-entries-update-request-timeline-comment' + properties: + type: + $ref: '#/components/schemas/timeline-entries-update-request-type' + id: + type: string + description: The ID of the timeline entry to update. + example: don:core:dvrv-us-1:devo/example:ticket/123:comment/comment-id + format: id + required: + - id + - type + title: timeline-entries-update-request + timeline-entries-update-request-timeline-comment: + type: object + properties: + artifacts: + $ref: '#/components/schemas/timeline-entries-update-request-timeline-comment-artifacts' + body: + type: string + description: The updated comment's body. + format: text + body_type: + $ref: '#/components/schemas/timeline-comment-body-type' + snap_kit_body: + $ref: '#/components/schemas/timeline-snap-kit-body' + title: timeline-entries-update-request-timeline-comment + timeline-entries-update-request-timeline-comment-artifacts: + type: object + properties: + add: + type: array + description: | + Adds the provided artifacts to the comment. An artifact cannot be + added more than once, i.e. nothing is done if the artifact is + already attached. Mutually exclusive with `set`. + example: + - ARTIFACT-12345 + items: + type: string + format: id + maxItems: 10 + remove: + type: array + description: | + Removes the provided artifacts from the comment. If an artifact is + not present, then it's ignored. Mututally exclusive with `set`. + example: + - ARTIFACT-12345 + items: + type: string + format: id + maxItems: 10 + set: + type: array + description: Sets the field to the provided artifacts. + example: + - ARTIFACT-12345 + items: + type: string + format: id + maxItems: 50 + title: timeline-entries-update-request-timeline-comment-artifacts + timeline-entries-update-request-type: + type: string + enum: + - timeline_comment + timeline-entries-update-response: + type: object + description: The response to updating a timeline entry. + properties: + timeline_entry: + $ref: '#/components/schemas/timeline-entry' + required: + - timeline_entry + title: timeline-entries-update-response + x-go-name: TimelineEntriesUpdateResponseBody + timeline-entry: + type: object + discriminator: + mapping: + timeline_comment: '#/components/schemas/timeline-comment' + propertyName: type + oneOf: + - $ref: '#/components/schemas/timeline-comment' + properties: + type: + $ref: '#/components/schemas/timeline-entry-type' + required: + - type + title: timeline-entry + timeline-entry-base: + allOf: + - $ref: '#/components/schemas/atom-base' + - type: object + properties: + object: + type: string + description: The object that the Timeline entry belongs to. + format: id + object_display_id: + type: string + description: | + The display ID of the object that the Timeline entry belongs to. + format: text + object_type: + $ref: '#/components/schemas/timeline-entry-object-type' + visibility: + $ref: '#/components/schemas/timeline-entry-visibility' + required: + - object + - object_display_id + title: timeline-entry-base + timeline-entry-base-summary: + allOf: + - $ref: '#/components/schemas/atom-base-summary' + title: timeline-entry-base-summary + timeline-entry-object-type: + type: string + description: The type of object that the Timeline entry belongs to. + enum: + - capability + - conversation + - enhancement + - feature + - issue + - product + - rev_org + - rev_user + - ticket + - timeline_comment + timeline-entry-type: + type: string + enum: + - timeline_comment + timeline-entry-visibility: + type: string + description: | + The visibility of the entry. If 'private', then the entry is only + visible to the creator, 'internal' is visible with the Dev + organization, 'external' is visible to the Dev organzation and Rev + users, and 'public' is visible to all. If not set, then the default + visibility is 'external'. + enum: + - external + - internal + - private + - public + timeline-snap-kit-body: + type: object + description: Snap Kit Body of the comment. + properties: + body: + type: object + description: The JSON body of the SnapKit. + snap_in_action_name: + type: string + description: | + The name of an action defined in the SnapIn. The combination of + snap_in_id and snap_in_action_name uniquely identifies the + interaction object which is to be called when actions on a snapkit + element is taken. + format: text + snap_in_id: + type: string + description: ID of the snap-in which created the SnapKit. + format: text + title: timeline-snap-kit-body + update-command-action: + type: object + properties: + action_details: + $ref: '#/components/schemas/update-command-action-details' + artifacts: + type: array + description: IDs of the new artifact items + example: + - ARTIFACT-12345 + items: + type: string + format: id + code: + type: string + description: | + The raw code to execute, defined in the language specified by + executor + format: text + executor_config: + type: object + description: Executor specific config + message: + type: string + description: | + The message to populate in discussion box, when the command is + selected to execute. + format: text + snap_in_function_id: + type: string + description: | + Function containing logic for the command. If function ID is + specified the executor config is ignored and command is executed by + functions. + format: id + template_type: + $ref: '#/components/schemas/command-action-template-type' + title: update-command-action + update-command-action-details: + type: object + properties: + object_update_payload: + type: object + description: | + The payload to update the object in context upon command execution. + title: update-command-action-details + update-command-surface: + type: object + properties: + object_types: + type: array + description: Objects types on which a command can be invoked + items: + $ref: '#/components/schemas/command-surface-object-types' + surface: + $ref: '#/components/schemas/command-surface-surface' + title: update-command-surface + user-base: + allOf: + - $ref: '#/components/schemas/atom-base' + - type: object + properties: + display_name: + type: string + description: | + The user's display name. The name is non-unique and mutable. + format: text + display_picture: + $ref: '#/components/schemas/artifact-summary' + email: + type: string + description: Email address of the user. + format: text + full_name: + type: string + description: Full name of the user. + format: text + phone_numbers: + type: array + description: Phone numbers of the user. + items: + type: string + format: text + primary_identity: + $ref: '#/components/schemas/user-summary' + state: + $ref: '#/components/schemas/user-state' + title: user-base + user-base-summary: + allOf: + - $ref: '#/components/schemas/atom-base-summary' + - type: object + properties: + display_name: + type: string + description: | + The user's display name. The name is non-unique and mutable. + format: text + display_picture: + $ref: '#/components/schemas/artifact-summary' + email: + type: string + description: Email address of the user. + format: text + full_name: + type: string + description: Full name of the user. + format: text + state: + $ref: '#/components/schemas/user-state' + title: user-base-summary + user-skill: + type: object + description: Skill associated with the user. + properties: + name: + type: string + description: Name of the skill. + format: text + title: user-skill + user-state: + type: string + description: State of the user. + enum: + - active + - deactivated + - deleted + - locked + - shadow + - unassigned + user-summary: + type: object + discriminator: + mapping: + dev_user: '#/components/schemas/dev-user-summary' + rev_user: '#/components/schemas/rev-user-summary' + service_account: '#/components/schemas/service-account-summary' + sys_user: '#/components/schemas/sys-user-summary' + propertyName: type + oneOf: + - $ref: '#/components/schemas/dev-user-summary' + - $ref: '#/components/schemas/rev-user-summary' + - $ref: '#/components/schemas/service-account-summary' + - $ref: '#/components/schemas/sys-user-summary' + properties: + type: + $ref: '#/components/schemas/user-type' + required: + - type + title: user-summary + user-type: + type: string + enum: + - dev_user + - rev_user + - service_account + - sys_user + vista-group-item-state: + type: string + description: Defines the state of the group item. + enum: + - active + - completed + - planned + vista-group-item-summary: + type: object + description: Vista group item. + properties: + type: + $ref: '#/components/schemas/vista-group-item-type' + end_date: + type: string + description: Timestamp when the vista ends. + example: "2023-01-01T12:00:00.000Z" + format: date-time + id: + type: string + description: ID of the group item in don v2 format. + format: id + name: + type: string + description: Name of the group. + format: text + start_date: + type: string + description: Timestamp when the vista starts. + example: "2023-01-01T12:00:00.000Z" + format: date-time + state: + $ref: '#/components/schemas/vista-group-item-state' + required: + - id + - name + - type + title: vista-group-item-summary + vista-group-item-type: + type: string + description: Type of the group object. + enum: + - curated + - dynamic + web-crawler-job: + allOf: + - $ref: '#/components/schemas/atom-base' + - type: object + properties: + accept_regexs: + type: array + description: | + URL patterns to accept (an empty value means accept all URLs) + subject to explicit rejects (if any). + items: + type: string + format: text + description: + type: string + description: Description of the web crawler job. + format: text + domain_names: + type: array + description: | + Domain names to crawl URLs for. If this field is not set, it is + inferred based on the domain names in the seed set of URLs. + items: + type: string + format: text + frequency: + type: integer + description: Number of days between re-sync job runs. + format: int32 + max_depth: + type: integer + description: | + Specifies the maximum recursion depth from the seed URL that we + will crawl. If this value is -1, there is no limit on recursion + depth. + format: int32 + no_parent: + type: boolean + description: | + Specifies whether we should never ascend to the parent directory + when crawling from a seed set URL. + notify_on_complete: + type: boolean + description: Whether to notify via email. + num_bytes: + type: integer + description: Number of bytes stored. + format: int32 + num_timeout_urls: + type: integer + description: Number of URLs that timed out. + format: int32 + num_urls_scraped: + type: integer + description: Number of URLs whose webpage are scraped. + format: int32 + reject_regexs: + type: array + description: | + URL patterns to reject (an empty value means no explicit + rejections). + items: + type: string + format: text + sitemap_index_urls: + type: array + description: | + Sitemap index URLs. The URLs in the referenced sitemaps add to the + seed set of URLs to crawl from. + items: + type: string + format: text + sitemap_urls: + type: array + description: | + Sitemap URLs. The URLs in the sitemap add to the seed set of URLs + to crawl from. + items: + type: string + format: text + state: + $ref: '#/components/schemas/web-crawler-job-state' + urls: + type: array + description: URLs to add to the seed set of URLs to crawl from. + items: + type: string + format: text + user_agent: + type: string + description: User agent to use for crawling websites in this job. + format: text + title: web-crawler-job + web-crawler-job-state: + type: string + description: State of the web crawler job. + enum: + - aborted + - completed + - running + - scheduled + - suspended + web-crawler-jobs-control-request: + type: object + description: The request to resume a web crawler job. + properties: + action: + $ref: '#/components/schemas/web-crawler-jobs-control-request-action' + id: + type: string + description: The ID of the job. + format: id + required: + - action + - id + title: web-crawler-jobs-control-request + web-crawler-jobs-control-request-action: + type: string + enum: + - abort + - pause + - resume + web-crawler-jobs-control-response: + type: object + description: The response to resume a web crawler job. + properties: + web_crawler_job: + $ref: '#/components/schemas/web-crawler-job' + required: + - web_crawler_job + title: web-crawler-jobs-control-response + x-go-name: WebCrawlerJobsControlResponseBody + web-crawler-jobs-create-request: + type: object + description: | + The request to create a web crawler job which will create webpages as + artifacts. + properties: + accept_regex: + type: string + deprecated: true + description: The regex a URL must satisfy to be crawled. + format: text + accept_regexes: + type: array + description: The list of regexes a URL must satisfy to be crawled. + items: + type: string + format: text + applies_to_parts: + type: array + description: | + The parts to which created webpage/articles during this crawler job + will be linked to. + example: + - PROD-12345 + items: + type: string + format: id + maxItems: 1 + minItems: 1 + description: + type: string + description: The description of the job. + format: text + domain_names: + type: array + description: The list of allowed domain names to crawl. + items: + type: string + format: text + frequency: + type: integer + description: | + Number of days between re-sync job runs. If 0, the job will run + only once. + format: int32 + max_depth: + type: integer + description: The maximum depth to crawl. + format: int32 + notify_on_complete: + type: boolean + description: | + Whether to notify the user when the job is complete. Default is + true. + reject_regex: + type: string + deprecated: true + description: | + The regex which if satisfied by a URL results in rejection of the + URL. If a URL matches both accept and reject regexes, it is + rejected. + format: text + reject_regexes: + type: array + description: | + The list of regexes which if satisfied by a URL results in + rejection of the URL. If a URL matches both accept and reject + regexes, it is rejected. + items: + type: string + format: text + sitemap_index_urls: + type: array + description: The list of sitemap index URLs to crawl. + items: + type: string + format: text + sitemap_urls: + type: array + description: The list of sitemap URLs to crawl. + items: + type: string + format: text + urls: + type: array + description: The list of URLs to crawl. + items: + type: string + format: text + user_agent: + type: string + description: User agent to use for crawling websites in this job. + format: text + maxLength: 1024 + required: + - applies_to_parts + title: web-crawler-jobs-create-request + web-crawler-jobs-create-response: + type: object + description: The response to create a web crawler job. + properties: + web_crawler_job: + $ref: '#/components/schemas/web-crawler-job' + required: + - web_crawler_job + title: web-crawler-jobs-create-response + x-go-name: WebCrawlerJobsCreateResponseBody + web-crawler-jobs-get-request: + type: object + description: The request to get a web crawler job. + properties: + id: + type: string + description: The ID of the job. + format: id + required: + - id + title: web-crawler-jobs-get-request + web-crawler-jobs-get-response: + type: object + description: The response to get a web crawler job. + properties: + web_crawler_job: + $ref: '#/components/schemas/web-crawler-job' + required: + - web_crawler_job + title: web-crawler-jobs-get-response + x-go-name: WebCrawlerJobsGetResponseBody + web-crawler-jobs-list-request: + type: object + description: The request to list web crawler jobs. + properties: + created_by: + type: array + description: | + Filters for web crawler jobs created by any of the provided users. + example: + - DEVU-12345 + items: + type: string + format: id + created_date: + $ref: '#/components/schemas/date-filter' + cursor: + type: string + description: | + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. + format: text + limit: + type: integer + description: | + The maximum number of web crawler jobs to return. The default is + '50'. + format: int32 + mode: + $ref: '#/components/schemas/list-mode' + modified_date: + $ref: '#/components/schemas/date-filter' + title: web-crawler-jobs-list-request + web-crawler-jobs-list-response: + type: object + description: The response to list web crawler jobs. + properties: + next_cursor: + type: string + description: | + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. + format: text + prev_cursor: + type: string + description: | + The cursor used to iterate preceding results in accordance to the + sort order. If not set, then no prior elements exist. + format: text + web_crawler_jobs: + type: array + description: The list of jobs. + items: + $ref: '#/components/schemas/web-crawler-job' + required: + - web_crawler_jobs + title: web-crawler-jobs-list-response + x-go-name: WebCrawlerJobsListResponseBody + webhook: + allOf: + - $ref: '#/components/schemas/atom-base' + - type: object + properties: + event_types: + type: array + description: The event types that the webhook will receive. + items: + $ref: '#/components/schemas/webhook-event-type' + secret: + type: string + description: The secret to use for verifying webhook events. + format: byte + status: + $ref: '#/components/schemas/webhook-status' + url: + type: string + description: The URL of the webhook endpoint. + format: text + required: + - secret + - status + - url + title: webhook + webhook-event-request: + type: object + properties: + type: + $ref: '#/components/schemas/webhook-event-type' + account_created: + $ref: '#/components/schemas/event-account-created' + account_deleted: + $ref: '#/components/schemas/event-account-deleted' + account_updated: + $ref: '#/components/schemas/event-account-updated' + ai_agent_response: + $ref: '#/components/schemas/event-ai-agent-response' + conversation_created: + $ref: '#/components/schemas/event-conversation-created' + conversation_deleted: + $ref: '#/components/schemas/event-conversation-deleted' + conversation_updated: + $ref: '#/components/schemas/event-conversation-updated' + dashboard_created: + $ref: '#/components/schemas/event-dashboard-created' + dashboard_deleted: + $ref: '#/components/schemas/event-dashboard-deleted' + dashboard_updated: + $ref: '#/components/schemas/event-dashboard-updated' + dev_user_created: + $ref: '#/components/schemas/event-dev-user-created' + dev_user_deleted: + $ref: '#/components/schemas/event-dev-user-deleted' + dev_user_updated: + $ref: '#/components/schemas/event-dev-user-updated' + group_created: + $ref: '#/components/schemas/event-group-created' + group_deleted: + $ref: '#/components/schemas/event-group-deleted' + group_member_added: + $ref: '#/components/schemas/event-group-member-added' + group_member_removed: + $ref: '#/components/schemas/event-group-member-removed' + group_updated: + $ref: '#/components/schemas/event-group-updated' + id: + type: string + description: The event's ID. + format: id + incident_created: + $ref: '#/components/schemas/event-incident-created' + incident_deleted: + $ref: '#/components/schemas/event-incident-deleted' + incident_updated: + $ref: '#/components/schemas/event-incident-updated' + link_created: + $ref: '#/components/schemas/event-link-created' + link_deleted: + $ref: '#/components/schemas/event-link-deleted' + link_updated: + $ref: '#/components/schemas/event-link-updated' + part_created: + $ref: '#/components/schemas/event-part-created' + part_deleted: + $ref: '#/components/schemas/event-part-deleted' + part_updated: + $ref: '#/components/schemas/event-part-updated' + question_answer_created: + $ref: '#/components/schemas/event-question-answer-created' + question_answer_deleted: + $ref: '#/components/schemas/event-question-answer-deleted' + question_answer_updated: + $ref: '#/components/schemas/event-question-answer-updated' + rev_org_created: + $ref: '#/components/schemas/event-rev-org-created' + rev_org_deleted: + $ref: '#/components/schemas/event-rev-org-deleted' + rev_org_updated: + $ref: '#/components/schemas/event-rev-org-updated' + rev_user_created: + $ref: '#/components/schemas/event-rev-user-created' + rev_user_deleted: + $ref: '#/components/schemas/event-rev-user-deleted' + rev_user_updated: + $ref: '#/components/schemas/event-rev-user-updated' + sla_tracker_created: + $ref: '#/components/schemas/event-sla-tracker-created' + sla_tracker_deleted: + $ref: '#/components/schemas/event-sla-tracker-deleted' + sla_tracker_fetched: + $ref: '#/components/schemas/event-sla-tracker-fetched' + sla_tracker_updated: + $ref: '#/components/schemas/event-sla-tracker-updated' + survey_created: + $ref: '#/components/schemas/event-survey-created' + survey_deleted: + $ref: '#/components/schemas/event-survey-deleted' + survey_response_created: + $ref: '#/components/schemas/event-survey-response-created' + survey_response_deleted: + $ref: '#/components/schemas/event-survey-response-deleted' + survey_response_updated: + $ref: '#/components/schemas/event-survey-response-updated' + survey_updated: + $ref: '#/components/schemas/event-survey-updated' + sync_history_created: + $ref: '#/components/schemas/event-sync-history-created' + sync_history_deleted: + $ref: '#/components/schemas/event-sync-history-deleted' + sync_history_updated: + $ref: '#/components/schemas/event-sync-history-updated' + tag_created: + $ref: '#/components/schemas/event-tag-created' + tag_deleted: + $ref: '#/components/schemas/event-tag-deleted' + tag_updated: + $ref: '#/components/schemas/event-tag-updated' + timeline_entry_created: + $ref: '#/components/schemas/event-timeline-entry-created' + timeline_entry_deleted: + $ref: '#/components/schemas/event-timeline-entry-deleted' + timeline_entry_updated: + $ref: '#/components/schemas/event-timeline-entry-updated' + timestamp: + type: string + description: | + Timestamp of the webhook's invocation for the event. Note this + should be used to protect against replay attacks, where the event + should only be processed if the timestamp isn't stale by several + seconds. + example: "2023-01-01T12:00:00.000Z" + format: date-time + verify: + $ref: '#/components/schemas/webhook-event-verify' + webhook_created: + $ref: '#/components/schemas/event-webhook-created' + webhook_deleted: + $ref: '#/components/schemas/event-webhook-deleted' + webhook_id: + type: string + description: ID of the webhook for the event. + example: don:integration:dvrv-us-1:devo/example:webhook/webhook-id + format: id + webhook_updated: + $ref: '#/components/schemas/event-webhook-updated' + widget_created: + $ref: '#/components/schemas/event-widget-created' + widget_deleted: + $ref: '#/components/schemas/event-widget-deleted' + widget_updated: + $ref: '#/components/schemas/event-widget-updated' + work_created: + $ref: '#/components/schemas/event-work-created' + work_deleted: + $ref: '#/components/schemas/event-work-deleted' + work_fetched: + $ref: '#/components/schemas/event-work-fetched' + work_updated: + $ref: '#/components/schemas/event-work-updated' + required: + - id + - webhook_id + title: webhook-event-request + webhook-event-response: + type: object + properties: + challenge: + type: string + description: | + The challenge from the "verify" request, otherwise this should not + be set for other request types. + format: byte + title: webhook-event-response + x-go-name: WebhookEventResponseBody + webhook-event-type: + type: string + description: The event types that the webhook will receive. + enum: + - account_created + - account_deleted + - account_updated + - ai_agent_response + - conversation_created + - conversation_deleted + - conversation_updated + - dashboard_created + - dashboard_deleted + - dashboard_updated + - dev_user_created + - dev_user_deleted + - dev_user_updated + - group_created + - group_deleted + - group_member_added + - group_member_removed + - group_updated + - incident_created + - incident_deleted + - incident_updated + - job_created + - job_deleted + - job_updated + - link_created + - link_deleted + - link_updated + - part_created + - part_deleted + - part_updated + - question_answer_created + - question_answer_deleted + - question_answer_updated + - rev_org_created + - rev_org_deleted + - rev_org_updated + - rev_user_created + - rev_user_deleted + - rev_user_updated + - sla_tracker_created + - sla_tracker_deleted + - sla_tracker_fetched + - sla_tracker_updated + - survey_created + - survey_deleted + - survey_response_created + - survey_response_deleted + - survey_response_updated + - survey_updated + - sync_history_created + - sync_history_deleted + - sync_history_updated + - sync_unit_updated + - tag_created + - tag_deleted + - tag_updated + - timeline_entry_created + - timeline_entry_deleted + - timeline_entry_updated + - verify + - webhook_created + - webhook_deleted + - webhook_updated + - widget_created + - widget_deleted + - widget_updated + - work_created + - work_deleted + - work_fetched + - work_updated + webhook-event-verify: + type: object + properties: + challenge: + type: string + description: The challenge that must be echoed in the response. + format: byte + required: + - challenge + title: webhook-event-verify + webhook-status: + type: string + description: The status of the webhook. + enum: + - active + - inactive + - unverified + webhook-summary: + allOf: + - $ref: '#/components/schemas/atom-base-summary' + title: webhook-summary + webhooks-create-request: + type: object + description: The request to create a new webhook. + properties: + event_types: + type: array + description: The event types that the webhook endpoint will receive. + items: + $ref: '#/components/schemas/webhook-event-type' + secret: + type: string + description: | + The secret to use when verifying webhook events. If provided, the + secret must be between 8 and 32 bytes (inclusive). If not set, a + secret will be automatically generated and provided in the + response. + format: byte + url: + type: string + description: The URL of the webhook endpoint. + format: text + required: + - url + title: webhooks-create-request + webhooks-create-response: + type: object + description: The response to creating a new webhook. + properties: + webhook: + $ref: '#/components/schemas/webhook' + required: + - webhook + title: webhooks-create-response + x-go-name: WebhooksCreateResponseBody + webhooks-delete-request: + type: object + description: The request to delete a webhook. + properties: + id: + type: string + description: ID for the webhook. + example: don:integration:dvrv-us-1:devo/example:webhook/webhook-id + format: id + required: + - id + title: webhooks-delete-request + webhooks-delete-response: + type: object + additionalProperties: false + description: The response to deleting the webhook. + title: webhooks-delete-response + x-go-name: WebhooksDeleteResponseBody + webhooks-get-request: + type: object + description: The request to get a webhook's information. + properties: + id: + type: string + description: ID for the webhook. + example: don:integration:dvrv-us-1:devo/example:webhook/webhook-id + format: id + required: + - id + title: webhooks-get-request + webhooks-get-response: + type: object + description: The response to getting the information for the webhook. + properties: + webhook: + $ref: '#/components/schemas/webhook' + required: + - webhook + title: webhooks-get-response + x-go-name: WebhooksGetResponseBody + webhooks-list-request: + type: object + additionalProperties: false + description: The request to list the webhooks. + title: webhooks-list-request + webhooks-list-response: + type: object + description: The response to listing the webhooks. + properties: + webhooks: + type: array + description: The list of webhooks. + items: + $ref: '#/components/schemas/webhook' + required: + - webhooks + title: webhooks-list-response + x-go-name: WebhooksListResponseBody + webhooks-update-action: + type: string + description: The action to update the webhook's status. + enum: + - activate + - deactivate + webhooks-update-request: + type: object + description: The request to update a webhook. + properties: + action: + $ref: '#/components/schemas/webhooks-update-action' + event_types: + $ref: '#/components/schemas/webhooks-update-request-event-types' + id: + type: string + description: ID for the webhook. + example: don:integration:dvrv-us-1:devo/example:webhook/webhook-id + format: id + secret: + type: string + description: | + If provided, updates the secret that's used when verifying webhook + events, which must be between 8 and 32 bytes (inclusive). Otherwise + if empty, then a new secret is generated. If the webhook is active, + then its status will transition to the 'unverified' state and it + won't receive any object events until successfully verified. + format: byte + url: + type: string + description: | + The webhook's updated URL. If the webhook is active, then the + webhook's status will transition to the 'unverified' state and it + won't receive any object events until successfully verified. + format: text + required: + - id + title: webhooks-update-request + webhooks-update-request-event-types: + type: object + properties: + add: + type: array + description: | + The event types to add. If a provided event type is already set for + the webhook, then nothing is done. Note this is mutually exclusive + with 'set'. + items: + $ref: '#/components/schemas/webhook-event-type' + remove: + type: array + description: | + The event types to remove. If a provided event type isn't set for + the webhook, then nothing is done. Note this is mutually exclusive + with 'set'. + items: + $ref: '#/components/schemas/webhook-event-type' + set: + type: array + description: | + The updated event types, which will replace the webhook's current + event types. Note this is mutually exclusive with 'add' and + 'remove'. + items: + $ref: '#/components/schemas/webhook-event-type' + title: webhooks-update-request-event-types + webhooks-update-response: + type: object + description: The response to updating the webhook. + properties: + webhook: + $ref: '#/components/schemas/webhook' + required: + - webhook + title: webhooks-update-response + x-go-name: WebhooksUpdateResponseBody + weekly-org-schedule: + type: object + additionalProperties: false + description: The schedule for each week. + title: weekly-org-schedule + widget: + allOf: + - $ref: '#/components/schemas/atom-base' + title: widget + work: + type: object + discriminator: + mapping: + issue: '#/components/schemas/issue' + ticket: '#/components/schemas/ticket' + propertyName: type + oneOf: + - $ref: '#/components/schemas/issue' + - $ref: '#/components/schemas/ticket' + properties: + type: + $ref: '#/components/schemas/work-type' + required: + - type + title: work + work-base: + allOf: + - $ref: '#/components/schemas/atom-base' + - type: object + properties: + applies_to_part: + $ref: '#/components/schemas/part-summary' + artifacts: + type: array + description: The artifacts attached to the work item. + items: + $ref: '#/components/schemas/artifact-summary' + body: + type: string + description: Body of the work object. + format: text + owned_by: + type: array + description: The users that own the work. + items: + $ref: '#/components/schemas/user-summary' + reported_by: + type: array + description: Users that reported the work. + items: + $ref: '#/components/schemas/user-summary' + stage: + $ref: '#/components/schemas/legacy-stage' + tags: + type: array + description: Tags associated with the object. + items: + $ref: '#/components/schemas/tag-with-value' + target_close_date: + type: string + description: Timestamp when the work is expected to be complete. + example: "2023-01-01T12:00:00.000Z" + format: date-time + title: + type: string + description: Title of the work object. + format: text + required: + - owned_by + - title + title: work-base + work-base-summary: + allOf: + - $ref: '#/components/schemas/atom-base-summary' + - type: object + properties: + owned_by: + type: array + description: The users that own the work. + items: + $ref: '#/components/schemas/user-summary' + stage: + $ref: '#/components/schemas/legacy-stage-summary' + title: + type: string + description: Title of the work object. + format: text + required: + - owned_by + - title + title: work-base-summary + work-type: + type: string + enum: + - issue + - ticket + workflow-run-summary: + allOf: + - $ref: '#/components/schemas/atom-base-summary' + title: workflow-run-summary + workflow-summary: + allOf: + - $ref: '#/components/schemas/atom-base-summary' + title: workflow-summary + works-create-request: + type: object + discriminator: + mapping: + issue: '#/components/schemas/works-create-request-issue' + ticket: '#/components/schemas/works-create-request-ticket' + propertyName: type + oneOf: + - $ref: '#/components/schemas/works-create-request-issue' + - $ref: '#/components/schemas/works-create-request-ticket' + properties: + type: + $ref: '#/components/schemas/work-type' + applies_to_part: + type: string + description: | + The [part](https://devrev.ai/docs/product/parts) that the work + applies to. Specifying a part is required when creating tickets and + issues. + example: PROD-12345 + format: id + artifacts: + type: array + description: | + The IDs of the artifacts to associate with the work item. + example: + - ARTIFACT-12345 + items: + type: string + format: id + body: + type: string + description: Body of the work object. + format: text + maxLength: 65536 + owned_by: + type: array + description: The users that own the work. + example: + - DEVU-12345 + items: + type: string + format: id + reported_by: + type: array + description: The users that reported the work. + example: + - DEVU-12345 + items: + type: string + format: id + stage: + $ref: '#/components/schemas/stage-init' + stage_validation_options: + type: array + description: | + The type of stage validations options when creating a work item. + items: + $ref: '#/components/schemas/stage-validation-option-for-create' + tags: + type: array + description: Tags associated with the work item. + items: + $ref: '#/components/schemas/set-tag-with-value' + target_close_date: + type: string + description: Timestamp for when the work is expected to be complete. + example: "2023-01-01T12:00:00.000Z" + format: date-time + title: + type: string + description: Title of the work object. + format: text + maxLength: 256 + minLength: 1 + required: + - applies_to_part + - owned_by + - title + - type + title: works-create-request + works-create-request-issue: + type: object + properties: + developed_with: + type: array + description: The IDs of the parts associated with issue. + example: + - PROD-12345 + items: + type: string + format: id + maxItems: 8 + priority: + $ref: '#/components/schemas/issue-priority' + priority_v2: + type: integer + description: | + Priority enum id of the work based upon impact and criticality. The + allowed ids can be extended by the user. Stock allowed values: + ``` + { + "id": 1, + "label": "P0", + "ordinal": 1, + "overridable": true + }, + { + "id": 2, + "label": "P1", + "ordinal": 2, + "overridable": true + }, + { + "id": 3, + "label": "P2", + "ordinal": 3, + "overridable": true + }, + { + "id": 4, + "label": "P3", + "ordinal": 4, + "overridable": true + } + ``` + format: int64 + x-devrev-uenum-overridable: true + x-devrev-uenum-values: + - id: 1 + label: P0 + ordinal: 1 + overridable: true + - id: 2 + label: P1 + ordinal: 2 + overridable: true + - id: 3 + label: P2 + ordinal: 3 + overridable: true + - id: 4 + label: P3 + ordinal: 4 + overridable: true + sprint: + type: string + description: The sprint that the issue belongs to. + format: id + target_start_date: + type: string + description: Timestamp for when the work is expected to start. + example: "2023-01-01T12:00:00.000Z" + format: date-time + title: works-create-request-issue + works-create-request-ticket: + type: object + properties: + account: + type: string + description: The account that the ticket is associated with. + example: ACC-12345 + format: id + channels: + type: array + description: Channels of the ticket. + items: + $ref: '#/components/schemas/ticket-channels' + channels_v2: + type: array + description: Channel IDs of the ticket. + items: + type: string + format: id + group: + type: string + description: The group that the ticket is associated with. + format: id + is_spam: + type: boolean + description: Whether the ticket is spam. + needs_response: + type: boolean + description: Whether the ticket needs a response. + rev_org: + type: string + description: The Rev organization that the ticket is associated with. + example: REV-AbCdEfGh + format: id + severity: + $ref: '#/components/schemas/ticket-severity' + source_channel: + type: string + description: The source channel of the ticket. + format: text + source_channel_v2: + type: string + description: Source channel ID of the ticket. + format: id + title: works-create-request-ticket + works-create-response: + type: object + properties: + work: + $ref: '#/components/schemas/work' + required: + - work + title: works-create-response + x-go-name: WorksCreateResponseBody + works-delete-request: + type: object + properties: + id: + type: string + description: The work's ID. + example: ISS-12345 + format: id + required: + - id + title: works-delete-request + works-delete-response: + type: object + additionalProperties: false + title: works-delete-response + x-go-name: WorksDeleteResponseBody + works-export-request: + type: object + properties: + type: + type: array + description: Filters for work of the provided types. + items: + $ref: '#/components/schemas/work-type' + actual_close_date: + $ref: '#/components/schemas/date-filter' + applies_to_part: + type: array + description: Filters for work belonging to any of the provided parts. + example: + - PROD-12345 + items: + type: string + format: id + created_by: + type: array + description: Filters for work created by any of these users. + example: + - DEVU-12345 + items: + type: string + format: id + created_date: + $ref: '#/components/schemas/date-filter' + first: + type: integer + description: | + The number of work items to return. The default is '50', the + maximum is '5000'. + format: int32 + issue: + $ref: '#/components/schemas/works-filter-issue' + modified_by: + type: array + description: Filters for work modified by any of these users. + example: + - DEVU-12345 + items: + type: string + format: id + modified_date: + $ref: '#/components/schemas/date-filter' + owned_by: + type: array + description: Filters for work owned by any of these users. + example: + - DEVU-12345 + items: + type: string + format: id + reported_by: + type: array + description: Filters for work reported by any of these users. + example: + - DEVU-12345 + items: + type: string + format: id + stage: + $ref: '#/components/schemas/stage-filter' + staged_info: + $ref: '#/components/schemas/staged-info-filter' + state: + type: array + description: Filters for work with any of the provided states. + items: + type: string + format: text + sync_metadata: + $ref: '#/components/schemas/sync-metadata-filter' + tags: + type: array + description: Filters for work with any of the provided tags. + example: + - TAG-12345 + items: + type: string + format: id + target_close_date: + $ref: '#/components/schemas/date-filter' + ticket: + $ref: '#/components/schemas/works-filter-ticket' + title: works-export-request + works-export-response: + type: object + properties: + works: + type: array + description: The resulting collection of work items. + items: + $ref: '#/components/schemas/work' + required: + - works + title: works-export-response + x-go-name: WorksExportResponseBody + works-filter-issue: + type: object + properties: + accounts: + type: array + description: Filters for issues with any of the provided accounts. + example: + - ACC-12345 + items: + type: string + format: id + actual_start_date: + $ref: '#/components/schemas/date-filter' + priority: + type: array + description: Filters for issues with any of the provided priorities. + items: + $ref: '#/components/schemas/issue-priority' + priority_v2: + type: array + description: | + Filters for issues with any of the provided priority enum ids. + items: + type: integer + format: int64 + rev_orgs: + type: array + description: | + Filters for issues with any of the provided Rev organizations. + example: + - REV-AbCdEfGh + items: + type: string + format: id + sla_summary: + $ref: '#/components/schemas/sla-summary-filter' + sprint: + type: array + description: Filters for issues with any of the sprint. + items: + type: string + format: id + target_start_date: + $ref: '#/components/schemas/date-filter' + title: works-filter-issue + works-filter-ticket: + type: object + properties: + brand: + type: array + description: | + Filters for tickets that are associated with any of the brands. + items: + type: string + format: id + channels: + type: array + description: Filters for tickets with any of the provided channels. + items: + $ref: '#/components/schemas/ticket-channels' + channels_v2: + type: array + description: | + Filters for tickets that are associated with any of the channels. + items: + type: string + format: id + group: + type: array + description: Filters for tickets belonging to specific groups. + items: + type: string + format: id + is_frozen: + type: boolean + description: Filters for frozen tickets. + is_spam: + type: boolean + description: Filters for tickets that are spam. + needs_response: + type: boolean + description: Filters for tickets that need response. + rev_org: + type: array + description: | + Filters for tickets that are associated with any of the provided + Rev organizations. + example: + - REV-AbCdEfGh + items: + type: string + format: id + severity: + type: array + description: Filters for tickets with any of the provided severities. + items: + $ref: '#/components/schemas/ticket-severity' + sla_summary: + $ref: '#/components/schemas/sla-summary-filter' + source_channel: + type: array + description: | + Filters for tickets with any of the provided source channels. + items: + type: string + format: text + source_channel_v2: + type: array + description: | + Filters for tickets that are associated with any of the source + channels. + items: + type: string + format: id + surveys: + $ref: '#/components/schemas/survey-aggregation-filter' + title: works-filter-ticket + works-get-request: + type: object + properties: + id: + type: string + description: The work's ID. + example: ISS-12345 + format: id + required: + - id + title: works-get-request + works-get-response: + type: object + properties: + work: + $ref: '#/components/schemas/work' + required: + - work + title: works-get-response + x-go-name: WorksGetResponseBody + works-list-request: + type: object + properties: + type: + type: array + description: Filters for work of the provided types. + items: + $ref: '#/components/schemas/work-type' + actual_close_date: + $ref: '#/components/schemas/date-filter' + applies_to_part: + type: array + description: Filters for work belonging to any of the provided parts. + example: + - PROD-12345 + items: + type: string + format: id + created_by: + type: array + description: Filters for work created by any of these users. + example: + - DEVU-12345 + items: + type: string + format: id + created_date: + $ref: '#/components/schemas/date-filter' + cursor: + type: string + description: | + The cursor to resume iteration from. If not provided, then + iteration starts from the beginning. + format: text + issue: + $ref: '#/components/schemas/works-filter-issue' + limit: + type: integer + description: | + The maximum number of works to return. The default is '50'. + format: int32 + mode: + $ref: '#/components/schemas/list-mode' + modified_by: + type: array + description: Filters for work modified by any of these users. + example: + - DEVU-12345 + items: + type: string + format: id + modified_date: + $ref: '#/components/schemas/date-filter' + owned_by: + type: array + description: Filters for work owned by any of these users. + example: + - DEVU-12345 + items: + type: string + format: id + reported_by: + type: array + description: Filters for work reported by any of these users. + example: + - DEVU-12345 + items: + type: string + format: id + sort_by: + type: array + description: | + Fields to sort the works by and the direction to sort them. + items: + type: string + format: sort-by + stage: + $ref: '#/components/schemas/stage-filter' + staged_info: + $ref: '#/components/schemas/staged-info-filter' + state: + type: array + description: Filters for work with any of the provided states. + items: + type: string + format: text + sync_metadata: + $ref: '#/components/schemas/sync-metadata-filter' + tags: + type: array + description: Filters for work with any of the provided tags. + example: + - TAG-12345 + items: + type: string + format: id + target_close_date: + $ref: '#/components/schemas/date-filter' + ticket: + $ref: '#/components/schemas/works-filter-ticket' + title: works-list-request + works-list-response: + type: object + properties: + next_cursor: + type: string + description: | + The cursor used to iterate subsequent results in accordance to the + sort order. If not set, then no later elements exist. + format: text + prev_cursor: + type: string + description: | + The cursor used to iterate preceding results in accordance to the + sort order. If not set, then no prior elements exist. + format: text + works: + type: array + description: The list of works. + items: + $ref: '#/components/schemas/work' + required: + - works + title: works-list-response + x-go-name: WorksListResponseBody + works-update-request: + type: object + discriminator: + mapping: + issue: '#/components/schemas/works-update-request-issue' + none: '#/components/schemas/empty' + ticket: '#/components/schemas/works-update-request-ticket' + propertyName: type + oneOf: + - $ref: '#/components/schemas/empty' + - $ref: '#/components/schemas/works-update-request-issue' + - $ref: '#/components/schemas/works-update-request-ticket' + properties: + type: + $ref: '#/components/schemas/work-type' + applies_to_part: + type: string + description: Updates the part that the work item applies to. + example: PROD-12345 + format: id + artifacts: + $ref: '#/components/schemas/works-update-request-artifacts' + body: + type: string + description: | + Updated body of the work object, or unchanged if not provided. + format: text + maxLength: 65536 + id: + type: string + description: The work's ID. + example: ISS-12345 + format: id + owned_by: + $ref: '#/components/schemas/works-update-request-owned-by' + reported_by: + $ref: '#/components/schemas/works-update-request-reported-by' + stage: + $ref: '#/components/schemas/stage-update' + stage_validation_options: + type: array + description: | + The type of stage validations options when updating the stage or + the stage diagram of an object. + items: + $ref: '#/components/schemas/stage-validation-option-for-update' + staged_info: + $ref: '#/components/schemas/works-update-request-staged-info-update' + tags: + $ref: '#/components/schemas/works-update-request-tags' + target_close_date: + type: string + description: | + Updates the timestamp for when the work is expected to be complete. + example: "2023-01-01T12:00:00.000Z" + format: date-time + nullable: true + title: + type: string + description: | + Updated title of the work object, or unchanged if not provided. + format: text + maxLength: 256 + minLength: 1 + required: + - id + title: works-update-request + works-update-request-artifacts: + type: object + properties: + add: + type: array + description: | + Adds the provided artifacts (if not already present) to the field. + example: + - ARTIFACT-12345 + items: + type: string + format: id + maxItems: 50 + remove: + type: array + description: | + Removes the provided artifacts (if they exist) from the field. + example: + - ARTIFACT-12345 + items: + type: string + format: id + maxItems: 50 + set: + type: array + description: Sets the field to the provided artifacts. + example: + - ARTIFACT-12345 + items: + type: string + format: id + maxItems: 50 + title: works-update-request-artifacts + works-update-request-issue: + type: object + properties: + developed_with: + $ref: '#/components/schemas/works-update-request-issue-developed-with' + priority: + $ref: '#/components/schemas/issue-priority' + priority_v2: + type: integer + description: | + Priority enum id of the work based upon impact and criticality. The + allowed ids can be extended by the user. Stock allowed values: + ``` + { + "id": 1, + "label": "P0", + "ordinal": 1, + "overridable": true + }, + { + "id": 2, + "label": "P1", + "ordinal": 2, + "overridable": true + }, + { + "id": 3, + "label": "P2", + "ordinal": 3, + "overridable": true + }, + { + "id": 4, + "label": "P3", + "ordinal": 4, + "overridable": true + } + ``` + format: int64 + x-devrev-uenum-overridable: true + x-devrev-uenum-values: + - id: 1 + label: P0 + ordinal: 1 + overridable: true + - id: 2 + label: P1 + ordinal: 2 + overridable: true + - id: 3 + label: P2 + ordinal: 3 + overridable: true + - id: 4 + label: P3 + ordinal: 4 + overridable: true + sprint: + type: string + description: Updates the sprint that the issue belongs to. + format: id + nullable: true + target_start_date: + type: string + description: | + Updates the timestamp for when the work is expected to start. + example: "2023-01-01T12:00:00.000Z" + format: date-time + nullable: true + title: works-update-request-issue + works-update-request-issue-developed-with: + type: object + properties: + set: + type: array + description: Sets the IDs of the parts associated with issue. + example: + - PROD-12345 + items: + type: string + format: id + maxItems: 8 + title: works-update-request-issue-developed-with + works-update-request-owned-by: + type: object + properties: + set: + type: array + description: | + Sets the owner IDs to the provided user IDs. This must not be + empty. + example: + - DEVU-12345 + items: + type: string + format: id + title: works-update-request-owned-by + works-update-request-reported-by: + type: object + properties: + set: + type: array + description: | + Sets the users that reported the work to the provided user IDs. + example: + - DEVU-12345 + items: + type: string + format: id + title: works-update-request-reported-by + works-update-request-staged-info-update: + type: object + properties: + sync_in_unresolved_fields: + type: array + description: | + Updates the sync in unresolved fields of the staged work. + items: + $ref: '#/components/schemas/works-update-request-staged-info-update-unresolved-field' + sync_out_unresolved_fields: + type: array + description: | + Updates the sync out unresolved fields of the staged work. + items: + $ref: '#/components/schemas/works-update-request-staged-info-update-unresolved-field' + unresolved_fields: + type: array + description: Updates the unresolved fields of the staged work. + items: + type: string + format: text + title: works-update-request-staged-info-update + works-update-request-staged-info-update-unresolved-field: + type: object + properties: + devrev_field_name: + type: string + description: DevRev field name of the object's attribute. + format: text + external_display_name: + type: string + description: External field name as seen by the end user. + format: text + external_field_name: + type: string + description: Api name of the external object's field. + format: text + title: works-update-request-staged-info-update-unresolved-field + works-update-request-tags: + type: object + properties: + set: + type: array + description: Sets the provided tags on the work item. + items: + $ref: '#/components/schemas/set-tag-with-value' + title: works-update-request-tags + works-update-request-ticket: + type: object + properties: + account: + type: string + description: Updates the account that the ticket is associated with. + example: ACC-12345 + format: id + nullable: true + channels: + $ref: '#/components/schemas/works-update-request-ticket-channels' + channels_v2: + type: array + description: Updates channel IDs of the ticket. + items: + type: string + format: id + group: + type: string + description: Updates the group that the ticket is associated with. + format: id + nullable: true + is_archived: + type: boolean + description: Whether the ticket is archived. + is_frozen: + type: boolean + description: Whether the ticket is frozen. + is_spam: + type: boolean + description: Updates whether the ticket is spam. + needs_response: + type: boolean + description: Updates whether the ticket needs a response. + rev_org: + type: string + description: | + Updates the Rev organization that the ticket is associated with. + example: REV-AbCdEfGh + format: id + nullable: true + sentiment: + type: integer + description: | + The enum ID for the sentiment of the ticket. The allowed ids can be + extended by the user. Stock allowed values: + ``` + { + "id": 1, + "label": "Delighted", + "ordinal": 1, + "overridable": true + }, + { + "id": 2, + "label": "Happy", + "ordinal": 2, + "overridable": true + }, + { + "id": 3, + "label": "Neutral", + "ordinal": 3, + "overridable": true + }, + { + "id": 4, + "label": "Unhappy", + "ordinal": 4, + "overridable": true + }, + { + "id": 5, + "label": "Frustrated", + "ordinal": 5, + "overridable": true + } + ``` + format: int64 + x-devrev-uenum-overridable: true + x-devrev-uenum-values: + - id: 1 + label: Delighted + ordinal: 1 + overridable: true + - id: 2 + label: Happy + ordinal: 2 + overridable: true + - id: 3 + label: Neutral + ordinal: 3 + overridable: true + - id: 4 + label: Unhappy + ordinal: 4 + overridable: true + - id: 5 + label: Frustrated + ordinal: 5 + overridable: true + sentiment_modified_date: + type: string + description: Timestamp at which sentiment was last modified. + example: "2023-01-01T12:00:00.000Z" + format: date-time + sentiment_summary: + type: string + description: Summary justifying the current sentiment. + format: text + severity: + $ref: '#/components/schemas/ticket-severity' + source_channel_v2: + type: string + description: Updates the source channel of the ticket. + format: id + nullable: true + title: works-update-request-ticket + works-update-request-ticket-channels: + type: object + properties: + set: + type: array + description: Sets the channels to the provided channels. + items: + $ref: '#/components/schemas/ticket-channels' + title: works-update-request-ticket-channels + works-update-response: + type: object + properties: + work: + $ref: '#/components/schemas/work' + required: + - work + title: works-update-response + x-go-name: WorksUpdateResponseBody + securitySchemes: + auth-token: + type: http + description: |- + All the DevRev APIs require a token to authenticate the user. Provide `Authorization: ` as a header to every API request. + [How do I find my token?](https://devrev.ai/docs/apis/auth) + scheme: bearer + x-fern-bearer: + env: DEVREV_TOKEN + name: token +info: + description: DevRev's REST API. + title: DevRev REST API + version: "2024-01-24" +openapi: 3.0.3 +paths: + /accounts.create: + post: + description: | + Creates an account, which is a record representing a customer or an + organization. + operationId: accounts-create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-create-request' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-create-response' + description: The response to creating a new account. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "409": + $ref: '#/components/responses/conflict' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Create Account + tags: + - accounts + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /accounts.delete: + post: + description: Deletes an account. + operationId: accounts-delete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-delete-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-delete-response' + description: The response to deleting an account. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Delete Account + tags: + - accounts + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /accounts.export: + get: + description: Exports a collection of accounts. + operationId: accounts-export + parameters: + - description: Filters for accounts created by the specified user(s). + explode: false + in: query + name: created_by + schema: + type: array + items: + type: string + format: id + - description: | + Filters for objects created after the provided timestamp (inclusive). + explode: false + in: query + name: created_date.after + schema: + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time + - description: | + Filters for objects created before the provided timestamp + (inclusive). + explode: false + in: query + name: created_date.before + schema: + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time + - description: Array of display names of accounts to be filtered. + explode: false + in: query + name: display_name + schema: + type: array + items: + type: string + format: text + - description: Array of references of accounts to be filtered. + explode: false + in: query + name: external_refs + schema: + type: array + items: + type: string + format: text + - description: The number of accounts to return. The default is '50'. + explode: false + in: query + name: first + schema: + type: integer + format: int32 + maximum: 500 + minimum: 1 + - description: | + Filters for objects created after the provided timestamp (inclusive). + explode: false + in: query + name: modified_date.after + schema: + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time + - description: | + Filters for objects created before the provided timestamp + (inclusive). + explode: false + in: query + name: modified_date.before + schema: + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time + - description: | + Fields to sort the accounts by and the direction to sort them in. + explode: false + in: query + name: sort_by + schema: + type: array + items: + type: string + format: sort-by + - description: Filters for accounts on specified stages. + explode: false + in: query + name: stage + schema: + type: array + items: + type: string + format: id + - description: Tier of the accounts to be filtered. + explode: false + in: query + name: tier + schema: + type: array + items: + type: string + format: text + - description: Array of websites of accounts to be filtered. + explode: false + in: query + name: websites + schema: + type: array + items: + type: string + format: text + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-export-response' + description: The response to exporting a collection of accounts. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Export Accounts + tags: + - accounts + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: AccountsExportQuery + post: + description: Exports a collection of accounts. + operationId: accounts-export-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-export-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-export-response' + description: The response to exporting a collection of accounts. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Export Accounts (POST) + tags: + - accounts + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /accounts.get: + get: + description: Retrieves an account's information. + operationId: accounts-get + parameters: + - description: The ID of the account to be retrieved. + explode: false + in: query + name: id + required: true + schema: + type: string + example: ACC-12345 + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-get-response' + description: The returned account. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Account + tags: + - accounts + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: AccountsGetQuery + post: + description: Retrieves an account's information. + operationId: accounts-get-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-get-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-get-response' + description: The returned account. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Account (POST) + tags: + - accounts + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /accounts.list: + get: + description: Gets a list of accounts. + operationId: accounts-list + parameters: + - description: Filters for accounts created by the specified user(s). + explode: false + in: query + name: created_by + schema: + type: array + items: + type: string + format: id + - description: | + Filters for objects created after the provided timestamp (inclusive). + explode: false + in: query + name: created_date.after + schema: + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time + - description: | + Filters for objects created before the provided timestamp + (inclusive). + explode: false + in: query + name: created_date.before + schema: + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time + - description: | + The cursor to resume iteration from. If not provided, then iteration + starts from the beginning. + explode: false + in: query + name: cursor + schema: + type: string + format: text + - description: Array of display names of accounts to be filtered. + explode: false + in: query + name: display_name + schema: + type: array + items: + type: string + format: text + - description: Array of references of accounts to be filtered. + explode: false + in: query + name: external_refs + schema: + type: array + items: + type: string + format: text + - description: | + The maximum number of accounts to return per page. The default is + '50'. + explode: false + in: query + name: limit + schema: + type: integer + format: int32 + - description: | + The iteration mode to use, otherwise if not set, then "after" is + used. + explode: false + in: query + name: mode + schema: + $ref: '#/components/schemas/list-mode' + - description: | + Filters for objects created after the provided timestamp (inclusive). + explode: false + in: query + name: modified_date.after + schema: + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time + - description: | + Filters for objects created before the provided timestamp + (inclusive). + explode: false + in: query + name: modified_date.before + schema: + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time + - description: | + Fields to sort the accounts by and the direction to sort them in. + explode: false + in: query + name: sort_by + schema: + type: array + items: + type: string + format: sort-by + - description: Filters for accounts on specified stages. + explode: false + in: query + name: stage + schema: + type: array + items: + type: string + format: id + - description: Tier of the accounts to be filtered. + explode: false + in: query + name: tier + schema: + type: array + items: + type: string + format: text + - description: Array of websites of accounts to be filtered. + explode: false + in: query + name: websites + schema: + type: array + items: + type: string + format: text + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-list-response' + description: | + The response to listing all accounts matching the filter criteria. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Accounts + tags: + - accounts + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: AccountsListQuery + post: + description: Gets a list of accounts. + operationId: accounts-list-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-list-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-list-response' + description: | + The response to listing all accounts matching the filter criteria. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Accounts (POST) + tags: + - accounts + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /accounts.merge: + post: + description: Merges two accounts. + operationId: accounts-merge + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-merge-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-merge-response' + description: The response to merging an account. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Merge Accounts + tags: + - accounts + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /accounts.update: + post: + description: Updates an account's information. + operationId: accounts-update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-update-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/accounts-update-response' + description: Updated account object. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "409": + $ref: '#/components/responses/conflict' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Update Account + tags: + - accounts + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /articles.create: + post: + description: | + Article is an object which can contain a URL or artifacts in the + resource. It also contains the data regarding the owner, author, status + and published date of the object. This call creates an article. + operationId: create-article + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/articles-create-request' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/articles-create-response' + description: Create article response. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Create Article + tags: + - articles + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /articles.delete: + post: + description: Deletes an article. + operationId: delete-article + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/articles-delete-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/articles-delete-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Delete Article + tags: + - articles + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /articles.get: + get: + description: Gets an article. + operationId: get-article + parameters: + - description: The ID of the required article. + explode: false + in: query + name: id + required: true + schema: + type: string + example: ARTICLE-12345 + format: id + - description: Optional Dev Org ID for the unauthenticated user. + explode: false + in: query + name: dev_org + schema: + type: string + example: DEV-AbCdEfGh + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/articles-get-response' + description: Get article response. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Article + tags: + - articles + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: GetArticleQuery + post: + description: Gets an article. + operationId: get-article-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/articles-get-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/articles-get-response' + description: Get article response. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Article (POST) + tags: + - articles + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /articles.list: + get: + description: Lists a collection of articles. + operationId: list-articles + parameters: + - description: | + Filters for articles belonging to any of the provided parts. + explode: false + in: query + name: applies_to_parts + schema: + type: array + example: + - PROD-12345 + items: + type: string + format: id + - description: | + Filter for the type of articles. If this is not provided, then + articles that are not content blocks are returned. + explode: false + in: query + name: article_type + schema: + type: array + items: + $ref: '#/components/schemas/article-type' + - description: | + Filters for articles authored by any of the provided users. + explode: false + in: query + name: authored_by + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id + - description: | + Filters for articles belonging to any of the provided brands. + explode: false + in: query + name: brands + schema: + type: array + items: + type: string + format: id + - description: Filters for articles created by any of the provided users. + explode: false + in: query + name: created_by + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id + - description: | + The cursor to resume iteration from. If not provided, then iteration + starts from the beginning. + explode: false + in: query + name: cursor + schema: + type: string + format: text + - description: Optional Dev Org ID for the unauthenticated user. + explode: false + in: query + name: dev_org + schema: + type: string + example: DEV-AbCdEfGh + format: id + - description: | + The maximum number of articles to return. The default is '50'. + explode: false + in: query + name: limit + schema: + type: integer + format: int32 + - description: | + The iteration mode to use, otherwise if not set, then "after" is + used. + explode: false + in: query + name: mode + schema: + $ref: '#/components/schemas/list-mode' + - description: | + Filters for articles modified by any of the provided users. + explode: false + in: query + name: modified_by + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id + - description: Filters for articles owned by any of the provided users. + explode: false + in: query + name: owned_by + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id + - description: Filter for the scope of the articles. + explode: false + in: query + name: scope + schema: + type: array + items: + type: integer + format: int64 + - description: ID of the group/member with whom the item is shared. + explode: false + in: query + name: shared_with.member + schema: + type: string + format: id + - description: Role ID of the group/member with whom the item is shared. + explode: false + in: query + name: shared_with.role + schema: + type: string + format: id + - description: Filters for article with any of the provided tags. + explode: false + in: query + name: tags + schema: + type: array + example: + - TAG-12345 + items: + type: string + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/articles-list-response' + description: List articles response. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Articles + tags: + - articles + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: ListArticlesQuery + post: + description: Lists a collection of articles. + operationId: list-articles-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/articles-list-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/articles-list-response' + description: List articles response. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Articles (POST) + tags: + - articles + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /articles.update: + post: + description: Updates an article. + operationId: update-article + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/articles-update-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/articles-update-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Update Article + tags: + - articles + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /artifacts.get: + get: + description: Gets the requested artifact's information. + operationId: artifacts-get + parameters: + - description: The requested artifact's ID. + explode: false + in: query + name: id + required: true + schema: + type: string + example: ARTIFACT-12345 + format: id + - description: The version of the artifact that needs to be fetched. + explode: false + in: query + name: version + schema: + type: string + format: text + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/artifacts-get-response' + description: The response to getting an artifact's information. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Artifact + tags: + - artifacts + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: ArtifactsGetQuery + post: + description: Gets the requested artifact's information. + operationId: artifacts-get-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/artifacts-get-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/artifacts-get-response' + description: The response to getting an artifact's information. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Artifact (POST) + tags: + - artifacts + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /artifacts.list: + get: + description: List the artifacts attached to an object. + operationId: artifacts-list + parameters: + - description: The ID of the object to filter artifacts. + explode: false + in: query + name: parent_id + schema: + type: string + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/artifacts-list-response' + description: The response to list artifacts attached to an object. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Artifacts + tags: + - artifacts + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: ArtifactsListQuery + post: + description: List the artifacts attached to an object. + operationId: artifacts-list-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/artifacts-list-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/artifacts-list-response' + description: The response to list artifacts attached to an object. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Artifacts (POST) + tags: + - artifacts + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /artifacts.locate: + get: + description: Gets the download URL for the artifact. + operationId: artifacts-locate + parameters: + - description: The ID of the artifact to get the URL for. + explode: false + in: query + name: id + required: true + schema: + type: string + example: ARTIFACT-12345 + format: id + - description: The version of the artifact that needs to be fetched. + explode: false + in: query + name: version + schema: + type: string + format: text + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/artifacts-locate-response' + description: The response to getting an artifact's download URL. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Locate Artifacts + tags: + - artifacts + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: ArtifactsLocateQuery + post: + description: Gets the download URL for the artifact. + operationId: artifacts-locate-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/artifacts-locate-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/artifacts-locate-response' + description: The response to getting an artifact's download URL. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Locate Artifacts (POST) + tags: + - artifacts + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /artifacts.prepare: + post: + description: | + Creates an artifact and generates an upload URL for its data. + operationId: artifacts-prepare + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/artifacts-prepare-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/artifacts-prepare-response' + description: The response to preparing a URL to upload a file. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Prepare Artifacts + tags: + - artifacts + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /artifacts.versions.delete: + post: + description: Permanently deletes a version of an artifact. + operationId: artifacts-hard-delete-version + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/artifacts-hard-delete-version-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/artifacts-hard-delete-version-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Delete Artifacts Version + tags: + - artifacts + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /artifacts.versions.prepare: + post: + description: | + Prepares a new version for an artifact, returning the URL and form data + to upload the updated file. + operationId: artifacts-versions-prepare + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/artifacts-versions-prepare-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/artifacts-versions-prepare-response' + description: The response to preparing a new artifact version. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Prepare Artifacts Versions + tags: + - artifacts + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /atoms.get: + get: + description: Gets the specified object. + operationId: atoms-get + parameters: + - description: The ID of the object to get. + explode: false + in: query + name: id + required: true + schema: + type: string + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/atoms-get-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Atom + tags: + - atoms + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: AtomsGetQuery + post: + description: Gets the specified object. + operationId: atoms-get-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/atoms-get-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/atoms-get-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Atom (POST) + tags: + - atoms + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /auth-tokens.create: + post: + description: | + Creates a JWT corresponding to the requested token type for the + authenticated user. + operationId: auth-tokens-create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/auth-tokens-create-request' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/auth-tokens-create-response' + description: | + Response for the request to create a new token corresponding to the + requested token type. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "409": + $ref: '#/components/responses/conflict' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Create Auth Token + tags: + - auth-tokens + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /auth-tokens.delete: + post: + description: | + Revokes the token that matches the given token ID issued under the + given Dev organization. + operationId: auth-tokens-delete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/auth-tokens-delete-request' + required: true + responses: + "200": + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Delete Auth Token + tags: + - auth-tokens + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /auth-tokens.get: + get: + description: | + Gets the token metadata corresponding to the given token ID under the + given Dev organization. + operationId: auth-tokens-get + parameters: + - description: | + The unique identifier of the token under a given Dev organization. + explode: false + in: query + name: token_id + required: true + schema: + type: string + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/auth-tokens-get-response' + description: The response to get the token metadata. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Auth Token + tags: + - auth-tokens + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: AuthTokensGetQuery + post: + description: | + Gets the token metadata corresponding to the given token ID under the + given Dev organization. + operationId: auth-tokens-get-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/auth-tokens-get-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/auth-tokens-get-response' + description: The response to get the token metadata. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Auth Token (POST) + tags: + - auth-tokens + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /auth-tokens.info: + get: + description: | + Returns the Dev organization, user and token attributes extracted from + the auth token. + operationId: auth-tokens-info + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/auth-tokens-info-response' + description: | + The Dev organization, user and token attributes extracted from the auth + token. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Info Auth Tokens + tags: + - auth-tokens + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: AuthTokensInfoQuery + post: + description: | + Returns the Dev organization, user and token attributes extracted from + the auth token. + operationId: auth-tokens-info-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/auth-tokens-info-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/auth-tokens-info-response' + description: | + The Dev organization, user and token attributes extracted from the auth + token. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Info Auth Tokens (POST) + tags: + - auth-tokens + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /auth-tokens.list: + get: + description: | + Gets the token metadata for all the tokens corresponding to the given + token type issued for a given subject. + operationId: auth-tokens-list + parameters: + - description: | + An identifier that represents the application, which requested the + token. Only relevant for application access tokens. + explode: false + in: query + name: client_id + schema: + type: string + format: text + - description: | + The type of the requested token. If no value is specified, the + response will include tokens of all the types. + explode: false + in: query + name: requested_token_type + schema: + $ref: '#/components/schemas/auth-token-requested-token-type' + - description: | + The subject associated with the token. In the absence of this + parameter, the ID of the authenticated entity is treated as the + subject. + explode: false + in: query + name: subject + schema: + type: string + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/auth-tokens-list-response' + description: The response to list the token metadata. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Auth Tokens + tags: + - auth-tokens + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: AuthTokensListQuery + post: + description: | + Gets the token metadata for all the tokens corresponding to the given + token type issued for a given subject. + operationId: auth-tokens-list-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/auth-tokens-list-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/auth-tokens-list-response' + description: The response to list the token metadata. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Auth Tokens (POST) + tags: + - auth-tokens + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /auth-tokens.self.delete: + post: + description: | + Revokes all the tokens that matches the given token type created by the + authenticated user. + operationId: auth-tokens-self-delete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/auth-tokens-self-delete-request' + required: true + responses: + "200": + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Delete Auth Tokens Self + tags: + - auth-tokens + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /auth-tokens.update: + post: + description: | + Updates token metadata of a token issued under a given Dev + organization. + operationId: auth-tokens-update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/auth-tokens-update-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/auth-tokens-update-response' + description: Response for the request to update the token metadata. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Update Auth Token + tags: + - auth-tokens + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /chats.create: + post: + description: Creates a new chat, or optionally opens an existing one. + operationId: chats-create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/chats-create-request' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/chats-create-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Create Chat + tags: + - chats + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /chats.get: + get: + description: Gets a chat's information. + operationId: chats-get + parameters: + - description: The chat's ID. + explode: false + in: query + name: id + schema: + type: string + example: CHAN-AbCdEfGh + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/chats-get-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Chat + tags: + - chats + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: ChatsGetQuery + post: + description: Gets a chat's information. + operationId: chats-get-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/chats-get-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/chats-get-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Chat (POST) + tags: + - chats + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /chats.update: + post: + description: Updates a chat's information. + operationId: chats-update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/chats-update-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/chats-update-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Update Chat + tags: + - chats + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /code-changes.create: + post: + description: Creates a code change object. + operationId: code-changes-create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/code-changes-create-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/code-changes-create-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Create Code Change + tags: + - code-changes + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /code-changes.delete: + post: + description: Deletes a code change object. + operationId: code-changes-delete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/code-changes-delete-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/code-changes-delete-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Delete Code Change + tags: + - code-changes + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /code-changes.get: + get: + description: Gets a code change object. + operationId: code-changes-get + parameters: + - description: The code change object ID. + explode: false + in: query + name: id + required: true + schema: + type: string + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/code-changes-get-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Code Change + tags: + - code-changes + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: CodeChangesGetQuery + post: + description: Gets a code change object. + operationId: code-changes-get-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/code-changes-get-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/code-changes-get-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Code Change (POST) + tags: + - code-changes + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /code-changes.list: + get: + description: Lists code change objects. + operationId: code-changes-list + parameters: + - description: | + The cursor to resume iteration from. If not provided, then iteration + starts from the beginning. + explode: false + in: query + name: cursor + schema: + type: string + format: text + - description: | + The maximum number of code change objects to return. The default is + '50'. + explode: false + in: query + name: limit + schema: + type: integer + format: int32 + - description: | + The iteration mode to use, otherwise if not set, then "after" is + used. + explode: false + in: query + name: mode + schema: + $ref: '#/components/schemas/list-mode' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/code-changes-list-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Code Changes + tags: + - code-changes + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: CodeChangesListQuery + post: + description: Lists code change objects. + operationId: code-changes-list-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/code-changes-list-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/code-changes-list-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Code Changes (POST) + tags: + - code-changes + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /code-changes.update: + post: + description: Updates a code change object. + operationId: code-changes-update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/code-changes-update-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/code-changes-update-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Update Code Change + tags: + - code-changes + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /commands.create: + post: + description: Creates a command. + operationId: commands-create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/command-create-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/command-create-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Create Command + tags: + - commands + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /commands.get: + get: + description: Gets a command. + operationId: commands-get + parameters: + - description: The command's ID. + explode: false + in: query + name: id + required: true + schema: + type: string + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/command-get-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Command + tags: + - commands + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: CommandsGetQuery + post: + description: Gets a command. + operationId: commands-get-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/command-get-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/command-get-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Command (POST) + tags: + - commands + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /commands.list: + get: + description: Lists commands for a Dev organization. + operationId: commands-list + parameters: + - description: | + The cursor to resume iteration from. If not provided, then iteration + starts from the beginning. + explode: false + in: query + name: cursor + schema: + type: string + format: text + - description: Filtering based on executor_type. + explode: false + in: query + name: executor_type + schema: + type: array + items: + $ref: '#/components/schemas/command-action-executor-type' + - description: | + The maximum number of commands to return per page. The default is + '50'. + explode: false + in: query + name: limit + schema: + type: integer + format: int32 + - description: | + The iteration mode to use, otherwise if not set, then "after" is + used. + explode: false + in: query + name: mode + schema: + $ref: '#/components/schemas/list-mode' + - description: Filter commands based on namespace. + explode: false + in: query + name: namespace + schema: + type: array + items: + type: string + format: text + - description: | + List of fields to sort the commands items by and how to sort them. + explode: false + in: query + name: sort_by + schema: + type: array + items: + type: string + format: sort-by + - description: | + ID of the object where command is invoked (work/part/conversation). + explode: false + in: query + name: source_object_id + schema: + type: string + format: id + - description: Filter commands based on status. + explode: false + in: query + name: status + schema: + type: array + items: + $ref: '#/components/schemas/command-status' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/commands-list-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Commands + tags: + - commands + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: CommandsListQuery + post: + description: Lists commands for a Dev organization. + operationId: commands-list-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/commands-list-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/commands-list-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Commands (POST) + tags: + - commands + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /commands.update: + post: + description: Updates a command. + operationId: commands-update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/command-update-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/command-update-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Update Command + tags: + - commands + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /conversations.create: + post: + description: Creates a conversation. + operationId: conversations-create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/conversations-create-request' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/conversations-create-response' + description: The response to creating a new conversation. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Create Conversation + tags: + - conversations + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /conversations.delete: + post: + description: Deletes the requested conversation. + operationId: conversations-delete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/conversations-delete-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/conversations-delete-response' + description: The response for deleting a conversation. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Delete Conversation + tags: + - conversations + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /conversations.get: + get: + description: Gets the requested conversation's information. + operationId: conversations-get + parameters: + - description: The requested conversation's ID. + explode: false + in: query + name: id + required: true + schema: + type: string + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/conversations-get-response' + description: The response to getting a conversation's information. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Conversation + tags: + - conversations + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: ConversationsGetQuery + post: + description: Gets the requested conversation's information. + operationId: conversations-get-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/conversations-get-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/conversations-get-response' + description: The response to getting a conversation's information. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Conversation (POST) + tags: + - conversations + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /conversations.list: + get: + description: Lists the available conversations. + operationId: conversations-list + parameters: + - description: | + Filters for conversations belonging to any of the provided parts. + explode: false + in: query + name: applies_to_parts + schema: + type: array + example: + - PROD-12345 + items: + type: string + format: id + - description: | + Filters for tickets that are associated with any of the brands. + explode: false + in: query + name: brand + schema: + type: array + items: + type: string + format: id + - description: | + Filters for conversations that are associated with any of the + channels. + explode: false + in: query + name: channels + schema: + type: array + items: + type: string + format: id + - description: | + The cursor to resume iteration from. If not provided, then iteration + starts from the beginning. + explode: false + in: query + name: cursor + schema: + type: string + format: text + - description: Filters for conversation that belong to the given groups. + explode: false + in: query + name: group + schema: + type: array + items: + type: string + format: id + - description: | + Filters for conversations that are created by verified users. + explode: false + in: query + name: is_creator_verified + schema: + type: boolean + - description: Filters for conversations that are frozen. + explode: false + in: query + name: is_frozen + schema: + type: boolean + - description: Filters for conversations that are spam. + explode: false + in: query + name: is_spam + schema: + type: boolean + - description: | + The maximum number of conversations to return. The default is '50'. + explode: false + in: query + name: limit + schema: + type: integer + format: int32 + - description: | + Filters for conversations where these users are participants. + explode: false + in: query + name: members + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id + - description: | + The iteration mode to use, otherwise if not set, then "after" is + used. + explode: false + in: query + name: mode + schema: + $ref: '#/components/schemas/list-mode' + - description: | + Filters for objects created after the provided timestamp (inclusive). + explode: false + in: query + name: modified_date.after + schema: + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time + - description: | + Filters for objects created before the provided timestamp + (inclusive). + explode: false + in: query + name: modified_date.before + schema: + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time + - description: Filters for conversations owned by any of these users. + explode: false + in: query + name: owned_by + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id + - deprecated: true + description: | + Filters for conversations that are associated with any of the + provided Rev organizations. + explode: false + in: query + name: rev_org + schema: + type: array + deprecated: true + example: + - REV-AbCdEfGh + items: + type: string + format: id + - description: | + Filters for conversations that are associated with any of the + provided Rev organizations. + explode: false + in: query + name: rev_orgs + schema: + type: array + example: + - REV-AbCdEfGh + items: + type: string + format: id + - description: Filters for records with any of the provided SLA stages. + explode: false + in: query + name: sla_summary.stage + schema: + type: array + items: + $ref: '#/components/schemas/sla-summary-stage' + - description: | + Filters for conversations with any of the provided source channels. + explode: false + in: query + name: source_channel + schema: + type: array + items: + type: string + format: text + - description: | + Filters for conversations that are associated with the source + channel. + explode: false + in: query + name: source_channel_v2 + schema: + type: array + items: + type: string + format: id + - deprecated: true + description: | + Filters for conversations with any of the provided source channels. + explode: false + in: query + name: source_channels + schema: + type: array + deprecated: true + items: + type: string + format: text + - description: Filters for records in the provided stage(s) by name. + explode: false + in: query + name: stage.name + schema: + type: array + items: + type: string + format: text + - description: Filters for conversations with any of the provided states. + explode: false + in: query + name: state + schema: + type: array + items: + type: string + format: text + - deprecated: true + description: Filters for conversations with any of the provided tags. + explode: false + in: query + name: tags + schema: + type: array + deprecated: true + example: + - TAG-12345 + items: + type: string + format: id + - description: The ID of the tag. + explode: false + in: query + name: tags_v2.id + schema: + type: string + example: TAG-12345 + format: id + - description: | + The value for the object's association with the tag. If specified, + the value must be one that's specified in the tag's allowed values. + explode: false + in: query + name: tags_v2.value + schema: + type: string + format: text + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/conversations-list-response' + description: The response to listing the conversations. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Conversations + tags: + - conversations + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: ConversationsListQuery + post: + description: Lists the available conversations. + operationId: conversations-list-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/conversations-list-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/conversations-list-response' + description: The response to listing the conversations. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Conversations (POST) + tags: + - conversations + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /conversations.update: + post: + description: Updates the requested conversation. + operationId: conversations-update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/conversations-update-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/conversations-update-response' + description: The response for updating a conversation. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Update Conversation + tags: + - conversations + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /dev-orgs.auth-connections.create: + post: + description: | + Creates a new enterprise authentication connection for a Dev + organization. This authentication connection will not be enabled by + default for the organization and the user will need to explicitly + enable this. Only 5 authentication connections can be created by an + organization. + operationId: dev-org-auth-connections-create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dev-org-auth-connections-create-request' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/dev-org-auth-connections-create-response' + description: | + Response for the request to create a new enterprise authentication + connection. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Create Dev Orgs Auth Connection + tags: + - auth-connections + - dev-orgs + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /dev-orgs.auth-connections.delete: + post: + description: | + Deletes an authentication connection. Only enterprise connections which + are explicitly set up for a Dev organization can be deleted. Default + connections can not be deleted using this method. + operationId: dev-org-auth-connections-delete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dev-org-auth-connections-delete-request' + required: true + responses: + "200": + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Delete Dev Orgs Auth Connection + tags: + - auth-connections + - dev-orgs + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /dev-orgs.auth-connections.get: + get: + description: Retrieves the details for an authentication connection. + operationId: dev-org-auth-connections-get + parameters: + - description: ID of the authentication connection. + explode: false + in: query + name: id + required: true + schema: + type: string + format: text + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/dev-org-auth-connections-get-response' + description: | + Response object encapsulating the configuration details of an + authentication connection. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Dev Orgs Auth Connection + tags: + - auth-connections + - dev-orgs + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: DevOrgAuthConnectionsGetQuery + post: + description: Retrieves the details for an authentication connection. + operationId: dev-org-auth-connections-get-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dev-org-auth-connections-get-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/dev-org-auth-connections-get-response' + description: | + Response object encapsulating the configuration details of an + authentication connection. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Dev Orgs Auth Connection (POST) + tags: + - auth-connections + - dev-orgs + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /dev-orgs.auth-connections.list: + get: + description: | + Lists all the authentication connections available for a Dev + organization. This list will include both social and enterprise + connections which are either available by default or are explicitly + created by the user. + operationId: dev-org-auth-connections-list + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/dev-org-auth-connections-list-response' + description: | + Response object for the request to list all the social and enterprise + authentication connections configured for a Dev organization. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Dev Orgs Auth Connections + tags: + - auth-connections + - dev-orgs + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: DevOrgAuthConnectionsListQuery + post: + description: | + Lists all the authentication connections available for a Dev + organization. This list will include both social and enterprise + connections which are either available by default or are explicitly + created by the user. + operationId: dev-org-auth-connections-list-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/empty' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/dev-org-auth-connections-list-response' + description: | + Response object for the request to list all the social and enterprise + authentication connections configured for a Dev organization. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Dev Orgs Auth Connections (POST) + tags: + - auth-connections + - dev-orgs + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /dev-orgs.auth-connections.toggle: + post: + description: | + Enable or disable an authentication connection for a Dev organization. + Atleast one authentication connection must be enabled for a Dev + organization. + operationId: dev-org-auth-connections-toggle + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dev-org-auth-connections-toggle-request' + required: true + responses: + "200": + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Toggle Dev Orgs Auth Connections + tags: + - auth-connections + - dev-orgs + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /dev-orgs.auth-connections.update: post: + description: Updates an authentication connection. + operationId: dev-org-auth-connections-update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dev-org-auth-connections-update-request' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/dev-org-auth-connections-update-response' + description: | + Response for the request to update an enterprise authentication + connection. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Update Dev Orgs Auth Connection + tags: + - auth-connections + - dev-orgs + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /dev-orgs.get: + get: description: | - Creates an account, which is a record representing a customer or an - organization. - operationId: accounts-create + Gets the Dev organization's information of the authenticated user. + operationId: dev-orgs-get + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/dev-orgs-get-response' + description: The response to get a Dev organization's information. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Dev Org + tags: + - dev-orgs + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: DevOrgsGetQuery + post: + description: | + Gets the Dev organization's information of the authenticated user. + operationId: dev-orgs-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/accounts-create-request' + $ref: '#/components/schemas/dev-orgs-get-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/dev-orgs-get-response' + description: The response to get a Dev organization's information. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Dev Org (POST) + tags: + - dev-orgs + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /dev-users.activate: + post: + description: Activates the requested user. + operationId: dev-users-activate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dev-users-activate-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/dev-users-activate-response' + description: The response to activate the Dev user. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Activate Dev Users + tags: + - dev-users + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /dev-users.create: + post: + description: Creates a Dev user for a Dev organization. + operationId: dev-users-create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dev-users-create-request' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/accounts-create-response' - description: The response to creating a new account. + $ref: '#/components/schemas/dev-users-create-response' + description: | + Response object for request to create a new Dev user for a Dev + organization. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "409": - $ref: '#/components/responses/conflict' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Create Account + summary: Create Dev User tags: - - accounts + - dev-users x-fern-audiences: - docs - sdks - /accounts.delete: + x-fern-availability: generally-available + /dev-users.deactivate: post: - description: Deletes an account. - operationId: accounts-delete + description: Deactivates the requested user. + operationId: dev-users-deactivate requestBody: content: application/json: schema: - $ref: '#/components/schemas/accounts-delete-request' + $ref: '#/components/schemas/dev-users-deactivate-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/accounts-delete-response' - description: The response to deleting an account. + $ref: '#/components/schemas/dev-users-deactivate-response' + description: The response to deactivate the Dev user. "400": $ref: '#/components/responses/bad-request' "401": @@ -12427,208 +19625,109 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Delete Account + summary: Deactivate Dev Users tags: - - accounts + - dev-users x-fern-audiences: - docs - sdks - /accounts.export: + x-fern-availability: generally-available + /dev-users.get: get: - description: Exports a collection of accounts. - operationId: accounts-export - parameters: - - description: Filters for accounts created by the specified user(s). - explode: false - in: query - name: created_by - schema: - type: array - items: - type: string - format: id - - description: | - Filters for objects created after the provided timestamp (inclusive). - explode: false - in: query - name: created_date.after - schema: - type: string - example: "2023-01-01T12:00:00.000Z" - format: date-time - - description: | - Filters for objects created before the provided timestamp - (inclusive). - explode: false - in: query - name: created_date.before - schema: - type: string - example: "2023-01-01T12:00:00.000Z" - format: date-time - - description: Array of display names of accounts to be filtered. - explode: false - in: query - name: display_name - schema: - type: array - items: - type: string - format: text - - description: Array of references of accounts to be filtered. - explode: false - in: query - name: external_refs - schema: - type: array - items: - type: string - format: text - - description: The number of accounts to return. The default is '50'. - explode: false - in: query - name: first - schema: - type: integer - format: int32 - maximum: 500 - minimum: 1 - - description: | - Filters for objects created after the provided timestamp (inclusive). - explode: false - in: query - name: modified_date.after - schema: - type: string - example: "2023-01-01T12:00:00.000Z" - format: date-time - - description: | - Filters for objects created before the provided timestamp - (inclusive). - explode: false - in: query - name: modified_date.before - schema: - type: string - example: "2023-01-01T12:00:00.000Z" - format: date-time - - description: | - Fields to sort the accounts by and the direction to sort them in. - explode: false - in: query - name: sort_by - schema: - type: array - items: - type: string - format: sort-by - - description: Filters for accounts on specified stages. - explode: false - in: query - name: stage - schema: - type: array - items: - type: string - format: id - - description: Tier of the accounts to be filtered. - explode: false - in: query - name: tier - schema: - type: array - items: - type: string - format: text - - description: Array of websites of accounts to be filtered. + description: Gets the requested user's information. + operationId: dev-users-get + parameters: + - description: User ID of the requested Dev user. explode: false in: query - name: websites + name: id + required: true schema: - type: array - items: - type: string - format: text + type: string + format: id responses: "200": content: application/json: schema: - $ref: '#/components/schemas/accounts-export-response' - description: The response to exporting a collection of accounts. + $ref: '#/components/schemas/dev-users-get-response' + description: The response to getting the information for the Dev user. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Export Accounts + summary: Get Dev User tags: - - accounts + - dev-users x-fern-audiences: - docs - x-request-name: AccountsExportQuery + x-fern-availability: generally-available + x-request-name: DevUsersGetQuery post: - description: Exports a collection of accounts. - operationId: accounts-export-post + description: Gets the requested user's information. + operationId: dev-users-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/accounts-export-request' + $ref: '#/components/schemas/dev-users-get-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/accounts-export-response' - description: The response to exporting a collection of accounts. + $ref: '#/components/schemas/dev-users-get-response' + description: The response to getting the information for the Dev user. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Export Accounts (POST) + summary: Get Dev User (POST) tags: - - accounts + - dev-users x-fern-audiences: - docs - sdks - /accounts.get: - get: - description: Retrieves an account's information. - operationId: accounts-get - parameters: - - description: The ID of the account to be retrieved. - explode: false - in: query - name: id - required: true - schema: - type: string - example: ACC-12345 - format: id + x-fern-availability: generally-available + /dev-users.identities.link: + post: + description: Links an external/secondary identity to the Dev user. + operationId: dev-users-identities-link + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dev-users-identities-link-request' + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/accounts-get-response' - description: The returned account. + $ref: '#/components/schemas/dev-users-identities-link-response' + description: | + Response for the request to link an external identity to a Dev user. "400": $ref: '#/components/responses/bad-request' "401": @@ -12643,28 +19742,32 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Account + summary: Link Dev Users Identities tags: - - accounts + - dev-users x-fern-audiences: - docs - x-request-name: AccountsGetQuery + - sdks + x-fern-availability: generally-available + /dev-users.identities.unlink: post: - description: Retrieves an account's information. - operationId: accounts-get-post + description: Unlinks an external/secondary identity from the Dev user. + operationId: dev-users-identities-unlink requestBody: content: application/json: schema: - $ref: '#/components/schemas/accounts-get-request' + $ref: '#/components/schemas/dev-users-identities-unlink-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/accounts-get-response' - description: The returned account. + $ref: '#/components/schemas/dev-users-identities-unlink-response' + description: | + Response for the request to unlink an external identity from a Dev + user. "400": $ref: '#/components/responses/bad-request' "401": @@ -12679,45 +19782,18 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Account (POST) + summary: Unlink Dev Users Identities tags: - - accounts + - dev-users x-fern-audiences: - docs - sdks - /accounts.list: + x-fern-availability: generally-available + /dev-users.list: get: - description: Gets a list of accounts. - operationId: accounts-list + description: Lists users within your organization. + operationId: dev-users-list parameters: - - description: Filters for accounts created by the specified user(s). - explode: false - in: query - name: created_by - schema: - type: array - items: - type: string - format: id - - description: | - Filters for objects created after the provided timestamp (inclusive). - explode: false - in: query - name: created_date.after - schema: - type: string - example: "2023-01-01T12:00:00.000Z" - format: date-time - - description: | - Filters for objects created before the provided timestamp - (inclusive). - explode: false - in: query - name: created_date.before - schema: - type: string - example: "2023-01-01T12:00:00.000Z" - format: date-time - description: | The cursor to resume iteration from. If not provided, then iteration starts from the beginning. @@ -12727,27 +19803,31 @@ paths: schema: type: string format: text - - description: Array of display names of accounts to be filtered. + - description: Filters Dev users based on email addresses. explode: false in: query - name: display_name + name: email schema: type: array items: type: string format: text - - description: Array of references of accounts to be filtered. + - description: Unique ID of the user in the external source. explode: false in: query - name: external_refs + name: external_identity.id schema: - type: array - items: - type: string - format: text + type: string + format: text + - description: Issuer of the external identity of the user. + explode: false + in: query + name: external_identity.issuer + schema: + type: string + format: text - description: | - The maximum number of accounts to return per page. The default is - '50'. + The maximum number of Dev users to return. The default is '50'. explode: false in: query name: limit @@ -12763,26 +19843,7 @@ paths: schema: $ref: '#/components/schemas/list-mode' - description: | - Filters for objects created after the provided timestamp (inclusive). - explode: false - in: query - name: modified_date.after - schema: - type: string - example: "2023-01-01T12:00:00.000Z" - format: date-time - - description: | - Filters for objects created before the provided timestamp - (inclusive). - explode: false - in: query - name: modified_date.before - schema: - type: string - example: "2023-01-01T12:00:00.000Z" - format: date-time - - description: | - Fields to sort the accounts by and the direction to sort them in. + Fields to sort the Dev users by and the direction to sort them. explode: false in: query name: sort_by @@ -12791,157 +19852,364 @@ paths: items: type: string format: sort-by - - description: Filters for accounts on specified stages. - explode: false - in: query - name: stage - schema: - type: array - items: - type: string - format: id - - description: Tier of the accounts to be filtered. - explode: false - in: query - name: tier - schema: - type: array - items: - type: string - format: text - - description: Array of websites of accounts to be filtered. + - description: Filters Dev users based on state. explode: false in: query - name: websites + name: state schema: type: array items: - type: string - format: text + $ref: '#/components/schemas/user-state' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/dev-users-list-response' + description: The response to listing the Dev users. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Dev Users + tags: + - dev-users + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: DevUsersListQuery + post: + description: Lists users within your organization. + operationId: dev-users-list-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dev-users-list-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/dev-users-list-response' + description: The response to listing the Dev users. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Dev Users (POST) + tags: + - dev-users + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /dev-users.merge: + post: + description: | + Merges the identity of a secondary Dev user with the primary Dev user. + The account of the secondary Dev user will be deactivated and will no + longer be able to log into DevRev. All objects - issues, tickets, parts + etc. owned by the secondary Dev user will be transferred to the primary + Dev user. + operationId: dev-users-merge + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dev-users-merge-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/dev-users-merge-response' + description: Response object for request to merge Dev users. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Merge Dev Users + tags: + - dev-users + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /dev-users.self: + get: + description: Gets the authenticated user's information. + operationId: dev-users-self responses: "200": content: application/json: schema: - $ref: '#/components/schemas/accounts-list-response' + $ref: '#/components/schemas/dev-users-self-response' description: | - The response to listing all accounts matching the filter criteria. + The response to getting the information for the authenticated user. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Accounts + summary: Self Dev User tags: - - accounts + - dev-users x-fern-audiences: - docs - x-request-name: AccountsListQuery + x-fern-availability: generally-available + x-request-name: DevUsersSelfQuery post: - description: Gets a list of accounts. - operationId: accounts-list-post + description: Gets the authenticated user's information. + operationId: dev-users-self-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/accounts-list-request' + $ref: '#/components/schemas/dev-users-self-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/accounts-list-response' + $ref: '#/components/schemas/dev-users-self-response' description: | - The response to listing all accounts matching the filter criteria. + The response to getting the information for the authenticated user. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Accounts (POST) + summary: Self Dev User (POST) tags: - - accounts + - dev-users x-fern-audiences: - docs - sdks - /accounts.update: + x-fern-availability: generally-available + /dev-users.self.update: post: - description: Updates an account's information. - operationId: accounts-update + description: Updates the authenticated user. + operationId: dev-users-self-update requestBody: content: application/json: schema: - $ref: '#/components/schemas/accounts-update-request' + $ref: '#/components/schemas/dev-users-self-update-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/accounts-update-response' - description: Updated account object. + $ref: '#/components/schemas/dev-users-update-response' + description: The response to update a Dev user. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' - "409": - $ref: '#/components/responses/conflict' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Update Account + summary: Update Dev Users Self tags: - - accounts + - dev-users x-fern-audiences: - docs - sdks - /articles.create: + x-fern-availability: generally-available + /dev-users.update: post: - description: | - Article is an object which can contain a URL or artifacts in the - resource. It also contains the data regarding the owner, author, status - and published date of the object. This call creates an article. - operationId: create-article + description: Updates the user corresponding to the input Id. + operationId: dev-users-update requestBody: content: application/json: schema: - $ref: '#/components/schemas/articles-create-request' + $ref: '#/components/schemas/dev-users-update-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/dev-users-update-response' + description: The response to update a Dev user. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Update Dev User + tags: + - dev-users + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /directories.count: + get: + description: Get count of directories matching given filter. + operationId: directories-count + parameters: + - description: | + Filters for directories created by any of the provided users. + explode: false + in: query + name: created_by + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id + - description: | + Filters for directories modified by any of the provided users. + explode: false + in: query + name: modified_by + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/directories-count-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Count Directories + tags: + - directory + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: DirectoriesCountQuery + post: + description: Get count of directories matching given filter. + operationId: directories-count-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/directories-count-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/directories-count-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Count Directories (POST) + tags: + - directory + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /directories.create: + post: + description: Creates a directory for the specified inputs. + operationId: directories-create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/directories-create-request' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/articles-create-response' - description: Create article response. + $ref: '#/components/schemas/directories-create-response' + description: Create directory response. "400": $ref: '#/components/responses/bad-request' "401": @@ -12954,28 +20222,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Create Article + summary: Create Directory tags: - - articles + - directory x-fern-audiences: - docs - sdks - /articles.delete: + x-fern-availability: generally-available + /directories.delete: post: - description: Deletes an article. - operationId: delete-article + description: Delete the specified directory. + operationId: directories-delete requestBody: content: application/json: schema: - $ref: '#/components/schemas/articles-delete-request' + $ref: '#/components/schemas/directories-delete-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/articles-delete-response' + $ref: '#/components/schemas/directories-delete-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -12991,33 +20260,41 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Delete Article + summary: Delete Directory tags: - - articles + - directory x-fern-audiences: - docs - sdks - /articles.get: + x-fern-availability: generally-available + /directories.get: get: - description: Gets an article. - operationId: get-article + description: Gets the specified directory. + operationId: directories-get parameters: - - description: The ID of the required article. + - description: The ID of the requested directory. explode: false in: query name: id required: true schema: type: string - example: ARTICLE-12345 + format: id + - description: Optional Dev Org ID for the unauthenticated user. + explode: false + in: query + name: dev_org + schema: + type: string + example: DEV-AbCdEfGh format: id responses: "200": content: application/json: schema: - $ref: '#/components/schemas/articles-get-response' - description: Get article response. + $ref: '#/components/schemas/directories-get-response' + description: Get directory response. "400": $ref: '#/components/responses/bad-request' "401": @@ -13032,28 +20309,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Article + summary: Get Directory tags: - - articles + - directory x-fern-audiences: - docs - x-request-name: GetArticleQuery + x-fern-availability: generally-available + x-request-name: DirectoriesGetQuery post: - description: Gets an article. - operationId: get-article-post + description: Gets the specified directory. + operationId: directories-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/articles-get-request' + $ref: '#/components/schemas/directories-get-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/articles-get-response' - description: Get article response. + $ref: '#/components/schemas/directories-get-response' + description: Get directory response. "400": $ref: '#/components/responses/bad-request' "401": @@ -13068,52 +20346,20 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Article (POST) + summary: Get Directory (POST) tags: - - articles + - directory x-fern-audiences: - - docs - - sdks - /articles.list: - get: - description: Lists a collection of articles. - operationId: list-articles - parameters: - - description: | - Filters for articles belonging to any of the provided parts. - explode: false - in: query - name: applies_to_parts - schema: - type: array - example: - - PROD-12345 - items: - type: string - format: id - - description: | - Filter for the type of articles. If this is not provided, then - articles that are not content blocks are returned. - explode: false - in: query - name: article_type - schema: - type: array - items: - $ref: '#/components/schemas/article-type' - - description: | - Filters for articles authored by any of the provided users. - explode: false - in: query - name: authored_by - schema: - type: array - example: - - DEVU-12345 - items: - type: string - format: id - - description: Filters for articles created by any of the provided users. + - docs + - sdks + x-fern-availability: generally-available + /directories.list: + get: + description: Lists directories matching the request. + operationId: directories-list + parameters: + - description: | + Filters for directories created by any of the provided users. explode: false in: query name: created_by @@ -13133,8 +20379,16 @@ paths: schema: type: string format: text + - description: Optional Dev Org ID for the unauthenticated user. + explode: false + in: query + name: dev_org + schema: + type: string + example: DEV-AbCdEfGh + format: id - description: | - The maximum number of articles to return. The default is '50'. + The maximum number of directories to return. The default is '50'. explode: false in: query name: limit @@ -13150,7 +20404,7 @@ paths: schema: $ref: '#/components/schemas/list-mode' - description: | - Filters for articles modified by any of the provided users. + Filters for directories modified by any of the provided users. explode: false in: query name: modified_by @@ -13161,58 +20415,13 @@ paths: items: type: string format: id - - description: Filters for articles owned by any of the provided users. - explode: false - in: query - name: owned_by - schema: - type: array - example: - - DEVU-12345 - items: - type: string - format: id - - description: Filter for the scope of the articles. - explode: false - in: query - name: scope - schema: - type: array - items: - type: integer - format: int64 - - description: ID of the group/member with whom the item is shared. - explode: false - in: query - name: shared_with.member - schema: - type: string - format: id - - description: Role ID of the group/member with whom the item is shared. - explode: false - in: query - name: shared_with.role - schema: - type: string - format: id - - description: Filters for article with any of the provided tags. - explode: false - in: query - name: tags - schema: - type: array - example: - - TAG-12345 - items: - type: string - format: id responses: "200": content: application/json: schema: - $ref: '#/components/schemas/articles-list-response' - description: List articles response. + $ref: '#/components/schemas/directories-list-response' + description: List directory response. "400": $ref: '#/components/responses/bad-request' "401": @@ -13225,28 +20434,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Articles + summary: List Directories tags: - - articles + - directory x-fern-audiences: - docs - x-request-name: ListArticlesQuery + x-fern-availability: generally-available + x-request-name: DirectoriesListQuery post: - description: Lists a collection of articles. - operationId: list-articles-post + description: Lists directories matching the request. + operationId: directories-list-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/articles-list-request' + $ref: '#/components/schemas/directories-list-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/articles-list-response' - description: List articles response. + $ref: '#/components/schemas/directories-list-response' + description: List directory response. "400": $ref: '#/components/responses/bad-request' "401": @@ -13259,29 +20469,30 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Articles (POST) + summary: List Directories (POST) tags: - - articles + - directory x-fern-audiences: - docs - sdks - /articles.update: + x-fern-availability: generally-available + /directories.update: post: - description: Updates an article. - operationId: update-article + description: Updates the specified directory. + operationId: directories-update requestBody: content: application/json: schema: - $ref: '#/components/schemas/articles-update-request' + $ref: '#/components/schemas/directories-update-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/articles-update-response' - description: Success. + $ref: '#/components/schemas/directories-update-response' + description: Update directory response. "400": $ref: '#/components/responses/bad-request' "401": @@ -13296,151 +20507,363 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Update Article + summary: Update Directory tags: - - articles + - directory x-fern-audiences: - docs - sdks - /artifacts.get: + x-fern-availability: generally-available + /groups.create: + post: + description: Creates a new group. A group is a collection of users. + operationId: groups-create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/groups-create-request' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/groups-create-response' + description: The response to group creation. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Create Group + tags: + - groups + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /groups.get: get: - description: Gets the requested artifact's information. - operationId: artifacts-get + description: Gets the requested group. + operationId: groups-get parameters: - - description: The requested artifact's ID. + - description: The ID of the group to get. + explode: false + in: query + name: id + required: true + schema: + type: string + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/groups-get-response' + description: The response to getting the group. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Group + tags: + - groups + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: GroupsGetQuery + post: + description: Gets the requested group. + operationId: groups-get-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/groups-get-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/groups-get-response' + description: The response to getting the group. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Group (POST) + tags: + - groups + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /groups.list: + get: + description: Lists the available groups. + operationId: groups-list + parameters: + - description: Filters the groups on the basis of creator. + explode: false + in: query + name: created_by + schema: + type: array + items: + type: string + format: id + - description: | + The cursor to resume iteration from. If not provided, then iteration + starts from the beginning. + explode: false + in: query + name: cursor + schema: + type: string + format: text + - description: Filters the groups based on the group type. + explode: false + in: query + name: group_type + schema: + type: array + items: + $ref: '#/components/schemas/group-type' + - description: Filter groups by ingestion source(s). + explode: false + in: query + name: ingestion_source + schema: + type: array + items: + $ref: '#/components/schemas/group-ingestion-source' + - description: Whether to fetch default or custom groups. + explode: false + in: query + name: is_default + schema: + type: boolean + - description: | + The maximum number of groups to return. The default is '50'. + explode: false + in: query + name: limit + schema: + type: integer + format: int32 + - description: Filters the groups on basis of member type. + explode: false + in: query + name: member_type + schema: + type: array + items: + $ref: '#/components/schemas/group-member-type' + - description: | + The iteration mode to use, otherwise if not set, then "after" is + used. + explode: false + in: query + name: mode + schema: + $ref: '#/components/schemas/list-mode' + - description: Filters the groups on the basis of group name. explode: false in: query - name: id - required: true + name: name schema: - type: string - example: ARTIFACT-12345 - format: id - - description: The version of the artifact that needs to be fetched. + type: array + items: + type: string + format: text + - description: Comma-separated fields to sort the groups by. explode: false in: query - name: version + name: sort_by schema: - type: string - format: text + type: array + items: + type: string + format: sort-by + - description: Filters for issues with this specific external reference. + explode: false + in: query + name: sync_metadata.external_reference + schema: + type: array + items: + type: string + format: text + - description: Filters for works with selected sync statuses. + explode: false + in: query + name: sync_metadata.last_sync_in.status + schema: + type: array + items: + $ref: '#/components/schemas/sync-metadata-filter-sync-in-filter-status' + - description: Filters for works modified with selected sync history. + explode: false + in: query + name: sync_metadata.last_sync_in.sync_history + schema: + type: array + items: + type: string + format: id + - description: Filters for works modified with selected sync units. + explode: false + in: query + name: sync_metadata.last_sync_in.sync_unit + schema: + type: array + items: + type: string + format: id + - description: Filters for works with selected sync statuses. + explode: false + in: query + name: sync_metadata.last_sync_out.status + schema: + type: array + items: + $ref: '#/components/schemas/sync-metadata-filter-sync-out-filter-status' + - description: Filters for works modified with selected sync history. + explode: false + in: query + name: sync_metadata.last_sync_out.sync_history + schema: + type: array + items: + type: string + format: id + - description: Filters for works modified with selected sync units. + explode: false + in: query + name: sync_metadata.last_sync_out.sync_unit + schema: + type: array + items: + type: string + format: id + - description: | + Filters for issues synced from this specific origin system. + explode: false + in: query + name: sync_metadata.origin_system + schema: + type: array + items: + type: string + format: text responses: "200": content: application/json: schema: - $ref: '#/components/schemas/artifacts-get-response' - description: The response to getting an artifact's information. + $ref: '#/components/schemas/groups-list-response' + description: The response to listing the groups. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Artifact + summary: List Groups tags: - - artifacts + - groups x-fern-audiences: - docs - x-request-name: ArtifactsGetQuery + x-fern-availability: generally-available + x-request-name: GroupsListQuery post: - description: Gets the requested artifact's information. - operationId: artifacts-get-post + description: Lists the available groups. + operationId: groups-list-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/artifacts-get-request' + $ref: '#/components/schemas/groups-list-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/artifacts-get-response' - description: The response to getting an artifact's information. + $ref: '#/components/schemas/groups-list-response' + description: The response to listing the groups. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Artifact (POST) + summary: List Groups (POST) tags: - - artifacts + - groups x-fern-audiences: - docs - sdks - /artifacts.list: - get: - description: List the artifacts attached to an object. - operationId: artifacts-list - parameters: - - description: The ID of the object to filter artifacts. - explode: false - in: query - name: parent_id - schema: - type: string - format: id - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/artifacts-list-response' - description: The response to list artifacts attached to an object. - "400": - $ref: '#/components/responses/bad-request' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' - "429": - $ref: '#/components/responses/too-many-requests' - "500": - $ref: '#/components/responses/internal-server-error' - "503": - $ref: '#/components/responses/service-unavailable' - summary: List Artifacts - tags: - - artifacts - x-fern-audiences: - - docs - x-request-name: ArtifactsListQuery + x-fern-availability: generally-available + /groups.members.add: post: - description: List the artifacts attached to an object. - operationId: artifacts-list-post + description: Adds a member to a group. + operationId: group-members-add requestBody: content: application/json: schema: - $ref: '#/components/schemas/artifacts-list-request' + $ref: '#/components/schemas/group-members-add-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/artifacts-list-response' - description: The response to list artifacts attached to an object. + $ref: '#/components/schemas/group-members-add-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -13455,114 +20878,94 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Artifacts (POST) + summary: Add Groups Members tags: - - artifacts + - groups x-fern-audiences: - docs - sdks - /artifacts.locate: + x-fern-availability: generally-available + /groups.members.list: get: - description: Gets the download URL for the artifact. - operationId: artifacts-locate + description: Lists the members in a group. + operationId: group-members-list parameters: - - description: The ID of the artifact to get the URL for. + - description: ID of the group for which to list members. explode: false in: query - name: id + name: group required: true schema: type: string - example: ARTIFACT-12345 format: id - - description: The version of the artifact that needs to be fetched. + - description: | + The cursor to resume iteration from. If not provided, then iteration + starts from the beginning. explode: false in: query - name: version + name: cursor schema: type: string format: text + - description: | + The maximum number of members to return. If not set, then the default + is '50'. + explode: false + in: query + name: limit + schema: + type: integer + format: int32 + - description: | + The iteration mode to use, otherwise if not set, then "after" is + used. + explode: false + in: query + name: mode + schema: + $ref: '#/components/schemas/list-mode' responses: "200": content: application/json: schema: - $ref: '#/components/schemas/artifacts-locate-response' - description: The response to getting an artifact's download URL. - "400": - $ref: '#/components/responses/bad-request' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' - "429": - $ref: '#/components/responses/too-many-requests' - "500": - $ref: '#/components/responses/internal-server-error' - "503": - $ref: '#/components/responses/service-unavailable' - summary: Locate Artifacts - tags: - - artifacts - x-fern-audiences: - - docs - x-request-name: ArtifactsLocateQuery - post: - description: Gets the download URL for the artifact. - operationId: artifacts-locate-post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/artifacts-locate-request' - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/artifacts-locate-response' - description: The response to getting an artifact's download URL. + $ref: '#/components/schemas/group-members-list-response' + description: List of group members. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Locate Artifacts (POST) + summary: List Groups Members tags: - - artifacts + - groups x-fern-audiences: - docs - - sdks - /artifacts.prepare: + x-fern-availability: generally-available + x-request-name: GroupMembersListQuery post: - description: | - Creates an artifact and generates an upload URL for its data. - operationId: artifacts-prepare + description: Lists the members in a group. + operationId: group-members-list-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/artifacts-prepare-request' + $ref: '#/components/schemas/group-members-list-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/artifacts-prepare-response' - description: The response to preparing a URL to upload a file. + $ref: '#/components/schemas/group-members-list-response' + description: List of group members. "400": $ref: '#/components/responses/bad-request' "401": @@ -13575,28 +20978,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Prepare Artifacts + summary: List Groups Members (POST) tags: - - artifacts + - groups x-fern-audiences: - docs - sdks - /artifacts.versions.delete: + x-fern-availability: generally-available + /groups.members.remove: post: - description: Permanently deletes a version of an artifact. - operationId: artifacts-hard-delete-version + description: Removes a member from a group. + operationId: group-members-remove requestBody: content: application/json: schema: - $ref: '#/components/schemas/artifacts-hard-delete-version-request' + $ref: '#/components/schemas/group-members-remove-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/artifacts-hard-delete-version-response' + $ref: '#/components/schemas/group-members-remove-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -13604,74 +21008,82 @@ paths: $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Delete Artifacts Version + summary: Remove Groups Members tags: - - artifacts + - groups x-fern-audiences: - docs - sdks - /artifacts.versions.prepare: + x-fern-availability: generally-available + /groups.update: post: - description: | - Prepares a new version for an artifact, returning the URL and form data - to upload the updated file. - operationId: artifacts-versions-prepare + description: Updates the requested group. + operationId: groups-update requestBody: content: application/json: schema: - $ref: '#/components/schemas/artifacts-versions-prepare-request' + $ref: '#/components/schemas/groups-update-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/artifacts-versions-prepare-response' - description: The response to preparing a new artifact version. + $ref: '#/components/schemas/groups-update-response' + description: The response to group update. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Prepare Artifacts Versions + summary: Update Group tags: - - artifacts + - groups x-fern-audiences: - docs - sdks - /atoms.get: + x-fern-availability: generally-available + /keyrings.authorize: get: - description: Gets the specified object. - operationId: atoms-get + description: OAuth2 authorization callback. + operationId: keyrings-create-callback parameters: - - description: The ID of the object to get. + - description: Code to exchange for an access token. explode: false in: query - name: id + name: code required: true schema: type: string - format: id + format: text + - description: State value given to the authorization request. + explode: false + in: query + name: state + required: true + schema: + type: string + format: text responses: "200": - content: - application/json: - schema: - $ref: '#/components/schemas/atoms-get-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -13685,27 +21097,25 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Atom + security: [] + summary: Authorize Keyrings tags: - - atoms + - keyrings x-fern-audiences: - docs - x-request-name: AtomsGetQuery + x-fern-availability: generally-available + x-request-name: KeyringsCreateCallbackQuery post: - description: Gets the specified object. - operationId: atoms-get-post + description: OAuth2 authorization callback. + operationId: keyrings-create-callback-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/atoms-get-request' + $ref: '#/components/schemas/keyrings-create-callback-request' required: true responses: "200": - content: - application/json: - schema: - $ref: '#/components/schemas/atoms-get-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -13719,68 +21129,67 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Atom (POST) + summary: Authorize Keyrings (POST) tags: - - atoms + - keyrings x-fern-audiences: - docs - sdks - /auth-tokens.create: + x-fern-availability: generally-available + /links.create: post: description: | - Creates a JWT corresponding to the requested token type for the - authenticated user. - operationId: auth-tokens-create + Creates a link between two objects to indicate a relationship. + operationId: links-create requestBody: content: application/json: schema: - $ref: '#/components/schemas/auth-tokens-create-request' + $ref: '#/components/schemas/links-create-request' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/auth-tokens-create-response' - description: | - Response for the request to create a new token corresponding to the - requested token type. + $ref: '#/components/schemas/links-create-response' + description: The response to creating a new link. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "409": - $ref: '#/components/responses/conflict' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Create Auth Token + summary: Create Link tags: - - auth-tokens + - links x-fern-audiences: - docs - sdks - /auth-tokens.delete: + x-fern-availability: generally-available + /links.delete: post: - description: | - Revokes the token that matches the given token ID issued under the - given Dev organization. - operationId: auth-tokens-delete + description: Deletes a link. + operationId: links-delete requestBody: content: application/json: schema: - $ref: '#/components/schemas/auth-tokens-delete-request' + $ref: '#/components/schemas/links-delete-request' required: true responses: "200": - description: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/links-delete-response' + description: The response for deleting a link. "400": $ref: '#/components/responses/bad-request' "401": @@ -13795,24 +21204,22 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Delete Auth Token + summary: Delete Link tags: - - auth-tokens + - links x-fern-audiences: - docs - sdks - /auth-tokens.get: + x-fern-availability: generally-available + /links.get: get: - description: | - Gets the token metadata corresponding to the given token ID under the - given Dev organization. - operationId: auth-tokens-get + description: Gets the requested link's information. + operationId: links-get parameters: - - description: | - The unique identifier of the token under a given Dev organization. + - description: The requested link's ID. explode: false in: query - name: token_id + name: id required: true schema: type: string @@ -13822,8 +21229,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/auth-tokens-get-response' - description: The response to get the token metadata. + $ref: '#/components/schemas/links-get-response' + description: The response to getting a link's information. "400": $ref: '#/components/responses/bad-request' "401": @@ -13838,30 +21245,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Auth Token + summary: Get Link tags: - - auth-tokens + - links x-fern-audiences: - docs - x-request-name: AuthTokensGetQuery + x-fern-availability: generally-available + x-request-name: LinksGetQuery post: - description: | - Gets the token metadata corresponding to the given token ID under the - given Dev organization. - operationId: auth-tokens-get-post + description: Gets the requested link's information. + operationId: links-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/auth-tokens-get-request' + $ref: '#/components/schemas/links-get-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/auth-tokens-get-response' - description: The response to get the token metadata. + $ref: '#/components/schemas/links-get-response' + description: The response to getting a link's information. "400": $ref: '#/components/responses/bad-request' "401": @@ -13876,125 +21282,289 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Auth Token (POST) + summary: Get Link (POST) tags: - - auth-tokens + - links x-fern-audiences: - docs - sdks - /auth-tokens.list: + x-fern-availability: generally-available + /links.list: get: - description: | - Gets the token metadata for all the tokens corresponding to the given - token type issued for a given subject. - operationId: auth-tokens-list + description: Lists the available links. + operationId: links-list parameters: + - description: The ID of the object to list the links for. + explode: false + in: query + name: object + required: true + schema: + type: string + format: id - description: | - An identifier that represents the application, which requested the - token. Only relevant for application access tokens. + The cursor to resume iteration from. If not provided, then iteration + starts from the beginning. explode: false in: query - name: client_id + name: cursor schema: type: string format: text - description: | - The type of the requested token. If no value is specified, the - response will include tokens of all the types. + The direction of the links to list, otherwise if not present, then + links in both directions (source and target) are included. explode: false in: query - name: requested_token_type + name: direction schema: - $ref: '#/components/schemas/auth-token-requested-token-type' + $ref: '#/components/schemas/links-direction' - description: | - The subject associated with the token. In the absence of this - parameter, the ID of the authenticated entity is treated as the - subject. + The maximum number of links to return. If not set, then the default + is '50'. explode: false in: query - name: subject + name: limit schema: - type: string - format: id + type: integer + format: int32 + - description: | + The link type(s) to filter for, otherwise if not present, all link + types are included. + explode: false + in: query + name: link_type + schema: + type: array + items: + $ref: '#/components/schemas/link-type' + - description: | + The iteration mode to use, otherwise if not set, then "after" is + used. + explode: false + in: query + name: mode + schema: + $ref: '#/components/schemas/list-mode' + - description: | + The object types to filter for, otherwise if not present, all object + types are included. + explode: false + in: query + name: object_types + schema: + type: array + items: + $ref: '#/components/schemas/link-endpoint-type' + - deprecated: true + description: | + The link types to filter for, otherwise if not present, all link + types are included. + explode: false + in: query + name: types + schema: + type: array + deprecated: true + items: + $ref: '#/components/schemas/link-type' responses: "200": content: application/json: schema: - $ref: '#/components/schemas/auth-tokens-list-response' - description: The response to list the token metadata. + $ref: '#/components/schemas/links-list-response' + description: The response to listing the links. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Auth Tokens + summary: List Links tags: - - auth-tokens + - links x-fern-audiences: - docs - x-request-name: AuthTokensListQuery + x-fern-availability: generally-available + x-request-name: LinksListQuery post: - description: | - Gets the token metadata for all the tokens corresponding to the given - token type issued for a given subject. - operationId: auth-tokens-list-post + description: Lists the available links. + operationId: links-list-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/auth-tokens-list-request' + $ref: '#/components/schemas/links-list-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/auth-tokens-list-response' - description: The response to list the token metadata. + $ref: '#/components/schemas/links-list-response' + description: The response to listing the links. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Auth Tokens (POST) + summary: List Links (POST) tags: - - auth-tokens + - links x-fern-audiences: - docs - sdks - /auth-tokens.self.delete: + x-fern-availability: generally-available + /links.replace: post: - description: | - Revokes all the tokens that matches the given token type created by the - authenticated user. - operationId: auth-tokens-self-delete + description: Replaces a link. + operationId: links-replace requestBody: content: application/json: schema: - $ref: '#/components/schemas/auth-tokens-self-delete-request' + $ref: '#/components/schemas/links-replace-request' required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/links-replace-response' + description: The response to replacing a link. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Replace Links + tags: + - links + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /meetings.count: + get: + description: Counts the meeting records. + operationId: meetings-count + parameters: + - description: Filters for meeting on specified channels. + explode: false + in: query + name: channel + schema: + type: array + items: + $ref: '#/components/schemas/meeting-channel' + - description: Filters for meetings created by the specified user(s). + explode: false + in: query + name: created_by + schema: + type: array + items: + type: string + format: id + - description: Filters for meetings with the provided external_ref(s). + explode: false + in: query + name: external_ref + schema: + type: array + items: + type: string + format: text + - description: | + Filters for link type in links associated with the meeting. + explode: false + in: query + name: links.link_type + schema: + type: string + format: text + - description: | + Filters for target id in links associated with the meeting. + explode: false + in: query + name: links.target + schema: + type: string + format: id + - description: | + Filters for target object type in links associated with the meeting. + explode: false + in: query + name: links.target_object_type + schema: + type: string + format: text + - description: Filter for meeting on specified Member Ids. + explode: false + in: query + name: members + schema: + type: array + items: + type: string + format: id + - description: Filter for meeting on specified organizers. + explode: false + in: query + name: organizer + schema: + type: array + items: + type: string + format: id + - deprecated: true + description: Filters for meetings with the provided parent. + explode: false + in: query + name: parent + schema: + type: array + deprecated: true + example: + - ACC-12345 + items: + type: string + format: id + - description: Filters for meeting on specified state or outcomes. + explode: false + in: query + name: state + schema: + type: array + items: + $ref: '#/components/schemas/meeting-state' responses: "200": + content: + application/json: + schema: + $ref: '#/components/schemas/meetings-count-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -14002,76 +21572,71 @@ paths: $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Delete Auth Tokens Self + summary: Count Meetings tags: - - auth-tokens + - meetings x-fern-audiences: - docs - - sdks - /auth-tokens.update: + x-fern-availability: generally-available + x-request-name: MeetingsCountQuery post: - description: | - Updates token metadata of a token issued under a given Dev - organization. - operationId: auth-tokens-update + description: Counts the meeting records. + operationId: meetings-count-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/auth-tokens-update-request' + $ref: '#/components/schemas/meetings-count-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/auth-tokens-update-response' - description: Response for the request to update the token metadata. + $ref: '#/components/schemas/meetings-count-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Update Auth Token + summary: Count Meetings (POST) tags: - - auth-tokens + - meetings x-fern-audiences: - docs - sdks - /conversations.create: + x-fern-availability: generally-available + /meetings.create: post: - description: Creates a conversation. - operationId: conversations-create + description: Creates a new meeting record. + operationId: meetings-create requestBody: content: application/json: schema: - $ref: '#/components/schemas/conversations-create-request' + $ref: '#/components/schemas/meetings-create-request' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/conversations-create-response' - description: The response to creating a new conversation. + $ref: '#/components/schemas/meetings-create-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -14084,29 +21649,30 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Create Conversation + summary: Create Meeting tags: - - conversations + - meetings x-fern-audiences: - docs - sdks - /conversations.delete: + x-fern-availability: generally-available + /meetings.delete: post: - description: Deletes the requested conversation. - operationId: conversations-delete + description: Deletes the meeting record. + operationId: meetings-delete requestBody: content: application/json: schema: - $ref: '#/components/schemas/conversations-delete-request' + $ref: '#/components/schemas/meetings-delete-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/conversations-delete-response' - description: The response for deleting a conversation. + $ref: '#/components/schemas/meetings-delete-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -14121,18 +21687,19 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Delete Conversation + summary: Delete Meeting tags: - - conversations + - meetings x-fern-audiences: - docs - sdks - /conversations.get: + x-fern-availability: generally-available + /meetings.get: get: - description: Gets the requested conversation's information. - operationId: conversations-get + description: Gets the meeting record. + operationId: meetings-get parameters: - - description: The requested conversation's ID. + - description: The meeting's ID. explode: false in: query name: id @@ -14145,8 +21712,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/conversations-get-response' - description: The response to getting a conversation's information. + $ref: '#/components/schemas/meetings-get-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -14161,28 +21728,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Conversation + summary: Get Meeting tags: - - conversations + - meetings x-fern-audiences: - docs - x-request-name: ConversationsGetQuery + x-fern-availability: generally-available + x-request-name: MeetingsGetQuery post: - description: Gets the requested conversation's information. - operationId: conversations-get-post + description: Gets the meeting record. + operationId: meetings-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/conversations-get-request' + $ref: '#/components/schemas/meetings-get-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/conversations-get-response' - description: The response to getting a conversation's information. + $ref: '#/components/schemas/meetings-get-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -14197,35 +21765,30 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Conversation (POST) + summary: Get Meeting (POST) tags: - - conversations + - meetings x-fern-audiences: - docs - sdks - /conversations.list: + x-fern-availability: generally-available + /meetings.list: get: - description: Lists the available conversations. - operationId: conversations-list + description: Lists the meeting records. + operationId: meetings-list parameters: - - description: | - Filters for conversations belonging to any of the provided parts. + - description: Filters for meeting on specified channels. explode: false in: query - name: applies_to_parts + name: channel schema: type: array - example: - - PROD-12345 items: - type: string - format: id - - description: | - Filters for conversations that are associated with any of the - channels. + $ref: '#/components/schemas/meeting-channel' + - description: Filters for meetings created by the specified user(s). explode: false in: query - name: channels + name: created_by schema: type: array items: @@ -14235,207 +21798,347 @@ paths: The cursor to resume iteration from. If not provided, then iteration starts from the beginning. explode: false - in: query - name: cursor - schema: - type: string - format: text - - description: Filters for conversation that belong to the given groups. - explode: false - in: query - name: group - schema: - type: array - items: - type: string - format: id - - description: | - Filters for conversations that are created by verified users. - explode: false - in: query - name: is_creator_verified - schema: - type: boolean - - description: Filters for conversations that are frozen. - explode: false - in: query - name: is_frozen - schema: - type: boolean - - description: Filters for conversations that are spam. - explode: false - in: query - name: is_spam - schema: - type: boolean - - description: | - The maximum number of conversations to return. The default is '50'. - explode: false - in: query - name: limit - schema: - type: integer - format: int32 - - description: | - Filters for conversations where these users are participants. + in: query + name: cursor + schema: + type: string + format: text + - description: Filters for meetings with the provided external_ref(s). explode: false in: query - name: members + name: external_ref schema: type: array - example: - - DEVU-12345 items: type: string - format: id - - description: | - The iteration mode to use, otherwise if not set, then "after" is - used. + format: text + - description: The maximum number of meetings to return. explode: false in: query - name: mode + name: limit schema: - $ref: '#/components/schemas/list-mode' + type: integer + format: int32 - description: | - Filters for objects created after the provided timestamp (inclusive). + Filters for link type in links associated with the meeting. explode: false in: query - name: modified_date.after + name: links.link_type schema: type: string - example: "2023-01-01T12:00:00.000Z" - format: date-time + format: text - description: | - Filters for objects created before the provided timestamp - (inclusive). + Filters for target id in links associated with the meeting. explode: false in: query - name: modified_date.before + name: links.target schema: type: string - example: "2023-01-01T12:00:00.000Z" - format: date-time - - description: Filters for conversations owned by any of these users. - explode: false - in: query - name: owned_by - schema: - type: array - example: - - DEVU-12345 - items: - type: string - format: id + format: id - description: | - Filters for conversations that are associated with any of the - provided Rev organizations. + Filters for target object type in links associated with the meeting. explode: false in: query - name: rev_org + name: links.target_object_type schema: - type: array - deprecated: true - example: - - REV-AbCdEfGh - items: - type: string - format: id - - description: | - Filters for conversations that are associated with any of the - provided Rev organizations. + type: string + format: text + - description: Filter for meeting on specified Member Ids. explode: false in: query - name: rev_orgs + name: members schema: type: array - example: - - REV-AbCdEfGh items: type: string format: id - - description: Filters for records with any of the provided SLA stages. + - description: | + The iteration mode to use, otherwise if not set, then "after" is + used. explode: false in: query - name: sla_summary.stage + name: mode schema: - type: array - items: - $ref: '#/components/schemas/sla-summary-stage' - - description: | - Filters for conversations with any of the provided source channels. + $ref: '#/components/schemas/list-mode' + - description: Filter for meeting on specified organizers. explode: false in: query - name: source_channel + name: organizer schema: type: array items: type: string - format: text - - description: | - Filters for conversations with any of the provided source channels. + format: id + - deprecated: true + description: Filters for meetings with the provided parent. explode: false in: query - name: source_channels + name: parent schema: type: array deprecated: true + example: + - ACC-12345 items: type: string - format: text - - description: Filters for records in the provided stage(s) by name. + format: id + - description: | + Fields to sort the meetings by and the direction to sort them. explode: false in: query - name: stage.name + name: sort_by schema: type: array items: type: string - format: text - - description: Filters for conversations with any of the provided states. + format: sort-by + - description: Filters for meeting on specified state or outcomes. explode: false in: query name: state schema: type: array items: - type: string - format: text - - description: Filters for conversations with any of the provided tags. - explode: false - in: query - name: tags - schema: - type: array - deprecated: true - example: - - TAG-12345 - items: - type: string - format: id - - description: The ID of the tag. + $ref: '#/components/schemas/meeting-state' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/meetings-list-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Meetings + tags: + - meetings + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: MeetingsListQuery + post: + description: Lists the meeting records. + operationId: meetings-list-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/meetings-list-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/meetings-list-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Meetings (POST) + tags: + - meetings + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /meetings.update: + post: + description: Updates the meeting record. + operationId: meetings-update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/meetings-update-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/meetings-update-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Update Meeting + tags: + - meetings + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /metric-action.execute: + post: + description: Executes the metric action on the given object. + operationId: metric-action-execute + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/metric-action-execute-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/metric-action-execute-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Execute Metric Action + tags: + - slas + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /metric-definitions.create: + post: + description: Creates a custom metric definition + operationId: metric-definitions-create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/metric-definitions-create-request' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/metric-definitions-create-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Create Metric Definition + tags: + - slas + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /metric-definitions.delete: + post: + description: Deletes a custom metric definition + operationId: metric-definitions-delete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/metric-definitions-delete-request' + required: true + responses: + "204": + content: + application/json: + schema: + $ref: '#/components/schemas/metric-definitions-delete-response' + description: The response to deleting a metric definition. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Delete Metric Definition + tags: + - slas + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /metric-definitions.get: + get: + description: Gets a custom metric definition + operationId: metric-definitions-get + parameters: + - description: The ID of the metric definition to get. explode: false in: query - name: tags_v2.id + name: id schema: type: string - example: TAG-12345 format: id - - description: | - The value for the object's association with the tag. If specified, - the value must be one that's specified in the tag's allowed values. + - description: The unique human readable name of the metric. explode: false in: query - name: tags_v2.value + name: name schema: type: string format: text + maxLength: 64 + minLength: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/conversations-list-response' - description: The response to listing the conversations. + $ref: '#/components/schemas/metric-definitions-get-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -14448,28 +22151,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Conversations + summary: Get Metric Definition tags: - - conversations + - slas x-fern-audiences: - docs - x-request-name: ConversationsListQuery + x-fern-availability: generally-available + x-request-name: MetricDefinitionsGetQuery post: - description: Lists the available conversations. - operationId: conversations-list-post + description: Gets a custom metric definition + operationId: metric-definitions-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/conversations-list-request' + $ref: '#/components/schemas/metric-definitions-get-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/conversations-list-response' - description: The response to listing the conversations. + $ref: '#/components/schemas/metric-definitions-get-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -14482,73 +22186,127 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Conversations (POST) + summary: Get Metric Definition (POST) tags: - - conversations + - slas x-fern-audiences: - docs - sdks - /conversations.update: - post: - description: Updates the requested conversation. - operationId: conversations-update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/conversations-update-request' - required: true + x-fern-availability: generally-available + /metric-definitions.list: + get: + description: Lists metric definitions matching a filter. + operationId: metric-definitions-list + parameters: + - description: The type of objects the metric definition applies to. + explode: false + in: query + name: applies_to_type + schema: + type: array + items: + $ref: '#/components/schemas/metric-definition-applies-to' + - description: | + The cursor to resume iteration from. If not provided, then iteration + starts from the beginning. + explode: false + in: query + name: cursor + schema: + type: string + format: text + - description: | + Whether to include custom metrics in the response. If not set, then + custom metrics are excluded. + explode: false + in: query + name: include_custom_metrics + schema: + type: boolean + - description: | + The maximum number of records to return. The default is '50'. + explode: false + in: query + name: limit + schema: + type: integer + format: int32 + - description: | + The iteration mode to use, otherwise if not set, then "after" is + used. + explode: false + in: query + name: mode + schema: + $ref: '#/components/schemas/list-mode' + - description: | + Fields to sort the records by and the direction to sort them. + explode: false + in: query + name: sort_by + schema: + type: array + items: + type: string + format: sort-by + - description: The status of the metric definition. + explode: false + in: query + name: status + schema: + type: array + items: + $ref: '#/components/schemas/metric-definition-status' + - description: The type of metric definitions sought. + explode: false + in: query + name: type + schema: + type: array + items: + $ref: '#/components/schemas/metric-definition-metric-type' responses: "200": content: application/json: schema: - $ref: '#/components/schemas/conversations-update-response' - description: The response for updating a conversation. + $ref: '#/components/schemas/metric-definitions-list-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Update Conversation + summary: List Metric Definitions tags: - - conversations + - slas x-fern-audiences: - docs - - sdks - /dev-orgs.auth-connections.create: + x-fern-availability: generally-available + x-request-name: MetricDefinitionsListQuery post: - description: | - Creates a new enterprise authentication connection for a Dev - organization. This authentication connection will not be enabled by - default for the organization and the user will need to explicitly - enable this. Only 5 authentication connections can be created by an - organization. - operationId: dev-org-auth-connections-create + description: Lists metric definitions matching a filter. + operationId: metric-definitions-list-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/dev-org-auth-connections-create-request' + $ref: '#/components/schemas/metric-definitions-list-request' required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/dev-org-auth-connections-create-response' - description: | - Response for the request to create a new enterprise authentication - connection. + $ref: '#/components/schemas/metric-definitions-list-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -14561,28 +22319,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Create Dev Orgs Auth Connection + summary: List Metric Definitions (POST) tags: - - auth-connections - - dev-orgs + - slas x-fern-audiences: - docs - sdks - /dev-orgs.auth-connections.delete: + x-fern-availability: generally-available + /metric-definitions.update: post: - description: | - Deletes an authentication connection. Only enterprise connections which - are explicitly set up for a Dev organization can be deleted. Default - connections can not be deleted using this method. - operationId: dev-org-auth-connections-delete + description: Updates a custom metric definition + operationId: metric-definitions-update requestBody: content: application/json: schema: - $ref: '#/components/schemas/dev-org-auth-connections-delete-request' + $ref: '#/components/schemas/metric-definitions-update-request' required: true responses: "200": + content: + application/json: + schema: + $ref: '#/components/schemas/metric-definitions-update-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -14598,35 +22357,42 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Delete Dev Orgs Auth Connection + summary: Update Metric Definition tags: - - auth-connections - - dev-orgs + - slas x-fern-audiences: - docs - sdks - /dev-orgs.auth-connections.get: + x-fern-availability: generally-available + /metric-trackers.get: get: - description: Retrieves the details for an authentication connection. - operationId: dev-org-auth-connections-get + description: Gets a metric tracker. + operationId: metric-trackers-get parameters: - - description: ID of the authentication connection. + - description: The ID of the metric that is being tracked. explode: false in: query - name: id + name: metric required: true schema: type: string - format: text + format: id + - description: | + The ID of the underlying object on which the metric is being tracked. + explode: false + in: query + name: object + required: true + schema: + type: string + format: id responses: "200": content: application/json: schema: - $ref: '#/components/schemas/dev-org-auth-connections-get-response' - description: | - Response object encapsulating the configuration details of an - authentication connection. + $ref: '#/components/schemas/metric-trackers-get-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -14641,110 +22407,67 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Dev Orgs Auth Connection + summary: Get Metric Tracker tags: - - auth-connections - - dev-orgs + - slas x-fern-audiences: - docs - x-request-name: DevOrgAuthConnectionsGetQuery + x-fern-availability: generally-available + x-request-name: MetricTrackersGetQuery post: - description: Retrieves the details for an authentication connection. - operationId: dev-org-auth-connections-get-post + description: Gets a metric tracker. + operationId: metric-trackers-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/dev-org-auth-connections-get-request' + $ref: '#/components/schemas/metric-trackers-get-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/dev-org-auth-connections-get-response' - description: | - Response object encapsulating the configuration details of an - authentication connection. - "400": - $ref: '#/components/responses/bad-request' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' - "429": - $ref: '#/components/responses/too-many-requests' - "500": - $ref: '#/components/responses/internal-server-error' - "503": - $ref: '#/components/responses/service-unavailable' - summary: Get Dev Orgs Auth Connection (POST) - tags: - - auth-connections - - dev-orgs - x-fern-audiences: - - docs - - sdks - /dev-orgs.auth-connections.list: - get: - description: | - Lists all the authentication connections available for a Dev - organization. This list will include both social and enterprise - connections which are either available by default or are explicitly - created by the user. - operationId: dev-org-auth-connections-list - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/dev-org-auth-connections-list-response' - description: | - Response object for the request to list all the social and enterprise - authentication connections configured for a Dev organization. + $ref: '#/components/schemas/metric-trackers-get-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Dev Orgs Auth Connections + summary: Get Metric Tracker (POST) tags: - - auth-connections - - dev-orgs + - slas x-fern-audiences: - docs - x-request-name: DevOrgAuthConnectionsListQuery + - sdks + x-fern-availability: generally-available + /org-schedule-fragments.create: post: - description: | - Lists all the authentication connections available for a Dev - organization. This list will include both social and enterprise - connections which are either available by default or are explicitly - created by the user. - operationId: dev-org-auth-connections-list-post + description: Creates an organization schedule fragment. + operationId: org-schedule-fragments-create requestBody: content: application/json: schema: - $ref: '#/components/schemas/empty' + $ref: '#/components/schemas/org-schedule-fragments-create-request' required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/dev-org-auth-connections-list-response' - description: | - Response object for the request to list all the social and enterprise - authentication connections configured for a Dev organization. + $ref: '#/components/schemas/org-schedule-fragments-create-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -14757,28 +22480,32 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Dev Orgs Auth Connections (POST) + summary: Create Org Schedule Fragment tags: - - auth-connections - - dev-orgs + - schedules x-fern-audiences: - docs - sdks - /dev-orgs.auth-connections.toggle: - post: - description: | - Enable or disable an authentication connection for a Dev organization. - Atleast one authentication connection must be enabled for a Dev - organization. - operationId: dev-org-auth-connections-toggle - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/dev-org-auth-connections-toggle-request' - required: true + x-fern-availability: generally-available + /org-schedule-fragments.get: + get: + description: Gets an organization schedule fragment. + operationId: org-schedule-fragments-get + parameters: + - description: Organization schedule Fragment ID. + explode: false + in: query + name: id + required: true + schema: + type: string + format: id responses: "200": + content: + application/json: + schema: + $ref: '#/components/schemas/org-schedule-fragments-get-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -14786,215 +22513,161 @@ paths: $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Toggle Dev Orgs Auth Connections + summary: Get Org Schedule Fragment tags: - - auth-connections - - dev-orgs + - schedules x-fern-audiences: - docs - - sdks - /dev-orgs.auth-connections.update: + x-fern-availability: generally-available + x-request-name: OrgScheduleFragmentsGetQuery post: - description: Updates an authentication connection. - operationId: dev-org-auth-connections-update + description: Gets an organization schedule fragment. + operationId: org-schedule-fragments-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/dev-org-auth-connections-update-request' + $ref: '#/components/schemas/org-schedule-fragments-get-request' required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/dev-org-auth-connections-update-response' - description: | - Response for the request to update an enterprise authentication - connection. + $ref: '#/components/schemas/org-schedule-fragments-get-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Update Dev Orgs Auth Connection + summary: Get Org Schedule Fragment (POST) tags: - - auth-connections - - dev-orgs + - schedules x-fern-audiences: - docs - sdks - /dev-users.get: - get: - description: Gets the requested user's information. - operationId: dev-users-get - parameters: - - description: User ID of the requested Dev user. - explode: false - in: query - name: id - required: true - schema: - type: string - format: id + x-fern-availability: generally-available + /org-schedule-fragments.transition: + post: + description: Changes stage of an organization schedule fragment. + operationId: org-schedule-fragments-transition + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/org-schedule-fragments-transition-request' + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/dev-users-get-response' - description: The response to getting the information for the Dev user. + $ref: '#/components/schemas/org-schedule-fragments-transition-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Dev User + summary: Transition Org Schedule Fragments tags: - - dev-users + - schedules x-fern-audiences: - docs - x-request-name: DevUsersGetQuery + - sdks + x-fern-availability: generally-available + /org-schedules.create: post: - description: Gets the requested user's information. - operationId: dev-users-get-post + description: | + Creates an organization schedule with a default weekly organization + schedule and a list of organization schedule fragments. + operationId: org-schedules-create requestBody: content: application/json: schema: - $ref: '#/components/schemas/dev-users-get-request' + $ref: '#/components/schemas/org-schedules-create-request' required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/dev-users-get-response' - description: The response to getting the information for the Dev user. + $ref: '#/components/schemas/org-schedules-create-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Dev User (POST) + summary: Create Org Schedule tags: - - dev-users + - schedules x-fern-audiences: - docs - sdks - /dev-users.list: + x-fern-availability: generally-available + /org-schedules.evaluate: get: - description: Lists users within your organization. - operationId: dev-users-list + description: Evaluates an organization's schedule at specified instants. + operationId: org-schedules-evaluate parameters: - - description: | - The cursor to resume iteration from. If not provided, then iteration - starts from the beginning. - explode: false - in: query - name: cursor - schema: - type: string - format: text - - description: Filters Dev users based on email addresses. - explode: false - in: query - name: email - schema: - type: array - items: - type: string - format: text - - description: Unique ID of the user in the external source. - explode: false - in: query - name: external_identity.id - schema: - type: string - format: text - - description: Issuer of the external identity of the user. + - description: Organization schedule ID. explode: false in: query - name: external_identity.issuer + name: id + required: true schema: type: string - format: text - - description: | - The maximum number of Dev users to return. The default is '50'. - explode: false - in: query - name: limit - schema: - type: integer - format: int32 - - description: | - The iteration mode to use, otherwise if not set, then "after" is - used. - explode: false - in: query - name: mode - schema: - $ref: '#/components/schemas/list-mode' - - description: | - Fields to sort the Dev users by and the direction to sort them. + format: id + - description: Time instants to evaluate the organization schedule for. explode: false in: query - name: sort_by + name: instants + required: true schema: type: array + example: + - "2023-01-01T12:00:00.000Z" items: type: string - format: sort-by - - description: Filters Dev users based on state. - explode: false - in: query - name: state - schema: - type: array - items: - $ref: '#/components/schemas/user-state' + format: date-time + minItems: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/dev-users-list-response' - description: The response to listing the Dev users. + $ref: '#/components/schemas/org-schedules-evaluate-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -15007,28 +22680,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Dev Users + summary: Evaluate Org Schedules tags: - - dev-users + - schedules x-fern-audiences: - docs - x-request-name: DevUsersListQuery + x-fern-availability: generally-available + x-request-name: OrgSchedulesEvaluateQuery post: - description: Lists users within your organization. - operationId: dev-users-list-post + description: Evaluates an organization's schedule at specified instants. + operationId: org-schedules-evaluate-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/dev-users-list-request' + $ref: '#/components/schemas/org-schedules-evaluate-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/dev-users-list-response' - description: The response to listing the Dev users. + $ref: '#/components/schemas/org-schedules-evaluate-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -15041,24 +22715,33 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Dev Users (POST) + summary: Evaluate Org Schedules (POST) tags: - - dev-users + - schedules x-fern-audiences: - docs - sdks - /dev-users.self: + x-fern-availability: generally-available + /org-schedules.get: get: - description: Gets the authenticated user's information. - operationId: dev-users-self + description: Gets an organization schedule. + operationId: org-schedules-get + parameters: + - description: Organization schedule ID. + explode: false + in: query + name: id + required: true + schema: + type: string + format: id responses: "200": content: application/json: schema: - $ref: '#/components/schemas/dev-users-self-response' - description: | - The response to getting the information for the authenticated user. + $ref: '#/components/schemas/org-schedules-get-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -15071,29 +22754,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Self Dev User + summary: Get Org Schedule tags: - - dev-users + - schedules x-fern-audiences: - docs - x-request-name: DevUsersSelfQuery + x-fern-availability: generally-available + x-request-name: OrgSchedulesGetQuery post: - description: Gets the authenticated user's information. - operationId: dev-users-self-post + description: Gets an organization schedule. + operationId: org-schedules-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/dev-users-self-request' + $ref: '#/components/schemas/org-schedules-get-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/dev-users-self-response' - description: | - The response to getting the information for the authenticated user. + $ref: '#/components/schemas/org-schedules-get-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -15106,29 +22789,68 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Self Dev User (POST) + summary: Get Org Schedule (POST) tags: - - dev-users + - schedules x-fern-audiences: - docs - sdks - /dev-users.self.update: - post: - description: Updates the authenticated user. - operationId: dev-users-self-update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/dev-users-self-update-request' - required: true + x-fern-availability: generally-available + /org-schedules.list: + get: + description: Gets list of organization schedules. + operationId: org-schedules-list + parameters: + - description: Creator ID the filter matches. + explode: false + in: query + name: created_by_id + schema: + type: array + items: + type: string + format: id + - description: | + The cursor to resume iteration from. If not provided, then iteration + starts from the beginning. + explode: false + in: query + name: cursor + schema: + type: string + format: text + - description: | + Max number of organization schedules returned in a page. Default is + 50. + explode: false + in: query + name: limit + schema: + type: integer + format: int32 + - description: | + The iteration mode to use, otherwise if not set, then "after" is + used. + explode: false + in: query + name: mode + schema: + $ref: '#/components/schemas/list-mode' + - description: The organization schedule statuses the filter matches. + explode: false + in: query + name: status + schema: + type: array + items: + $ref: '#/components/schemas/org-schedule-status' responses: "200": content: application/json: schema: - $ref: '#/components/schemas/dev-users-update-response' - description: The response to update a Dev user. + $ref: '#/components/schemas/org-schedules-list-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -15141,29 +22863,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Update Dev Users Self + summary: List Org Schedules tags: - - dev-users + - schedules x-fern-audiences: - docs - - sdks - /dev-users.update: + x-fern-availability: generally-available + x-request-name: OrgSchedulesListQuery post: - description: Updates the user corresponding to the input Id. - operationId: dev-users-update + description: Gets list of organization schedules. + operationId: org-schedules-list-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/dev-users-update-request' + $ref: '#/components/schemas/org-schedules-list-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/dev-users-update-response' - description: The response to update a Dev user. + $ref: '#/components/schemas/org-schedules-list-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -15176,29 +22898,32 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Update Dev User + summary: List Org Schedules (POST) tags: - - dev-users + - schedules x-fern-audiences: - docs - sdks - /groups.create: + x-fern-availability: generally-available + /org-schedules.set-future: post: - description: Creates a new group. A group is a collection of users. - operationId: groups-create + description: | + Sets next organization schedule fragment which must begin the day the + last existing fragment ends. + operationId: org-schedules-set-future requestBody: content: application/json: schema: - $ref: '#/components/schemas/groups-create-request' + $ref: '#/components/schemas/org-schedules-set-future-request' required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/groups-create-response' - description: The response to group creation. + $ref: '#/components/schemas/org-schedules-set-future-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -15211,68 +22936,66 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Create Group + summary: Set-Future Org Schedules tags: - - groups + - schedules x-fern-audiences: - docs - sdks - /groups.get: - get: - description: Gets the requested group. - operationId: groups-get - parameters: - - description: The ID of the group to get. - explode: false - in: query - name: id - required: true - schema: - type: string - format: id + x-fern-availability: generally-available + /org-schedules.transition: + post: + description: Publishes or archives an organization schedule. + operationId: org-schedules-transition + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/org-schedules-transition-request' + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/groups-get-response' - description: The response to getting the group. + $ref: '#/components/schemas/org-schedules-transition-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Group + summary: Transition Org Schedules tags: - - groups + - schedules x-fern-audiences: - docs - x-request-name: GroupsGetQuery + - sdks + x-fern-availability: generally-available + /org-schedules.update: post: - description: Gets the requested group. - operationId: groups-get-post + description: Updates an organization schedule. + operationId: org-schedules-update requestBody: content: application/json: schema: - $ref: '#/components/schemas/groups-get-request' + $ref: '#/components/schemas/org-schedules-update-request' required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/groups-get-response' - description: The response to getting the group. + $ref: '#/components/schemas/org-schedules-update-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -15287,177 +23010,30 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Group (POST) + summary: Update Org Schedule tags: - - groups + - schedules x-fern-audiences: - docs - sdks - /groups.list: - get: - description: Lists the available groups. - operationId: groups-list - parameters: - - description: Filters the groups on the basis of creator. - explode: false - in: query - name: created_by - schema: - type: array - items: - type: string - format: id - - description: | - The cursor to resume iteration from. If not provided, then iteration - starts from the beginning. - explode: false - in: query - name: cursor - schema: - type: string - format: text - - description: Filters the groups based on the group type. - explode: false - in: query - name: group_type - schema: - type: array - items: - $ref: '#/components/schemas/group-type' - - description: Filter groups by ingestion source(s). - explode: false - in: query - name: ingestion_source - schema: - type: array - items: - $ref: '#/components/schemas/group-ingestion-source' - - description: Whether to fetch default or custom groups. - explode: false - in: query - name: is_default - schema: - type: boolean - - description: | - The maximum number of groups to return. The default is '50'. - explode: false - in: query - name: limit - schema: - type: integer - format: int32 - - description: Filters the groups on basis of member type. - explode: false - in: query - name: member_type - schema: - type: array - items: - $ref: '#/components/schemas/group-member-type' - - description: | - The iteration mode to use, otherwise if not set, then "after" is - used. - explode: false - in: query - name: mode - schema: - $ref: '#/components/schemas/list-mode' - - description: Filters the groups on the basis of group name. - explode: false - in: query - name: name - schema: - type: array - items: - type: string - format: text - - description: Comma-separated fields to sort the groups by. - explode: false - in: query - name: sort_by - schema: - type: array - items: - type: string - format: sort-by - - description: Filters for issues with this specific external reference. - explode: false - in: query - name: sync_metadata.external_reference - schema: - type: array - items: - type: string - format: text - - description: Filters for works with selected sync statuses. - explode: false - in: query - name: sync_metadata.last_sync_in.status - schema: - type: array - items: - $ref: '#/components/schemas/sync-metadata-filter-sync-in-filter-status' - - description: Filters for works modified with selected sync history. - explode: false - in: query - name: sync_metadata.last_sync_in.sync_history - schema: - type: array - items: - type: string - format: id - - description: Filters for works modified with selected sync units. - explode: false - in: query - name: sync_metadata.last_sync_in.sync_unit - schema: - type: array - items: - type: string - format: id - - description: Filters for works with selected sync statuses. - explode: false - in: query - name: sync_metadata.last_sync_out.status - schema: - type: array - items: - $ref: '#/components/schemas/sync-metadata-filter-sync-out-filter-status' - - description: Filters for works modified with selected sync history. - explode: false - in: query - name: sync_metadata.last_sync_out.sync_history - schema: - type: array - items: - type: string - format: id - - description: Filters for works modified with selected sync units. - explode: false - in: query - name: sync_metadata.last_sync_out.sync_unit - schema: - type: array - items: - type: string - format: id - - description: | - Filters for issues synced from this specific origin system. - explode: false - in: query - name: sync_metadata.origin_system - schema: - type: array - items: - type: string - format: text + x-fern-availability: generally-available + /parts.create: + post: + description: Creates new [part](https://devrev.ai/docs/product/parts). + operationId: parts-create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/parts-create-request' + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/groups-list-response' - description: The response to listing the groups. + $ref: '#/components/schemas/parts-create-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -15470,62 +23046,110 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Groups + summary: Create Part tags: - - groups + - parts x-fern-audiences: - docs - x-request-name: GroupsListQuery + - sdks + x-fern-availability: generally-available + /parts.delete: post: - description: Lists the available groups. - operationId: groups-list-post + description: Deletes a [part](https://devrev.ai/docs/product/parts). + operationId: parts-delete requestBody: content: application/json: schema: - $ref: '#/components/schemas/groups-list-request' + $ref: '#/components/schemas/parts-delete-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/groups-list-response' - description: The response to listing the groups. + $ref: '#/components/schemas/parts-delete-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Groups (POST) + summary: Delete Part tags: - - groups + - parts x-fern-audiences: - docs - sdks - /groups.members.add: + x-fern-availability: generally-available + /parts.get: + get: + description: | + Gets a [part's](https://devrev.ai/docs/product/parts) information. + operationId: parts-get + parameters: + - description: The ID of the part to retrieve. + explode: false + in: query + name: id + required: true + schema: + type: string + example: PROD-12345 + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/parts-get-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Part + tags: + - parts + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: PartsGetQuery post: - description: Adds a member to a group. - operationId: group-members-add + description: | + Gets a [part's](https://devrev.ai/docs/product/parts) information. + operationId: parts-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/group-members-add-request' + $ref: '#/components/schemas/parts-get-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/group-members-add-response' + $ref: '#/components/schemas/parts-get-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -15541,25 +23165,30 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Add Groups Members + summary: Get Part (POST) tags: - - groups + - parts x-fern-audiences: - docs - sdks - /groups.members.list: + x-fern-availability: generally-available + /parts.list: get: - description: Lists the members in a group. - operationId: group-members-list + description: | + Lists a collection of [parts](https://devrev.ai/docs/product/parts). + operationId: parts-list parameters: - - description: ID of the group for which to list members. + - description: Filters for parts created by any of these users. explode: false in: query - name: group - required: true + name: created_by schema: - type: string - format: id + type: array + example: + - DEVU-12345 + items: + type: string + format: id - description: | The cursor to resume iteration from. If not provided, then iteration starts from the beginning. @@ -15570,8 +23199,7 @@ paths: type: string format: text - description: | - The maximum number of members to return. If not set, then the default - is '50'. + The maximum number of parts to return. The default is '50'. explode: false in: query name: limit @@ -15586,47 +23214,85 @@ paths: name: mode schema: $ref: '#/components/schemas/list-mode' + - description: Filters for parts modified by any of these users. + explode: false + in: query + name: modified_by + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id + - description: Filters for parts of the provided name(s). + explode: false + in: query + name: name + schema: + type: array + items: + type: string + format: text + - description: Filters for parts owned by any of these users. + explode: false + in: query + name: owned_by + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id + - description: Number of levels to fetch the part hierarchy up to. + explode: false + in: query + name: parent_part.level + schema: + type: integer + format: int32 + minimum: 1 + - description: | + Part IDs to fetch the hierarchy for. Required if any parent_part.* + fields are provided. + explode: false + in: query + name: parent_part.parts + schema: + type: array + example: + - PROD-12345 + items: + type: string + format: id + minItems: 1 + - description: Filters for part with any of the provided tags. + explode: false + in: query + name: tags + schema: + type: array + example: + - TAG-12345 + items: + type: string + format: id + - description: Filters for parts of the provided type(s). + explode: false + in: query + name: type + schema: + type: array + items: + $ref: '#/components/schemas/part-type' responses: "200": content: application/json: schema: - $ref: '#/components/schemas/group-members-list-response' - description: List of group members. - "400": - $ref: '#/components/responses/bad-request' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "429": - $ref: '#/components/responses/too-many-requests' - "500": - $ref: '#/components/responses/internal-server-error' - "503": - $ref: '#/components/responses/service-unavailable' - summary: List Groups Members - tags: - - groups - x-fern-audiences: - - docs - x-request-name: GroupMembersListQuery - post: - description: Lists the members in a group. - operationId: group-members-list-post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/group-members-list-request' - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/group-members-list-response' - description: List of group members. + $ref: '#/components/schemas/parts-list-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -15639,28 +23305,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Groups Members (POST) + summary: List Parts tags: - - groups + - parts x-fern-audiences: - docs - - sdks - /groups.members.remove: + x-fern-availability: generally-available + x-request-name: PartsListQuery post: - description: Removes a member from a group. - operationId: group-members-remove + description: | + Lists a collection of [parts](https://devrev.ai/docs/product/parts). + operationId: parts-list-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/group-members-remove-request' + $ref: '#/components/schemas/parts-list-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/group-members-remove-response' + $ref: '#/components/schemas/parts-list-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -15668,37 +23335,37 @@ paths: $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Remove Groups Members + summary: List Parts (POST) tags: - - groups + - parts x-fern-audiences: - docs - sdks - /groups.update: + x-fern-availability: generally-available + /parts.update: post: - description: Updates the requested group. - operationId: groups-update + description: | + Updates a [part's](https://devrev.ai/docs/product/parts) information. + operationId: parts-update requestBody: content: application/json: schema: - $ref: '#/components/schemas/groups-update-request' + $ref: '#/components/schemas/parts-update-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/groups-update-response' - description: The response to group update. + $ref: '#/components/schemas/parts-update-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -15713,35 +23380,59 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Update Group + summary: Update Part tags: - - groups + - parts x-fern-audiences: - docs - sdks - /keyrings.authorize: + x-fern-availability: generally-available + /reactions.list: get: - description: OAuth2 authorization callback. - operationId: keyrings-create-callback + description: Lists the reactors for an object. + operationId: reactions-list parameters: - - description: Code to exchange for an access token. + - description: | + The emoji to list the reactors for. This can be the short name of the + emoji (e.g. "joy"), or the code point (e.g. "1f602"). explode: false in: query - name: code + name: emoji required: true schema: type: string format: text - - description: State value given to the authorization request. + - description: The ID of the object to list reactors for. explode: false in: query - name: state + name: object required: true + schema: + type: string + example: don:core:dvrv-us-1:devo/example:ticket/123:comment/comment-id + format: id + - description: | + The cursor to resume iteration from, otherwise if not provided, then + iteration starts from the beginning. + explode: false + in: query + name: cursor schema: type: string format: text + - description: The maximum number of reactors to return. + explode: false + in: query + name: limit + schema: + type: integer + format: int32 responses: "200": + content: + application/json: + schema: + $ref: '#/components/schemas/reactions-list-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -15755,24 +23446,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - security: [] - summary: Authorize Keyrings + summary: List Reactions tags: - - keyrings + - timeline-entries + - works x-fern-audiences: - docs - x-request-name: KeyringsCreateCallbackQuery + x-fern-availability: generally-available + x-request-name: ReactionsListQuery post: - description: OAuth2 authorization callback. - operationId: keyrings-create-callback-post + description: Lists the reactors for an object. + operationId: reactions-list-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/keyrings-create-callback-request' + $ref: '#/components/schemas/reactions-list-request' required: true responses: "200": + content: + application/json: + schema: + $ref: '#/components/schemas/reactions-list-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -15786,30 +23482,31 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Authorize Keyrings (POST) + summary: List Reactions (POST) tags: - - keyrings + - timeline-entries + - works x-fern-audiences: - docs - sdks - /links.create: + x-fern-availability: generally-available + /reactions.update: post: - description: | - Creates a link between two objects to indicate a relationship. - operationId: links-create + description: Updates a reaction for an object. + operationId: reactions-update requestBody: content: application/json: schema: - $ref: '#/components/schemas/links-create-request' + $ref: '#/components/schemas/reactions-update-request' required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/links-create-response' - description: The response to creating a new link. + $ref: '#/components/schemas/reactions-update-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -15822,105 +23519,72 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Create Link + summary: Update Reaction tags: - - links + - timeline-entries + - works x-fern-audiences: - docs - sdks - /links.delete: + x-fern-availability: generally-available + /rev-orgs.create: post: - description: Deletes a link. - operationId: links-delete + description: | + Creates a Rev organization in the authenticated user's Dev + organization. + operationId: rev-orgs-create requestBody: content: application/json: schema: - $ref: '#/components/schemas/links-delete-request' + $ref: '#/components/schemas/rev-orgs-create-request' required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/links-delete-response' - description: The response for deleting a link. + $ref: '#/components/schemas/rev-orgs-create-response' + description: | + Response object for request to create a new Rev organization. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' + "409": + $ref: '#/components/responses/conflict' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Delete Link + summary: Create Rev Org tags: - - links + - rev-orgs x-fern-audiences: - docs - sdks - /links.get: - get: - description: Gets the requested link's information. - operationId: links-get - parameters: - - description: The requested link's ID. - explode: false - in: query - name: id - required: true - schema: - type: string - format: id - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/links-get-response' - description: The response to getting a link's information. - "400": - $ref: '#/components/responses/bad-request' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' - "429": - $ref: '#/components/responses/too-many-requests' - "500": - $ref: '#/components/responses/internal-server-error' - "503": - $ref: '#/components/responses/service-unavailable' - summary: Get Link - tags: - - links - x-fern-audiences: - - docs - x-request-name: LinksGetQuery + x-fern-availability: generally-available + /rev-orgs.delete: post: - description: Gets the requested link's information. - operationId: links-get-post + description: Deletes the Rev organization. + operationId: rev-orgs-delete requestBody: content: application/json: schema: - $ref: '#/components/schemas/links-get-request' + $ref: '#/components/schemas/rev-orgs-delete-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/links-get-response' - description: The response to getting a link's information. + $ref: '#/components/schemas/rev-orgs-delete-response' + description: The response to deleting a Rev organization. "400": $ref: '#/components/responses/bad-request' "401": @@ -15935,197 +23599,137 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Link (POST) + summary: Delete Rev Org tags: - - links + - rev-orgs x-fern-audiences: - docs - sdks - /links.list: + x-fern-availability: generally-available + /rev-orgs.get: get: - description: Lists the available links. - operationId: links-list + description: Retrieves the Rev organization's information. + operationId: rev-orgs-get parameters: - - description: The ID of the object to list the links for. + - description: | + The ID of account for which default Rev organization is to be + fetched. explode: false in: query - name: object - required: true + name: account schema: type: string + example: ACC-12345 format: id - - description: | - The cursor to resume iteration from. If not provided, then iteration - starts from the beginning. + - description: The ID of the required Rev organization. explode: false in: query - name: cursor + name: id schema: type: string - format: text - - description: | - The direction of the links to list, otherwise if not present, then - links in both directions (source and target) are included. - explode: false - in: query - name: direction - schema: - $ref: '#/components/schemas/links-direction' - - description: | - The maximum number of links to return. If not set, then the default - is '50'. - explode: false - in: query - name: limit - schema: - type: integer - format: int32 - - description: | - The link type(s) to filter for, otherwise if not present, all link - types are included. - explode: false - in: query - name: link_type - schema: - type: array - items: - $ref: '#/components/schemas/link-type' - - description: | - The iteration mode to use, otherwise if not set, then "after" is - used. - explode: false - in: query - name: mode - schema: - $ref: '#/components/schemas/list-mode' - - description: | - The object types to filter for, otherwise if not present, all object - types are included. - explode: false - in: query - name: object_types - schema: - type: array - items: - $ref: '#/components/schemas/link-endpoint-type' - - description: | - The link types to filter for, otherwise if not present, all link - types are included. - explode: false - in: query - name: types - schema: - type: array - deprecated: true - items: - $ref: '#/components/schemas/link-type' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/links-list-response' - description: The response to listing the links. - "400": - $ref: '#/components/responses/bad-request' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "429": - $ref: '#/components/responses/too-many-requests' - "500": - $ref: '#/components/responses/internal-server-error' - "503": - $ref: '#/components/responses/service-unavailable' - summary: List Links - tags: - - links - x-fern-audiences: - - docs - x-request-name: LinksListQuery - post: - description: Lists the available links. - operationId: links-list-post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/links-list-request' - required: true + example: REV-AbCdEfGh + format: id responses: "200": content: application/json: schema: - $ref: '#/components/schemas/links-list-response' - description: The response to listing the links. + $ref: '#/components/schemas/rev-orgs-get-response' + description: The response to getting a Rev organization's information. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Links (POST) + summary: Get Rev Org tags: - - links + - rev-orgs x-fern-audiences: - docs - - sdks - /links.replace: + x-fern-availability: generally-available + x-request-name: RevOrgsGetQuery post: - description: Replaces a link. - operationId: links-replace + description: Retrieves the Rev organization's information. + operationId: rev-orgs-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/links-replace-request' + $ref: '#/components/schemas/rev-orgs-get-request' required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/links-replace-response' - description: The response to replacing a link. + $ref: '#/components/schemas/rev-orgs-get-response' + description: The response to getting a Rev organization's information. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Replace Links + summary: Get Rev Org (POST) tags: - - links + - rev-orgs x-fern-audiences: - docs - sdks - /metric-definitions.list: + x-fern-availability: generally-available + /rev-orgs.list: get: - description: Lists metric definitions matching a filter. - operationId: metric-definitions-list + description: | + Gets the list of Rev organizations' information belonging to the + authenticated user's Dev Organization which the user is also authorized + to access. + operationId: rev-orgs-list parameters: - - description: The type of objects the metric definition applies to. + - description: Filters by creator. explode: false in: query - name: applies_to_type + name: created_by schema: type: array items: - $ref: '#/components/schemas/metric-definition-applies-to' + type: string + format: id + - description: | + Filters for objects created after the provided timestamp (inclusive). + explode: false + in: query + name: created_date.after + schema: + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time + - description: | + Filters for objects created before the provided timestamp + (inclusive). + explode: false + in: query + name: created_date.before + schema: + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time - description: | The cursor to resume iteration from. If not provided, then iteration starts from the beginning. @@ -16135,16 +23739,26 @@ paths: schema: type: string format: text - - description: | - Whether to include custom metrics in the response. If not set, then - custom metrics are excluded. + - description: Array of display names of Rev orgs to be filtered. explode: false in: query - name: include_custom_metrics + name: display_name schema: - type: boolean + type: array + items: + type: string + format: text + - description: List of external refs to filter Rev organizations for. + explode: false + in: query + name: external_ref + schema: + type: array + items: + type: string + format: text - description: | - The maximum number of records to return. The default is '50'. + The maximum number of Rev organizations to be retrieved per page. explode: false in: query name: limit @@ -16160,119 +23774,84 @@ paths: schema: $ref: '#/components/schemas/list-mode' - description: | - Fields to sort the records by and the direction to sort them. + Filters for objects created after the provided timestamp (inclusive). explode: false in: query - name: sort_by + name: modified_date.after schema: - type: array - items: - type: string - format: sort-by - - description: The status of the metric definition. + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time + - description: | + Filters for objects created before the provided timestamp + (inclusive). explode: false in: query - name: status + name: modified_date.before schema: - type: array - items: - $ref: '#/components/schemas/metric-definition-status' - - description: The type of metric definitions sought. + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time + - description: | + Fields to sort the Rev organizations by and the direction to sort + them. explode: false in: query - name: type + name: sort_by schema: type: array items: - $ref: '#/components/schemas/metric-definition-metric-type' + type: string + format: sort-by responses: "200": content: application/json: schema: - $ref: '#/components/schemas/metric-definitions-list-response' - description: Success. + $ref: '#/components/schemas/rev-orgs-list-response' + description: | + The response to getting a list of Rev organizations' information. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Metric Definitions + summary: List Rev Orgs tags: - - slas + - rev-orgs x-fern-audiences: - docs - x-request-name: MetricDefinitionsListQuery + x-fern-availability: generally-available + x-request-name: RevOrgsListQuery post: - description: Lists metric definitions matching a filter. - operationId: metric-definitions-list-post + description: | + Gets the list of Rev organizations' information belonging to the + authenticated user's Dev Organization which the user is also authorized + to access. + operationId: rev-orgs-list-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/metric-definitions-list-request' + $ref: '#/components/schemas/rev-orgs-list-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/metric-definitions-list-response' - description: Success. - "400": - $ref: '#/components/responses/bad-request' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "429": - $ref: '#/components/responses/too-many-requests' - "500": - $ref: '#/components/responses/internal-server-error' - "503": - $ref: '#/components/responses/service-unavailable' - summary: List Metric Definitions (POST) - tags: - - slas - x-fern-audiences: - - docs - - sdks - /metric-trackers.get: - get: - description: Gets a metric tracker. - operationId: metric-trackers-get - parameters: - - description: The ID of the metric that is being tracked. - explode: false - in: query - name: metric - required: true - schema: - type: string - format: id - - description: | - The ID of the underlying object on which the metric is being tracked. - explode: false - in: query - name: object - required: true - schema: - type: string - format: id - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/metric-trackers-get-response' - description: Success. + $ref: '#/components/schemas/rev-orgs-list-response' + description: | + The response to getting a list of Rev organizations' information. "400": $ref: '#/components/responses/bad-request' "401": @@ -16287,28 +23866,30 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Metric Tracker + summary: List Rev Orgs (POST) tags: - - slas + - rev-orgs x-fern-audiences: - docs - x-request-name: MetricTrackersGetQuery + - sdks + x-fern-availability: generally-available + /rev-orgs.update: post: - description: Gets a metric tracker. - operationId: metric-trackers-get-post + description: Updates the Rev organization's information. + operationId: rev-orgs-update requestBody: content: application/json: schema: - $ref: '#/components/schemas/metric-trackers-get-request' + $ref: '#/components/schemas/rev-orgs-update-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/metric-trackers-get-response' - description: Success. + $ref: '#/components/schemas/rev-orgs-update-response' + description: Response object to updating Rev organization's information. "400": $ref: '#/components/responses/bad-request' "401": @@ -16317,70 +23898,79 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/not-found' + "409": + $ref: '#/components/responses/conflict' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Metric Tracker (POST) + summary: Update Rev Org tags: - - slas + - rev-orgs x-fern-audiences: - docs - sdks - /parts.create: + x-fern-availability: generally-available + /rev-users.create: post: - description: Creates new [part](https://devrev.ai/docs/product/parts). - operationId: parts-create + description: | + Creates a Rev user for a Rev organization. Rev user can be a customer + or a lead of an organization. + operationId: rev-users-create requestBody: content: application/json: schema: - $ref: '#/components/schemas/parts-create-request' + $ref: '#/components/schemas/rev-users-create-request' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/parts-create-response' - description: Success. + $ref: '#/components/schemas/rev-users-create-response' + description: | + Response object for creating a new Rev user for Rev organization. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' + "409": + $ref: '#/components/responses/conflict' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Create Part + summary: Create Rev User tags: - - parts + - rev-users x-fern-audiences: - docs - sdks - /parts.delete: + x-fern-availability: generally-available + /rev-users.delete: post: - description: Deletes a [part](https://devrev.ai/docs/product/parts). - operationId: parts-delete + description: Deletes a Rev user. + operationId: rev-users-delete requestBody: content: application/json: schema: - $ref: '#/components/schemas/parts-delete-request' + $ref: '#/components/schemas/rev-users-delete-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/parts-delete-response' - description: Success. + $ref: '#/components/schemas/rev-users-delete-response' + description: The response to deleting a Rev user of a Rev organization. "400": $ref: '#/components/responses/bad-request' "401": @@ -16395,34 +23985,33 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Delete Part + summary: Delete Rev User tags: - - parts + - rev-users x-fern-audiences: - docs - sdks - /parts.get: + x-fern-availability: generally-available + /rev-users.get: get: - description: | - Gets a [part's](https://devrev.ai/docs/product/parts) information. - operationId: parts-get + description: Returns the Rev user of a Rev organization by its ID. + operationId: rev-users-get parameters: - - description: The ID of the part to retrieve. + - description: The ID of Rev user to be retrieved. explode: false in: query name: id required: true schema: type: string - example: PROD-12345 format: id responses: "200": content: application/json: schema: - $ref: '#/components/schemas/parts-get-response' - description: Success. + $ref: '#/components/schemas/rev-users-get-response' + description: The returned Rev user. "400": $ref: '#/components/responses/bad-request' "401": @@ -16437,29 +24026,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Part + summary: Get Rev User tags: - - parts + - rev-users x-fern-audiences: - docs - x-request-name: PartsGetQuery + x-fern-availability: generally-available + x-request-name: RevUsersGetQuery post: - description: | - Gets a [part's](https://devrev.ai/docs/product/parts) information. - operationId: parts-get-post + description: Returns the Rev user of a Rev organization by its ID. + operationId: rev-users-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/parts-get-request' + $ref: '#/components/schemas/rev-users-get-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/parts-get-response' - description: Success. + $ref: '#/components/schemas/rev-users-get-response' + description: The returned Rev user. "400": $ref: '#/components/responses/bad-request' "401": @@ -16474,270 +24063,207 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Part (POST) + summary: Get Rev User (POST) tags: - - parts + - rev-users x-fern-audiences: - docs - sdks - /parts.list: + x-fern-availability: generally-available + /rev-users.list: get: description: | - Lists a collection of [parts](https://devrev.ai/docs/product/parts). - operationId: parts-list + Returns a list of all Rev Users belonging to the authenticated user's + Dev organization. + operationId: rev-users-list parameters: - - description: Filters for parts created by any of these users. + - description: | + Filters for Rev users with specified associations + (account/workspace). + explode: false + in: query + name: associations + schema: + type: array + items: + type: string + format: id + - description: | + Filters for Rev users that were created by the specified user(s). explode: false in: query name: created_by schema: type: array - example: - - DEVU-12345 items: type: string format: id - description: | - The cursor to resume iteration from. If not provided, then iteration - starts from the beginning. + Filters for objects created after the provided timestamp (inclusive). explode: false in: query - name: cursor + name: created_date.after schema: type: string - format: text + example: "2023-01-01T12:00:00.000Z" + format: date-time - description: | - The maximum number of parts to return. The default is '50'. + Filters for objects created before the provided timestamp + (inclusive). explode: false in: query - name: limit + name: created_date.before schema: - type: integer - format: int32 + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time - description: | - The iteration mode to use, otherwise if not set, then "after" is - used. + The cursor to resume iteration from. If not provided, then iteration + starts from the beginning. explode: false in: query - name: mode + name: cursor schema: - $ref: '#/components/schemas/list-mode' - - description: Filters for parts of the provided name(s). + type: string + format: text + - description: List of emails of Rev users to be filtered. explode: false in: query - name: name + name: email schema: type: array items: type: string format: text - - description: Filters for parts owned by any of these users. + - description: List of external refs to filter Rev users for. explode: false in: query - name: owned_by + name: external_ref schema: type: array - example: - - DEVU-12345 items: type: string - format: id - - description: Number of levels to fetch the part hierarchy up to. + format: text + - description: Value of is_verified field to filter the Rev users. explode: false in: query - name: parent_part.level + name: is_verified + schema: + type: boolean + - description: | + The maximum number of Rev users to return. The default is '50'. + explode: false + in: query + name: limit schema: type: integer format: int32 - minimum: 1 - description: | - Part IDs to fetch the hierarchy for. Required if any parent_part.* - fields are provided. + The iteration mode to use, otherwise if not set, then "after" is + used. explode: false in: query - name: parent_part.parts + name: mode + schema: + $ref: '#/components/schemas/list-mode' + - description: | + Filters for objects created after the provided timestamp (inclusive). + explode: false + in: query + name: modified_date.after + schema: + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time + - description: | + Filters for objects created before the provided timestamp + (inclusive). + explode: false + in: query + name: modified_date.before + schema: + type: string + example: "2023-01-01T12:00:00.000Z" + format: date-time + - description: | + List of phone numbers, in E.164 format, to filter Rev users on. + explode: false + in: query + name: phone_numbers schema: type: array - example: - - PROD-12345 items: type: string - format: id - minItems: 1 - - description: Filters for part with any of the provided tags. + format: text + - description: List of IDs of Rev organizations to be filtered. explode: false in: query - name: tags + name: rev_org schema: type: array example: - - TAG-12345 + - REV-AbCdEfGh items: type: string format: id - - description: Filters for parts of the provided type(s). + - description: | + Fields to sort the Rev users by and the direction to sort them. explode: false in: query - name: type - schema: - type: array - items: - $ref: '#/components/schemas/part-type' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/parts-list-response' - description: Success. - "400": - $ref: '#/components/responses/bad-request' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "429": - $ref: '#/components/responses/too-many-requests' - "500": - $ref: '#/components/responses/internal-server-error' - "503": - $ref: '#/components/responses/service-unavailable' - summary: List Parts - tags: - - parts - x-fern-audiences: - - docs - x-request-name: PartsListQuery - post: - description: | - Lists a collection of [parts](https://devrev.ai/docs/product/parts). - operationId: parts-list-post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/parts-list-request' - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/parts-list-response' - description: Success. - "400": - $ref: '#/components/responses/bad-request' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "429": - $ref: '#/components/responses/too-many-requests' - "500": - $ref: '#/components/responses/internal-server-error' - "503": - $ref: '#/components/responses/service-unavailable' - summary: List Parts (POST) - tags: - - parts - x-fern-audiences: - - docs - - sdks - /parts.update: - post: - description: | - Updates a [part's](https://devrev.ai/docs/product/parts) information. - operationId: parts-update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/parts-update-request' - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/parts-update-response' - description: Success. - "400": - $ref: '#/components/responses/bad-request' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' - "429": - $ref: '#/components/responses/too-many-requests' - "500": - $ref: '#/components/responses/internal-server-error' - "503": - $ref: '#/components/responses/service-unavailable' - summary: Update Part - tags: - - parts - x-fern-audiences: - - docs - - sdks - /rev-orgs.create: - post: - description: | - Creates a Rev organization in the authenticated user's Dev - organization. - operationId: rev-orgs-create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/rev-orgs-create-request' - required: true + name: sort_by + schema: + type: array + items: + type: string + format: sort-by responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/rev-orgs-create-response' + $ref: '#/components/schemas/rev-users-list-response' description: | - Response object for request to create a new Rev organization. + The response to listing all Rev users matching the filter criteria. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "409": - $ref: '#/components/responses/conflict' + "404": + $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Create Rev Org + summary: List Rev Users tags: - - rev-orgs + - rev-users x-fern-audiences: - docs - - sdks - /rev-orgs.delete: + x-fern-availability: generally-available + x-request-name: RevUsersListQuery post: - description: Deletes the Rev organization. - operationId: rev-orgs-delete + description: | + Returns a list of all Rev Users belonging to the authenticated user's + Dev organization. + operationId: rev-users-list-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/rev-orgs-delete-request' + $ref: '#/components/schemas/rev-users-list-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/rev-orgs-delete-response' - description: The response to deleting a Rev organization. + $ref: '#/components/schemas/rev-users-list-response' + description: | + The response to listing all Rev users matching the filter criteria. "400": $ref: '#/components/responses/bad-request' "401": @@ -16752,78 +24278,32 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Delete Rev Org + summary: List Rev Users (POST) tags: - - rev-orgs + - rev-users x-fern-audiences: - docs - sdks - /rev-orgs.get: - get: - description: Retrieves the Rev organization's information. - operationId: rev-orgs-get - parameters: - - description: | - The ID of account for which default Rev organization is to be - fetched. - explode: false - in: query - name: account - schema: - type: string - example: ACC-12345 - format: id - - description: The ID of the required Rev organization. - explode: false - in: query - name: id - schema: - type: string - example: REV-AbCdEfGh - format: id - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/rev-orgs-get-response' - description: The response to getting a Rev organization's information. - "400": - $ref: '#/components/responses/bad-request' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' - "429": - $ref: '#/components/responses/too-many-requests' - "500": - $ref: '#/components/responses/internal-server-error' - "503": - $ref: '#/components/responses/service-unavailable' - summary: Get Rev Org - tags: - - rev-orgs - x-fern-audiences: - - docs - x-request-name: RevOrgsGetQuery + x-fern-availability: generally-available + /rev-users.merge: post: - description: Retrieves the Rev organization's information. - operationId: rev-orgs-get-post + description: Merges the secondary Rev user into the primary Rev user. + operationId: rev-users-merge requestBody: content: application/json: schema: - $ref: '#/components/schemas/rev-orgs-get-request' + $ref: '#/components/schemas/rev-users-merge-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/rev-orgs-get-response' - description: The response to getting a Rev organization's information. + $ref: '#/components/schemas/rev-users-merge-response' + description: | + Acknowledgment response indicating that the merge request has been + received for processing asynchronously. "400": $ref: '#/components/responses/bad-request' "401": @@ -16838,21 +24318,31 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Rev Org (POST) + summary: Merge Rev Users tags: - - rev-orgs + - rev-users x-fern-audiences: - docs - sdks - /rev-orgs.list: + x-fern-availability: generally-available + /rev-users.scan: get: - description: | - Gets the list of Rev organizations' information belonging to the - authenticated user's Dev Organization which the user is also authorized - to access. - operationId: rev-orgs-list + description: Scans through all Rev users. + operationId: rev-users-scan parameters: - - description: Filters by creator. + - description: | + Filters for Rev users with specified associations + (account/workspace). + explode: false + in: query + name: associations + schema: + type: array + items: + type: string + format: id + - description: | + Filters for Rev users that were created by the specified user(s). explode: false in: query name: created_by @@ -16881,24 +24371,24 @@ paths: example: "2023-01-01T12:00:00.000Z" format: date-time - description: | - The cursor to resume iteration from. If not provided, then iteration - starts from the beginning. + The cursor to resume iteration, otherwise the beginning if not + provided. explode: false in: query name: cursor schema: type: string format: text - - description: Array of display names of Rev orgs to be filtered. + - description: List of emails of Rev users to be filtered. explode: false in: query - name: display_name + name: email schema: type: array items: type: string format: text - - description: List of external refs to filter Rev organizations for. + - description: List of external refs to filter Rev users for. explode: false in: query name: external_ref @@ -16907,22 +24397,12 @@ paths: items: type: string format: text - - description: | - The maximum number of Rev organizations to be retrieved per page. - explode: false - in: query - name: limit - schema: - type: integer - format: int32 - - description: | - The iteration mode to use, otherwise if not set, then "after" is - used. + - description: Value of is_verified field to filter the Rev users. explode: false in: query - name: mode + name: is_verified schema: - $ref: '#/components/schemas/list-mode' + type: boolean - description: | Filters for objects created after the provided timestamp (inclusive). explode: false @@ -16943,24 +24423,33 @@ paths: example: "2023-01-01T12:00:00.000Z" format: date-time - description: | - Fields to sort the Rev organizations by and the direction to sort - them. + List of phone numbers, in E.164 format, to filter Rev users on. explode: false in: query - name: sort_by + name: phone_numbers schema: type: array items: type: string - format: sort-by + format: text + - description: List of IDs of Rev organizations to be filtered. + explode: false + in: query + name: rev_org + schema: + type: array + example: + - REV-AbCdEfGh + items: + type: string + format: id responses: "200": content: application/json: schema: - $ref: '#/components/schemas/rev-orgs-list-response' - description: | - The response to getting a list of Rev organizations' information. + $ref: '#/components/schemas/rev-users-scan-response' + description: The response to scanning Rev users. "400": $ref: '#/components/responses/bad-request' "401": @@ -16975,32 +24464,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Rev Orgs + summary: Scan Rev Users tags: - - rev-orgs + - rev-users x-fern-audiences: - docs - x-request-name: RevOrgsListQuery + x-fern-availability: generally-available + x-request-name: RevUsersScanQuery post: - description: | - Gets the list of Rev organizations' information belonging to the - authenticated user's Dev Organization which the user is also authorized - to access. - operationId: rev-orgs-list-post + description: Scans through all Rev users. + operationId: rev-users-scan-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/rev-orgs-list-request' + $ref: '#/components/schemas/rev-users-scan-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/rev-orgs-list-response' - description: | - The response to getting a list of Rev organizations' information. + $ref: '#/components/schemas/rev-users-scan-response' + description: The response to scanning Rev users. "400": $ref: '#/components/responses/bad-request' "401": @@ -17015,29 +24501,30 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Rev Orgs (POST) + summary: Scan Rev Users (POST) tags: - - rev-orgs + - rev-users x-fern-audiences: - docs - sdks - /rev-orgs.update: + x-fern-availability: generally-available + /rev-users.update: post: - description: Updates the Rev organization's information. - operationId: rev-orgs-update + description: Updates a Rev user. + operationId: rev-users-update requestBody: content: application/json: schema: - $ref: '#/components/schemas/rev-orgs-update-request' + $ref: '#/components/schemas/rev-users-update-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/rev-orgs-update-response' - description: Response object to updating Rev organization's information. + $ref: '#/components/schemas/rev-users-update-response' + description: Updated Rev user object. "400": $ref: '#/components/responses/bad-request' "401": @@ -17054,69 +24541,112 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Update Rev Org + summary: Update Rev User tags: - - rev-orgs + - rev-users x-fern-audiences: - docs - sdks - /rev-users.create: + x-fern-availability: generally-available + /service-accounts.create: post: - description: | - Creates a Rev user for a Rev organization. Rev user can be a customer - or a lead of an organization. - operationId: rev-users-create + description: Creates a service account. + operationId: service-accounts-create requestBody: content: application/json: schema: - $ref: '#/components/schemas/rev-users-create-request' + $ref: '#/components/schemas/service-accounts-create-request' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/rev-users-create-response' + $ref: '#/components/schemas/service-accounts-create-response' description: | - Response object for creating a new Rev user for Rev organization. + The response object to the corresponding create service account + request. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "409": - $ref: '#/components/responses/conflict' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Create Rev User + summary: Create Service Account + tags: + - service-accounts + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /service-accounts.get: + get: + description: Gets a service account. + operationId: service-accounts-get + parameters: + - description: The ID of the requested service account. + explode: false + in: query + name: id + required: true + schema: + type: string + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/service-accounts-get-response' + description: | + The response object that carries the service account's information + corresponding to the request. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Service Account tags: - - rev-users + - service-accounts x-fern-audiences: - docs - - sdks - /rev-users.delete: + x-fern-availability: generally-available + x-request-name: ServiceAccountsGetQuery post: - description: Deletes a Rev user. - operationId: rev-users-delete + description: Gets a service account. + operationId: service-accounts-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/rev-users-delete-request' + $ref: '#/components/schemas/service-accounts-get-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/rev-users-delete-response' - description: The response to deleting a Rev user of a Rev organization. + $ref: '#/components/schemas/service-accounts-get-response' + description: | + The response object that carries the service account's information + corresponding to the request. "400": $ref: '#/components/responses/bad-request' "401": @@ -17131,18 +24661,19 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Delete Rev User + summary: Get Service Account (POST) tags: - - rev-users + - service-accounts x-fern-audiences: - docs - sdks - /rev-users.get: + x-fern-availability: generally-available + /sla-trackers.get: get: - description: Returns the Rev user of a Rev organization by its ID. - operationId: rev-users-get + description: Gets an SLA tracker. + operationId: sla-trackers-get parameters: - - description: The ID of Rev user to be retrieved. + - description: The ID of the SLA tracker to get. explode: false in: query name: id @@ -17155,8 +24686,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/rev-users-get-response' - description: The returned Rev user. + $ref: '#/components/schemas/sla-trackers-get-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -17171,28 +24702,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Rev User + summary: Get SLA Tracker tags: - - rev-users + - slas x-fern-audiences: - docs - x-request-name: RevUsersGetQuery + x-fern-availability: generally-available + x-request-name: SlaTrackersGetQuery post: - description: Returns the Rev user of a Rev organization by its ID. - operationId: rev-users-get-post + description: Gets an SLA tracker. + operationId: sla-trackers-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/rev-users-get-request' + $ref: '#/components/schemas/sla-trackers-get-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/rev-users-get-response' - description: The returned Rev user. + $ref: '#/components/schemas/sla-trackers-get-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -17207,40 +24739,18 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Rev User (POST) + summary: Get SLA Tracker (POST) tags: - - rev-users + - slas x-fern-audiences: - docs - sdks - /rev-users.list: + x-fern-availability: generally-available + /sla-trackers.list: get: - description: | - Returns a list of all Rev Users belonging to the authenticated user's - Dev organization. - operationId: rev-users-list + description: Lists SLA trackers matching a filter. + operationId: sla-trackers-list parameters: - - description: | - Filters for Rev users with specified associations - (account/workspace). - explode: false - in: query - name: associations - schema: - type: array - items: - type: string - format: id - - description: | - Filters for Rev users that were created by the specified user(s). - explode: false - in: query - name: created_by - schema: - type: array - items: - type: string - format: id - description: | Filters for objects created after the provided timestamp (inclusive). explode: false @@ -17269,32 +24779,8 @@ paths: schema: type: string format: text - - description: List of emails of Rev users to be filtered. - explode: false - in: query - name: email - schema: - type: array - items: - type: string - format: text - - description: List of external refs to filter Rev users for. - explode: false - in: query - name: external_ref - schema: - type: array - items: - type: string - format: text - - description: Value of is_verified field to filter the Rev users. - explode: false - in: query - name: is_verified - schema: - type: boolean - description: | - The maximum number of Rev users to return. The default is '50'. + The maximum number of SLA trackers to return. The default is '50'. explode: false in: query name: limit @@ -17329,201 +24815,111 @@ paths: example: "2023-01-01T12:00:00.000Z" format: date-time - description: | - List of phone numbers, in E.164 format, to filter Rev users on. + Fields to sort the SLA Trackers by and the direction to sort them. explode: false in: query - name: phone_numbers + name: sort_by schema: type: array items: type: string - format: text - - description: List of IDs of Rev organizations to be filtered. + format: sort-by + - description: The SLA tracker stages the filter matches. explode: false in: query - name: rev_org + name: stage schema: type: array - example: - - REV-AbCdEfGh items: type: string - format: id - - description: | - Fields to sort the Rev users by and the direction to sort them. + format: text + - description: The SLA tracker statuses the filter matches. explode: false in: query - name: sort_by + name: status schema: type: array items: type: string - format: sort-by - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/rev-users-list-response' - description: | - The response to listing all Rev users matching the filter criteria. - "400": - $ref: '#/components/responses/bad-request' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' - "429": - $ref: '#/components/responses/too-many-requests' - "500": - $ref: '#/components/responses/internal-server-error' - "503": - $ref: '#/components/responses/service-unavailable' - summary: List Rev Users - tags: - - rev-users - x-fern-audiences: - - docs - x-request-name: RevUsersListQuery - post: - description: | - Returns a list of all Rev Users belonging to the authenticated user's - Dev organization. - operationId: rev-users-list-post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/rev-users-list-request' - required: true + format: text responses: "200": content: application/json: schema: - $ref: '#/components/schemas/rev-users-list-response' - description: | - The response to listing all Rev users matching the filter criteria. + $ref: '#/components/schemas/sla-trackers-list-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Rev Users (POST) + summary: List SLA Trackers tags: - - rev-users + - slas x-fern-audiences: - docs - - sdks - /rev-users.update: + x-fern-availability: generally-available + x-request-name: SlaTrackersListQuery post: - description: Updates a Rev user. - operationId: rev-users-update + description: Lists SLA trackers matching a filter. + operationId: sla-trackers-list-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/rev-users-update-request' + $ref: '#/components/schemas/sla-trackers-list-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/rev-users-update-response' - description: Updated Rev user object. + $ref: '#/components/schemas/sla-trackers-list-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' - "409": - $ref: '#/components/responses/conflict' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Update Rev User + summary: List SLA Trackers (POST) tags: - - rev-users + - slas x-fern-audiences: - docs - sdks - /service-accounts.create: + x-fern-availability: generally-available + /slas.assign: post: - description: Creates a service account. - operationId: service-accounts-create + description: ' Assigns the SLA to a set of Rev organizations.' + operationId: slas-assign requestBody: content: application/json: schema: - $ref: '#/components/schemas/service-accounts-create-request' + $ref: '#/components/schemas/slas-assign-request' required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/service-accounts-create-response' - description: | - The response object to the corresponding create service account - request. - "400": - $ref: '#/components/responses/bad-request' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "429": - $ref: '#/components/responses/too-many-requests' - "500": - $ref: '#/components/responses/internal-server-error' - "503": - $ref: '#/components/responses/service-unavailable' - summary: Create Service Account - tags: - - service-accounts - x-fern-audiences: - - docs - - sdks - /service-accounts.get: - get: - description: Gets a service account. - operationId: service-accounts-get - parameters: - - description: The ID of the requested service account. - explode: false - in: query - name: id - required: true - schema: - type: string - format: id responses: "200": content: - application/json: - schema: - $ref: '#/components/schemas/service-accounts-get-response' - description: | - The response object that carries the service account's information - corresponding to the request. + application/json: + schema: + $ref: '#/components/schemas/slas-assign-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": @@ -17538,56 +24934,55 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Service Account + summary: Assign SLAs tags: - - service-accounts + - slas x-fern-audiences: - docs - x-request-name: ServiceAccountsGetQuery + - sdks + x-fern-availability: generally-available + /slas.create: post: - description: Gets a service account. - operationId: service-accounts-get-post + description: Creates an SLA in draft status. + operationId: slas-create requestBody: content: application/json: schema: - $ref: '#/components/schemas/service-accounts-get-request' + $ref: '#/components/schemas/slas-create-request' required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/service-accounts-get-response' - description: | - The response object that carries the service account's information - corresponding to the request. + $ref: '#/components/schemas/slas-create-response' + description: Success. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Service Account (POST) + summary: Create SLA tags: - - service-accounts + - slas x-fern-audiences: - docs - sdks - /sla-trackers.get: + x-fern-availability: generally-available + /slas.get: get: - description: Gets an SLA tracker. - operationId: sla-trackers-get + description: Gets an SLA. + operationId: slas-get parameters: - - description: The ID of the SLA tracker to get. + - description: The ID of the SLA to get. explode: false in: query name: id @@ -17600,7 +24995,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sla-trackers-get-response' + $ref: '#/components/schemas/slas-get-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -17616,27 +25011,28 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get SLA Tracker + summary: Get SLA tags: - slas x-fern-audiences: - docs - x-request-name: SlaTrackersGetQuery + x-fern-availability: generally-available + x-request-name: SlasGetQuery post: - description: Gets an SLA tracker. - operationId: sla-trackers-get-post + description: Gets an SLA. + operationId: slas-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/sla-trackers-get-request' + $ref: '#/components/schemas/slas-get-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/sla-trackers-get-response' + $ref: '#/components/schemas/slas-get-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -17652,36 +25048,34 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get SLA Tracker (POST) + summary: Get SLA (POST) tags: - slas x-fern-audiences: - docs - sdks - /sla-trackers.list: + x-fern-availability: generally-available + /slas.list: get: - description: Lists SLA trackers matching a filter. - operationId: sla-trackers-list + description: Lists SLAs matching a filter. + operationId: slas-list parameters: - - description: | - Filters for objects created after the provided timestamp (inclusive). + - description: The object types the SLA applies to. explode: false in: query - name: created_date.after + name: applies_to schema: - type: string - example: "2023-01-01T12:00:00.000Z" - format: date-time + type: array + items: + $ref: '#/components/schemas/sla-applies-to' - description: | - Filters for objects created before the provided timestamp - (inclusive). + The Filter operator to be applied on the applies to object types + filter. explode: false in: query - name: created_date.before + name: applies_to_op schema: - type: string - example: "2023-01-01T12:00:00.000Z" - format: date-time + $ref: '#/components/schemas/slas-filter-applies-to-operator-type' - description: | The cursor to resume iteration from. If not provided, then iteration starts from the beginning. @@ -17691,8 +25085,7 @@ paths: schema: type: string format: text - - description: | - The maximum number of SLA trackers to return. The default is '50'. + - description: The maximum number of SLAs to return. The default is '50'. explode: false in: query name: limit @@ -17707,59 +25100,184 @@ paths: name: mode schema: $ref: '#/components/schemas/list-mode' - - description: | - Filters for objects created after the provided timestamp (inclusive). - explode: false - in: query - name: modified_date.after - schema: - type: string - example: "2023-01-01T12:00:00.000Z" - format: date-time - - description: | - Filters for objects created before the provided timestamp - (inclusive). - explode: false - in: query - name: modified_date.before - schema: - type: string - example: "2023-01-01T12:00:00.000Z" - format: date-time - - description: | - Fields to sort the SLA Trackers by and the direction to sort them. + - description: The SLA types the filter matches. explode: false in: query - name: sort_by + name: sla_type schema: type: array items: - type: string - format: sort-by - - description: The SLA tracker stages the filter matches. + $ref: '#/components/schemas/sla-type' + - description: Fields to sort the SLAs by and the direction to sort them. explode: false in: query - name: stage + name: sort_by schema: type: array items: type: string - format: text - - description: The SLA tracker statuses the filter matches. + format: sort-by + - description: The SLA statuses the filter matches. explode: false in: query name: status schema: type: array items: - type: string - format: text + $ref: '#/components/schemas/sla-status' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/slas-list-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List SLAs + tags: + - slas + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: SlasListQuery + post: + description: Lists SLAs matching a filter. + operationId: slas-list-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/slas-list-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/slas-list-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List SLAs (POST) + tags: + - slas + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /slas.transition: + post: + description: Changes the status of an SLA. + operationId: slas-transition + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/slas-transition-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/slas-transition-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Transition SLAs + tags: + - slas + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /slas.update: + post: + description: Updates a draft SLA. + operationId: slas-update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/slas-update-request' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/slas-update-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Update SLA + tags: + - slas + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /snap-kit-action.execute.deferred: + post: + description: Executes deferred snap-kit actions. + operationId: snap-kit-action-execute-deferred + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/snap-kit-action-execute-deferred-request' + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/sla-trackers-list-response' + $ref: '#/components/schemas/snap-kit-action-execute-deferred-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -17773,27 +25291,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List SLA Trackers + summary: Deferred Snap Kit Action Execute tags: - - slas + - snap-kit-execution x-fern-audiences: - docs - x-request-name: SlaTrackersListQuery + - sdks + x-fern-availability: generally-available + /snap-widgets.create: post: - description: Lists SLA trackers matching a filter. - operationId: sla-trackers-list-post + description: Create a snap widget object. + operationId: snap-widgets-create requestBody: content: application/json: schema: - $ref: '#/components/schemas/sla-trackers-list-request' + $ref: '#/components/schemas/snap-widgets-create-request' required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/sla-trackers-list-response' + $ref: '#/components/schemas/snap-widgets-create-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -17807,28 +25327,31 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List SLA Trackers (POST) + summary: Create Snap Widget tags: - - slas + - snap-widgets x-fern-audiences: - docs - sdks - /slas.assign: + x-fern-availability: generally-available + /surveys.create: post: - description: ' Assigns the SLA to a set of Rev organizations.' - operationId: slas-assign + description: | + Creates a schema for survey, which includes name and description of + schema. + operationId: surveys-create requestBody: content: application/json: schema: - $ref: '#/components/schemas/slas-assign-request' + $ref: '#/components/schemas/surveys-create-request' required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/slas-assign-response' + $ref: '#/components/schemas/surveys-create-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -17836,36 +25359,35 @@ paths: $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Assign SLAs + summary: Create Survey tags: - - slas + - surveys x-fern-audiences: - docs - sdks - /slas.create: + x-fern-availability: generally-available + /surveys.delete: post: - description: Creates an SLA in draft status. - operationId: slas-create + description: Deletes the specified survey. + operationId: surveys-delete requestBody: content: application/json: schema: - $ref: '#/components/schemas/slas-create-request' + $ref: '#/components/schemas/surveys-delete-request' required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/slas-create-response' + $ref: '#/components/schemas/surveys-delete-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -17873,24 +25395,27 @@ paths: $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Create SLA + summary: Delete Survey tags: - - slas + - surveys x-fern-audiences: - docs - sdks - /slas.get: + x-fern-availability: generally-available + /surveys.get: get: - description: Gets an SLA. - operationId: slas-get + description: Gets a survey given the ID. + operationId: surveys-get parameters: - - description: The ID of the SLA to get. + - description: The ID of the survey to get. explode: false in: query name: id @@ -17903,7 +25428,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/slas-get-response' + $ref: '#/components/schemas/surveys-get-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -17911,35 +25436,34 @@ paths: $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get SLA + summary: Get Survey tags: - - slas + - surveys x-fern-audiences: - docs - x-request-name: SlasGetQuery + x-fern-availability: generally-available + x-request-name: SurveysGetQuery post: - description: Gets an SLA. - operationId: slas-get-post + description: Gets a survey given the ID. + operationId: surveys-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/slas-get-request' + $ref: '#/components/schemas/surveys-get-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/slas-get-response' + $ref: '#/components/schemas/surveys-get-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -17947,41 +25471,158 @@ paths: $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get SLA (POST) + summary: Get Survey (POST) tags: - - slas + - surveys x-fern-audiences: - docs - sdks - /slas.list: + x-fern-availability: generally-available + /surveys.list: get: - description: Lists SLAs matching a filter. - operationId: slas-list + description: List surveys requested by the user. + operationId: surveys-list parameters: - - description: The object types the SLA applies to. + - description: Filters for surveys created by any of these users. explode: false in: query - name: applies_to + name: created_by schema: type: array + example: + - DEVU-12345 items: - $ref: '#/components/schemas/sla-applies-to' + type: string + format: id - description: | - The Filter operator to be applied on the applies to object types - filter. + The cursor to resume iteration from. If not provided, then iteration + starts from the beginning. explode: false in: query - name: applies_to_op + name: cursor schema: - $ref: '#/components/schemas/slas-filter-applies-to-operator-type' + type: string + format: text + - description: | + The maximum number of surveys to return. If not set, then the default + is '50'. + explode: false + in: query + name: limit + schema: + type: integer + format: int32 + - description: | + The iteration mode to use, otherwise if not set, then "after" is + used. + explode: false + in: query + name: mode + schema: + $ref: '#/components/schemas/list-mode' + - description: Filters for surveys by name(s). + explode: false + in: query + name: name + schema: + type: array + items: + type: string + format: text + - description: | + Fields to sort the surveys by and the direction to sort them. + explode: false + in: query + name: sort_by + schema: + type: array + items: + type: string + format: sort-by + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/surveys-list-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Surveys + tags: + - surveys + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: SurveysListQuery + post: + description: List surveys requested by the user. + operationId: surveys-list-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/surveys-list-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/surveys-list-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Surveys (POST) + tags: + - surveys + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /surveys.responses.list: + get: + description: List survey responses requested by the user. + operationId: surveys-responses-list + parameters: + - description: | + Filters for survey responses created by any of these users. + explode: false + in: query + name: created_by + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id - description: | The cursor to resume iteration from. If not provided, then iteration starts from the beginning. @@ -17991,7 +25632,19 @@ paths: schema: type: string format: text - - description: The maximum number of SLAs to return. The default is '50'. + - description: | + Filters for survey responses associated with these unique IDs. + explode: false + in: query + name: dispatch_ids + schema: + type: array + items: + type: string + format: id + - description: | + The maximum number of survey responses to return. If not set, then + the default is '50'. explode: false in: query name: limit @@ -18006,15 +25659,32 @@ paths: name: mode schema: $ref: '#/components/schemas/list-mode' - - description: The SLA types the filter matches. + - description: Filters for survey responses created for the objects. explode: false in: query - name: sla_type + name: objects schema: type: array + example: + - ACC-12345 items: - $ref: '#/components/schemas/sla-type' - - description: Fields to sort the SLAs by and the direction to sort them. + type: string + format: id + - description: | + Filters for survey responses dispatched to any of these users. + explode: false + in: query + name: recipient + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id + - description: | + Fields to sort the survey responses by and the direction to sort + them. explode: false in: query name: sort_by @@ -18023,20 +25693,65 @@ paths: items: type: string format: sort-by - - description: The SLA statuses the filter matches. + - description: Filters for survey response stages. explode: false in: query - name: status + name: stages schema: type: array items: - $ref: '#/components/schemas/sla-status' + type: integer + format: int64 + - description: Filters for survey responses for the provided survey IDs. + explode: false + in: query + name: surveys + schema: + type: array + items: + type: string + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/surveys-responses-list-response' + description: Success. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Surveys Responses + tags: + - surveys + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: SurveysResponsesListQuery + post: + description: List survey responses requested by the user. + operationId: surveys-responses-list-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/surveys-responses-list-request' + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/slas-list-response' + $ref: '#/components/schemas/surveys-responses-list-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -18050,27 +25765,30 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List SLAs + summary: List Surveys Responses (POST) tags: - - slas + - surveys x-fern-audiences: - docs - x-request-name: SlasListQuery + - sdks + x-fern-availability: generally-available + /surveys.responses.update: post: - description: Lists SLAs matching a filter. - operationId: slas-list-post + description: | + Updates a user's survey response for the provided dispatch ID. + operationId: surveys-responses-update requestBody: content: application/json: schema: - $ref: '#/components/schemas/slas-list-request' + $ref: '#/components/schemas/surveys-responses-update-request' required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/slas-list-response' + $ref: '#/components/schemas/surveys-responses-update-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -18084,28 +25802,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List SLAs (POST) + summary: Update Surveys Response tags: - - slas + - surveys x-fern-audiences: - docs - sdks - /slas.transition: + x-fern-availability: generally-available + /surveys.send: post: - description: Changes the status of an SLA. - operationId: slas-transition + description: Sends a survey on the specified channels. + operationId: surveys-send requestBody: content: application/json: schema: - $ref: '#/components/schemas/slas-transition-request' + $ref: '#/components/schemas/surveys-send-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/slas-transition-response' + $ref: '#/components/schemas/surveys-send-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -18113,36 +25832,36 @@ paths: $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Transition SLAs + summary: Send Surveys tags: - - slas + - surveys x-fern-audiences: - docs - sdks - /slas.update: + x-fern-availability: generally-available + /surveys.submit: post: - description: Updates a draft SLA. - operationId: slas-update + description: | + Submits a user response to a survey, which is defined by the survey ID. + operationId: surveys-submit requestBody: content: application/json: schema: - $ref: '#/components/schemas/slas-update-request' + $ref: '#/components/schemas/surveys-submit-request' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/slas-update-response' + $ref: '#/components/schemas/surveys-submit-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -18150,36 +25869,35 @@ paths: $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Update SLA + summary: Submit Surveys tags: - - slas + - surveys x-fern-audiences: - docs - sdks - /snap-kit-action.execute.deferred: + x-fern-availability: generally-available + /surveys.update: post: - description: Executes deferred snap-kit actions. - operationId: snap-kit-action-execute-deferred + description: Updates a survey's metadata. + operationId: surveys-update requestBody: content: application/json: schema: - $ref: '#/components/schemas/snap-kit-action-execute-deferred-request' + $ref: '#/components/schemas/surveys-update-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/snap-kit-action-execute-deferred-response' + $ref: '#/components/schemas/surveys-update-response' description: Success. "400": $ref: '#/components/responses/bad-request' @@ -18193,29 +25911,18 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Deferred Snap Kit Action Execute + summary: Update Survey tags: - - snap-kit-execution + - surveys x-fern-audiences: - docs - sdks - /surveys.responses.list: + x-fern-availability: generally-available + /sys-users.list: get: - description: List survey responses requested by the user. - operationId: surveys-responses-list + description: Lists system users within your organization. + operationId: sys-users-list parameters: - - description: | - Filters for survey responses created by any of these users. - explode: false - in: query - name: created_by - schema: - type: array - example: - - DEVU-12345 - items: - type: string - format: id - description: | The cursor to resume iteration from. If not provided, then iteration starts from the beginning. @@ -18226,18 +25933,8 @@ paths: type: string format: text - description: | - Filters for survey responses associated with these unique IDs. - explode: false - in: query - name: dispatch_ids - schema: - type: array - items: - type: string - format: id - - description: | - The maximum number of survey responses to return. If not set, then - the default is '50'. + The maximum number of system users to return. Value can range from + '1' to '100', with a default of '50'. explode: false in: query name: limit @@ -18252,32 +25949,8 @@ paths: name: mode schema: $ref: '#/components/schemas/list-mode' - - description: Filters for survey responses created for the objects. - explode: false - in: query - name: objects - schema: - type: array - example: - - ACC-12345 - items: - type: string - format: id - - description: | - Filters for survey responses dispatched to any of these users. - explode: false - in: query - name: recipient - schema: - type: array - example: - - DEVU-12345 - items: - type: string - format: id - description: | - Fields to sort the survey responses by and the direction to sort - them. + Fields to sort the system users by and the direction to sort them. explode: false in: query name: sort_by @@ -18286,31 +25959,124 @@ paths: items: type: string format: sort-by - - description: Filters for survey response stages. - explode: false - in: query - name: stages - schema: - type: array - items: - type: integer - format: int64 - - description: Filters for survey responses for the provided survey IDs. - explode: false - in: query - name: surveys - schema: - type: array - items: - type: string - format: id responses: - "200": + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/sys-users-list-response' + description: The response to listing the system users. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Sys Users + tags: + - sys-users + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: SysUsersListQuery + post: + description: Lists system users within your organization. + operationId: sys-users-list-post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sys-users-list-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/sys-users-list-response' + description: The response to listing the system users. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: List Sys Users (POST) + tags: + - sys-users + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /sys-users.update: + post: + description: Updates the system user. + operationId: sys-users-update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sys-users-update-request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/sys-users-update-response' + description: Updated Sys user object. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Update Sys User + tags: + - sys-users + x-fern-audiences: + - docs + - sdks + x-fern-availability: generally-available + /tags.create: + post: + description: | + Creates a new tag, which is used to create associations between objects + and a logical concept denoted by the tag's name. + operationId: tags-create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/tags-create-request' + required: true + responses: + "201": content: application/json: schema: - $ref: '#/components/schemas/surveys-responses-list-response' - description: Success. + $ref: '#/components/schemas/tags-create-response' + description: The response to creating a new tag. "400": $ref: '#/components/responses/bad-request' "401": @@ -18323,86 +26089,134 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Surveys Responses + summary: Create Tag tags: - - surveys + - tags x-fern-audiences: - docs - x-request-name: SurveysResponsesListQuery + - sdks + x-fern-availability: generally-available + /tags.delete: post: - description: List survey responses requested by the user. - operationId: surveys-responses-list-post + description: Deletes a tag. + operationId: tags-delete requestBody: content: application/json: schema: - $ref: '#/components/schemas/surveys-responses-list-request' + $ref: '#/components/schemas/tags-delete-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/surveys-responses-list-response' - description: Success. + $ref: '#/components/schemas/tags-delete-response' + description: The response for deleting a tag. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Surveys Responses (POST) + summary: Delete Tag tags: - - surveys + - tags x-fern-audiences: - docs - sdks - /surveys.responses.update: + x-fern-availability: generally-available + /tags.get: + get: + description: Gets a tag's information. + operationId: tags-get + parameters: + - description: The requested tag's ID. + explode: false + in: query + name: id + required: true + schema: + type: string + example: TAG-12345 + format: id + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/tags-get-response' + description: The response to getting a tag's information. + "400": + $ref: '#/components/responses/bad-request' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' + "429": + $ref: '#/components/responses/too-many-requests' + "500": + $ref: '#/components/responses/internal-server-error' + "503": + $ref: '#/components/responses/service-unavailable' + summary: Get Tag + tags: + - tags + x-fern-audiences: + - docs + x-fern-availability: generally-available + x-request-name: TagsGetQuery post: - description: | - Updates a user's survey response for the provided dispatch ID. - operationId: surveys-responses-update + description: Gets a tag's information. + operationId: tags-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/surveys-responses-update-request' + $ref: '#/components/schemas/tags-get-request' required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/surveys-responses-update-response' - description: Success. + $ref: '#/components/schemas/tags-get-response' + description: The response to getting a tag's information. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Update Surveys Response + summary: Get Tag (POST) tags: - - surveys + - tags x-fern-audiences: - docs - sdks - /sys-users.list: + x-fern-availability: generally-available + /tags.list: get: - description: Lists system users within your organization. - operationId: sys-users-list + description: Lists the available tags. + operationId: tags-list parameters: - description: | The cursor to resume iteration from. If not provided, then iteration @@ -18413,9 +26227,7 @@ paths: schema: type: string format: text - - description: | - The maximum number of system users to return. Value can range from - '1' to '100', with a default of '50'. + - description: The maximum number of tags to return. The default is '50'. explode: false in: query name: limit @@ -18430,8 +26242,16 @@ paths: name: mode schema: $ref: '#/components/schemas/list-mode' - - description: | - Fields to sort the system users by and the direction to sort them. + - description: Filters for tags with the provided names. + explode: false + in: query + name: name + schema: + type: array + items: + type: string + format: text + - description: Fields to sort tags by and the direction to sort them. explode: false in: query name: sort_by @@ -18445,8 +26265,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/sys-users-list-response' - description: The response to listing the system users. + $ref: '#/components/schemas/tags-list-response' + description: The response to listing the tags. "400": $ref: '#/components/responses/bad-request' "401": @@ -18459,28 +26279,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Sys Users + summary: List Tags tags: - - sys-users + - tags x-fern-audiences: - docs - x-request-name: SysUsersListQuery + x-fern-availability: generally-available + x-request-name: TagsListQuery post: - description: Lists system users within your organization. - operationId: sys-users-list-post + description: Lists the available tags. + operationId: tags-list-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/sys-users-list-request' + $ref: '#/components/schemas/tags-list-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/sys-users-list-response' - description: The response to listing the system users. + $ref: '#/components/schemas/tags-list-response' + description: The response to listing the tags. "400": $ref: '#/components/responses/bad-request' "401": @@ -18493,29 +26314,30 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Sys Users (POST) + summary: List Tags (POST) tags: - - sys-users + - tags x-fern-audiences: - docs - sdks - /sys-users.update: + x-fern-availability: generally-available + /tags.update: post: - description: Updates the system user. - operationId: sys-users-update + description: Updates a tag's information. + operationId: tags-update requestBody: content: application/json: schema: - $ref: '#/components/schemas/sys-users-update-request' + $ref: '#/components/schemas/tags-update-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/sys-users-update-response' - description: Updated Sys user object. + $ref: '#/components/schemas/tags-update-response' + description: The response for updating a tag. "400": $ref: '#/components/responses/bad-request' "401": @@ -18530,107 +26352,108 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Update Sys User + summary: Update Tag tags: - - sys-users + - tags x-fern-audiences: - docs - sdks - /tags.create: + x-fern-availability: generally-available + /timeline-entries.create: post: - description: | - Creates a new tag, which is used to create associations between objects - and a logical concept denoted by the tag's name. - operationId: tags-create + description: Creates a new entry on an object's timeline. + operationId: timeline-entries-create requestBody: content: application/json: schema: - $ref: '#/components/schemas/tags-create-request' + $ref: '#/components/schemas/timeline-entries-create-request' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/tags-create-response' - description: The response to creating a new tag. + $ref: '#/components/schemas/timeline-entries-create-response' + description: The response to creating a timeline entry for an object. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' + "409": + $ref: '#/components/responses/conflict' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Create Tag + summary: Create Timeline Entry tags: - - tags + - timeline-entries x-fern-audiences: - docs - sdks - /tags.delete: + x-fern-availability: generally-available + /timeline-entries.delete: post: - description: Deletes a tag. - operationId: tags-delete + description: Deletes an entry from an object's timeline. + operationId: timeline-entries-delete requestBody: content: application/json: schema: - $ref: '#/components/schemas/tags-delete-request' + $ref: '#/components/schemas/timeline-entries-delete-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/tags-delete-response' - description: The response for deleting a tag. + $ref: '#/components/schemas/timeline-entries-delete-response' + description: The response to deleting a timeline entry from an object. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Delete Tag + summary: Delete Timeline Entry tags: - - tags + - timeline-entries x-fern-audiences: - docs - sdks - /tags.get: + x-fern-availability: generally-available + /timeline-entries.get: get: - description: Gets a tag's information. - operationId: tags-get + description: Gets an entry on an object's timeline. + operationId: timeline-entries-get parameters: - - description: The requested tag's ID. + - description: The ID of the timeline entry to get. explode: false in: query name: id required: true schema: type: string - example: TAG-12345 + example: don:core:dvrv-us-1:devo/example:ticket/123:comment/comment-id format: id responses: "200": content: application/json: schema: - $ref: '#/components/schemas/tags-get-response' - description: The response to getting a tag's information. + $ref: '#/components/schemas/timeline-entries-get-response' + description: The request to getting a timeline entry. "400": $ref: '#/components/responses/bad-request' "401": @@ -18645,28 +26468,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Tag + summary: Get Timeline Entry tags: - - tags + - timeline-entries x-fern-audiences: - docs - x-request-name: TagsGetQuery + x-fern-availability: generally-available + x-request-name: TimelineEntriesGetQuery post: - description: Gets a tag's information. - operationId: tags-get-post + description: Gets an entry on an object's timeline. + operationId: timeline-entries-get-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/tags-get-request' + $ref: '#/components/schemas/timeline-entries-get-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/tags-get-response' - description: The response to getting a tag's information. + $ref: '#/components/schemas/timeline-entries-get-response' + description: The request to getting a timeline entry. "400": $ref: '#/components/responses/bad-request' "401": @@ -18681,17 +26505,27 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Tag (POST) + summary: Get Timeline Entry (POST) tags: - - tags + - timeline-entries x-fern-audiences: - docs - sdks - /tags.list: + x-fern-availability: generally-available + /timeline-entries.list: get: - description: Lists the available tags. - operationId: tags-list + description: Lists the timeline entries for an object. + operationId: timeline-entries-list parameters: + - description: The ID of the object to list timeline entries for. + explode: false + in: query + name: object + required: true + schema: + type: string + example: PROD-12345 + format: id - description: | The cursor to resume iteration from. If not provided, then iteration starts from the beginning. @@ -18701,7 +26535,9 @@ paths: schema: type: string format: text - - description: The maximum number of tags to return. The default is '50'. + - description: | + The maximum number of entries to return. If not set, then this + defaults to `50`. explode: false in: query name: limit @@ -18710,180 +26546,185 @@ paths: format: int32 - description: | The iteration mode to use, otherwise if not set, then "after" is - used. - explode: false - in: query - name: mode - schema: - $ref: '#/components/schemas/list-mode' - - description: Filters for tags with the provided names. + used. explode: false in: query - name: name + name: mode schema: - type: array - items: - type: string - format: text - - description: Fields to sort tags by and the direction to sort them. + $ref: '#/components/schemas/list-mode' + - description: | + The visibility of the timeline entries to filter for. Note this is a + strict filter, such that only entries with the exact visibilities + specified will be returned. explode: false in: query - name: sort_by + name: visibility schema: type: array items: - type: string - format: sort-by + $ref: '#/components/schemas/timeline-entry-visibility' responses: "200": content: application/json: schema: - $ref: '#/components/schemas/tags-list-response' - description: The response to listing the tags. + $ref: '#/components/schemas/timeline-entries-list-response' + description: The response to listing timeline entries for an object. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Tags + summary: List Timeline Entries tags: - - tags + - timeline-entries x-fern-audiences: - docs - x-request-name: TagsListQuery + x-fern-availability: generally-available + x-request-name: TimelineEntriesListQuery post: - description: Lists the available tags. - operationId: tags-list-post + description: Lists the timeline entries for an object. + operationId: timeline-entries-list-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/tags-list-request' + $ref: '#/components/schemas/timeline-entries-list-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/tags-list-response' - description: The response to listing the tags. + $ref: '#/components/schemas/timeline-entries-list-response' + description: The response to listing timeline entries for an object. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Tags (POST) + summary: List Timeline Entries (POST) tags: - - tags + - timeline-entries x-fern-audiences: - docs - sdks - /tags.update: + x-fern-availability: generally-available + /timeline-entries.update: post: - description: Updates a tag's information. - operationId: tags-update + description: Updates an entry on an object's timeline. + operationId: timeline-entries-update requestBody: content: application/json: schema: - $ref: '#/components/schemas/tags-update-request' + $ref: '#/components/schemas/timeline-entries-update-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/tags-update-response' - description: The response for updating a tag. + $ref: '#/components/schemas/timeline-entries-update-response' + description: The response to updating a timeline entry. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' + "409": + $ref: '#/components/responses/conflict' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Update Tag + summary: Update Timeline Entry tags: - - tags + - timeline-entries x-fern-audiences: - docs - sdks - /timeline-entries.create: + x-fern-availability: generally-available + /web-crawler-jobs.control: post: - description: Creates a new entry on an object's timeline. - operationId: timeline-entries-create + description: | + Change state of a web crawler job to pause or resume it back to + running. + operationId: web-crawler-jobs-control requestBody: content: application/json: schema: - $ref: '#/components/schemas/timeline-entries-create-request' + $ref: '#/components/schemas/web-crawler-jobs-control-request' required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/timeline-entries-create-response' - description: The response to creating a timeline entry for an object. + $ref: '#/components/schemas/web-crawler-jobs-control-response' + description: The response to resume a web crawler job. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "409": - $ref: '#/components/responses/conflict' + "404": + $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Create Timeline Entry + summary: Control Web Crawler Jobs tags: - - timeline-entries + - web-crawler-job x-fern-audiences: - docs - sdks - /timeline-entries.delete: + x-fern-availability: generally-available + /web-crawler-jobs.create: post: - description: Deletes an entry from an object's timeline. - operationId: timeline-entries-delete + description: | + Creates a web crawler job whose objective is to crawl the provided + URLs/sitemaps and generate corresponding webpages as artifacts. + operationId: create-web-crawler-job requestBody: content: application/json: schema: - $ref: '#/components/schemas/timeline-entries-delete-request' + $ref: '#/components/schemas/web-crawler-jobs-create-request' required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/timeline-entries-delete-response' - description: The response to deleting a timeline entry from an object. + $ref: '#/components/schemas/web-crawler-jobs-create-response' + description: The response to create a web crawler job. "400": $ref: '#/components/responses/bad-request' "401": @@ -18896,33 +26737,33 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Delete Timeline Entry + summary: Create Web Crawler Job tags: - - timeline-entries + - web-crawler-job x-fern-audiences: - docs - sdks - /timeline-entries.get: + x-fern-availability: generally-available + /web-crawler-jobs.get: get: - description: Gets an entry on an object's timeline. - operationId: timeline-entries-get + description: Gets a web crawler job. + operationId: get-web-crawler-job parameters: - - description: The ID of the timeline entry to get. + - description: The ID of the job. explode: false in: query name: id required: true schema: type: string - example: don:core:dvrv-us-1:devo/example:ticket/123:comment/comment-id format: id responses: "200": content: application/json: schema: - $ref: '#/components/schemas/timeline-entries-get-response' - description: The request to getting a timeline entry. + $ref: '#/components/schemas/web-crawler-jobs-get-response' + description: The response to get a web crawler job. "400": $ref: '#/components/responses/bad-request' "401": @@ -18937,28 +26778,29 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Timeline Entry + summary: Get Web Crawler Job tags: - - timeline-entries + - web-crawler-job x-fern-audiences: - docs - x-request-name: TimelineEntriesGetQuery + x-fern-availability: generally-available + x-request-name: GetWebCrawlerJobQuery post: - description: Gets an entry on an object's timeline. - operationId: timeline-entries-get-post + description: Gets a web crawler job. + operationId: get-web-crawler-job-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/timeline-entries-get-request' + $ref: '#/components/schemas/web-crawler-jobs-get-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/timeline-entries-get-response' - description: The request to getting a timeline entry. + $ref: '#/components/schemas/web-crawler-jobs-get-response' + description: The response to get a web crawler job. "400": $ref: '#/components/responses/bad-request' "401": @@ -18973,26 +26815,30 @@ paths: $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Get Timeline Entry (POST) + summary: Get Web Crawler Job (POST) tags: - - timeline-entries + - web-crawler-job x-fern-audiences: - docs - sdks - /timeline-entries.list: + x-fern-availability: generally-available + /web-crawler-jobs.list: get: - description: Lists the timeline entries for an object. - operationId: timeline-entries-list + description: Lists web crawler jobs. + operationId: list-web-crawler-jobs parameters: - - description: The ID of the object to list timeline entries for. + - description: | + Filters for web crawler jobs created by any of the provided users. explode: false in: query - name: object - required: true + name: created_by schema: - type: string - example: PROD-12345 - format: id + type: array + example: + - DEVU-12345 + items: + type: string + format: id - description: | The cursor to resume iteration from. If not provided, then iteration starts from the beginning. @@ -19003,8 +26849,8 @@ paths: type: string format: text - description: | - The maximum number of entries to return. If not set, then this - defaults to `50`. + The maximum number of web crawler jobs to return. The default is + '50'. explode: false in: query name: limit @@ -19019,117 +26865,67 @@ paths: name: mode schema: $ref: '#/components/schemas/list-mode' - - description: | - The visibility of the timeline entries to filter for. Note this is a - strict filter, such that only entries with the exact visibilities - specified will be returned. - explode: false - in: query - name: visibility - schema: - type: array - items: - $ref: '#/components/schemas/timeline-entry-visibility' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/timeline-entries-list-response' - description: The response to listing timeline entries for an object. - "400": - $ref: '#/components/responses/bad-request' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' - "429": - $ref: '#/components/responses/too-many-requests' - "500": - $ref: '#/components/responses/internal-server-error' - "503": - $ref: '#/components/responses/service-unavailable' - summary: List Timeline Entries - tags: - - timeline-entries - x-fern-audiences: - - docs - x-request-name: TimelineEntriesListQuery - post: - description: Lists the timeline entries for an object. - operationId: timeline-entries-list-post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/timeline-entries-list-request' - required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/timeline-entries-list-response' - description: The response to listing timeline entries for an object. + $ref: '#/components/schemas/web-crawler-jobs-list-response' + description: The response to list web crawler jobs. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/not-found' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: List Timeline Entries (POST) + summary: List Web Crawler Jobs tags: - - timeline-entries + - web-crawler-job x-fern-audiences: - docs - - sdks - /timeline-entries.update: + x-fern-availability: generally-available + x-request-name: ListWebCrawlerJobsQuery post: - description: Updates an entry on an object's timeline. - operationId: timeline-entries-update + description: Lists web crawler jobs. + operationId: list-web-crawler-jobs-post requestBody: content: application/json: schema: - $ref: '#/components/schemas/timeline-entries-update-request' + $ref: '#/components/schemas/web-crawler-jobs-list-request' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/timeline-entries-update-response' - description: The response to updating a timeline entry. + $ref: '#/components/schemas/web-crawler-jobs-list-response' + description: The response to list web crawler jobs. "400": $ref: '#/components/responses/bad-request' "401": $ref: '#/components/responses/unauthorized' "403": $ref: '#/components/responses/forbidden' - "409": - $ref: '#/components/responses/conflict' "429": $ref: '#/components/responses/too-many-requests' "500": $ref: '#/components/responses/internal-server-error' "503": $ref: '#/components/responses/service-unavailable' - summary: Update Timeline Entry + summary: List Web Crawler Jobs (POST) tags: - - timeline-entries + - web-crawler-job x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /webhooks.create: post: description: Creates a new webhook target. @@ -19165,6 +26961,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /webhooks.delete: post: description: Deletes the requested webhook. @@ -19202,6 +26999,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /webhooks.event: post: description: | @@ -19241,6 +27039,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /webhooks.get: get: description: Gets the requested webhook's information. @@ -19281,6 +27080,7 @@ paths: - webhooks x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: WebhooksGetQuery post: description: Gets the requested webhook's information. @@ -19318,6 +27118,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /webhooks.list: get: description: Lists the webhooks. @@ -19346,6 +27147,7 @@ paths: - webhooks x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: WebhooksListQuery post: description: Lists the webhooks. @@ -19381,6 +27183,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /webhooks.update: post: description: Updates the requested webhook. @@ -19418,6 +27221,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /works.create: post: description: | @@ -19457,6 +27261,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /works.delete: post: description: Deletes a work item. @@ -19494,6 +27299,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /works.export: get: description: Exports a collection of work items. @@ -19588,6 +27394,17 @@ paths: items: type: string format: id + - description: Filters for work modified by any of these users. + explode: false + in: query + name: modified_by + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id - description: Filters for work owned by any of these users. explode: false in: query @@ -19716,6 +27533,16 @@ paths: items: type: string format: id + - description: | + Filters for tickets that are associated with any of the brands. + explode: false + in: query + name: ticket.brand + schema: + type: array + items: + type: string + format: id - description: Filters for tickets with any of the provided channels. explode: false in: query @@ -19800,6 +27627,17 @@ paths: items: type: string format: text + - description: | + Filters for tickets that are associated with any of the source + channels. + explode: false + in: query + name: ticket.source_channel_v2 + schema: + type: array + items: + type: string + format: id - description: Filters for work of the provided types. explode: false in: query @@ -19832,6 +27670,7 @@ paths: - works x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: WorksExportQuery post: description: Exports a collection of work items. @@ -19867,6 +27706,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /works.get: get: description: Gets a work item's information. @@ -19907,6 +27747,7 @@ paths: - works x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: WorksGetQuery post: description: Gets a work item's information. @@ -19944,6 +27785,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /works.list: get: description: Lists a collection of work items. @@ -20054,6 +27896,17 @@ paths: name: mode schema: $ref: '#/components/schemas/list-mode' + - description: Filters for work modified by any of these users. + explode: false + in: query + name: modified_by + schema: + type: array + example: + - DEVU-12345 + items: + type: string + format: id - description: Filters for work owned by any of these users. explode: false in: query @@ -20076,6 +27929,16 @@ paths: items: type: string format: id + - description: | + Fields to sort the works by and the direction to sort them. + explode: false + in: query + name: sort_by + schema: + type: array + items: + type: string + format: sort-by - description: Filters for records in the provided stage(s) by name. explode: false in: query @@ -20182,6 +28045,16 @@ paths: items: type: string format: id + - description: | + Filters for tickets that are associated with any of the brands. + explode: false + in: query + name: ticket.brand + schema: + type: array + items: + type: string + format: id - description: Filters for tickets with any of the provided channels. explode: false in: query @@ -20266,6 +28139,17 @@ paths: items: type: string format: text + - description: | + Filters for tickets that are associated with any of the source + channels. + explode: false + in: query + name: ticket.source_channel_v2 + schema: + type: array + items: + type: string + format: id - description: Filters for work of the provided types. explode: false in: query @@ -20298,6 +28182,7 @@ paths: - works x-fern-audiences: - docs + x-fern-availability: generally-available x-request-name: WorksListQuery post: description: Lists a collection of work items. @@ -20333,6 +28218,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available /works.update: post: description: Updates a work item's information. @@ -20370,6 +28256,7 @@ paths: x-fern-audiences: - docs - sdks + x-fern-availability: generally-available security: - auth-token: [] servers: @@ -20395,30 +28282,44 @@ tags: name: auth-connections - description: Security token interactions. name: auth-tokens + - description: DevRev chat APIs. + name: chats + - description: Code change interactions. + name: code-changes + - description: DevRev command interactions. + name: commands - description: DevRev conversation interaction. name: conversations - description: Dev organization interactions. name: dev-orgs - description: Dev user interactions. name: dev-users + - description: Directory APIs. + name: directory - description: Manages groups in a Dev organization. name: groups - description: DevRev secrets interactions. name: keyrings - description: DevRev link interactions. name: links + - description: DevRev meetings interaction. + name: meetings - description: DevRev part interactions. name: parts - description: Rev organization interactions. name: rev-orgs - description: Rev user interactions. name: rev-users + - description: Management APIs for availability schedules. + name: schedules - description: Service account interactions. name: service-accounts - description: Management APIs for Service Level Agreements. name: slas - description: DevRev deferred snap-kit-executions. name: snap-kit-execution + - description: SnapWidget APIs. + name: snap-widgets - description: Surveys APIs. name: surveys - description: System user interactions. @@ -20427,6 +28328,8 @@ tags: name: tags - description: APIs to manage timeline entries for objects. name: timeline-entries + - description: Web Crawler Jobs APIs. + name: web-crawler-job - description: Webhook event APIs. name: webhooks - description: DevRev work interactions. diff --git a/fern/fern.config.json b/fern/fern.config.json index 4acba7c5..e31482a3 100644 --- a/fern/fern.config.json +++ b/fern/fern.config.json @@ -1,4 +1,4 @@ { "organization": "devrev", - "version": "0.57.15" -} \ No newline at end of file + "version": "0.61.21" +} From e4bc470b71561e2e7009fa74fdaf951277e96ee6 Mon Sep 17 00:00:00 2001 From: Shivansh Rai Date: Wed, 4 Jun 2025 14:52:20 +0530 Subject: [PATCH 09/22] Point to customization API docs from identity SDK docs (#246) --- fern/docs/pages/sdks/web/user-identity.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/fern/docs/pages/sdks/web/user-identity.mdx b/fern/docs/pages/sdks/web/user-identity.mdx index ed33083c..31fbab11 100644 --- a/fern/docs/pages/sdks/web/user-identity.mdx +++ b/fern/docs/pages/sdks/web/user-identity.mdx @@ -64,7 +64,7 @@ Ensure that you follow the specified format when providing your phone number. ## Pass custom attributes -To create custom attributes, see [Object customization](https://devrev.ai/docs/product/object-customization). +To create custom attributes, see [Object customization](https://developer.devrev.ai/beta/guides/object-customization). You can pass the custom attributes that are created as shown below: ```json @@ -88,14 +88,14 @@ If you prefer a two-level structure, where users are directly associated with an |`display_name` |The name of the user that's shown on the widget. |string | |`phone_numbers` |The mobile number of the customer. |array | -**Attributes for workspaces** +**Attributes for workspaces** |Attributes |Description |Type | |---|---|---| |`workspace_ref` |A unique reference for the user's workspace. If not provided, and an account reference is passed, the user is directly attached to the account. |string | |`display_name` |The name of the workspace that's shown on the widget. |string | -**Attributes for accounts** +**Attributes for accounts** |Attributes |Description |Type | |---|---|---| @@ -104,7 +104,7 @@ If you prefer a two-level structure, where users are directly associated with an |`domains` |The domain names of the accounts that the users belongs to. |array | | `phone_numbers` |The phone number associated with the account. |array | -## Pass the session token +## Pass the session token While initializing the PLuG widget you pass the session token for DevRev to identify this user and thereby make the widget more customized for the user and their context. From aeba548ef7b57ba750201c574a71f4d2e2f916fe Mon Sep 17 00:00:00 2001 From: Brian Byrne Date: Wed, 4 Jun 2025 15:15:39 -0700 Subject: [PATCH 10/22] chore: Include 'Bearer' in authorization header documentation (#247) --- fern/apis/beta/openapi-beta.yaml | 2 +- fern/apis/public/openapi-public.yaml | 2 +- fern/docs/pages/create-accounts.mdx | 26 +++++++++++++------------- fern/docs/pages/custom-objects.mdx | 17 ++++++++--------- fern/docs/pages/customization.mdx | 26 +++++++++++++------------- fern/docs/pages/interact-agent.mdx | 12 ++++++------ fern/docs/pages/timeline-entries.mdx | 12 ++++++------ fern/docs/pages/webhooks.mdx | 3 ++- fern/docs/pages/welcome.mdx | 18 +++++++++--------- 9 files changed, 59 insertions(+), 59 deletions(-) diff --git a/fern/apis/beta/openapi-beta.yaml b/fern/apis/beta/openapi-beta.yaml index 662ef776..c106cd41 100644 --- a/fern/apis/beta/openapi-beta.yaml +++ b/fern/apis/beta/openapi-beta.yaml @@ -27997,7 +27997,7 @@ components: auth-token: type: http description: |- - All the DevRev APIs require a token to authenticate the user. Provide `Authorization: ` as a header to every API request. + All the DevRev APIs require a token to authenticate the user. Provide `Authorization: Bearer ` as a header to every API request. [How do I find my token?](https://devrev.ai/docs/apis/auth) scheme: bearer x-fern-bearer: diff --git a/fern/apis/public/openapi-public.yaml b/fern/apis/public/openapi-public.yaml index 1943f796..a95ee351 100644 --- a/fern/apis/public/openapi-public.yaml +++ b/fern/apis/public/openapi-public.yaml @@ -16021,7 +16021,7 @@ components: auth-token: type: http description: |- - All the DevRev APIs require a token to authenticate the user. Provide `Authorization: ` as a header to every API request. + All the DevRev APIs require a token to authenticate the user. Provide `Authorization: Bearer ` as a header to every API request. [How do I find my token?](https://devrev.ai/docs/apis/auth) scheme: bearer x-fern-bearer: diff --git a/fern/docs/pages/create-accounts.mdx b/fern/docs/pages/create-accounts.mdx index 035e3266..9075e3b5 100644 --- a/fern/docs/pages/create-accounts.mdx +++ b/fern/docs/pages/create-accounts.mdx @@ -19,7 +19,7 @@ flowchart TD acct-create[accounts.create] exist(((Account is existing 'account ID'))) -list[rev-orgs.list with +list[rev-orgs.list with 'account' filter] get[rev-orgs.get with 'account ID'] @@ -52,7 +52,7 @@ The payload to make a request is given below: curl --location 'https://api.devrev.ai/accounts.create' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ - --header 'Authorization: ' \ + --header 'Authorization: Bearer ' \ --data '{ "display_name": "John Doe" }' @@ -126,9 +126,9 @@ The payload to make a request is given below: } ``` -The response contains `"external_ref": "don:identity:dvrv-us-1:devo/:account/",`. The `external_ref` identifies the `devo` ID (Dev organization ID) as `devo/` and the `account` ID as `account/`. +The response contains `"external_ref": "don:identity:dvrv-us-1:devo/:account/",`. The `external_ref` identifies the `devo` ID (Dev organization ID) as `devo/` and the `account` ID as `account/`. -1. Check **Customers > Accounts** in the DevRev app to confirm that that account was created. +1. Check **Customers > Accounts** in the DevRev app to confirm that the account was created. ![account](../img/account.png) @@ -139,19 +139,19 @@ To create a contact associated with the account you created, follow the steps li Get the default rev org created along with the newly created account using the `rev-orgs.list` API: 1. Make a GET/POST request to "https://api.devrev.ai/rev-orgs.list" using cURL with the `account` filter. Use the `external_ref` from the previous response as an `account` filter. - + ```bash curl -X POST https://api.devrev.ai/rev-orgs.list \ - -H "Authorization: " \ + -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{"account": [ "" ] }' ``` - + It returns the following response: - + ```json focus={19} { "rev_orgs": [ @@ -189,26 +189,26 @@ Get the default rev org created along with the newly created account using the ` ] } ``` - + Note the `display_id` (example: `REV-abcd`) of the rev org from the response. - If there is an existing account then you can get the default rev org using the `rev-orgs.get` API: - Make a GET request to "https://api.devrev.ai/rev-orgs.get" using cURL with the `account` filter. - + ```bash curl -G https://api.devrev.ai/rev-orgs.get \ - -H "Authorization: " \ + -H "Authorization: Bearer " \ -d account=ACC-12345 \ ``` - + 2. Make a POST request to "https://api.devrev.ai/rev-users.create" to create a rev-user. In the request, set `rev_org` to the value of the `display_id` from the previous reponse. ```bash curl -X POST https://api.devrev.ai/rev-users.create \ - -H "Authorization: " \ + -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "rev_org": "" diff --git a/fern/docs/pages/custom-objects.mdx b/fern/docs/pages/custom-objects.mdx index 3dfcd699..3321c48b 100644 --- a/fern/docs/pages/custom-objects.mdx +++ b/fern/docs/pages/custom-objects.mdx @@ -29,7 +29,7 @@ All DevRev objects require a schema. First, create a schema for the "Campaign" c curl --location 'https://api.devrev.ai/schemas.custom.set' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "type": "tenant_fragment", "description": "Attributes for Campaign", @@ -79,7 +79,7 @@ Once the schema is created, you can create a custom object of type "Campaign": curl --location 'https://api.devrev.ai/custom-objects.create' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "leaf_type": "campaign", "unique_key": "CAMP-001", @@ -135,7 +135,7 @@ To get a custom object, use the `custom-objects.get` endpoint: curl --location 'https://api.devrev.ai/custom-objects.get' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "id": "don:core:dvrv-us-1:devo/demo:custom_object/campaign/1" }' @@ -149,7 +149,7 @@ To list custom objects, use the `custom-objects.list` endpoint: curl --location 'https://api.devrev.ai/custom-objects.list' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "leaf_type": "campaign", "filter": [ @@ -169,7 +169,7 @@ following example updates the budget of the previously created campaign custom o curl --location 'https://api.devrev.ai/custom-objects.update' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "id": "don:core:dvrv-us-1:devo/demo:custom_object/campaign/1", "custom_fields": { @@ -187,7 +187,7 @@ The following example deletes the previously created campaign custom object: curl --location 'https://api.devrev.ai/custom-objects.delete' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "id": "don:core:dvrv-us-1:devo/demo:custom_object/campaign/1" }' @@ -204,7 +204,7 @@ in the account tenant schema. curl --location 'https://api.devrev.ai/schemas.custom.set' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "type": "tenant_fragment", "description": "Tenant attributes for Account", @@ -234,7 +234,7 @@ campaign custom object with subtype "social_media", you can do so as follows: curl --location 'https://api.devrev.ai/custom-objects.create' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "leaf_type": "campaign", "custom_schema_spec": { @@ -253,4 +253,3 @@ curl --location 'https://api.devrev.ai/custom-objects.create' \ "unique_key": "CAMP-001" }' ``` - diff --git a/fern/docs/pages/customization.mdx b/fern/docs/pages/customization.mdx index 5a0cc709..3e04d467 100644 --- a/fern/docs/pages/customization.mdx +++ b/fern/docs/pages/customization.mdx @@ -61,7 +61,7 @@ Make sure to replace `` with your API token. ```curl curl --location 'https://api.devrev.ai/schemas.custom.set' \ --header 'Content-Type: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "type": "custom_type_fragment", "description": "Attributes for tracking a bug", @@ -105,7 +105,7 @@ _bug_-flavored _issue_ object to track it and assigns a relevant owner. ```curl {11-17} curl --location 'https://api.devrev.ai/works.create' \ --header 'Content-Type: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "type": "issue", "title": "API failure in Prod", @@ -138,7 +138,7 @@ a subtype-specific field. ```curl curl --location 'https://api.devrev.ai/schemas.custom.set' \ --header 'Content-Type: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "type": "tenant_fragment", "description": "Tenant attributes for issues", @@ -160,7 +160,7 @@ Populate the release notes in the issue object created above: ```curl {8-13} curl --location 'https://api.devrev.ai/works.update' \ --header 'Content-Type: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "id": "don:core:dvrv-us-1:devo/test:issue/1", "type": "issue", @@ -239,7 +239,7 @@ to `true` and _impacted_environments_ containing `"Prod"`. ```curl curl --location 'https://api.devrev.ai/works.list' \ --header 'Content-Type: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "type": [ "issue" ], "issue": { @@ -275,7 +275,7 @@ and delete the _regression_ field. ```curl {28-36} curl --location 'https://api.devrev.ai/schemas.custom.set' \ --header 'Content-Type: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "type": "custom_type_fragment", "description": "Attributes for tracking a bug", @@ -359,7 +359,7 @@ _regression_ field is dropped in the response. ```curl {16-18, 21} curl --location 'https://api.devrev.ai/works.get' \ --header 'Content-Type: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "id": "don:core:dvrv-us-1:devo/test:issue/2" }' @@ -414,7 +414,7 @@ organization: ```curl curl --location 'https://api.devrev.ai/schemas.custom.list' \ --header 'Content-Type: application/json' \ ---header 'Authorization: ' +--header 'Authorization: Bearer ' ``` Deprecated fragments aren't listed in the response. @@ -458,7 +458,7 @@ fragment with the following payload: ```curl curl --location 'https://api.devrev.ai/internal/schemas.custom.set' \ --header 'Content-Type: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "type": "tenant_fragment", "leaf_type": "issue", @@ -540,7 +540,7 @@ You want to add a new stage _Needs RCA_ to the _bug_ subtype. ```curl curl --location 'https://api.devrev.ai/stages.custom.create' \ --header 'Content-Type: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "name": "Needs RCA", "state": "closed", @@ -581,7 +581,7 @@ backl --> dev --> rca --> compl ```curl {11} curl --location 'https://api.devrev.ai/stage-diagrams.create' \ --header 'Content-Type: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "leaf_type": "issue", "subtype": "bug", @@ -629,7 +629,7 @@ The stage diagram created above can be referenced in the _bug_ subtype as follow ```curl {9} curl --location 'https://api.devrev.ai/schemas.custom.set' \ --header 'Content-Type: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "type": "custom_type_fragment", "leaf_type": "issue", @@ -654,7 +654,7 @@ _completed_ stage by adding a dependent field constraint. ```curl {12-22} curl --location 'https://api.devrev.ai/schemas.custom.set' \ --header 'Content-Type: application/json' \ ---header 'Authorization: ' \ +--header 'Authorization: Bearer ' \ --data '{ "type": "custom_type_fragment", "leaf_type": "issue", diff --git a/fern/docs/pages/interact-agent.mdx b/fern/docs/pages/interact-agent.mdx index afa36d95..da4b68f4 100644 --- a/fern/docs/pages/interact-agent.mdx +++ b/fern/docs/pages/interact-agent.mdx @@ -7,7 +7,7 @@ The DevRev async API enables you to execute agents without any execution timeout - Ability to handle long-running agent tasks. - In any unlikely and unforeseen circumstances, if an individual operation of the workflow times out, you do not receive an error event right now to notify that you should not wait for any more messages. It is better to have a client side timeout for now while the issue is brainstormed and fixed for you. + In any unlikely and unforeseen circumstances, if an individual operation of the workflow times out, you do not receive an error event right now to notify that you should not wait for any more messages. It is better to have a client side timeout for now while the issue is brainstormed and fixed for you. ## Set up webhook @@ -18,7 +18,7 @@ Before using the async API, you need to create a webhook to receive agent execut ```bash curl --location 'https://api.devrev.ai/internal/webhooks.create' \ --header 'Content-Type: application/json' \ - --header 'Authorization: ' \ + --header 'Authorization: Bearer ' \ --data '{ "url": "https://your-application.com/webhook-endpoint", "event_types": ["ai_agent_response"], @@ -86,7 +86,7 @@ You should follow the documentation provided for webhooks [here](https://develop curl --location 'https://api.devrev.ai/internal/ai-agents.events.execute-async' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ - --header 'Authorization: ' \ + --header 'Authorization: Bearer ' \ --data '{ "agent": "don:core:dvrv-us-1:devo/0:ai_agent/1", "event": { @@ -131,7 +131,7 @@ You should follow the documentation provided for webhooks [here](https://develop } }) }); - + return await response.json(); }; ``` @@ -276,7 +276,7 @@ function handleUserMessage(message) { method: "POST", headers: { "Content-Type": "application/json", - Authorization: "YOUR_API_KEY", + Authorization: Bearer "YOUR_API_KEY", }, body: JSON.stringify({ agent: "your_agent_id", @@ -342,7 +342,7 @@ If you're using DevRev workflows: Agent node. -1. Add the "Talk To Agent" node to your workflow +1. Add the "Talk To Agent" node to your workflow 2. Configure it with your agent ID 3. Connect it to response nodes to process the agent's output 4. The async API is used automatically by the workflow engine diff --git a/fern/docs/pages/timeline-entries.mdx b/fern/docs/pages/timeline-entries.mdx index 1efe60f9..cf3cb893 100644 --- a/fern/docs/pages/timeline-entries.mdx +++ b/fern/docs/pages/timeline-entries.mdx @@ -9,7 +9,7 @@ You can use this to send any information about a customer like their last logged To send a restricted visibility message, follow the steps listed below: -The payload to make a request would look like given below: +The payload to make a request would look like given below: ```json {4-6} @@ -20,12 +20,12 @@ The payload to make a request would look like given below: "private_to": [], "type": "timeline_comment" } -``` +``` * `object` must be of type string and contains ``, ``, and ``. * `body` is of type string and contains the actual message to be posted. -* `visibility` is set to `private` in order for the message to be visible only to users, `internal` is visible with the Dev organization, `external` is visible to the Dev organzation and customers, and `public` is visible to all. +* `visibility` is set to `private` in order for the message to be visible only to users, `internal` is visible with the Dev organization, `external` is visible to the Dev organzation and customers, and `public` is visible to all. * `type` should be `timeline_comment`. 1. Get the [object ID](/api-reference/getting-started) and object type where you want to send a message. @@ -44,15 +44,15 @@ In this example, you are using curl to make the requests but you can use any too ```bash -curl -X POST -H "Content-Type: application/json" -d +curl -X POST -H "Content-Type: application/json" -d '{ "object": "don:core::devo/:/", "body": "message", "visibility": "private", "type": "timeline_comment" -}' +}' 'https://api.devrev.ai/timeline-entries.create' \ ---header 'Authorization: ' +--header 'Authorization: Bearer ' ``` diff --git a/fern/docs/pages/webhooks.mdx b/fern/docs/pages/webhooks.mdx index b494893e..14d17443 100644 --- a/fern/docs/pages/webhooks.mdx +++ b/fern/docs/pages/webhooks.mdx @@ -98,7 +98,8 @@ You can start receiving event notifications using the following steps: ### Webhook create request `[bash]` ```bash -curl --request POST 'https://api.devrev.ai/webhooks.create' --header "Authorization:token" +curl --request POST 'https://api.devrev.ai/webhooks.create' + --header "Authorization: Bearer " --header 'Content-Type: application/json' --data-raw '{ "event_types": ["work_created", "work_deleted"], diff --git a/fern/docs/pages/welcome.mdx b/fern/docs/pages/welcome.mdx index 8bb32764..1cd7642b 100644 --- a/fern/docs/pages/welcome.mdx +++ b/fern/docs/pages/welcome.mdx @@ -11,17 +11,17 @@ You can also refer to our [Postman collection](https://postman.devrev.ai/). ``` -You can use the DevRev API in test a demo organization which doesn’t affect your live data or interact with your real customers. +You can use the DevRev API in test a demo organization which doesn’t affect your live data or interact with your real customers. To create a new organization in DevRev: -1. Click on your profile picture on the top left corner. +1. Click on your profile picture on the top left corner. 2. Go to the **Orgs** section and click on **+**. 3. Fill in the details and click **Create**. Now you can find your newly created org in **Orgs**. -Login into your demo org and [obtain the PAT token](/about/authentication#generate-a-personal-access-token-pat). +Login into your demo org and [obtain the PAT token](/about/authentication#generate-a-personal-access-token-pat). Now you can use this PAT token to make test API calls and try building something new. In this tutorial, you will be able to retrive your account information by using the `dev-users` API. Let's get started with DevRev APIs. @@ -30,11 +30,11 @@ In this tutorial, you will be able to retrive your account information by using First, create a DevRev account or log in. -Every call to a DevRev API must include a PAT. After you create your account, [generate a personal access token](/about/authentication) and store it in a safe place. +Every call to a DevRev API must include a PAT. After you create your account, [generate a personal access token](/about/authentication) and store it in a safe place. In this guide, you’ll make a call to the [`dev-users.self`](/api-reference/dev-users/self) API which gets the authenticated user's information. You will retrieve the user object created for your account on DevRev. This user object contains information such as a unique identifier, full name, display name, and profile picture. -Every object in DevRev is uniquely identified by an `id` known as DevRev Object Notation (DON). DON `id` can be found in the API response. +Every object in DevRev is uniquely identified by an `id` known as DevRev Object Notation (DON). DON `id` can be found in the API response. The value `SELF` can be passed in as `id` to reference the logged-in user. The `display-id` shown in the UI for [work item](https://docs.devrev.ai/product/core#work) objects such as issues and tickets can be used interchangeably with the `id` to enhance usability. In the image below, `ISS-69` serves as an example of a `display-id` for issues. @@ -45,17 +45,17 @@ Next, you'll want to set up your development environment to connect and interact ## Send your first API request -To do this, make a GET request to the DevRev server ("https://api.devrev.ai/dev-users.self") and include the PAT created in the authorization header of the request. +To do this, make a GET request to the DevRev server ("https://api.devrev.ai/dev-users.self") and include the PAT created in the authorization header of the request. This guide shows you how to get user information with a GET request using two popular languages as well as cURL: -### Making a GET request +### Making a GET request ```bash curl --location --request GET 'https://api.devrev.ai/dev-users.self' \ - --header 'Authorization: ' + --header 'Authorization: Bearer ' ``` @@ -123,7 +123,7 @@ If everything works, the command line displays the following response for a user -The response contains `"id": "don:identity:dvrv-us-1:devo/20:devu/40",`. The `id` identifies the `devo` ID (Dev organization ID) as `devo/` and the `devu` ID (Dev user ID) as `devu/`. +The response contains `"id": "don:identity:dvrv-us-1:devo/20:devu/40",`. The `id` identifies the `devo` ID (Dev organization ID) as `devo/` and the `devu` ID (Dev user ID) as `devu/`. In the present response, `devo/` is 20, and `devu/` is 40, respectively. In general, you can find devo, devu, revo, revu IDs in the `id` or `external_ref` fields of the API response. From c6c9488b925ab69081c63a2c10c6f6f06c1989e9 Mon Sep 17 00:00:00 2001 From: Shivansh Rai Date: Thu, 5 Jun 2025 12:16:18 +0530 Subject: [PATCH 11/22] Document `unit` and `is_read_only` customization UI hints (#248) - Use imperative tense in headings. This has been done in the custom objects documentation. - Use smaller image for group_name UI hint. --- .../img/customization-group_name-ui-hint.png | Bin 35276 -> 15512 bytes fern/docs/img/customization-unit-ui-hint.png | Bin 0 -> 8909 bytes fern/docs/pages/customization.mdx | 16 +++++++++++----- 3 files changed, 11 insertions(+), 5 deletions(-) create mode 100644 fern/docs/img/customization-unit-ui-hint.png diff --git a/fern/docs/img/customization-group_name-ui-hint.png b/fern/docs/img/customization-group_name-ui-hint.png index d64c6fb888c25da5a3c7c86b1fe3e3e719cd4d5e..7ffac4d94c35ee4d1840024ed20d6550c551f0b9 100644 GIT binary patch literal 15512 zcmdtJ1yCi;wl0V^?(Pl^H16*1?rx1k;~RJP#@!v7#@(fHcc*c8XzXqNbIv{gow@hD z7ZdR!W@ZOP)vnByS-CQ6)wjN{cDSOv1OhBBEC>h)f|R7FG6)DLa05Aj{sjClTeOh{ z0s>oaDI%gMB_cws_|4wj(#8w~L^3=n1xhth3v+1mp(qpr%zuhxP7&e=A`TS*LNU`L zE-4I6F({~rf)U??f)7VSnj3Ri8WvEX+#eEVY=o?M%1s;?(29sD3Th^>g>3FRd7jzwV)q331mX<$~kG5SOnXftZ2W}b*mL8W-Zc~+iO1SC5-63`sxq8H`c2z zj}gN6OG(XiGny8WxZO*PTpMylqG1M2{0I|B5*U#B**%Q2U-aBR?f|gj^bC2@-85{G zKMsh)kwwJBPLWF68nvy5v>9e?ef;77MODIF1(y)COW z2j*c*z1>sC#edzbib*LDDTu$t*H+W@LO3(?{>>Fd=gmf3Sv2>Bu(|FIuD?=i{1)58 z*2}+U(?-6K*C1h=Zc`>n(S8T|Lv?U=(;9nSD5*Yg(%pU_`x#1rt~23t_VaYzIX zegqC6jopyM^XAa%X0n8X7A>X?s^qdGxpi?dXj99^*?0J@Sh3JFPC5MmNvzx**a6X}Twx{0Qqk||4Tx%fG~#Nx zT`OkNXK-?w78MQ`A1)A>+!ge3BvdDG;$a7nsQ~Pho)Q(F>m#p8353)1R{fn zhF_SfvDqmu=c=cGT7VL{HR&;J4Ox%h_7WS(jp&!+l?F#pb`l=uxARsRw zvR4=~UN}ZLyq7u{54Ho=K#GPOE&<7sNlJW0np@h6l#kS#Jn>htDZ@8>uE6#rU8zoK zANjX@Nws=)Q`&2cMcQQQ1!`C7P8HJ6X`gGqC)1cwW6)+PwHDka3+JXPdwtd&;g-hP z!`}ln(@ZP3slYGKEN&NjYQC1+1I5UUD2vE}HK0(~iyKi(;-`tQ61~g2F2ySgEn6&o zE!R{Fq0wQ}YEZl@v}!w!OOHqo)c(Fg)4<#iX~oBiKK^~MxM-$vT7LF?R(#%NUh5d_ zZv1%uSnrq&cLi4;7c3eq8aLW5T1l?8ILACq> z{*C^1^iR!^l`|$^lD@Eg9um$WHU#c4JR)vAUK9>9JQ;!$f;D^&4oY;Yc({05RC;ts z)Lrxeo&}x;jsQDJDx+M2?0sr|dQ>X2Y=Im{+Cl~*BP+IzIA%e_)m)U#zGY)?W$$S= z*FvUcwsGfVdmmV%L%rnB&vnfvFgn~?5nmp(TqkEV|pRtr0ls9QZUj)=M>T+1&K253mojFE&o!2WABmOjeJbXY(y@Z2EL~ z2flhj$w2w{`GkhXs17~FWZ-8Iba8R--K^0pB1W||{C&)Q1gxmYrcpo& z9KC^FmM)8~LfhMs`Cjsl>zb`0p-Hyk#wQzYz`lQ7lF4W8zY;c zJ*xdtU!q;Vc1-J6C0eE12K$Ech4uvskw#7fzg*|%O^{8nO;-VoF3B$Cu7kIbH{o}h z_dJjxKQ>S~|J3fSZUTR#rB)llwgf)(-}v?Hr4*^?_=LK+FQomXqPR1hMA<~Fz6UQQ zaI%!7cts2;H3hKBxdq%DUJ|u%7=63C|MF;iBHCFhrf)z{A9M; zOH&)E=&x8&*QwlS|D%@dyTD*QW$kXAUWf3L!}OurtctH0Q9I>FwMWPFpZ2>~E>Nx^ zc4Ur1n@74u%BIf`vxA4x(H^ZHTpr#65HE^JHK`2azCV81&iWHg3q<(XY}#~rTDJ~cA2t_mW3#m@0Uk}hxTREb>(Br#7)HJxNpso<8jN<$?EDo>B~SOzy4;1z|1@L#iXZ{ zkJgLyyV{=LdUvqUdr!<_r2a!!d^?V3#yirU@AobiPq%x88iCai&_ zyVDAYIq9KXeUkzu-h_D6kNHn~OB(x&3)6?w8YZ+uj=L0_V_j@MNN;b>q_)Pwy-D9n z#6i(_9E?dph+@D5V<7!jKtUX*Z@u`;rfz)$sKMUDODry_oxnii!IZ*6JwO#>IKdr@ z@Ig3-akn82Jw00{$9h$qo(q-aL8h*T*}40ludD-c}~0dOzn-$=-q7{ zK1@J(-MN8>wr0*o#O}5>c23;xe58NX;07LloMs>;{;P_!H6N*_oFcJ^{WmjWc6vs7 zMpAxQVq#+6Z>Hwl%A(@`GzWg;BmL^^?7+>y;O6E=@5VxJ|ILDdiHnPifsvVknVAk) zgU-pr&e_PF&d!PKAC3I09Z@qUlW&#|&X)Fe#2@V%8QZ%!^O2H%bo3vee_W@TyXC)o zvUB?9uz&+(_$XmuqGx3IkG6rPydP(|6)oM(Y_vozZGr9q_QB80!o>Sm{r_9ZzkB?f zrRKjaSy(v#Zuz&8|Er~%li4>Bds|?a&iwzLnSUDpz3`ugybK>B|C=ZN;pV^20{zSn z%ggW|bH)#gET};Q0>YppB`T!q4tkaaqpNz*^6nc3oqxI$;5WPvW~J*OwQhpymYB+( z{&jZ0*fO2{sPp%|?<|F7hQh_!D|wTpwd=U?`h%!Rz9SZ-7zDbipw=1)=rYGs*W@&g zMF@_$A$A~Fm&Q}3)5c!f!)rE6mq*G$=I%lz7`CJz1n_S~E?1^a<|i>s90*LDpSYj! z2%P`N`Al*_5*JkB$VA|2kl^o&A3GRMDL>(3azRWgP*h@2Sn8UO9jZeDNbsDL-xql> zazQY3Wqokqj(m$86t*l8L@V>7t!_n7Wn!7tB?c-U-KJ0s4E!B;sf?C?Hq}4gM#1ymydE&_WJ8SU zTtaVnJb06h&&?&KGP`_YW~qyE)M>Pv-6^lAXlVAhAsWoE?+AQ<%XuFto!(`%zW1us zZ5c`3{6=MPm(XOl>}T)m8E%FeD+Tmkt_X~?%bd2h_9ycRFOZFm4RbM4QqmvhcSD2C zqZ-v)aj5f72S01wubLPEV_(tH(P@M{VPBs^w>Y}qf>Fn0U*3=y3L-P`vH{0DrDbJ8 zuJVYc=kv%wFEljcaoF*93p~6)w!hxDg~h}S-U$2wbv@e%H0XNNxjmo7V>!>T`)t0} z`MS`xReXA}>f4PyMDW+_LxP3|-A14e?IalY4~pWQ#3d%e;hf|3`duMf6p2xI3PNmyRYuB(ygOW|tKuX-u!pH5lK1^DRxpEG_(F ziRp@U=W!_;7#KW0Ka;7n@Z$6qz!CNQLi;5tClwG|6PqUKdSqafg2r)wl`8=(b&04#WzX(X|#Fk_-l3TCt4k;K; zZKlv_XI-fpQFx;rX(F!}#rv)eC+u(IjCAMX0@9$oNN?8}=l`o8IAxa9D- zB{$~Y*5$mzQYHCS>(|Lw9sBwPmut|HP;$c(>hWD>r(b*@$g5iA?@4E~)>#_mcKY;w zH*?{5`xW)=@j55|duEh}lSR|;5cJ0!Hzz{ir;{bY28Y}aHPYc-^~U;!5WO8jnh=!8 zWd#VlADP)s%wSvAq7h+*`o6rnyzI?)8Q-r#YAZNz_l921_`a4T&yJ45)x7OtyqrHU z>|RlIR>9n$DSQd}qMQ~&p}XZhvv(mpV_Eo~O zQqtCr=#9ieVKM{(Y~UvIXt%ew>*|F4%#=vF=CE5++yJFGB*0(m)qS~Ca^JZcaKGZ{ zn#+9eXm6#xahdwGz z#Y3!66cT8GO4z>s9-1WMpSTZ5E^tka{a7sA>4I$`_XK({D`dd%=iip**H>}x=0v9D z_Sfw|0gQXJM>FieU`h|IDCy#uzAOnW&_KkY*|4e(3jjeplN7#x3`80^?{R-VP&$3&;}CV!E;K=V-jFlQGQ>(xST9hCC(q8 zC=qPaco86=D@#Z*5y3b!gZ<>5^iW#NMBiS)ynuo&vz`F2N&q@G4Cq)1sth>_pkopI z5z%IBS09LX=eReb6JGe4PMF4G2@$ZSuG3bTZ4R5=3zUMlxL z({;p%gsRNBIp@yb`gS(Jj$=~W9Y3~MU~bP8k!EtH1?L4;`F6=gvazxoU-XcR!bAIq zhPwRX_T5Gu85w0FZqKn)+U*Q`dkY+jbLs>^8t*`Q6#?MQavKi;s%$h7k&t@w?I+k} z5TGyT?aKbFM^2^>v|StSChKuJ9AbyS$IJxHCFO{%l3%)zD5`pmFI7~OmIlNsAf<4e zZF|h3%+wTp4fo?F%_mUmsawYSVgJq)h0TxMasbEEYYK;Fi>iF3Raf-8ri{?~WeR&N zm0jpL?j>M!spSOur_(k1u%T>rs^9iiEgcOp%5`L&<)|GSn*%1{$k|q&$86<3i)gYg zZJ$DpuW}nW2_4-i@;Dt#oFFa4&xuTlsAHoK+@Nws6&1s>k9lwdUhbBbs1inRH2~;s zHX3B@lNZ{?ATP=kc2t59etwv?!I@cUO+wi#o8?O7v5u%coc`^cIX*Ef-WZQU((Lvk zIWLvSZ!;QKU5qk2=g_5n$66$^XHJ#_TqpcQ>Apk(V6P6hOTUr_xrvMW_9Y`DM-{cS zs?^F}02CVldpavCtINw59B6p>?(10gayysKd77HdTS!Dg{+LIjT5JJ!!i*;G@aqWJ z3J;2Ffo$E>+pGgOk4*M7dKr|Nz3F*g7X)V`6J#=rZ+;_ zEZ$E~!5WT?OarNQt%(&O2h5}dm{`$Vb(EVgMqkaU+4bc(BEnjk>&qmx-LGhpJL*OX z`R&~AkA`Gp?9V9)`TPfqDS2<^n(Da}(?mM7RinJ2V#%0$z35c{1>q9PjAk>M6s-@I zpFRzVZ`b&GmIUjG1ZCV2QHwA)0b?pA#Pv0UNVdZq4<|Hf`JGEc9AtW@H^6e}sASS; z;T3Hj-y}?(SrKM3B9;TM$~3zLL_k1*?I(WKz}*o+(Dk)+CZ7fU@E}-|DQh{}JpM<9qL8bn#m^XN4lIhp8un-^9S6fC-0`r#x+hsn12bZsnM$asz!Y4C8{FN)DqGOYAP*eW>_tA)PzN?GYCNogI%#ptjr=+b z+YWTllasH}Zvw|+(3{6UG4OD~VgKAjF-ko7ipNY2%hSmjMkYlS??Q<+DzH|1PU0Fq zsN=&ME45{tjB4y9atW3vUwq1X_4~)s>Y*FaL!j92^&ZF#Ci9BZ9 zWl_Y_Sg;0=?~dF$Xj)ezzlJ%jW!=mrj!8ElJdwzETmN`nNeE=8hr4Om`~Y-46VE53 z@9`0@kg9-{jcls%!gP*op*FxGorO~6X!=#!(om6SXlth^zJJX z$7iT#g$4sk$MDkfKgat#mFfxcM;CebM-nvst#6hm@0jip2-d6BT?q!1}^KNRUgxTLtO86#wWKs)$C9~DKxE}Qanq|E4+66$ z2FxYhrhgf$Np*kstE3u+0Lu&sEBogYYO~@ zk3UoIlljYw3u0QF%=Jw#)1ED%k@4<@E7@wj6vw%qa^40zQqNp@(Tb%PXuK+}1{|gLG~{Z8xdBUS-1lMjZ43 zkJr0%>YJ*tM~m;cMsO~If|;{>A($Rmo;vzumEf$1Y)Y8Prt+#GH#4*L)IxpCalaUZ$$t-POb`2(%r889_>NCzh5 zmO-q*r%A3GFyrnp0JRYSn$CVC+GK?vNqYy-^7s|j@EMr1WKsfsgG=&}j2~tJ5!8hS z$f^P`gJ%UI*;!~yppOMFfR=zRuq7X$X$kNGvcx4nvU~uQAj$kQM)y7NGCAdd)Bvk6 zE)Y^p@%UE*pnzw)7yUtqPS=<$YCDkJ_XD$dLIkRSlPfOhIWHLvn3v>0x{HACwCYbo zGxFLC13YE5H~pH{hyk{rH}RAF5(5nxrK+k*B$jZ)OG5=J8?I00vb~*`099oo-j&!Z zoz$O4N-*T+dWI+B>ySzc7BuXl)%+~h#64K>93e?@q97FoF+kuSqkO(^>pOS(Z#uG7<|K8&Q5me*Qi1oSf9-1i&f}0xDmB5VsGP=y;`Z!U%_SWCRCfFIXr_YD<=g3%*FBV=ko%rEq4?y1BpzXwMz3p%djeT;ryGRQ z_hyTJ!!K|9HVqNKem!7zV+(;bL09V55fqu3J#Mo^o-s>F@dPfFIzT`^X^rb>0|-J9 zOG+;e1uKr;y{s|P>6F*zuAC;n^cKm8aXK=?i9j{I_~@W3Me;>2c{0MFfD3PJ8|nR= zFlY|?dHoF@`ocm>mxtf!o)@va6#xL_6&K@r|GDjrIzro;7Xlb{sH<0i1%-wh#-q~C zA|r1_((AQuxiRot<$|0n;AL+X(CMz_!z|0{7I}QtL{JazceWZ4=oD(ELd^r+(%D`Kk2)%UD z6nIzskS9JF^XM-nG}qH3V4nBsJ>)bIcjOkx1=w(L1s~?Cms3UInai@AqND2zDUVR2 zVOlT=l$X5Kt;x^P1|S;#SA@}+0S)Gd3YPl<^KZEakUsZq)O`9UYrnl3J@ z()Vh`*1>4%fWBt)J27E~7PAK(C5f2!Dv!iF&S1$AFm2>iI51#VT3NY3qwUjyYTwbM z?viKyH>@hWr3H7w;hopIK7=Ch1#@?3(B!6(K}lc9h^_+D?c&js(Pie$0QJeG!?{J$ zC1+~k)k zqK=ArfN6xo))W(bWaMC`R-*kIV?DFRs*Idmzqmwdx?uLPbMS4$1~u#G;g(PapfDJ# z#(0^hLRPkId%1*&g{!kA!~GTlHzWOWOl5OsU(gKk&Pu5^eU>+7IE=CGWd=`n zw5B5X%hau!Q}DM;pFjBK>jKkDI56; znp1k1L!wGf8ZF(9 zRS2^laC>SuTy85PEzQJBKZt!$>|9!7rC@7Y#Wb-n0R)ng()?w2<$OGs)jxo@qN?lB zjz{D1*QlDVz2Yr<(vU=|ST(A_)zqOMvxOkihvoZpvLYI8&uXhzPd@lk(gU-b-ss?S z3{|frP6u)6RmI4nfVqZ0US=={hd2u9z}TWU-6d0duWUW?xmoXm6T}d+Mu; zuZo|=28xzio{@_c2ufc4Qj59T>Za|?dgE`Jbxu)3n zgh6B{oPFH^4|h`HtswTbFqB5fE)w01R0J9xTF_A{d|Pok3&b`B%hbo_RRF+n3+${ivzkMSe1 zu14Z)#p2l%{{BGiTareKQD3qi9luca1Ba<3x~rF?;vKyL>4_|TvTw6eRps)6yW@*N z-MPxGx)a&?xt*jGU)5`ttiWt9KiLOBD8#}=V-rM^Ia(Udxuqma$~FCOarCs<{}e}C zJEiPoJM*%kT~sd_-tj*OmD5p=cnaDL##8&N?p@GiLo^0B?=*V1D$oI*X*O>=)L6T$?aoortvc}4|_cS@OzPA(kV$?b1#MKZXBw+xUUQYm_%>^oi9$KMNoVNP%sLuSbQ z6Y?qaoD+3ZBQ3z;)`j@2s)j66Zw5$)I{XLz-q^5|3K}AJuz*==g`BO&tVUIOg4eqI zcH1b2@?y8H%gkfBq8ob8BSD8>PQwC3+;M^jK%wX?^B}l^6i5_D0x8dn{KSFs1V3s} zErmD?yHATK$el5j7mAX4ZirvgAatd>MPMwwy*p$CL@ow{|1~_7?XCH9C%k7CyXv7!;SY*R7zC7K{*)?9cD*fr(kTT8+sUNos2}E8 zBJlA3ff!d`5&rWBxl=x~Eh(SRe-M#Cn9B~$N#DW_&zSx}|Ng%VXagboMh!?~4v?a- z1S0(sl$rm}0YOtnA9kDx2GWu6&j>ubdW^e_4s091F0+zB&zD_t~A&e4DTRBzU{Eq>fTYA zr?NI1&4>o4E79-IT^!tMd|DrxXIl=isXu>Cd?gGOiIZPX5TbC|P%&vS(SzS$Ru;@AX0y}t^)M=BKz87-VXX|{YzV(QwHe>m5F zoM-S2nJ$p%86QU=lh_FC3H(Gt$G6T*`6eNBI4X~bnA-2URS=8R&Tdjrq23(XDyUGnP<0z47_*k5Em2#hl}sMCP;z-b`TTCD9V zznIasSe>p!48E9_7S2uxB3mQ}Us!Cc#6nt~d439j8R5;UhlckHJRjhG?&qkpKZ&MK zOh1tVmyzT`<4|l)cdk&axnnWZ``d%n%Y}8#?%m>B$n$xId3yf`S&Dkd2!;rEq~LoE zw$|2avRx2sbdzjrb;kovIKN}kUL8OiXZQQ?RA_zLDdP?qTN?YQ;C=SvR~=zOstr=T*~ zSX-vMmI`X-e%&8|3q!M%$&;n}dvF48 zIQ>b#kcclXhuZYqhtlTnt2LtClh2W6!~Z7p@n(lS+SkN5T>h&1dh}o{22$g05Q=Xcp?e{$ zo~zf_-)u=nz7eX8tT#J~ctCy6b#rilV<9cvnYrDu_bKCg_w;blfRpDCYZfyX|4Ym! zAm5rQ?=bTQ0|O)WJ%ia9wxKw zuD*UYVmS3LH*}8`5`P|9AWt?w-+-=!<&Z)|@#L70-T9v=uYU@$|20k4tK4L_&TV z>9C&v)M4MW|E|M^1kGGWsGnh9I|5hQ6gwDK%hP9S>L#sHU*9|TwmsxT(@4Mi?f1}s`c>lLD z+wi}^kTvYSLd6|!d#wR~ie8au;v(I$2eMmW4HdqqU zD>(h)!DOF@C#^PSW==SrImNssptR-Q4|FP~Y~pu{V{$yrQRww(dcza7u(_B1JgnAh zikOhy6Uqwr`yso#Yo=7*VA1DQw&R2MKBr-_onz^@2kZCE*Mk#2iEWwXngO-C$VZokN|F^K|4My%TF zjKTSJTOhk0f4S*BP1nnTxzYLO?^qA&>xqeBczFSu+v$)dGh*U=I&{2Zpi9X}SMm*c zNPmX}+w$BS-Ge70W3Fh_#d*B|GeIBdO&>2io-d7GW++K8avI)9=<>pr7gb}~e7?e) z%Vy+yOZ)Vgovyh+FLQaonle%<$aY^oE+w-mGW}h~UH_MiJ5r_de)YRR+|$R0KP(2m zPl=778+b<>W(h8&-GnLejkUINo0h)@O*;-o?Kt}g-qAaKgPj(uQdPj_7)v!@qW;_- zQ21TtGd+#a*LVJOIuUK1CZMG5cpzJbJh_uRF zSYg@E%C=UcJ_{%E2?#O7`Kt;u@Ceg+)@|xn+T4hhl@-c1ELql6TkG=vA?em<=c$(d zmx}H`Su+2?&{#4b%`bzo(L?*T2Knvzz1r$@^u~g|1z{V_)0N9|{Mr8Yve;&I@Mw~P zlMtee6XpkG+%)J)(z10E`iy;!pRXXkO&aw7mLh8)vHu%IRu1L%|3ugI>;!>AB{+iQVT)yPD?}go>1-Wr(BJ+vxs6?G@jRLi z>7Ty55YM4g?~kWP;LKh$Bu6`v=X!#9Jf)B*upblP7vA+ApIDK=v3ft>&cw_r=V(YJ~~Mo+zFbD1>9tbh3w?r~>S z^elOjsUXB?E!BPW%Nf62Vq9xmTg9`2+`gKPbNC)sf%dpg_3CX)t#ON09u0BsjJwTJ zi*pO~c)14Gl4-AYF_PE3!@B+ljS>&uM_dtUa4yrER8iz^JdN);0L(mF$sD+8@m~LY zDuZ%dJB7SILJN}J!ypsZ)>h98nUynlO50fP*gDv?{_R{|Ins+3QW-3%6F?k+Rxzbozh~Bqr9OcN&dQq{W zqN8ISRo94yvOyH)t016qQ;a0vnA|Y#2vobvPG<&gPJJZ*C(7}<&phzm zlKF`IuEw96B3X}eR?>zGfr-eaKsf*iYwb{xoAPYtm*a^0EM^%!cCab(qepJUo;o$h zSkgDx<_p)w_UyFL&-KQ->deEN5RD6#`LS@1XkX2bcEW1}M@)P%WJ z7UA&}*Pyuc(bg-I%vBsFFXZZqUq|yNu3I}r73n6gv^Dg7A#`op*vSX42so(01P1v1 z@r8-Q+=-EUM0TnV$g2yFmp?ism1%Ezz7v&=t(uoJ<0ToC$Nnjb5B~h=uNQ^>#kb*n z8vWqg$ma7Caph&~>AxA4YWGP_V@6niZ=3puZXNwE-8xSfNz8PBmWph*l4(7Spe)iI z?UXMr>O^{}AN1YbigH7ZK6>HYiKuWTA-^3;RL4}BSna7Tg37-Nc}=F6>1R@kVBH3Xs`eIYMY0ft-d;$S%4FSE zcm9oc2XOVOS5@oGe^PGPDU7mAzj?B-UiDsjf%U)x#1hMJv^HH&oO_1lxz}~V3H;KZfDJP zN>&x-&-+uEg??>RFt8W4SW+#&ld!F8s^1!Fi=`HSTxR{2Dt@eWQXnLX(Mj~NrA4Xx z6kW$)d_tW<18uqI0q_Y1Nrfy|jdMi=wndTaq4Z}d6`%E+{nAI?)Htf;{=0On%f zfNW0+**;X9pEdL_AfVELr8&m$(#2FLLio7VNpO^WOBsw%T5^xz6uz2_*em$&x@TC4 zbQYkK(zB?VOQ^S@y1IuXmiXT+TNqyKe`eW6$ap@?AO7{GpkF(8L2IkJ=TJvGe={4= zl>El`nsxwbE^}r|cIS&E*Rj1c$?J#$0j(g|1RC;zb4#AsMvvWDqx6A*5D})Sk<`AZ z*-C$WcBwyX@SI?P&POKpl?wDZ@ZA;Hoay7+6daHo(w|^ml>&~G`D3JcMMl7a4rHKe vy(e3j1xx_w$$+Xgjy5hZQTXqxKfZ5+4*6T+%u|2-TtZ4rUbI@+FyMaxuh#uB literal 35276 zcmeFZRa9I{)Gpd|8cPC!kU(&U5Zv7%xCeK4cZUchxVr{-cTEWH?(XhxXAzRU_qpec zaUbr(efb$R;aN_XQ?!)0U5 z@w{i>jcs2I{rMb}*Ia9~=&`f}=!h7)v^oSdmLBl|H3xP<>-oSF3YsA55HVI-T4Yev z;@SS{DT3GA>AWD(0?)Ji@$ba1I-x;$v`B_@}xtc?Kfyt7ATPYh>@=O zcjA+|)!`2LzM7{ZB!m}^7#g}|gr73^1|UmtahpQ&bkHeQcuLgb+LLcRGnYN1Z#Y^H zu$YQ-4ZHc4BWPRdIr|cE3V&@OHAU(P2=eD6fc*Twd^!{D=~4JhlDi|L>Yeb+7A6Ks zDq_9$*yn-;pPL3thwv*sv9k;^KT~V$l2!&n53ULs)dDe3{tN2@VVqaodbYAmoEA=V zn6Y$JhF?9~q7klAM(*=FBv!IdXm`z!EroGy-*rg}`@}r8)=Fg|d#Z!*HEpHlaFL(M zSa5PCTN^W$KoZ@b_!nI$5fM*Du)JQ^$7P=#$JK6M-F8U>e`gu~3sGJNzU+636S`2I z1D~2Xcany9_zFW-2$#Vyu7W8@N6GI?L?tv&K`6v21-YE8!DmwCfnJG{Ig*;LQJt6DN zlvkX7+^r5L!U(PiRmiXP3!D0ayT$`T-E4(i-uL(4zPsj|@CmN`)!2%tvtBGW0iFNa z6il%L84IY;ZI5u$YvsgIvu-JCMYsxoX8*n@mRd?7R;0$Z!8Z6ig*VpV9>bx<#n$@jM;00S9Ev6b%$=Giuv1c*dLg0G1c;xxgn# z2so2(zig2$+B;T@N(my$gRTTU=KZc1+U!Y%)(aL;91l4Qvh`=`ud8bD%>$@Wq zgqIcaOqkRL)7k3;&y!$Z=DEC(y|nHK2DWdh3?fDlNs8P6g&mB_XDVLBlt?3lT1;~R zsZ_MVZ6mZRtlf4{rVlMGeGjs(t{Me~SSuYZIukB=>$_r%d?-`z{>yh`Uru%QtqA&> zm8%KWexy1PP&FGa93QSaz1Hw&UNSt$yLeLn;$A!jIRFk3LJbb4`4%D=Bk~si1Cj$0 zB1+%Sh7k!T38I&=0+`=nXZ*>2VJ%@T*({MPX)KB8kRBqJBnuFrhhPbFr5n9W{=oAN z-yCn3BoR*?-#&aUY_ua&56y;#HIf1!Eu6fguA{wEu|uj8_ifxOaz8ZUID+(^%=~n- zta528nOZX3Y?Tj~xi1*K4@ z)>hUwuqkp%sHZmaxo2I8oK9~Q88O5$_9jP(lBX1;j1Ec;?+wqH&@d!0IAQPwLSu|# z1Y#&MXbh0qk+b=7MQR8XrQoJ(em^&nWhh{*iF50{j2n#;Vz4whGo>wWGZi#lHKiP% z%CP6%j%5;=R$&)b&2A8IjXyKq6?z_^{bPX+63`m38&DQtf&D!w5K)R$C`;ThSkhNA zxv;V@&mwG(V%B6@8XDn9$K2aK zqo6^iG>0?~U6f@c-JC<1<>9sl5^)sIaIA2f@MRLt%;$2NawWz!oAAT)O0^V-#^mNY{uZ<3%#KbnUc%UBE=3>q4npc}J}m(Crbk^8-# zem8B>Fv^<8JjOKEIVM&RpPxLrF@0d>XSQX&H#KB-Yi2kxHla~QI90N1v&%H8UMaLY zyHmECw@b~Mg1CpM<12xfs0**l*)G~P7SOPnz1Lw)VVCddw(!f&&+46niH!?wpN-m9 z_2_b6;PuYVTEcq$>}8+R?xFUwe|uHH{c!7?;DYR~jXBty@8B~uN*rmuoxRoT8ViSp z)ix`CJJqeRwX@FI7WK8cg}G(z&CtD)!DSLvU+fl*KCXR{gXafo3zJ)yeciKp&D&n% zxN|{sHFI_K$r9zUZ{w=nmk4ofaU1&;lBqPKENl1A8`V7wJlvWvntbn2@A&Sq@1$5A z60rI#`usubAm!#oFJ?9BJ&wIj9ts+wVuoTuVfMGQ+3z+yik+<#tlX_Mzp8d5goLMl z9yk~nO=Wg&}w(mx0#u0+rxkh#I4B}DZ z1`$MYjqn*pJEjI8fW5ra(LU>Ly?+AVu#^H?GIk zeblKEKN`LptsXi{zUG(ri`tgYwsNJuGq7(qmOUgop^7;d>Yez0E}zl?sdG$iTeU=cHo(o?uL zyPoVe;HG>^b)}8SB}9{DUN|`;Xp7sk+%wIF8=FkqWbWPik@#6Hnh!<3x`28_-Nw4k z`VwQSC#9suOzAJD&Y#4=jqsP5jRI)`3O2Sm=R=h9OY?qByGl&jlRo;%VqY@2BUz*6 zBiz-fl3d8biOQtOCcQFbW1x;}Z0@bFK`rc7f-kZ*r z+oQcxBd^TQDpbth&ke{no71Y%9`y;9pOhcZdy;!@!7x>Awj3|=a_@3nr{mw(>)oWh-OC zA(pz5BC@)iJl2ewW8sO=O4R+R7NNwTJu^nr0`SuJ5)- z(khM39VMmM+;_!yVuQ*S4g2rk+$?X}CfJhpT_;#JEZ8r0NbMxYQPpainK_zr-;_=F z`?AllV^BM*nKbS=*JRl0tRIqlC`zg$)L$(#&QEx#5=CFN_SjtH1 zT~ZuZf$Q2)eg$du`jKV0=e7rx`(0|)iete%b7Qf)^~Q^P?x|~%Q~Rcf2CNI)OY%>O z?Dsaec?H~=_jlVjz#5NeWOP!!4!Yf&xn4P!;_kT-zEZmE+>`5GKj?RaJ%WWvcSH9) zPy{{cN|PV~dG0~HqQIahNtij|^6M=>K4$loe}cOq&1d6BM0EsVEO5JV`*>4NkH(>(LaBWa_T!7|J##=?Vn)* z1EhX zR3k;Ql|X%Jc}(-Cmt}srj^{&Bdax zScS>xkgMLtf0ikaEF44yv_IdZ$#t>7?|c7 zt?p#skymy>k1qq0*&>Yn-Z|R2WWu11{Ui*3sL8WQe1pyXuj9buhlePD_9sgCJsf5O z=}gD+ZF~&|nxSmQ)g46(R4Tf9#eAMXG9}&BE$VI&CmY@CT#qWJJqVks57+l-+5d45 zc(ZU2S&-#qsUTJ3g{<=Fs3O%q;Z%8OA*p?+L2q1Vm1<+8pg&soda~!DhUIi+0mto# zXNG)U%dG9rXVPNZb*jtZTcD1Np@Lj z>1w0vJ>@4DgpmCFeA$cj-un+0wVR5i9=9&8jgI>obX&3akzFmk#^9?VtKr_NjyOis zoi8nj?BXhwM)+k0{gv%-3q$oRAOAQ{yjwVkBuFZjO~T{uShG6a)A8EerUhZVrhP6E z0kbjmnEDOgy!(0Lha6eKxkOs^AeQfe%&HU1>U9pvGU{pX1B=H`R~p@~SA20jLSPUu zgdH3le!0Oef1Kh`EKrfRv9VcdoXv<<*WS&o`1k`&{jKNywdU#%U!16R-20*e6euia zm8X1vd~XN=1WfAXi-@^5b(=JPuI9Y-t-VX|aza39WEyq|APa3Q=n_$m%s7FRcRXSnV<0LkPkVKOUCq4w zdb?8uYdD zhBGB*-8d!pSK~x}0L1yKDsYEzEh|bEal>&5ko6;<$yD8(C+^qe1O_ z*Mj}KM?S|xdJA=PwQY&f|AH6?ZiGU6GmILAi5>2BbAf6V-O`ciU@f}?hr(2aDQR7x zlgEO$>#p?r`Z}gH%gF02$^dh-A`Q+A{_C@&PEy;|S;zTs^ZDrNXYA)QTt^q4IAo(- zP0$C2?T)2o6~ICan``KcNXTWS(`^%1F46g7UUYZSt$FuWQPV!d6{{Z+%z|SQ;r-X5 z<>4WspkNHf_jearO-fPi*yDq7Afl&CA3&z+qz-!&X+qq@_S<8Wa;F`kirwt=a~11S zEQ?O)+;BgB+;6JR1cU8F=d#H& zdScH9OhrZIU}(hO@4HvUz4m5YS0EcyC{M1)b!{i9$vi4tlB;)WW^Hw~b9#6_ zg#U#(j!MDo{lzjX-O7@-LzDG#+jo-ZL5@$GpslJbX7zTC(`K*uF>Oy7$2(OmC91OS zuA;d+;H((8Ofmuk@^nCuRsP#cb^SAr1E1^Q7s153_yQ4>0+;@%7=RSS}vu55} z>-YI4DK(mfW>XetN<+D=#d7NRY-I75)m~FKocP^bF;`74@6FbAKGRLMFLHKdv)@{Z z;}ef(Qf9-M{$X&a3YvGEzwboSEyARdh(GgDbG$`38)`*+5$d{6rVM#QW$C<*)Vzwk z#P)YtYzhF&;$l^?t+Sx&uI*@dcpd9=3$EBK+9N$bC|XZ6E9O-ZiBce``epZ%43vUSn92VUm8o-Npd#oRhmv z$LNFua&yTc0rTHpb0i)X;}g~A7z`6H<>`Hx=Mz+XEM#OtdlK1;dM>+tgCjUy&y=`p zw#Ir6Co$QcvR67G0ZE7htboY#p&SK!K z%4l-xj=gl3_F4ku_mt7JwJXx1rmTNcHMi&D5M|cX^KzS8RQ(wz%~`tz*D^E9iEQkx zb~K{nF@_xE{0h*|MiR5m6zBdd>w3cRj2mD|@9b+_gXw2YyQ3(n?I};Rc5Ce|8UfW{ zyO6E9m! z>(|X`?Huc4v^u}!Gqw(J>^5C;9jN2cwa#w{gYViOx=%e8v1l{`I}N3e*9*?- zqAau&Ec;+uI`p@feF6pfV(9B)1U*I8KFcT$Y=qy&nJ@+Sa zt`j#Q{3{}5ZzONQuEXc^o|b%IO)^cll4cFIA%Q^G<3O?uf^zv07$x%RlzE;iDg?X3 z70-LQttbrZy^kKBW_VsjBVxXDoWGS~4u;9z7_AHDRN!vG?e)+!886(`P(-t6x*08C z`c-O6r$WTiYdhYw7tu{cZe6z)5zC>UJ7d)%(U)q(vKlVM)yWxT4~w~=^eq(kujlx+Dd75L(-|^># zV!G`*ifEt^1=#8K3W4PLkye%DY0LC_LRmV$?-^aYz{hwt{WuDh`iZe3bLY+0b+OA= zW6&+cAHChNh}m&yCc47?y_h&-xR_3jr(fZkgrM zLWN|AMMrj5@P6`Xvu#P%YxeTcKWZcJswh@=B0)oF6sWYE*T|$=|AlNm)!{@~iOGvoW;M!RIPoS~iUN@XWBo7ZqNlxIN`Yy`e2V9x3!=BGwU+(e9)WL?!;F1lbv zDWGDXS$&$!4^n*d8vSoPC;SBL{kpkJVK#2o{+#n@$~1iTpe3~@Pd<+XO@l?+!?S%? zwn(F4Ky1$=AFT9@O0B%(3fkj(7hP6OZDlOu2jkUw6VKf|WmDK%?+fdGSI37#V-Ep~ za;aX}B>j@NRwRvwj7g#rWg-T8QJsB$-S zD0g(RuxWmv-eWf&+M!gt1%{k2p23)aQU&XsNs!E7I#Y{(Ae_Zab|~fc1xb)XWBX=< zUT+*DlmAmKgzkKiUf%Nk(Omi0jDgbgO+^2Rh$rCF13*Cyra8(4VIaxgxdD@Z9wKo7 zk+)YMJeWo637_ph3!43*6oKsjTAD)@a_zFKGM!tK+~Z*G^<+#u?#Vx4yKEE?R_pr) z`TQL&5OM$F2SH)IVC?!QM2CV)r+|W3bs=IS`2Gt5d<8=J{~iQ@Em&9?kRt+{4FmC? z4)Bm(0983g-u~MsUPvhfshN!3jsfdGfgBL>FF0k(!2G93AHWaf95#$t{@O3#C^>+t zhtg@!|5McUk_VKvGcaiNkCs5*57E(b>U;G66h#mNIKyOW+TuTf1PFYH!~<&Q52X7~ z5t$eWDxs8LsO7J*0-kFL-|K&Kpg__8DDFRs^Y%h{OGOpc;Ce2itsM%iK#{|{TPRD~ zUNL#FvV1NOq*Sh~=mBx2JTW;r`GGnw2-f4P5#Hk*rYu1|TqC$0FnJ{%BI`lnUY)(_KzYA_qU)?0*AMp&_IHSu#IJQ@-;{;MmxjPNB~) zRK=iX(nB%UP1e{}-9APB6-^7VV&ir{LHKQqbRWI?Znm20>(!1Y(dB#t-kiMJNRNB} z>eWtpSu<}u{CiMV^AiD-KhlK4W%ur%VMEJiIZ)9zh2mK^4#91R9|YYb%2r8gq?mm~ zZjL+?w$gpHOr9l(!`>9-q`{~=5;r~R9J`4yEZ8JTPETXR#&q<#xFb@tH~Lcy@Z);= z8tBz`x3;~bGCNiBnur;KNawvfeVkEwDT@3G%@}Us(+$Xq{jp&$O^BU=dDG#(>TrG~ zDKB0J!~t`kNIsxxA;m3+2LyX*oNE4P_1_={!$?vJcH5K%7j?Ii*Z?q8C@FJZ&ITt0X7Q^N(+Ac8Nng1FBA1i2T&3)i>~ z!nZE=Zuz0Pcp)5MUKb7I=1xpQlRqb7qDY<)h@dRH=&CU#gn+Ue}DV=8N=qmtLuD&~9UpSO3;oj{(aSX8Co&zcvHWg{G3y_JgeXuN=|-@m7o zxb(Ux*I9&*CNbYNDEACBdPdxlHQGX!FBbu?;Ce0t-V-8AQ% zOl5aHxjWJ~l)^jv#uPr8Gq&IKg8e-gCJWR}b4!|j?>Htw)r75}p-eyf`Eyr?_8{=( zc4Dxwj7-UG@M#vi#mOiukk4~~_AIJPtVq19DFO=%En!@)Z_7T;wgdHX{d)0~LcU0z z1z^zgp6yK=k|oVvGZ?$BEH)xZ2-LG72&V@DqZ9G-_fO3IZoz1`-|xvZ(tEt;n%ohV zkw?VNu3A`~-(-oO{fWR!UP!`oop7>#wOL>#<<2m+Xf#kA=GzX@wsT;Xgg0ulvvWnd ziR8&aP?qC9f#DfP>u#L~SgBDb(2k=r(fK-OGwED6s}#D}2MLS&kTRCukvDb^&#N16 z5dzqgcR6VY1#gMY>iB!OUWZHUu_L6xCVG!_fnRyH_X1m15G#Mw-j#u;G5ARnHJ@x% z*=_5`ddiv1l%$SqZl7&pLZIr+E-@|_TAcU9f`^SE#ry=F(*x)W@s@9>%%{r5kFd!# z-1VO>RG2n}((00Sjup&L!)$vt!klh*`bC=V(1NR%mW3rBOktA`PZ{iVG!k2Car-_; zoxR_uXf$?!oC@#adJy(h zm#SrdX*-;jKmH{*VkJmnI+NlUS9RB=Tdd^i0_*}rkcj@JKWT@3m@rD|m-%W!r)<}gMx%E@cnR>We!zAqkZjFZKMx+Vj^~GGHRxL>kV>{ z!KzQxd#Z)K0vi|&Z+fPM(}=hm%wVZ&p5BoUqu!`fL7`I4cNSl`rMgea99W!0#OI15 z0ovyG?0?cKD z1GzzMo{zI9DGG3H0b?7eMT{~Rb}=-tEm9sU->}n9J4M)W7nE_X- zV_YR1M<@yv6Q3N z2CZYa2oIxk)=r7Ath+Ek)!R*)jL($l`Z^4yU4N6Lb-Z3XQFi#=%Svl=(fpZ18{Z2% z4AvU+ofl?I|Lq__ES80tsjs@*0=ENMQjI$E(+8x=Z%m=B;Xe5hv=bPp)=D24I&8?~L%8yU75093UIBoI|@lvQn zTZj{}JuXL?%{Uh!#klsL>nt}|g+Sv4a;hfdod^vd4DL@XNTaSWusR_+!(eT6{k30!ORmI7v(G~vs*-xaEXDwJ)252+S4ce+{qpsg#xZ<>0O_TM%c}jP zwm~u@z89rWHaB<|mc^vISMavpX8AO_cJe#?LJ74*$@`l)=Z%o#m5A_Q$L=qC;_kPc zWnXu_wu9*`f`NFc?qh`zti*+?i*+|b2Tl^Um`Z0xQ%WifNxdc+sQFoN~ zLtBiPE2qr!RlbBh6*F(WvlFhJ3?Gc!SgO2$(CY;~M%owU2vo|=bcF&H#uN%t}HxJdQvMltP>Iq%m#m^#@hH`F;mi z4hmvKdd~pmcHSV>)fPzX-~at3e2r77br`mZ4zdVnyQ?R5E&3zLY5(-B8{M~vB<$ylDvF7evAhJA5peglhFCj-OnemTKUi z=nz5WZ~L}MQP37hC->BP(a5S8qBct;sgwr6Lt%Xz@;*i<^ul#HQ8wjIQ{T6Ba5Tm^ z5?KZzmXI?5vicxwPruIZI~4{i5oQ~G)sblE=V+~FVWlzMiLkFs-Q@wXf0+2qfB{&- z&CBLzfu57++%c+)Bn;+L!c-VemGPQsUpM(|B*xWPS+=gQ4O8PCVJ3pvW?%#-MSMUC z!^n*IgRe}cx6OS@J~NPz5F5tFLLYC@ipmi|sTB{$M7^0dm2kgKpej(sHaTy(g;S^S z1tAJ$pVR~(H>V{f;w57m_Q%;lB~X3#X9T>4W~|iv7o2DL1%s+&u> zvYOG&yX2Wu7S=%lWB&*P_mkL-kDd~63&IhI3H@)NIJVQI)aQL_*-n3YuVbZ1|7Z{f zvy7bZnMdtk?AnJ#E9Qw8Y(2YJY)`W7C-hQ(weuS~;=zL4AT@KpsnXNcOwifaNJ`9s z33V~(fh^l=B?s;}gdyw4*@d2mOEsB%6n`yR9@3ebiK+p$BZOT^yLuz+0~*^f8=j9f z-*>w#_K?kz)L<=m>&_Yn*ftEK<$%4+`Z;Hs-H#B$c7*sOK9H~1x8iu<1e>Cjb+g;o zo(~Iis_E1l$)65rHR|X0WRmyjipCgg(!&*snr0jlSbJ;0x@BxpKj+wlsg_Q=+%Cda z=#u*G!(YFCmnDAj^CcRw3Jg^KE8)l0OAW;hIlw|$b83WlOb8DrR1A7UB;U)VA}a^W zsF1(1dCK#q=d_igU7+EZ*A7VlWEA3~LmA^X}O|~IN$x0cv780Y^B`@Gp zx_#?u(Sy>cRNT`S<=Tt>9bQX4hGntB(Ts@ew0W=>awr@4offd|C4+@nW3MGLX+(hNUe}DC2If{-A33 zxpZy#GsvN%_zQ3rdw>Xu-g%8ujuX+_=8?&IJ+rLy^FPN7Mn=h3&t=Xp^5c2kZqk<` zf)=?QQ0%88ktqIlbtl2>*wM;*Lb@ZaJ(#ULNtjF-7!(@Du0*hW@mkCs+wHjRRiqMH zkD|3gORVi6q&VsUQVRT@#Wy9w*aK!`{4p|8E<#vVnbWZC7bM+*m;uZpO0ypyVW}|- zUtlkG+=+Q^7QEYFnrd`0xl%Vuv&uLC9(2W9dKw|zB-S#1pM`Ftt){A%^A7lTBmxg3 zG3-guHPp919P1!w_+>rWf3`T4H5ZIZrJ`-_G4?4m3swOw!DBokS*R%ypBG7r`&}*)5-3i_htbK-!Zaqv6tsi&2hMc&*+v znG-HLDCV)dS7JQakf z7IGU)?yc+&_pngIs@OzI8n!e)=bUU+<|4J}Ex$@$!*F}f&?%F=oNtAuqLHrv$R`cj zDwl(%9OV&0MhbcWi>lA85y7bscn@IPLO#F4F#tw>iVPQ)B8+dwP!aZsGAR!6H=F-~ z@V>o#cvwyyA?5i9U2Wdi4?d=>3Cn?bU%oQ-i?O%_a4G<~nrQdVc=y{udo}+cLL%a| zrn&BIkPYVvNm7JZnQ-x!V?2tZ#fhF%h5r&F>kYu>uit-T`jdqLmgKo@H_@y3VDsg* zRXPK;2!z2)wDH^5yu#^^Au&*hKi>|(Jhl(`Qvj$FIo%pHE3aVjlY@X^1Dk;;kBLA- zBZ-?9?WH*jm__De#2<|Q!%HZHFL~O&rg6fiL~xMU=Dk_&DL5yLpR91eHu_m61>q0= z#{y?WBo}Cc5z*geZRbsZ&X@8_jkN0LVr6(BG*p7w&yh!mfFw)+g@Be|{&N>b-+=O) zddAi(;uOtyem&hP76ozMn^0gD8h&2>KWJPD%7F61F8kAT$z8S1zP_LauqY4SH;A8~ zpPsKrMs}J%V_BF})+vvLT%K1yO9jfX14}fL*406ZCx|-uO#<7#OIX5UppASS!F$nV{q^ zr43xDk4{!4Bw(=<1{e!qJh$MfOUXoJTUG@i=_bCF54|PS+PtNgr{DQOuHUSl|5N$h z=TV~X#l;fzK)<(V66}{=`LcC|1S@-|M#(#z%faeA3`>LH8{`mcO zQ;1LijPsH55p8_Pa^QIna2AHYXof`|$MxXLpdPX+@qawRU5_CKAwYo8>%?pl{ae!u z;C22T-vc2Vf()=J=(Ig{FCT66Av|lw_X0TxKl;eW!F0d@)J(t|12*`_?+-N>03q0k z9?wy~C4kd|06fq8=k$qx)4c#;tpFjgUz+_{Ru7}1`v_P+p--&j-y9^MOBO%~MEJ`8 z3>uvm;9!tj#7X~C6AMTQ{R1WZkGlSUR9DD*2!NF8@6Wl*Dk%{O3JS{BdwOD=1{FeL zc@!ewg(W6Zva(Lf0?BBdU0qMrY>}J2F<)Xp9!=+Kve(o3S?;~ipYC52+*VdrlxV{u z<%#b^$>6=;z`a7-ucB7}^5x4JF-4Y1&`7=vr!?OiD6AH*u-AWlx*pi|Y$sB^&a+%6 z%?B9^@N3@9!E0Z{HM>kk^YKUX6rb^hL!hv}YNsIov65eK*&Wj1z5t%)(8gRc^%eoj z6FwWguP?D~SMeKOeFDDMEw-k~r$-~kvIDan=iMJ2+4LG3h+`vOfvj4dB1;c{{rEA_ z0kyi+5MXa!W6;t4NhSFx!ej1Hwf{DRt-?0;5@8K#Fc%5ThEh-HnKe=nu9(C018yON zR~zk7_z;snTu-Ds5*K+E2K$sMD`Z41tE0Ypbu3qz6@kW45TuCVV)56B1pH=u%mB9M zo4kNA9F`t7H=kh~T4CBEWa#w6T==#M^$zq=sH+slA_ z|8EC3AuJLmEHRJ~LIDpC-i+9NJg*mPMz++C{>LjA(s-}!J5r?B-j0#;6bu{8qtDd@ za8b;CGkX zKNQ2G|MV+Eo9H;=%ZIjyML}q&sGa=5L812BOrq;3Y#j&PFc)l}`-9vi{3M>6o>n<+ z4tQ9P-ro7z>Yr|%R_?GG+K2Na8oyNJl*G6H*l4?MVLVZsWb60nkoDjmP$>msmL8Hjdm^Q*ho~b^C%yj>gvTZ^Z~^G4--Vwg%UWx znX_%pbpMe$x^pS-{c5{d)F0fofXR%xSRda;`Oun@HYgwL<1`)8x8$nkW;nY3zKU!t`t1atJ!j6}7=|kBv#p8|dEfjXz z?qCIy- zY67jV{KlD%x6nW)+$(>z$U?Ussi;ti?ogcCQt4Bosi;$LWHv&cP;LG~e)Vc8a zUpxcHTMr&CaR;5z;N#A0RlmdD&Rmu<)QXT43UX23ElSSvA*p8A(vnVAZni4I==E_j zg8gy*^&Dxb-sU^tbQ48RwY{$jw}l6{fExgp%(1H8NjHbUqYV>q+{FlUzf;Df}Mh# zO+5}HjnA}4d`p3NsT(V3bJ_fa^M!NJkU`RT&M6BNlj}FMUg7XQ`_2^c;_iRbXWA zq1V*76^*3yszTpoFg|)NBNs5`Tw}9E){cqN+a}u^d+_T*SXG6p zr*lR*LsR)m|Lq6P^VGm^k&M>WE1#zEl&T|xZ z(DdB#zm`{9b`BM-%$~1J@U;Z&R^sAUhacWV0rQ3Vulq~0T#}u0Y3I1!~Wh}yFGa~lR>t8)O~y*ooux>$^hUXy6NXkKqe#8Je; zLc(~c+S`sc6LM8mL$EX&%tpY-07#dKZ}KERT(uU4Ol_!=TB*9nrM9Dg-Wcu07^4O@ zkeo~@6z{o+ilU$g<22vMr(Euo5xa7wQn}wzg_DCZQbY>yQ-)|i+UwvX(Hb`cnx?Lj z2Gjhprs|CWn#FP2BP3eGc~)b%@wx<$3ccTQqRp2zRspPJsAhTJ(ohNHn=^*Y&wIGX zQsvRy_Iql6t^O*GyA>a>*_zthT}w(X1u9ZIt>8HO^{f!vVxw1#3l|}R8jVV7;+cR^ z!`v;JW|E0#&BkSSKps=YDE{v~p2y{-u#eY31qqNf7ERR#Ab@L@!r3gCHiI=o)iQef zqU-?+uJ$+aV`}|kYWIj|Th6745q+YWpfzDhO1GOnwx8C7u(dJK zZ0GgdGmjv}aX8uVA2XQ> zR7LYz;^WbfTL!E3h9|%#MFrT{k2+tdMhjh(oyQZYx)IJPm#U78jjx zD@HXuPI|`XxIG}{B#?JA z%7H468$fd{!#cz=(3RDr#ZPLGx@-6K(v6R(NgHz6(^fL~I-Tn(*Sb}3&aUrRw28?W zCzqI@Uie+IXZ%ZYd1e7T-@hc6eQ3zI%;NAAZN@AU6ad)kEzS9XMi?^3(ZQ41yGGxJdo^&`9?L>C{!Ggxw4{#Pe9{=`bvJFzM=x(f2$+li>Ma5JFZVG84akK zb&<#sHh0`H~?wn9UdqnDbezG)Vf;Z}IrI_hMeA%LBc8Am2x`TnV zaO-peGBsKDp=eF_mN68`M^xJ<$rfTY%T|%$kT^3Srhg{2@1T=Y^dnRpZ$v)kser_j z>+?!Y&+ZQflJ%!&W_h$KRVMiE*C$qG0w~QvzA)}>OV0$pfNxVN$!cjxm#l5&$(9 z$i&{~1|_YkZQg=ZMkCv+d?W0^)l^bRIsmS&@7q|9#4KtW=|zt_{Y^gUTO{|7BbpZlz@gjzBZ zw{rh2{SyE_Pc`=|2RJd|asK|i1+$?QFEVW+sGCD9l-WKf(;*Q0xCSFjzVN8a>3&6D z={Ch7+_FNS2#_6Xt4pe?joHipX>2*>?M9;}*eN-7A)aOvd-7`b++i{K=qsssStXg; z(eWjMqG!1+u=8U~F;Bf}{LPd-(Le;aLFscXlcw(^h>Js_x@jxv8YIo{J(op$L_#44 zJHg!amgU6cg#8=VVW+9<5r-D?Z}YUqR(ydydi9>`v{Zd0%km3GVJW|>CzpiNbRX^S z5CP)vl?-0$-NcRS-`L*S$>`H@315a06HIzaajUwOK5EJo;q;D<^nHx!U?UIP`C%Vm z8NS0wMyf&}Tmy#p{%|-i5{}q%h|4bnJjK9zpI%wh6iGsXMYm}7%g&o!@Cts%YziI zp?`U`d%M(zglv#PyzZ${s)PI$txnA0RSLO-$m8aW4iHpGwO?IE%1|=0vpYV@{lC*} zZ}4lfd!9c~!*irVjf7sy@Sl;5VU*Ic%`XgW(^Y*qxl=T$$5)m9FC5$Ft(6?&?U_oL?e0HtADI2pkZ|MR6I=y0+StTKBce zlv1a278Tdn&J7+hw@txjYN(Qdi)i=zPc^T7hRcl!Ym62qfuCfNkA0;g8n^3>{FGKW zZ;e{({F@pzmySpT@`4z#Wl&y9q*gY}8N5+978e)oW1@eyHmVzu32=bB7L0GdWj4A? zMvoPAO=(Q~uL*7F)CfQy^qg~rwzkceY~i0?PG{ObTW4ytxOMSZHvZ5Cw;oLwb7hC3dh71`+=!eIwZyV$_Wsy?dH03qZ15 ze(3Cr^JV>I1M@uVsGV?np(fm@@ixuIw-mdbn9z`Q{xr@IsbjQYu&Z(<2^6^P&3_KRlRrh-rraIYkyaT-k}^S5)oD-op3zs>}6l%!^v&b z>OJnFxA7-KRK?fTSzDOBhsd;z!=2V1Jh<6Fl@LEkAV!^p{+lw{yEoPJ}r9Y zHc_^S@IX`3-LfUukK01Ua9Ky;_5dE`llIg0EHK~d%j;==N+f*cTi12PSBgW}7Ug*G zie-%l9uy~VF(SAZeDwf&B!Ms6Q<9k$3awPPrNYY&0SfaQtIvER%uAKlhG+W(?p8zqfFv8@V7`=C~LleTVuD$ zeiiB6JCFI=G;lo$0t8vQw%y4$G^m8M1@*q}v)m@mP7unjdbWzi{%spL}e`Cc6yD>b>-;TUmUeon!hWp*yi5`Y;$1 zxy$%^68a=g#^ei&_Yhy#r?6mH{Sh?SPk1o;I}M?wZy;VpZ+?#&*4@Euk@}GP7>3lq zE52?*(a?j7SMVKe8cu~;c5u*OSckma{d$QjI}je-VY0V@orPS|f+QKeUn>FPp5JRT zVMLLA=84|7o}FCN&z_|~fo{ASFVQT_Vw5GQYjP^1v!16(5H71o#Cox>!8jcPSj2>) zvFV$sRn5Emkz>o1X$8Z06iq8~$9DS3TP+_A9bseUJ!HUMtEOLsMRoej+shxJmMj6W zX16_XUW%rMPub(>>F5;B=RyMCfV>P>UTo3{5fxeXbhwe^(h_GN+4?T5hnD9#h~u8e zfXB}xywI2@?pxggI+l!?z3zYsE}#eV%^Xgd{9^15uKg8jwi^5b;hvy(vvIczHEGAK z1PCYe!jg~i_hQ8-)KY5=E;c#)3^ISs_I^?EKC-K;AX6TPt5)rQCl4Fh28=ZCWX#*& zjP4=Gdw>{h|NN?_r=8#H8kIk>Z@$ZEw$y51RK$Jneb3asi9HQ`^U&p@0WZ-kaG=9a zcaukfCb$}%CXcTFAE-mFm=|qkh@HV~o5E{kS!X7wW=#gYvEGB=n2cw`w>&&K>>~-{ zc~n3g*FxGdrwN84pPBSm11N!qHJ3Gn(6G7r_;g z$a|XJE?x+2iPPiMeDMDr=GFW6K6WX{G%)XHE!*aaV7Lvz-yqctp*q5d` zext1XY?$^9H1zviUe}_4HE*LN^=;(e#o`1)=h&a5u@w5F>UW+LFrM{R3aKW+CC*Kt z_?-t|dgQ9jE!@Xs*N^2|Bz`cvcMt=;;=Tv?t> zUIrjt)adw-e}lo<2InWSSFMhT5uf9ooj0s$L?rBSE`Uy+$aA2x>z+yx=H82VI5+MH zJUpH25}$39y!ZV~pRZJty{1VhptACfH-U*nv^)77b?vG*vd=*3R~=HUguoW09Mo`pKFLa4vCdYVtrhXod-Mwl>_E={)%G_XNI(Gai#3zd;9S$Y1>sCz zpW``hp7qK88u;219ZuF5Et%x@H_7A9^gUdOFW1!2L-rt*NG&`S?|GM#EeD+^%1Vhq zw;}Kq<3*e&F~xMN*ZSuu%b2BMcRKyALfgD2cfNzU0ESTuU>KtjX;@Ma2#YPLD_#PD z_+Fkblk4Nx+|}NkV7LA64Zgs8DF0GI691(nKG6f+pSZ7N(zQzR3(vGyH>#`i#QVyN z>aKjj$Itn4cSPc*q*}t=F9grSnaEsmvAc9nhuaN|BD%&N@m8hmy0$0TuA)hHl6bSC zI^R`z#>Ty}OIfM@4$yPB0HY;AL%23p^%`N-7QHf5dY_kBs=YvLago}TpHO-!tT7v5BaNeS2ajX=0;?8N|54M-vQ8yKr+vOJa9eEC&X(cDu2g1k$?9u@mM znw=%-Bk0?nRwGa=b>6$FFmD8|)kNtV_C)XS>vx({^7OcuxxRyYU~$-7wZf>q1hBCJ z$nn<0n-b^UdT<37$)eFLI}s|Pg^G!eHZ=ciO7rrnrDekVkNgh3G?TTpBIrEnx5p3B z84u$jp3Tbyjnj8UUR!A)QYk6COdMPi6P}d;c_flQV&Y31cn>eR1$1V**{9;kOI_w@Jkt zw02M9?&U)O#)|jM8$=g?>XP}l=_w9wainhG#bY`@kP+bES~FSlQvKUB1>F0;&ipqs z|CrH#HgmCZ{O3)7EaJa)=D!vA|NY&>RDipMEEkN3EPG2LcBGs0BJ~-QW$#3F+t}E9 z{Y2(#^!B|ILibuFFW#iUA>!`WejMlFLTx~zC8dLin1t7+~q2 z$!5;bu7TO=#P%rsR6P9DlPoGH8{(>H1dnH)^lH#>+!$jkH$z0kaE8V3!bPM`4%Q<# zV%v_H|5&y!-Yb5P)kv`<7o%;tQi@nzuY!L=Z=IGpwa}hr&Z~^)M_M9bcORMd*VqDr zJnaYTsI+`Q#t96rS}hbl4|G<9YJu%*m#^gXM2Y8Dr+_UNiU1X5*d8YCnhbCo4_hn5 zR8|Ian9bi7g&z}9wvAPR-8KbG`=xc9&!|mDwsbf77^EqkG5arV0lg$7&17)!4Z+2= zvUKG{M8q30#rilw#or+*4~~yr9A|qLlbKb;jy2}!x7q*13Sa$j*{Hp_tB-i%dFHQl z#)pTqk&0QT*l$j}d6MrN!`-cVH2mH!>0GO#-W_R5Kc7LBLZt26`T@79DzS?ykX#0J zn!C59)#F(n2+|_ z7O|?EH>z66y)&`9b&ccgDf^=12D|xiVYKahM>{lUv-6Js6B01z%gcL9Y5^M}#b6I_B!DgUd=T8>3lwE&H=n zz2e36{X8}qy&B&5-Kcsv<60Z=KPJ8de@cvsWDAK|QQcJ)$4G}~s)}qw$9VU2YILw? zn7L#uI;^4_oyl^%QR9zXTuhmKUHC|HV_NQv6_8R2ci-(6;Z2Zsd3TDzwes*NHXCAh z*>0KMIY8;p4^MiMuLoz9XN1rSL=d?iM&MjIQFL^iKKR}2-(VrUwk&q$x(>D|C>JB) zj@5DWJ>6=)h2BX_(~0yrELbn-FTyhQy(p3~*V!Mzq9IPqVxgH|6I7lcA)F?(VTD{lRBy;4D+hZ4rP8@@q?^WImL(s`ZQOz`Xf4vsd* zy4HDkE@#Bb%ka7*XH`X(>%b*?GRGgbpKTrkI$h~nhr5QOrG^vc)1)dQ+juT6zZ89& z7Mn@M&6+a`y@tIuq9i|E{cL5H;()0Luv|$!D-VU9`^K0TR%u#RZ(l`gV7G)pt76!l*u1%g#IsD&x}CiNc!##r zq<)IAkx{#F8{d^WlAWk%# z&dUbGg~t+48ja-WrbGU^N#mWT)*e%|&=vetXA963OLs_&v_OpjWz`)~hm+B+`zw?} zzZO&AQM+zn6Y!)}14cUWQDq<7DM=%1ihF6WyJ1`fwl}hBuK&)?gxe-6cB6LoARFQ$ zRl(LXdy_jX3T27**DeRt=63r0UrWdS`(*Ra`&55ekDf1Sb#!vASu0hXJMcQI`&vda z=^$N}cD;__r0H<7n+igdfBy-{X{lGokJRms{hQ5_&=7P5trZN8f{DJxeFJCWDz4;J+DpmS{I;6ITd40 zAFK<1vjm$>)K=A^dyaZ56i<&LRkMQlar)w?q3>GC;9_jX-#j$~51X(4^W<`gfLTHW za#lNS8g@geo9EieiH_$N7d!Lcfhk?sAjN$r$74P|D$^AC<|TI8(&g#YuaGrDMZzc5 zqRcDxyXAF#k^q>i@_P|Ijuh*yD)a_6Zrd0AyNm<&Pn6Iv#bi8wqJ09+jfzCUCf_tj zGNV(LZ>#4I@bFbk@Ee)U;i7^WFtEc3dZ&puQ+2(p&3+AQ1p+3$EvZ%%uI^*otgfpG z+x~Tj%Af-sueEK~y5VL>+5=W2#`Pc*VMx%@Ac;wk6&AY$NcYyj7`g?0z zjxit3y%&^vvUdNMP;bHRkzd|^sY{+>kcu3}8RwO2dv;c3(tjeZj(mv@eBI~` zL_usgTVbLv#fjg^geKtPLoz)JjT~Uox?ZaR%{mK4JP~>FN3td0h%vIfS$wjX5 zT90LED!ACLfsfQmuw7D({UOVbCASZZRfiMUT?8R(pik&C3S3n4Q>A2$ z{|kk;LsIJD7$@drox!miLVj{z5X5=R@I&% zIq-kqMv%B>D)>ND^Emh{2jzj#Ly3lNP$C9f`hLRQ9GW!B*%@5=oxTV9>v|(G&6BT_ zo?2{K$w(Cy;es@ve&ALTq2&tH6xN(#Dek-_aSU(R?DcP97mD{socgI0iCF7m<4|UC zq)A)M3mvupfHLWoKq#rpH-Jtz@h z5gA}k_I(fLb)Kf%=u<){`|InSRS%JUBfx;fztX;tA8h(GcF% z?#)UuQFcnVZ6btpIk#{pj;`=9*U@j6S4_|_4{Li#{W|)A%fSn-!b&j#>izHu>wQr2dyNT-s*peV}}LoN^O8vbuxo6dghQ zA-x}F9{gFqLAdv+t8H+Osk z;XG}zWII0)WPSQOmNf)&?QeP&YQk-pT8ntmym#QPEhH#w#MD;k&%Gp&*U7vG4iGjo ze_8<9CIT|=*_ZmXe_m*Sas~wxC~Li7_Sc`~2nTQGCKISN?Kl6wrB|xEaA&@_-KMr31TcAs@ics=PjPra%0dfG)7)FEo8~+9Ro?ZZq24Y3e8u}+F zXCey&ni%;0U8>3CwSb90P6(;c{h1mGCI+BM#LVK)_z9T4!f^4Xpmh%4p8l~qK;sH% zavmJH`tNBFe1b+(x7DXM|Bl!hz%jS8ONjqH?f>(M^0`elQe~HAFDr51m+w>_Z3s*K+9xkUir{hgl69i5$J;HJ_JV}<$W6tCF{$h{SqMi}edKd3>LO1)_LQw!BwW5o-AwcPLa82pZXJXrB^ZKE+$)yyZa~!z@PFMRB9rc-3-;hRK0cGg z4Rh7HQIF7MAYg1v8AkbZlpZjQxBPXhYy|0%jg-8a3WB^k)}@|RfX@zO`P#``c3GN9z^QEgh1x`L*>g#z zBs|ABn_MTSvHXar0TvLeZxSHCbM9?lD;qab!pnJYGK=3UY-c#g^bRE`vC+5ePuL{$ zK3o`I(6}7a(SzcRFyeFOMrPmdzw;3^0ereq>2_EqV zJY6xrzvnSWg6E2KLWB*H?cUcexK;d(Mj;Lr9%CwnR5)c8Q2PX2+3)=9jz=7^u-Nk+ zalXcR%FPXC@NlmLk&*9SN=0EWtQCwIQn8)3UE7|Pqc+=2Y-HJaUjKCX5v@#lk(F>@}Io}Uf zE}Pg{1c%`ylCN$tQ0xfBdHBW8BB|V9Nn7AodChcDaI_$}y8@-dH}}jGnf@~HFzt$* z7mo+*q1Hj(L#?yK(+_?>`Ly?>JH8 zdLSv6=1;VC1it13z$wd}<(_9P!wZu?@k_&~>kBsV7k`(-r4Jr|==XO#sGXs&{AMp$ zQCG2|W!1o)cVH03Fy8Z3=-S$9U2NMGdiZhlFw2PcuNrW{DXmqZa_1Dz_&U`Mboys6 z_d|?o>CEs@sgZK%T-=MKB<*(xsEU}i3NWW>Uu|HLbH?YI;A&S>PtP<4dpIo{l{e$r z|jn+>F*K{%bnP4(#NLdW#Fb`t(l@@7bXg+*)XA)bi_I88t_etz- zM<;ib6scfan4&S`#c?($XM*`Zb0fRPI{ zTm+U|p-7{iDJe*(X+|c@8fIpeJFa`Ao58$ZAF&97Hj(9uP)E1@mGU2{Sozljd55(z zgw<7v{3!5(aXbr+i;D})R3>E?ezV&oFsA?Hlyb2a2$H~VLm<-O!<6e}C%fWPTU$`|0xo_wep#K)Ssvk=~wZl)5tPbK^y34kw(e$-zsrt z#Cz)de%FRM=TfINq)Pqf9a$O8IcSIq)S9TCukLDn8z688Az;eX3*0c+Draug6A&Od zTF~n`3%QcdSSh^WsK6JIH*o_!^^2pH4nZwQ8nR9JT)W z`a^I@KO&v${n00j$9LW+8j`b@+f?vpJuU9>OwDr(3nKRhmMtoDSziQWY+z{5cQnM= zT2%0G?ci0z1kNoh5aOWwbr<$CbdVQqT9!4N;$-W_U{aIWFm9UynM@Z~9dl@Pn9kd} z2%)|Q6GX{+ADL}DJGNMOpYt*;VQ+QdUHy}!>H4_+kip#YusuQS+TD3uJAqDhFn82^ zr+SC%u7>c-bt|D4^u`IdmKwTS2#Y+|n2~`jx4g?u17J9a=e+BmZs#mjdGT%v3-`DD z4oS2yjCNGA0zN1}XL%Mh7+?I9uTj`>uKg5WJRrIGgqU_cK&{+tgITWJg#8+$+Hj~h zg%xY1Z;&T+y{`QAB#zPNAd~s=LoteOL7|Ut^1stT&|AZbv%9pO!6xud0QR66);inv zu6w&)a&)Lw_`rUgMk&R8;f-*DRH{HX(Mf9k?J?jC1~T|lj4`JVRYfpnzkcu6 zc!{mBO!lC~re8AMO{#EH_V;s{E15o6e!P%aeSnv75uQdV`}7l#6@?@K1zM}~PkE)^ ztmz_G;}g;yY2?qSml(W4K&5$$8oz0SsfqDKaW5!SKYc$vLpR=){kwUj7Uu~$_HpwSSSC!PT{lo=3?$C&o z?k$rO;@vNuOL$Z(&HBJg)KBcPsy@}t0JX1gRft`i8LyK!UX_|B_ z5LGinFcDVYf0>ETwF~_tjbhpPSeXQ3V$Q<%aD_}esCx;QW)I4*A;A7G%mf|F z>Eafj*;~UsR8f!D2Q!`EW%KFeT9mr|ELX`{l*@|v9xcYqJcR>RGY2mQ9_>C zV9Gxc-FQ}@PbfgDGqa72?azR&y`}gmQ5T#CsrHPurB^{h^NE$_ z)Tzs52ImW{*&c+*ko9^03n8!#`>romMcT0=qv``aMlS5y4x2`(H z)I3m1RjPFu)A*OEVEOnq>{d@5BajiFY_JN8#24ma3oFds@=;w{DxO}|1wakz4TfIM z)bL_x(+jC0$3pO~TWEm>dMKDUKh4}h46TMfwr+iHuza{!ac?oAA4kJ~GJvmn^k*hy z-M0>V+DV>A_}SCk#pcMwJgw{(aWIeKn7(Sgp1FlXOQKaJv{4Dthg%#P>AVX$M3Dw1 zZ-xwm_54|g8g7ESwV9fAJW+0f;h_B1+GPaR72SXBB=Wi3fZy?6C@bZPySlDS@})-- z;)q}Qj8GxrO`3$V?52}zc04wc~;{p;T>ZL=9cuN34s-q$1#i01H$?K8T| z%{i{b%7fV#c;#Z%aU=1u{kO9+;qu+LffU}_HCmWgKYj|;9)I4D<~Y`2+z+*QR1Vj? zMcfD%5$_;zF>*3GdjPJljX&OaK#OFipDa-C&qzs`j9?JXxMKa1DowoTy+=z*vwO?+ zMrLq|F75WJn8Rr`Ig*at=8$~yxXoTK(QhEr8|kkW*bQ!MT&e5vlH&Q z5m`QVBQ}GtMzfh#6FM8~xP$1Q|8~&d7<`AeAlM!9 zpqmK_6_~C|B;3AW8GK6Fri{JgPS3IyjQ7A6>lp|=KPt$lT*ynlIn%~|FGcNR)8*?f z#yhPC%S^jEj=_Q1V>V6Z-k1@8;S>!;DsNIA>a_ahD9SvO44_^=y7mnK;2dTu9U8qD zP`LMlB1umJeZ!Pmq*qDZA|c8okkY$+bZ(cs-f)=Bj9+Zs0NcJd>NqZarFgtOS^SB) zNq3#f=jjAjGg>1^=Qoq>-CeDIJB4M?`~JX3diYarjLvU8(GcZ8cl*-7UKUEgpANcC zdrws*6^k~K(hH8;?`cv$w*3YGu<-gM6HuuA4a`@utzIHn8d$KbsoaaYEvha2yE8G6 z+5mgiJn;$WW%n{}TDkFg2w50AkHR4S5YpTt|B4SoFX`=_c`-Tf%_a1s>Z3_kEWBg?k+gYJYaa~BC zN1Dei_TIGOHcsL!;#aJfwkP6G1Brhk$I6PR@51qqdL5qcj1>kwtaNi!tyTjx34_Zx&q6if^8+lJz228Ru_Ez^RH!BnV$V7#f0 z!=PAK{UNaH%c3}p(|fs!t#k9A?qNlg0@vfG?_&YzIn;q)ivO9lx$LL1jL_vrMa;6M zz;kq<(MyVw4m#7C$o?RTe%jBNnl%5M161@bQeT*7Wg9M3RYYzNEU|_l2L_ zUi{PQJ!&C~>=?S;vNLllrP44rdr_&C!O>x{&^`Y|<%c35bV- zDrf7kEh)-l5ls++7!2r>P$iT&IpF5&cOTXCb?m|GOPiyX(f0`(HPJ;W%$!1mexbv3 z1xt?{;0YwQnlm|)q?1M9l*ug&<)RBP+CBJ!vp%ia<{*$2J`7d$aR7$fn@NQexS=!isK}9@;A47L(LsR%prBVe~2xW&onLOqqA2qd7n&I@GiPpTTIpc#KRK zyi)=)uecBGvi1Bwb=+UBE0x0oRs4#ZgQaf^QGbMydmQ)*theEmWGazB%x*FOPAX@! zp=*i3|x~_#1hrW@2|WGvSXhR0$$_%=DiEVNbZ&Qym;@RGkzZi4i$koHpb-_ z$E-!e-SGwnR?WW5bp7ATC06E?f-_sckT~e=;}FL}nL36z(6_`Ig)@&sa!0(Y^bK46 zK|QemU8>nA=at~xej_?_fX=LHEn>omY4cMZFnC?<4@(%hEBSkqG?%2$ckRDPC#BDv z`6nL=WiRssvr1Enby;L~%qEA}*&Sz4Nz?hsdOdU9@O?QUPcFr^9=UZ*4IX_FIDB=* z^~4K^H%gctHL9M?&wp5D^1_MDDyHO1XnYYCp_UiJdF3Q|u^<=o!9HIj2`?=x#~{~` z#q&D1P=CZK0Rw}#gEp|ldv*cQ)lF}QV0}pL_cW0qKKi|yIFgh2c1!Fch+7qf)r` zi8`WkQcyVf&=?IboCl`8q~j@K2SC7H51$buRRX;wqh|o}^GPUgiOCg9`o$OiuLd5U z0WyrtNc%=i%b=BnP`r!@@RD^fiIZcXHM){(nKnRgruu@O$hst+&@y>BDQ9-~P0`z- z8`x4evaJX_-SI{9%&Qv0)FyqTi|s}aBK$H%zxG_+t)b4=bn7)!u7K$yY~$j67l7m$ z8g_i;Vog{hJi5sQwS&FwH}O@?2L#!y;^T+9m8rVvHU0ryKJg@Span@D79Q!k-OzJV@ z_L})zZ*<*1Q9gXb%VM2hiuEj?N9LhXq_3A;0V^*QXx%e&m}T;_Tx4+Klgh>DeJm}^ zI=_RlSK=en-1wVDhXLf44dF2~8*T|V+3tE=34w|gT>y^hfRq@{Gyi!Sb2H0w>BOnK z?`5!@{h5v@od!qHdKz3lI&+i$AJKf8%=xJroqa~^^IiE$yPH!V176=*74lq@IwUWM zdJ96#`t}@T!ug7g;#VDpi;9+uejz`IK?@-HpnMd-Wwtnq4KS@gzdzukvgs3ZBjv!(s2p_ zDb3ee;>K!jPH=pWJ5o#C|9xMI_WM4o(fuwsRcj(?)>Yl>=U9crD5d-p2@~Hhhz_&G zf}d9$zRWg>qvUQ4_Ju8UgDuRR97ME;T?$QDtK!S*qv?1bW^o|xRk4u%&>78}6da&c ze!x=bh27sJ;An(p(BnJ23ht%*UbK4eR%-&CwfyW={HCIMbs(R0u#X#ncYUVqJm|Xr zy~woD(#C*%fB`L!3bd&`-buZm3``lO{(!VkOwL@%kB}H8v`|L!6H)t)oOegcLwhJT zVrfwzJW{?2^sTKW%3cf8F1NkE_ywaB-OvN5#`SU6uL@W|8J7|=U1WYh41Od}G@6ng*zqndDChmetSd$hTUF2~mg!G>!N0LViVgBYKT`J*{$4 zV{9J)YKiSZTpPrCqUQ)C4&JMm0Cs$rLiB0Y-mMGl_?u1&MGxhZuh?;w2vb)xyW%YJdS)xK-8b5?Efw9#3DtxF#<9*Dlb_7q(m|xyzr#CgdG` zFBqoAiQB-iMiPhHOFA+yuUUE=Ka+cT9@F`GARVrfDEteIJ9ekr@bCg`BZ!Le4rR>a z&5K67(8zF@Sfj#8dSRFre@ETlR#Em2h*c^{{}NW8`XphwVbrH^-5$nw9e4R&vA$e# z(w!o+H(m?650=XTu7mye$>lZE1H4sy^CIuQ;pZ)QNhZ(g1LU_z>TUbyiw3uGt$79o zSQfjqrhZ4*TEjjllP`KhSJdM@_K7BI7wVj2b3xj z^An(T&N+0s!30a(RL2XQT8_~j3N?3et^1b*A6;HFkjR8{>yp@j85kL{)Jq+BOR!xB zV)V|dn4urljuTxET9{iV_;8-WNH_nc40dn<{f5bbRC%vgT(LWgorG6kOUQY)b&nee zTbeC)8&Cq>-WTNmyW50I@D5bP=GV2gjzK)ML5Jljd2hm`aw1IL_xk+nA5|ncBMoky z$rp1^CZFq#z_S9#4UWX*eJG*IO2O3B9o&<7i=gA8FVqG1M)?{xp#P)fz)(U0g=ap} z#ygvD2GM%^Hm2Zarl~Y_WtFKdA#zaC+c{r;&XOuEw(T}UkQExVf4o$;FAOYRYCk$A9Cqj=Z^S) ev!mSyOB&og1K&9a={)~ZwStU_bm24IkN*o!uNB__ diff --git a/fern/docs/img/customization-unit-ui-hint.png b/fern/docs/img/customization-unit-ui-hint.png new file mode 100644 index 0000000000000000000000000000000000000000..86306dd1521a03463d127a2644f8ddcea0ee5870 GIT binary patch literal 8909 zcmb`LWl)?=vxXP9U;&oE;_mLwA_0O+aCdiicXtgzgS$fr65I*FJ-EBW+4p-tt8@OI zt(u+Qp1!-EnWt*&>WNg8|A>l=j|>0+P^G2Bl_B#YWLP1>L%vxzuB!k5%cLPwS#xBo37s8G2-EW*eTL-Cl8Bsi!Y4JZy}D!hSV<~Dhn*Tu_y=5BX-=YQ9A zwd!mKAen7@FHI*4MIx6&ii&bxGT1*b?HCL|Z4BhghXFA$>-KIrfB{DAN9!k7z5uyu z_bRHU*O$9Ds}UbjK6F4tumiMkZhF|cX8%Xe_m=R0Zz@tN7N%h)NoS;$bP~wo9tKIF zvjRfHNGdTUvOD4-4l|2rvUI8yCuYqv**a@zbdyGOU;On3-#ipM+bL1*2dP5v+_0Z$(LVbob1 z?>GVvSo9P+S?l7N;j=DYhHf3!HnWItLYsK$krcoC);YDM! zhB}iX^9g@RtvWZZfql4udh`G)GzF^hoVc&l-7Eo!DFJj-uwFk9Goa{;gs3;*I}@UU zMQ9=bbq2H>ffNbwMFx~Z@E{Q(8rbC?J4Ix)0I`h^JV^4vUJg(?Q1d;uQ&8kO{OV*bM{gGT=EMgXUdS=oTp{MVN^qS0g4}NL0S^K8Y&Q z3vzC7wFviD`F+e^D5zlKe5DU?$p&f~xLl!oy|Ni_2z{96?==u>0va|1Jm__x)qhZL z@ZBT(fKJ1_H@MGPkn^z>IZ~iTkbjClA@-2ec-jO3$qvE3!&J+z5xSk^#?90c=Gn=FN`tnsZ}V_+;>Q2zH=MH8RU>DhSGR zN;)MTS})~xpm1`c%A&p?>r*Q1B#fw~3eiPbiQjy^{01ruFPs1NQm&yEMyJiG*`#<= zWYuw)kQJ2`td+7v*TmKoZ6(NoJ)Sa9QasZ>&nr+El{Gk!RCsC!6`zl5)c z4;>2~iyvzjt0dQ6^2ID_7j4{Y++53o5v3|ri@xdBT6fl~qN@C)WPFxsN~r2Z1L1ew z6w<6_p|ez}oVkX&0=I~IL5KQX`Kh*GR$jVZ{Tfr(C$Hc~RbO=9#8;-5(Z`wtD;J<( zsvg+>D>~l(2Uz@}cWC&Hpcp*1cjTzfsMhbk;9>{>SWR`wp}@&3-S%rp8v+1Ur( z?9eDxPt(w9jHJz{8O3m?={C_b=9o#Ir^31yh%+2znrf+LI%h4{fL1rrRNdmoJ?~++ zvO?&rz312B*eKn^Yjf5A`6t&9*L?HzZE$WV;bisLX`bNX+PYttZ}5vZ!Y72lKELqr zIMu<2xNL%K!fsw(e(BuuTzJU8z;^CvE-{N*Cc!Rn7Zo=qx@FWW9fe6>H&=&UN1@~O zz-%XN%WcKhfXFz{U~SXW_cZKO=PvkEkjN$8BmRq^mjJ3jTOLjxb7xHFz23)8y}B{Y z;YzGZ_cg9Ha($!Bz$PHl!G9*}Clkk?;UUf==J4NpE=7?AM&SMm4^nj7 zpO`WyfH#NRdj=naCwl8cnfq+|>ie|%$~H%Pm@L{VY9S+5D%zcHeJSPdEa>7=xl`J7}aXpwsxsD%1@b= z^2{C_iBPg#3dXEmVKbDP{%n^p<7qG_eqR(p0$KX%@{@Ivtpa$#^6+1xYEQ?=0C z%?|9x#(K7U@_PCT!#*pf)?_e``_~TJ&IS@s3rG3ctlM;Zp6#B&JqKxra)tg3-PZQd zwtF#oQW;jj(#C3Ows&4?_UCu&@OXM5%;S&4p~W@DxjD({Zm`4kRqv@*=tw{Lu6eBJ zV}R}$Z=;|fEhXKjx81dT7ne?z>Xz=AK9_QoV$VdpIJiFFv~KNx1GNehiXiC^e0e@M z_|emjJR7wowjh=nu16HdxAKT`l|DkQ^$|JVho4Sp$(i9;<5RJ->5gOW_Hy|Ko#xy| zx_)vUIj`oCDwSKM5p-hpuK+Sdf!qdhBLn`ckjxdxk;)(QM8Y~8JDI<|dE zzxEXu);a6#6*Em%)4Thg>2(i&ckl2Pb>Dj#dO{~=@SD0ycyriLIxM`4XD5yq9QKUz z)H;v3th{fVxQbdI_pdo{JZxJyT3)^-d;Xa$q_>_eJoEP9Y|>lWPxD#kO>HM&^+%}a zTTk44wBB8JVke$=_8a<+e@ZvIxBIO^jqq}qQP|`9r*#FNg-fNY?P&$HFInNdeUrka zzC<9}`+|p^1@+ze-_!fk>c;egj@y*$W8Iv7=&!FXWVS}&-c+YjNhs_s2O}~7aU8Tr z99+N>6u@!%+DFiI>e@eu7Wyr+)cl;*85)oXtrQXN38fgv1LIgs0N@$I--I*p_HLUT z>s4`nDpHaMOkE6d@%2AlSO??DwaHCh`>m+)5c@ATGa1Q0LR_o`$u#5?NyO}(Oi8$ySeRJIgpf%{NCccr%=nbWCI2ah z{1POyaB*?qV`g@DcV}{EXR>!PXJ+N)LN%+_E({QfBt?>QxD7kRI+pa=e8glWd3V~nU#r!`QN!A zQh~p`e2SJHrZ$@5mbQ@Nfz%LUW#JO|NBsX;`A^0FQfmB1$;Qh4-^%}5`QJ)4XHzFJ zds|3J7oq>WnSYA^d-0z_0p`DU{$D5Y_c8y&3pr;YWC7-XzcV3ZX#e;p001XJT3l4s z1L{N)f$xj1T2}6_%&IAh^P6tU-HaTUCi=CalTUL&7obu_=Uf*v{-Rd-Jsi5r) z)SBHESQ7LnD5_wH4E&8|;CtEgBrgy7)EEorildp=Q6j+2rgrYD~1W_smkSJ>uQ04^=kdkzUgnWP^%j^fJ+=KuU zV|D?gB&^WlY>`kUhe%Llc;gVA5p0CXdl=a{EQmh~CM2LA5o4GFKBJr(;^#m>go?x@ zNs@lYqNV`xTcBY;zb6-=Nd90@o`*q_G)+JPOCk9~b?dRr3+Cg-W?wiBeTB%+m#0?$ zw?KI-Yb&cD_>vM9ZhL^S@yRj{xfi<@^`WECzFbf*n8T}di8UMVfb|gb)a{^bsn~cmz2p15z>s6N8{G^a3%Un8~ ze8Pe5bk3Raooda!I=K0LqO7(QNReM4>YIX{k?p?cdJ`TJWzrlG6dyJ0As!T&rXY;W z942%VriT&5au+jxWP0`7DS9r51UfV{R7zU9ioKx4dETz5qy&!u`sTZrZmkC=3|#{< z4f&6r9<;nuCPd`x@Y3*#p}o!7*}bImjUKT^>*aEJMfL`}Ev-XT7nFmddFwzv98Q+N z4tHl(!z~I5D!ri8R2-+X)xKXf-Tj}KzvnB?hN5)$eM=|W4XXjRAvb^quwGhJ|02OpA#AtKV$3nNry(e5q&bs;6*EY ztDhjq)>oUf^CJexg6!j>dYb zZFEz&1MC2VCgl|?f8c@(EoYgSI&S{E3u=k`=MOl+FkG<~)d zAMu^%kzAwAqB4``@%;AjYZl(~%kuD53Zd-lq`xEik-O}JO??JB+yh)hY;0fgsIp^FF89fsJjYq2;2~ zuk2LU=&EHlD-OaH&Hzjr**~f30tUc~##SUt8!CB|E=Et{viI(1ZY#n`=dlSOVOK_)WX3(!gE|lzwuGS3>k%c8+``Itv)>%zp5o=Oh zTnsj^7*H$vh894K;ztk}**8DyFW%v{c7AmeWDjD7r;5&@k$Pv%!@IcYq)caLVpdpN z3u`{98^-Eg{MBo#x}2e{ejE8#Mp9IiH7Yv#B0-a%*xp@}HH&}I_-}Ac84@($bzj_jvTV#krj z$Gm-6&Y{{8ixqS^J|$EooGbG3YdJXtsW-xr;Ht!9$z8dxU!tAm=m*#ZGj<+LW)SA13^s-F_3lF749x1P%oHL~1nfJ7_N1M#LkpZrHeY zgXT8vtUuVPe508z}H@UtU%4q8d$4@2k()1LgUFq>K;R?MIYe2ayRm=iDjb|L#4l}M^*KO;{ z)_W94L1Mf^t;43b4UiXXx0Rf{5xL zGYt)mUr3{sc(a)A@neL1_4+S&=vi$Rrub^6U7@6<($e)~)+Z>opioFmYHxo1?5{9l zynY=LMZQ?TcLkWgXWCr-`Z8V62BRIninHz^e@p~YsF&JFEOfNd1(N8gZ#?Wx=!d47 z8tWJymG;w@)iyt~2e#>)^phtLF17reM2PPzu~gwO23o&;-DXhEjI2$Vu*o%t(w3}l z%62Q%U(Xvu&N6s96&o6*?>GMvV>EZL$8BXxP$U!|vl7UAwOiLTM;E61{eIh)%hqbV z6CD&fo?XwKq21nYbef~-;XlUXa=Ly~8SQuFGU;wXaB!D~J{&@m zIczzy-!J&RhX}iSa%S{sKaF@9;Bl?dZ@Zxl^##E z0ypbpSKY$f)#=htFV||7v*e2=Wm@m$&p_77*rH?ZKc-k+hfSBryI}%xB6HtMs-20d z_iVY0?s~C{>+79>4;b#e_kN_|&cKAGYlrj~m2;ws#1a$lnINQT8?ol9& z^9rp&p%n^nKYH-e(8u~4C8SCii%`E2epjMdA5{F`PAuki8dc&dynk`WKZA)9Q&052 zDTr_Trk>zxz9jOOg-e#6CQDZ_%;|R{PI0XsZc06@+=d!sdKj6la^e zSEMD)XN7L0n*9JS55Q22g#aC=kg5!##b0P=j93N@7U6`z+P?zD*66U{xWorV@*u`W_k|V*S4)%q_>?jAd5bJL>!k76h*=Gw|lak0>R`lB5I61LueRKgzGK_AiO` z-z2`Id7QAxO-4d$OU+|JyFzHW0)~W+3YJ4cWKa6Dj!salw*NrYviq-@)VJs3&3%og zow@Rq5DrNaK|#WYhXT6+4vlN^HLo%*0wl?xuf=b~d(W}%~0li~RpR=*hz3cYqJ z^;f7TrK|W?c91aBGR5RJf>HiBg2O7uAWg(BM0HEwyk;gdPOCzxIZZ| z_`*$nrkw&hhtIh*d%(Di*Bx=#`-h>UU)KRx+*VIeE1ku8uD=?){10zB+|GJ(c(3ZL z=Gbxs9I?$Ob09EES)%ZTGTdZr;lg5e3ACr7c|2^a(d~v);`2(m<nrsv?F1gX){i6T1rMHP=XxA z<#az(FcC7TAIDL zkwq*d`p+M?=o+fsZpT^j_3ay7EaUn|=W97HaYEhn7}0*l@cG)Lp7JK z=F7vmqzn0{#>*dlPaiXky8GJN$l2KHGjSpV5)&~eaumSpdjYCu)A*WNKjwZ)YqV6T z&$2qMEIYV61HIDI)3>E$1$w<<-;lzM2Nn8eM{&f$J4X&-gM#@CmMV*b8s|d!UCvEy zZ!k2UX^#ZGjT6$<0sQ=+d)67}_stiM=7Vc<%!S)t;Qai2fcxoM&oS>6qzeihP8J?$ zb4L2`)B`&WUjOdfzqiq2zr`@>-?nbO)mhfW*=)1+BQK6yeKDE*V*#t{Blkk9A?nKN zYRGZ(5Y7G5lktf8m#C`%fd6xzFA9i@PJg@1rYH{?(pfQ0$XkpdrX+d6Q2sQv=wA`u z1Iou>3@o%gAx3?Yk;rT*%_h-qIU;TGTqv_4qeLZ4zLuAUqthq)UU7Ma zBA^6auw_PP<@j{9)95T{$*1XLW)G=|8e&#fRhcYa(~?3ze@dm6Z{}?+0W2 zDi#h*j`3zad*_Yo(^l)b&36lD5w4F$fE}`2Zz;Icf{t<7^yZlEFuTi`!Eau&g0sVx z&ZH}u&O~S(;g0GxaxOJcw_|5urA5_1AaQrF-LvukW+QBdfKH8oc9U|#J-Ayf^c*xn4O zfu&_+7%GU2rS?;-Bv=ewYckBH`uQ^%=_a(_%MI*At{{XiL8OE8CMze}^)7foW-Y~S zt;ON-Z0ARnFstTv6O004o2hlYki-Z0}%^N^J1Lo#1Nh>5_x z(tys-75=t!TU`mNY7%`IQ!_IZhx?@nY6W-Pg{4KKlaf^_bL%EZqomPkBDl+-F)Tyh zCKY?_wC?by0V;#f87Z32uK!uWdgG6Yx>!jy7J|37V+HAJ%axS*=hP$)#2C<>(CxMFoE-k+#h#~L-IY$t_iXdZN|Um3AVeo7 zy=O-G9G*baQFY|Ho?wK!Hq+?u%-4M>Z+<;16R(%wiVM6NQ>l@Lvp5@o{f-WeHFfY- zeGGVaP`)1)O@>!i-W7(U8?5uCYMifXjb(O&JL~w2Ec`EQsgsj^+j;o63LV8H_Se?d z&>^&eD9<@^CAg#JOgWnxkBL4z! zK1mf}F#PCR!D2RMAzICP))k(37Wb`zs0_~K(3kC13j1yjRNtbSS{xlYyuqE^2j)XD zVs-Qp+(zKxkBvqHh9uPz=pG)zvwE;Bg3eW(=(Po<~)XwcPxh(D1p!t8BU3E1s!*xt5IA zZthSf2P2Umo$Ry)#lfjo4B44AIx70y>~8Od)a=^O1Wxa{xF47MIH3YgN=T*KFS;-#tv${x`B6B zqP0YTD*JwMRCxEC21Sk6lEcI_vA@=(9m~>P&Q&z?iCMY?nT9Tz2&#;#@LEuPHAvM< z`u)9P6>{n!KlC#c;I%cIl(HIq{!^4VMKZJ+Oii*q^2i+nM^XRHrk8YL#NS+Xsq6kw zk{@O?-b$oHT%C>`DMbZW4zEWYKQwYn_shND;&t>kA%$*6HV_?#Iwa+A8bYvNKmCVb z^#_O+cD;czO~qMBC7dI>qG*pjNUuwWztq|EYRK3N^0K?rsg z59Kg2kW7SveJYT$$pry&Q+XN#chfHdxpKtY|B2+uy$cd(PS>xHzKf8DW5OUR2? IgAIcI2U;Ds5dZ)H literal 0 HcmV?d00001 diff --git a/fern/docs/pages/customization.mdx b/fern/docs/pages/customization.mdx index 3e04d467..7f30f5f6 100644 --- a/fern/docs/pages/customization.mdx +++ b/fern/docs/pages/customization.mdx @@ -47,7 +47,7 @@ _issue_ would have all _issue_ fields plus _bug_-specific fields like _RCA_. Subtypes are defined using a schema fragment of type `custom_type_fragment`. -## Customizing a DevRev object +## Customize a DevRev object Your team needs to track software bugs. You want to know: - Which environments are affected (development, testing, production) @@ -388,7 +388,7 @@ The object now references the latest fragment version (`custom_type_fragment/2`) the optional release notes field is absent, the tenant fragment remains attached, allowing for future tenant-specific field additions. -## Deprecating a custom schema fragment +## Deprecate a custom schema fragment Custom schema fragments can be deprecated to avoid creating work items using them. The following POST request payload to `schemas.custom.set` can be used: @@ -406,7 +406,7 @@ following POST request payload to `schemas.custom.set` can be used: } ``` -## Listing custom schema fragments +## List custom schema fragments The following API call can be used to list all the custom schema fragments in your organization: @@ -431,10 +431,16 @@ hints: * `is_sortable`: Whether the field is sortable. Requires `is_filterable` to be true. * `is_groupable`: Whether the field is groupable. Requires `is_filterable` to be true. * `order`: The order in which the field appears in the side panel. +* `is_read_only`: Whether the field is read-only in the UI. Once the object is created, this + field cannot be updated in the UI. * `group_name`: The group title under which field(s) appear in the side panel. In the example below, the fields are grouped under groups titled **Group 1** and **Group 2**. ![customization-group_name-ui-hint](../img/customization-group_name-ui-hint.png) +* `unit`: The unit for the field. For example, days, kg. The unit is displayed + in the side panel as shown below: + + ![customization-unit-ui-hint](../img/customization-unit-ui-hint.png) `is_filterable` is not a UI hint but a top level field property. @@ -535,7 +541,7 @@ and _closed_ states in your organization. You want to add a new stage _Needs RCA_ to the _bug_ subtype. -### Adding a custom stage +### Add a custom stage ```curl curl --location 'https://api.devrev.ai/stages.custom.create' \ @@ -622,7 +628,7 @@ curl --location 'https://api.devrev.ai/stage-diagrams.create' \ It is important to specify the start stage for the diagram. This is the default stage that gets assigned to the newly created objects. -### Using a stage diagram +### Apply a stage diagram The stage diagram created above can be referenced in the _bug_ subtype as follows: From 0cb6bec7e2196257aaaddb4cea932aa33521769c Mon Sep 17 00:00:00 2001 From: Ben Colborn Date: Thu, 5 Jun 2025 11:30:43 -0700 Subject: [PATCH 12/22] style rules for marketplace (#214) * some minor updates and organization * MP style and sample * corrected LLM token var name * prohibited * check responses better --------- Co-authored-by: Atul-Butola --- .github/workflows/stylecheck.yml | 2 +- llm_client.py | 38 ++++++++++++++------------------ style/prompt.md | 4 ++-- style/sample-marketplace.md | 33 +++++++++++++++++++++++++++ style/style-common.md | 28 ++++++++++++++++------- style/style-marketplace.md | 9 ++++++++ style/term-common.csv | 1 + 7 files changed, 82 insertions(+), 33 deletions(-) create mode 100644 style/sample-marketplace.md create mode 100644 style/style-marketplace.md diff --git a/.github/workflows/stylecheck.yml b/.github/workflows/stylecheck.yml index 5b7c358d..3fe3e58b 100644 --- a/.github/workflows/stylecheck.yml +++ b/.github/workflows/stylecheck.yml @@ -33,7 +33,7 @@ jobs: id: stylecheck env: GITHUB_TOKEN: ${{ secrets.STYLECHECK }} - LLM_JWT: ${{ secrets.LLM_JWT }} + LLM_TOKEN: ${{ secrets.LLM_TOKEN }} REPO_OWNER: ${{ github.repository_owner }} REPO_NAME: ${{ github.event.repository.name }} PR_NUMBER: ${{ github.event.pull_request.number }} diff --git a/llm_client.py b/llm_client.py index 879f0147..f95a8e5b 100644 --- a/llm_client.py +++ b/llm_client.py @@ -21,40 +21,34 @@ def get_response(prompt): r = requests.post('https://openwebui.dev.devrev-eng.ai/api/chat/completions', json=payload, headers=headers) r.raise_for_status() - print(r) if not r.text: raise ValueError("Empty response received from API") - else: - response = r.json() - - if not response.get('choices'): + json_response = r.json() + if not json_response.get('choices'): raise ValueError("No 'choices' field in response") - if not response['choices'][0].get('message'): + if not json_response['choices'][0].get('message'): raise ValueError("No 'message' field in response") - if not response['choices'][0]['message'].get('content'): + if not json_response['choices'][0]['message'].get('content'): raise ValueError("No 'content' field in response") - else: - response = response['choices'][0]['message']['content'] + response = json_response['choices'][0]['message']['content'] + + # Check if final response is empty if not response: - raise ValueError("Empty content received from LLM.") - else: - print("Response received from LLM.") - return response + raise ValueError("Empty content received from API") + + return response except requests.RequestException as e: - msg = f"HTTP request failed. Error: {type(e)} {e}" - print(msg) - return msg + print(f"HTTP request failed. Error: {type(e)} {e}") + return None except ValueError as e: - msg = f"Invalid response received. Error: {e}" - print(msg) - return msg + print(f"Invalid response received. Error: {e}") + return None except Exception as e: - msg = f"Failed to generate response. Error: {type(e)} {e}" - print(msg) - return msg + print(f"Failed to generate response. Error: {type(e)} {e}") + return None def get_lines_between_tags(text, tag): pattern = r'<' + tag + r'>(.*?)<\/' + tag + r'>' diff --git a/style/prompt.md b/style/prompt.md index 22316c4a..e289c319 100644 --- a/style/prompt.md +++ b/style/prompt.md @@ -1,3 +1,3 @@ -You are an expert technical documentation editor. Analyze the included document and revise it so that it adheres to the following style rules. While you can make suggestions for being more concise, be very careful not to remove any facts from the document. Also do not change the document structure, including removing the title or headings, unless the original structure violates any of the guidelines. Also check the terminology given in CSV format inside the `` element. +You are an expert technical documentation editor. Analyze the included document and revise it so that it adheres to the following style rules. While you can make suggestions for being more concise, be very careful not to remove any facts from the document. In general, make the minimum number of changes necessary to ensure that the document adheres to the guidelines. Avoid changing the document structure, including removing the title or headings, unless the original structure violates any of the guidelines. Also check the terminology given in CSV format inside the `` element. -In your response, summarize the violations that you fixed. Return the revised markdown inside a separate element `` element, just like in this request, that contains only the document and no other commentary. I’m going to read your suggestions through an API and need to be able to get just the document for the next stage. \ No newline at end of file +In your response, summarize the fixes you made. Return the revised markdown inside a separate `` element, just like in this request, that contains only the document and no other commentary. I’m going to read your suggestions through an API and need to be able to get just the document for the next stage. \ No newline at end of file diff --git a/style/sample-marketplace.md b/style/sample-marketplace.md new file mode 100644 index 00000000..31a65521 --- /dev/null +++ b/style/sample-marketplace.md @@ -0,0 +1,33 @@ +# Auto Parts to Conversation + + + +## Overview + +The Auto Part to Conversation snap-in is a powerful tool that utilizes advanced natural language processing (NLP) capabilities to analyze customer conversations. It aims to automatically identify the specific parts discussed in a conversation, providing valuable insights for enhanced customer service. + +## How it Works + +Once you install the snap-in, it does the following: + +1. Resolution assignment: When the conversation is resolved, the snap-in will automatically analyze customer conversations and identify the relevant parts being discussed. It will assign the appropriate part to the conversation based on its analysis. + +2. No part assignment when uncertain: In cases where the snap-in is unable to confidently identify a part, it will refrain from assigning any part to the conversation, ensuring accuracy. + +## Features + +**Automatic part assignment** + +The Auto Part to Conversation snap-in eliminates the need for manual intervention by automatically assigning the relevant part to a conversation. + +**Channel compatibility** + +It seamlessly works across various communication channels, including email, PLuG, and Slack, providing consistent functionality and efficiency. + +**High accuracy** + +The snap-in ensures high accuracy by assigning a part only when it has a high level of confidence, minimizing the possibility of errors. + +## Installation + +To enable the auto part to conversation snap-in, click the Install button and follow the installation steps. \ No newline at end of file diff --git a/style/style-common.md b/style/style-common.md index 104e8b8b..ed4fafff 100644 --- a/style/style-common.md +++ b/style/style-common.md @@ -7,21 +7,33 @@ For the writing style, apply the following descriptive keywords to revising the - Vocabulary choice: consistent, technical - Grammar and syntax: structured, flawless, articulate - Descriptive language: clear, concise, informative -- Language variant: standard technical/professional US American English; not British, Indian, or other variants. +- Language variant: standard technical/professional US American English; not British, Indian, or other variants +- Prohibited: profanity, hate speech, non-inclusive words, or any other unprofessional expressions There are also some very specific style rules that need to be followed: +- Avoid future tense when describing the behavior of the product. Use simple present instead. +- Do not make any reference to how things used to be ("currently", "new") or to future plans. + +### Titles + +- Do not use w-words (what, why, how) in headings or titles. +- Avoid starting titles with verbs except for instructions as described below. +- Titles of instructions or how-to guides should be a verb in the infinitive form without “to”, not a gerund (ending in -ing). Titles of any other type of section should be noun phrases. - Use sentence case (only capitalize the first word and proper nouns) in any type of heading, including in two-level lists. + +### Instructions or how-to guides + +- They may use two levels; both should be ordered (numbered) lists, not unordered (bulleted) lists. +- Instructions should be in imperative mood. +- If there is a location or condition in a step, it should be at the front of the main clause, which must still be in imperative mood. +- Steps should be more than a single "click"; combine steps if needed to make them more meaningful. If there is an outcome of the step stated, it should be part of the same step, not a new step. + +### Lists + - Ensure that any list is in parallel structure (use the same syntax for every entry). -- Instructions or how-to guides: - - They may use two levels; both should be ordered (numbered) lists, not unordered (bulleted) lists. - - Instructions should be in imperative mood. - - If there is a location or condition in a step, it should be at the front of the main clause, which must still be in imperative mood. - - Steps should be more than a single "click"; combine steps if needed to make them more meaningful. If there is an outcome of the step stated, it should be part of the same step, not a new step. - End each list item with a period or other appropriate sentence-ending punctuation, except in the following cases: - If the item consists of a single word, don't add end punctuation. - If the item doesn't include a verb, don't add end punctuation. - If the item is entirely in code font, don't add end punctuation. - If the item is entirely link text or a document title, don't add end punctuation. -- Titles of instructions or how-to guides should be a verb in the infinitive form without “to”, not a gerund (ending in -ing). Titles of any other type of section should be noun phrases. -- Avoid future tense when describing the behavior of the product. Use simple present instead. \ No newline at end of file diff --git a/style/style-marketplace.md b/style/style-marketplace.md new file mode 100644 index 00000000..b8745b77 --- /dev/null +++ b/style/style-marketplace.md @@ -0,0 +1,9 @@ +## Marketplace-specific style + +### Document structure + +- Start with a paragraph, not a title or heading. +- The first section should be an H2 titled "Features" containing a bulleted list of the snap-in features. +- The second section should be an H2 titled "Installation" containing a numbered list of the installation instructions. +- The third section should be an H2 titled "Configuration" containing a numbered list of the configuration instructions. +- No other sections are allowed. \ No newline at end of file diff --git a/style/term-common.csv b/style/term-common.csv index 88838474..4778c88f 100644 --- a/style/term-common.csv +++ b/style/term-common.csv @@ -1,6 +1,7 @@ Deprecated;Approved foo;example Devrev;DevRev +navigate to;go to RevOrg;workspace RevUser;customer snapin;snap-in \ No newline at end of file From 431bd83fe86b38b71b37554f9887af6d64c42d3a Mon Sep 17 00:00:00 2001 From: Ben Colborn Date: Thu, 5 Jun 2025 13:24:54 -0700 Subject: [PATCH 13/22] add instructions for local instance (#171) * add instructions for local instance * use yarn --------- Co-authored-by: Atul-Butola --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3fe1e03a..09923dc0 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ fern generate --version In the root of this repository: ``` -cd custom-implementation/ && npm i && npm run build && cd .. +cd custom-implementation/ && yarn && yarn build && cd .. fern docs dev ``` @@ -56,4 +56,4 @@ When the action completes, it adds the `stylecheck-complete` tag. If you want st To run the script locally and not as part of a PR, set your environment variable `LLM_TOKEN` to your PAT from [OpenWebUI](https://openwebui.dev.devrev-eng.ai/) > **Settings** > **Account** > API Keys. Include the supplemental developer style rules with the `--style` option. ``` python stylecheck.py --style=style/developer.md -``` +``` \ No newline at end of file From 08a5cd9c2ac9a97ea0bbfe572c98e7eeceab59bc Mon Sep 17 00:00:00 2001 From: Arturo Aparicio <16090899+arturo-aparicio@users.noreply.github.com> Date: Thu, 5 Jun 2025 16:41:38 -0700 Subject: [PATCH 14/22] Update supported objects for Airdrop (#250) * Update supported objects for Airdrop * Update supported-object-types.mdx * Update supported-object-types.mdx * Update supported-object-types.mdx --- fern/docs/pages/airdrop/supported-object-types.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/fern/docs/pages/airdrop/supported-object-types.mdx b/fern/docs/pages/airdrop/supported-object-types.mdx index c2e0042a..cb86699a 100644 --- a/fern/docs/pages/airdrop/supported-object-types.mdx +++ b/fern/docs/pages/airdrop/supported-object-types.mdx @@ -1682,3 +1682,4 @@ This document contains the list of all DevRev object types that are supported fo [ ▲ top](#summary) --- + From 347068dbfeed8274f2962bfb10fbf06177dd8dd3 Mon Sep 17 00:00:00 2001 From: Ben Colborn Date: Mon, 9 Jun 2025 08:04:28 -0700 Subject: [PATCH 15/22] Update ekline.yml (#249) ISS-180063 Co-authored-by: Atul-Butola --- .github/workflows/ekline.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ekline.yml b/.github/workflows/ekline.yml index aecb4f8c..517c2f77 100644 --- a/.github/workflows/ekline.yml +++ b/.github/workflows/ekline.yml @@ -19,5 +19,5 @@ jobs: ek_token: ${{ secrets.ek_token }} github_token: ${{ secrets.github_token }} reporter: github-pr-review - filter_mode: file + filter_mode: diff_context ignore_rule: "EK00031" # passive voice From e48fd8d9ad6cc47b88319bdc4170adeca9d129f8 Mon Sep 17 00:00:00 2001 From: shalomgk Date: Tue, 10 Jun 2025 14:57:55 +0530 Subject: [PATCH 16/22] Cross-domain session tracking link (#252) * Cross-domain session tracking link * Update fern/docs/pages/sdks/web/methods.mdx --------- Co-authored-by: Atul-Butola --- fern/docs/pages/sdks/web/methods.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/docs/pages/sdks/web/methods.mdx b/fern/docs/pages/sdks/web/methods.mdx index ba615946..a3f9643a 100644 --- a/fern/docs/pages/sdks/web/methods.mdx +++ b/fern/docs/pages/sdks/web/methods.mdx @@ -177,7 +177,7 @@ window.plugSDK.addSessionProperties({ ## Get session details -You can use the `getSessionDetails` method to fetch the session ID and tab ID of currently ongoing session. These details can then be passed across different domains to maintain the journey as a single, continuous session. +You can use the `getSessionDetails` method to fetch the session ID and tab ID of currently ongoing session. These details can then be passed across different domains to maintain the journey as a single, continuous session. For more details on how to fetch the session ID and tab ID, and pass them across different domains for a seamless journey, refer to [Cross-domain session tracking](https://devrev.ai/docs/plug/cross-domain-session). ```jsx const { sessionId, tabId } = window.plugSDK.getSessionDetails(); From d55f2f5ea3efe9aa82459e6ed9368bf5567bf4d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Patricija=20Bre=C4=8Dko?= Date: Wed, 11 Jun 2025 09:05:16 +0200 Subject: [PATCH 17/22] Minor Airdrop fixes (#253) --- fern/docs/pages/airdrop/getting-started.mdx | 7 +++---- fern/docs/pages/airdrop/local-development.mdx | 9 +++++---- fern/docs/pages/airdrop/manifest.mdx | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/fern/docs/pages/airdrop/getting-started.mdx b/fern/docs/pages/airdrop/getting-started.mdx index 7d8efe9b..9db5da85 100644 --- a/fern/docs/pages/airdrop/getting-started.mdx +++ b/fern/docs/pages/airdrop/getting-started.mdx @@ -3,8 +3,7 @@ as well as the capabilities and limitations of the external system being integra ## DevRev organization -If this is your first time setting up an organization within DevRev, you need to create a -DevRev organization for developing your new Airdrop snap-in: +If this is your first time developing a snap-in, you should start by creating a new DevRev organization: 1. Click on your profile picture in the top left corner. 2. Go to the **Orgs** section and click on **+**. @@ -40,13 +39,13 @@ A _sync unit_ is one self-encompassing unit of data that is synced to an externa - An organization Zendesk. In Jira, users often have multiple projects. Each project acts as an individual sync unit. -In contrast, Zendesk operates with a single large pool of tickets and agents. Here, the entire Zendesk instance can be synced in a single airdrop. +In contrast, Zendesk operates with a single large pool of tickets and agents. Here, the entire Zendesk instance can be synced in a single import. ### Sync run Airdrop extractions are done in _sync runs_. A sync run is one end-to-end (extract-transform-load) execution of a _sync unit_. -If you do an initial import from the external system to DevRev, that import will be one sync run. +If you do an initial import from the external system to DevRev, that import is one sync run. Another import in the same direction is another sync run. And if you then decide to do a reverse sync from DevRev to the external system, that would be another sync run. diff --git a/fern/docs/pages/airdrop/local-development.mdx b/fern/docs/pages/airdrop/local-development.mdx index 6610b944..a14652f5 100644 --- a/fern/docs/pages/airdrop/local-development.mdx +++ b/fern/docs/pages/airdrop/local-development.mdx @@ -3,6 +3,7 @@ For easier development you can run your Airdrop snap-in locally and receive logs ## Prerequisites - [devrev-cli](https://developer.devrev.ai/snapin-development/references/cli-install) (version 4.7 or higher) +- [chef-cli](https://github.com/devrev/adaas-chef-cli) - [jq](https://stedolan.github.io/jq) - [nodejs](https://nodejs.org/en/download/package-manager) (version 18.x.x+ or higher) - [ngrok](https://ngrok.com) @@ -13,7 +14,7 @@ DevRev offers a starter Airdrop snap-in template that is ready for immediate use 1. Create a new repository: - Create a new repository from this template by clicking the "Use this template" button in the upper right corner and then "Create a new repository". - - The repository name must start with `airdrop-` (for example, `airdrop--snap-in`). + - The repository name must start with `airdrop-` (for example, `airdrop-asana-snap-in`). 2. Open the project in your IDE and authenticate to your DevRev organization using the DevRev CLI: ```bash devrev profiles authenticate --org @@ -48,10 +49,10 @@ DevRev offers a starter Airdrop snap-in template that is ready for immediate use # Initial sync -Now that you have a running snap-in, you can start an airdrop. +Now that you have a running snap-in, you can start an import. Go to DevRev app and click **Airdrops** -> **Start Airdrop** -> **Your snap-in**. -1. Starting an airdrop begins with establishing a connection to the external system. The Airdrop snap-in prompts for specific information needed to create this connection. Afterwards, the snap-in verifies that the connection is successful and you should see a success message. +1. Starting an import begins with establishing a connection to the external system. The Airdrop snap-in prompts for specific information needed to create this connection. Afterwards, the snap-in verifies that the connection is successful and you should see a success message. 2. Once the connection is established, the snap-in collects information from the external system about the data unit to be exported. This phase is called _external sync units extraction_. An external sync unit is the data unit from the external system to be imported to DevRev. At this point, the DevRev app prompts the user to select an external sync unit from the list. @@ -65,4 +66,4 @@ Go to DevRev app and click **Airdrops** -> **Start Airdrop** -> **Your snap-in** The process described above is called the **initial sync**. In all subsequent syncs, the first two steps are skipped. -The snap-in constantly communicates with Airdrop platform, which manages its behavior. When an action occurs in the DevRev app, Airdrop platform sends a message to the snap-in with details about the event. The snap-in performs an action based on the event type. For example, when a user starts a new airdrop for the first time, Airdrop platform instructs the snap-in to perform an external sync unit extraction. The snap-in carries out the task and sends back available sync units to Airdrop platform. +The snap-in constantly communicates with Airdrop platform, which manages its behavior. When an action occurs in the DevRev app, Airdrop platform sends a message to the snap-in with details about the event. The snap-in performs an action based on the event type. For example, when a user starts a new import for the first time, Airdrop platform instructs the snap-in to perform an external sync unit extraction. The snap-in carries out the task and sends back available sync units to Airdrop platform. diff --git a/fern/docs/pages/airdrop/manifest.mdx b/fern/docs/pages/airdrop/manifest.mdx index 5dcbb7bc..22f8a5f3 100644 --- a/fern/docs/pages/airdrop/manifest.mdx +++ b/fern/docs/pages/airdrop/manifest.mdx @@ -110,7 +110,7 @@ keyring_types: There are some options to consider: * `kind` - The `kind` option can be either "secret" or "oauth2". The "secret" option is intended for storing various tokens, such as a PAT token. Use of OAuth2 is encouraged when possible. More information is available for [secret](/public/snapin-development/references/keyrings/secret-configuration) and [oauth2](/oauth-configuration). + The `kind` option can be either "secret" or "oauth2". The "secret" option is intended for storing various tokens, such as a PAT token. Use of OAuth2 is encouraged when possible. More information is available for [secret](/public/snapin-development/references/keyrings/secret-configuration) and [oauth2](/public/snapin-development/references/keyrings/oauth-configuration). * `is_subdomain` The `is_subdomain` field relates to the API endpoints being called. When the endpoints for fetching data from an external system include a slug representing the organization—such as for example `https://subdomain.freshdesk.com/api/v2/tickets`—set this key to "true". In this scenario, users creating a new connection are prompted to insert the subdomain. From a8e18ec0c4877c3fa14fac343f5b1fb4c1895465 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tilen=20Kav=C4=8Di=C4=8D?= Date: Wed, 11 Jun 2025 10:26:28 +0200 Subject: [PATCH 18/22] docs: Add fallback docs (#241) * Update IDM docs * Update supported object types * Add fallback description * Address comments * Don't capitalize titles in supported object types * Add hint for integrating DevRev documentation into MCP server * Introduce Chef UI, better explain fallbacks * Update fern/docs/pages/airdrop/initial-domain-mapping.mdx Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Nits * Address comments * frontend user-identity method (#232) * Update user-identity.mdx * Update user-identity.mdx Add beta message with limitations * changed the position of note (#243) * adding a note * Update ue-migration.mdx --------- Co-authored-by: Atul-Butola * chore: Update OpenAPI specs (#245) * Point to customization API docs from identity SDK docs (#246) * chore: Include 'Bearer' in authorization header documentation (#247) * Document `unit` and `is_read_only` customization UI hints (#248) - Use imperative tense in headings. This has been done in the custom objects documentation. - Use smaller image for group_name UI hint. * style rules for marketplace (#214) * some minor updates and organization * MP style and sample * corrected LLM token var name * prohibited * check responses better --------- Co-authored-by: Atul-Butola * add instructions for local instance (#171) * add instructions for local instance * use yarn --------- Co-authored-by: Atul-Butola * Update supported objects for Airdrop (#250) * Update supported objects for Airdrop * Update supported-object-types.mdx * Update supported-object-types.mdx * Update supported-object-types.mdx --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: shalomgk Co-authored-by: Avinash Singh Co-authored-by: Atul-Butola Co-authored-by: Brian Byrne Co-authored-by: Shivansh Rai Co-authored-by: Ben Colborn Co-authored-by: Arturo Aparicio <16090899+arturo-aparicio@users.noreply.github.com> --- .gitignore | 1 + .../pages/airdrop/initial-domain-mapping.mdx | 68 +++++++++++-------- fern/docs/pages/airdrop/mcp.mdx | 7 +- 3 files changed, 45 insertions(+), 31 deletions(-) diff --git a/.gitignore b/.gitignore index 4557c521..3179cd9a 100644 --- a/.gitignore +++ b/.gitignore @@ -3,5 +3,6 @@ fern/dist fern/*/definition/ .DS_Store .idea +.vscode temp __pycache__ \ No newline at end of file diff --git a/fern/docs/pages/airdrop/initial-domain-mapping.mdx b/fern/docs/pages/airdrop/initial-domain-mapping.mdx index b0f9d214..8e6b7636 100644 --- a/fern/docs/pages/airdrop/initial-domain-mapping.mdx +++ b/fern/docs/pages/airdrop/initial-domain-mapping.mdx @@ -11,17 +11,17 @@ system is triggered. You can create initial domain mappings using two methods: -1. **Chef-cli UI**: Interactive web interface for comprehensive mapping creation +1. **Chef UI**: Interactive web interface for comprehensive mapping creation 2. **Model Context Protocol (MCP)**: AI-assisted mapping creation for developers (experimental) -Choose the chef-cli UI for manual control or use MCP for rapid prototyping with AI assistance. +Choose the Chef UI for manual control or use MCP for rapid prototyping with AI assistance. MCP is an experimental feature and works locally without requiring a sync to be created. For AI-assisted mapping creation, see the [Model Context Protocol integration guide](./mcp.mdx). -## Chef-cli initial domain mapping setup +## Chef UI setup ### Prerequisites @@ -36,7 +36,7 @@ or by running `make auth` in your snap-in repository. ### Add your token as an environment variable -Obtain a PAT-token from the **Settings** > **Account** tab of the dev org where you deploy your snap-in, +Obtain a PAT-token from the **Settings** > **Account** tab of the org where you deploy your snap-in, and export it as `DEVREV_TOKEN`. You can also run the following command if you are authenticated with the CLI: @@ -70,7 +70,7 @@ Or you can use the interactive helper of the CLI: eval $(chef-cli ctx init); chef-cli ctx show > ctx.json ``` -### Use the local UI to create a recipe blueprint for your initial import +### Use the Chef UI ```bash chef-cli configure-mappings --env prod @@ -81,62 +81,57 @@ If you are also creating a bidirectional sync (DevRev to external system), to en chef-cli configure-mappings --env prod --reverse ``` -If your org is not in `US-East-1`, you have to override an environment variable to make sure the tool reaches the right server. For example: +If your org is not in `US-East-1`, you h ave to override an environment variable to make sure the tool reaches the right server. For example: ```bash ACTIVE_PARTITION=dvrv-in-1 chef-cli configure-mappings --env prod ``` The options are: `dvrv-us-1`, `dvrv-eu-1`, `dvrv-in-1`, and `dvrv-de-1`. -The first function of the local UI is to assemble a *blueprint* for a concrete import running in the test-org, allowing the mapping to be tested out and evaluated. -After it is used for the import, the mappings become immutable, but the chef-cli UI offers a button to make a draft clone, which can be edited again for refinements. +The first function of the Chef UI is to assemble a *blueprint* for a concrete import running in the test-org, allowing the mapping to be tested out and evaluated. +After it is used for the import, the mappings become immutable, but the Chef UI offers a button to make a draft clone, which can be edited again for refinements. ### Continue to initial domain mapping -When you are done, you should have the chef-cli context set up and have the chef-cli local UI running in your browser. -You can now use the chef-cli web UI to create initial domain mappings. +When you are done, you should have the chef-cli context set up and have the Chef UI running in your browser. +You can now use the Chef UI to create initial domain mappings. -## Use the local UI to create initial domain mappings +## Use the Chef UI to create initial domain mappings -The chef-cli UI generates an `initial_domain_mapping.json` file that must be embedded in your extractor. This defines the options that the end-user will see when they are mapping the data. +The Chef UI generates an `initial_domain_mapping.json` file that must be embedded in your extractor. This defines the options that the end-user sees when they are mapping the data. -Initial domain mappings differ from user mappings in two key ways: +Initial domain mappings provide two key configuration capabilities: -1. **Multiple mapping options**: The developer can choose how external record types map to DevRev records (e.g., external *task* can map to either *issue* or *ticket*). -2. **Category-based defaults**: Mappings can apply to entire record type categories, automatically handling new record types. +- **Multiple mapping options**: The developer can choose how external record types map to DevRev records (for example, external *task* can map to either *issue* or *ticket*). +- **Category-based defaults**: Mappings can apply to entire record type categories, automatically handling new record types. ### Map record types and fields -Use the chef-cli UI to map record types and fields. -The UI will show you the record types that are available in the org and allow you to map them to the external record types. -You should map one record type at a time. - -#### Mapping as custom object -The system allows importing record types and categories as custom objects. To achieve this you have to select `new_custom_object` when mapping the record type. For each external record type mapped as a custom object, a new custom **Leaf type** will be defined in DevRev and a **Subtype** will automatically be created. For more details on customization concepts, please refer to the -[Customization](../customization.mdx) and [Custom Objects](../custom-objects.mdx) documentation. - -The field mapping works the same as for the stock DevRev types, with the difference being that there are significantly fewer fields to map. All the unmapped fields of the external record type will be created as custom fields. +Use the Chef UI to map record types and fields. +The UI displays the external record types you defined in external domain metadata and allows you to map them to DevRev objects. +Map one record type at a time, ensuring you map all required fields and as many optional fields as possible. ### Specify fallback mappings -For most required DevRev fields we require a fallback. This is used on object creation if the extractor doesn't provide a value. +For some required DevRev fields a fallback is required. -The fallback should be a DevRev value that is valid for the field. -For enum fields, the fallback should be the enum **value** as specified in [Supported object types](./supported-object-types.mdx). +The fallback you choose is used on item creation if the extractor doesn't provide a value for the required DevRev field. +This is useful for fields that are required by DevRev but optional in the external system. ### Install the blueprint -Click **Install in this org** to access the initial domain mapping creation screen. +Apply the mappings and **install them in your org** to access the initial domain mapping creation screen. Follow the instructions to create your initial domain mapping. ### Merge configurations -You can repeat the process for different record types and fields to create multiple mappings. -In the install screen, you can merge your mappings with existing initial mappings. +To create multiple mappings for different record types and fields, repeat this process: +Create a new import, map the record types and fields, then install the mappings in your org. +The install screen allows you to merge new mappings with existing initial domain mappings. ### Export the mapping file @@ -148,6 +143,12 @@ When all fields are mapped correctly, click **Export** to download `initial_doma You can provide a local metadata file for enhanced functionality: + + +### Advanced configuration + +You can provide a local metadata file for enhanced functionality: + ```bash chef-cli configure-mappings --env prod -m metadata.json ``` @@ -156,6 +157,13 @@ This enables: - Raw jq transformations using external fields as input (experimental) - Example input data for testing transformations + +The local metadata file is not validated against the snap-in submission. + +This enables: +- Raw jq transformations using external fields as input (experimental) +- Example input data for testing transformations + The local metadata file is not validated against the snap-in submission. diff --git a/fern/docs/pages/airdrop/mcp.mdx b/fern/docs/pages/airdrop/mcp.mdx index 0a387c34..c76417e4 100644 --- a/fern/docs/pages/airdrop/mcp.mdx +++ b/fern/docs/pages/airdrop/mcp.mdx @@ -42,6 +42,11 @@ Create a `.mcp.json` file with the following content: 3. Use the editor to guide the AI to create the initial domain mappings. 4. Use `initial-mapping check` to test the initial domain mappings against the local domain metadata file. + +To assist you in creating the Airdrop snap-in you can add DevRev's documentation to your MCP server, just add `https://developer.devrev.ai/public/airdrop/` as a custom docs URL. +See [Cursor documentation](https://docs.cursor.com/context/@-symbols/@-docs#add-custom-docs) for more information. + + ### Claude Code setup 1. Provide `.mcp.json` in your project root. @@ -58,7 +63,7 @@ You can use the same `.mcp.json` file in other IDEs that support MCP. To guide the AI tool, provide the following instructions to your AI assistant: ```markdown -When asked to perform airdrop initial mapping: +When asked to perform Airdrop initial mapping: - Refer to the `metadata.json` for the external domain metadata. - Use `mappings.json` as your initial domain mapping file. From ddfbb0ce5609bba4c01013369654f1ea0708b031 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tilen=20Kav=C4=8Di=C4=8D?= Date: Wed, 11 Jun 2025 11:00:12 +0200 Subject: [PATCH 19/22] Fix merge --- fern/docs/pages/airdrop/supported-object-types.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/docs/pages/airdrop/supported-object-types.mdx b/fern/docs/pages/airdrop/supported-object-types.mdx index cb86699a..513573a6 100644 --- a/fern/docs/pages/airdrop/supported-object-types.mdx +++ b/fern/docs/pages/airdrop/supported-object-types.mdx @@ -1,6 +1,6 @@ # Supported DevRev object types for Airdrop -Last updated: _June 9, 2025_ +Last updated: _June 11, 2025_ This document contains the list of all DevRev object types that are supported for Airdrop. From 701f9e6294f6368eb516ea65d9d4dbec890ea71c Mon Sep 17 00:00:00 2001 From: Faris Date: Wed, 11 Jun 2025 12:49:08 +0200 Subject: [PATCH 20/22] Readd custom object documentation --- fern/docs/pages/airdrop/initial-domain-mapping.mdx | 6 ++++++ fern/docs/pages/airdrop/metadata-extraction.mdx | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/fern/docs/pages/airdrop/initial-domain-mapping.mdx b/fern/docs/pages/airdrop/initial-domain-mapping.mdx index f7f4ee1a..bba41525 100644 --- a/fern/docs/pages/airdrop/initial-domain-mapping.mdx +++ b/fern/docs/pages/airdrop/initial-domain-mapping.mdx @@ -115,6 +115,12 @@ Use the Chef UI to map record types and fields. The UI displays the external record types you defined in external domain metadata and allows you to map them to DevRev objects. Map one record type at a time, ensuring you map all required fields and as many optional fields as possible. +#### Mapping as custom object +The system allows importing record types and categories as custom objects. To achieve this you have to select `new_custom_object` when mapping the record type. For each external record type mapped as a custom object, a new custom **Leaf type** will be defined in DevRev and a **Subtype** will automatically be created. For more details on customization concepts, please refer to the +[Customization](../customization.mdx) and [Custom Objects](../custom-objects.mdx) documentation. + +The field mapping works the same as for the stock DevRev types, with the difference being that there are significantly fewer fields to map. All the unmapped fields of the external record type will be created as custom fields. + ### Specify fallback mappings For some required DevRev fields a fallback is required. diff --git a/fern/docs/pages/airdrop/metadata-extraction.mdx b/fern/docs/pages/airdrop/metadata-extraction.mdx index e473d1f6..72be473d 100644 --- a/fern/docs/pages/airdrop/metadata-extraction.mdx +++ b/fern/docs/pages/airdrop/metadata-extraction.mdx @@ -561,6 +561,6 @@ be changed by the end user at any time, such as mandatory fields or custom field In the above example: - The external *type* field is declared as the `link_type_field`. - The `link_direction_names` provide a mapping of each value in the `link_type_field` to their directional names. `forward_name` and `backward_name` can be the same, but both are required. - - The human-readable name of the link type is taken from the enum values defined on the `link_type_field`. The linkable object types in DevRev will be defined based on the mappings of the *source_id* and *target_id* [fields](./supported-object-types.mdx#custom_link#). + - The human-readable name of the link type is taken from the enum values defined on the `link_type_field`. The linkable object types in DevRev are defined based on the mappings of the *source_id* and *target_id* [fields](./supported-object-types.mdx#custom_link#). \ No newline at end of file From 85c4748a6d50cdc92f417a6b6365b914f0974006 Mon Sep 17 00:00:00 2001 From: Faris Date: Wed, 11 Jun 2025 12:50:26 +0200 Subject: [PATCH 21/22] remove metadata version mentions --- fern/docs/pages/airdrop/metadata-extraction.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/docs/pages/airdrop/metadata-extraction.mdx b/fern/docs/pages/airdrop/metadata-extraction.mdx index 72be473d..bb094cf1 100644 --- a/fern/docs/pages/airdrop/metadata-extraction.mdx +++ b/fern/docs/pages/airdrop/metadata-extraction.mdx @@ -504,7 +504,7 @@ be changed by the end user at any time, such as mandatory fields or custom field - If a status field has no explicit transitions but you still want a stage diagram, set `all_transitions_allowed` to `true`, which creates a diagram where all the defined stages can transition to each other. - External systems may categorize statuses (like Jira's status categories), which can be included in the diagram metadata (`states` in the example). - The `starting_stage` defines the initial stage for new object instances. This data should always be provided if available, otherwise the starting stage is selected alphabetically. - - In current metadata format (v0.2.0), the order and human-readable name are taken from the enum values defined on the controlling field. + - The order and human-readable name are taken from the enum values defined on the controlling field. - If the `states` field is not provided, default DevRev states are used: `open`, `in_progress`, and `closed`. ### Declare custom link types From 0f697195d05d239ad286006588766a8428cbb38b Mon Sep 17 00:00:00 2001 From: ftopic <108405023+ftopic@users.noreply.github.com> Date: Thu, 12 Jun 2025 08:19:02 +0200 Subject: [PATCH 22/22] Update fern/docs/pages/airdrop/metadata-extraction.mdx Co-authored-by: Ben Colborn --- fern/docs/pages/airdrop/metadata-extraction.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/docs/pages/airdrop/metadata-extraction.mdx b/fern/docs/pages/airdrop/metadata-extraction.mdx index bb094cf1..578a5768 100644 --- a/fern/docs/pages/airdrop/metadata-extraction.mdx +++ b/fern/docs/pages/airdrop/metadata-extraction.mdx @@ -561,6 +561,6 @@ be changed by the end user at any time, such as mandatory fields or custom field In the above example: - The external *type* field is declared as the `link_type_field`. - The `link_direction_names` provide a mapping of each value in the `link_type_field` to their directional names. `forward_name` and `backward_name` can be the same, but both are required. - - The human-readable name of the link type is taken from the enum values defined on the `link_type_field`. The linkable object types in DevRev are defined based on the mappings of the *source_id* and *target_id* [fields](./supported-object-types.mdx#custom_link#). + - The human-readable name of the link type is taken from the enum values defined on the `link_type_field`. The linkable object types in DevRev are defined based on the mappings of the `source_id` and `target_id` [fields](./supported-object-types.mdx#custom_link#). \ No newline at end of file