{
  "openapi": "3.0.3",
  "servers": [
    {
      "url": "https://api.smartsheet.com/2.0"
    },
    {
      "url": "https://api.smartsheet.eu/2.0"
    },
    {
      "url": "https://api.smartsheet.au/2.0"
    }
  ],
  "info": {
    "title": "Smartsheet OpenAPI Reference",
    "version": "2.0.0",
    "contact": {
      "name": "Support",
      "url": "https://help.smartsheet.com/contact"
    },
    "description": "Welcome to the OpenAPI reference documentation for the Smartsheet API!\n\n> **Important:**\n> * The Smartsheet API is restricted to users on Business and Enterprise plans\n> * The <a href=\"https://www.smartsheet.com/legal/developer-program-agreement\" target=\"_blank\" rel=\"noopener noreferrer\">Developer Agreement</a> governs the use of the Smartsheet API and Smartsheet software development kits (SDKs)\n\n**QUICKLINKS**\n\n- **Base URL:**\n\n    ```\n    https://api.smartsheet.com/2.0/\n    ```\n\n- **Getting started:** <a href=\"https://help.smartsheet.com/articles/2482389-generate-API-key\" target=\"_blank\" rel=\"noopener noreferrer\">Generate an API access token</a> and [make a request](/api/smartsheet/guides/getting-started).\n\n- **Changelog:** See the latest [API updates](/api/smartsheet/changelog).\n\n- **Schemas:** View the [object schemas](/api/smartsheet/openapi/schemas) not explicitly listed in the resource sections.\n\n- **Error codes:** Look up common API [error codes](/api/smartsheet/error-codes).\n\n- **Guides:** Learn various ways of using the API with the help of our [Guides](/api/smartsheet/introduction).\n\nBrowse the Smartsheet API operations by resource on the left and start building with the Smartsheet API!\n"
  },
  "tags": [
    {
      "name": "alternateEmailAddress",
      "x-displayName": "Alternate Email addresses",
      "description": "A User in Smartsheet must have a primary email address associated with\ntheir user account (User.email) and may optionally have one or more\nalternate email addresses associated with their account\n(User.alternateEmails). \n\n> **Who can use these operations?**\n> \n> - **Plans:** Only Enterprise and Advanced Work Management plans with this feature activated by Support can use this method. If you want to activate this feature, please contact Support.\n> - **Permissions:** System Admin\n\nThe following operations must be performed using\nan user's primary email address:\n\n* Add Group Members\n* Add User\n* Create Update Request\n* Share Report\n* Share Sheet\n* Share Workspace\n\nAttempting to specify a user's alternate email address for any of the\nabove operations results in an error.\n"
    },
    {
      "name": "attachments",
      "x-displayName": "Attachments",
      "description": "Attachments can exist on a [comment](/api/smartsheet/openapi/comments) (that is,\nwithin a discussion), on a [row](/api/smartsheet/openapi/rows), or on a\n[sheet](/api/smartsheet/openapi/sheets).\n\n<h2>Post an Attachment</h2>\n\nLike the Smartsheet app, the Smartsheet API allows uploading files to\nsheets, rows, and comments.\n\nYou can upload a file by performing either a simple upload or a multipart\nupload.\n\n\nA simple upload allows you\nto add a single file attachment to the specified object.\n\nFor example, you can perform a simple upload to attach a file to a\nsheet, [attach a\nfile to a row](/api/smartsheet/openapi/attachments/row-attachments-attachfile), or\n[attach a file to a\ncomment](/api/smartsheet/openapi/attachments/attachments-attachtocomment).\n\n\nA multipart upload\nallows you to add a single file attachment to the specified object (that\nis, attach a file to a sheet, row, or comment), or to create an object and\nattach a file using a single request.\n\nFor example, you can perform a multipart upload to [add a new\ncomment](/api/smartsheet/openapi/comments/comments-create) that contains a single\nfile attachment or to [add a new discussion to a\nsheet](/api/smartsheet/openapi/discussions/discussions-create) that contains a\nsingle file attachment.\n\n\nThe max file size for uploads through the API is limited to 30mb.\n\n\nNOTE: This is a resource-intensive operation. If you encounter an error,\nsee [Rate Limiting](/api/smartsheet/guides/advanced-topics/scalability-options).\n\n\n<h3>Multipart Uploads</h3>\n\n\nA multipart upload request must include the following HTTP headers:\n\n\n| Header | Description |\n| -----|-----|\n| **Content-Length** | The length of the request payload. |\n| **Content-Type** | Must be set to **multipart/form-data**, and include the\nboundary string that separates the parts in the request payload. |\n\n\nThe request body of a multipart upload request contains one or more parts,\neach part containing either JSON or a file to upload.\n\nThe request body must contain at least one part.\n\nEach part must start with the boundary string specified in the\n**Content-Type** request header, and must contain the following part\nheaders:\n\n\n| Header | Description |\n| -----|-----|\n| **Content-Disposition** | Contains the following semicolon-delimited items:<ul><li>form-data</li><li>name='*partname*'</li><li>filename='*filename*' (only required for file parts)</li></ul>NOTE: Values specified in the Content-Disposition header must be URL-encoded. |\n| **Content-Type** | The content type of the part: **application/json** for JSON objects, or the applicable MIME type for file parts |\n\n\nThe last part in the request must be followed by the boundary string,\nfollowed by two hyphens.\n\n\nThe documentation for each operation that supports multipart uploads\nspecifies the number and names of parts that are expected for the\noperation.\n\nFile parts must have the part name \"file\", and documentation for\noperations which allow for JSON object parts specify the required part\nname for the JSON part.\n\n\nThe following example shows a multipart upload request that creates a\ncomment containing the specified text and file attachment:\n\n\n`POST\nhttps://api.smartsheet.com/2.0/sheets/4509093797881732/discussions/2889925487028100/comments`\n\n`Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789`\n\n`Content-Length: 29008`\n\n`Content-Type: multipart/form-data; boundary=----gU8h01zAAp3LagBr`\n\n\n`------gU8h01zAAp3LagBr`\n\n`Content-Disposition: form-data; name=\"comment\"`\n\n`Content-Type: application/json`\n\n\n`{ \"text\": \"Please review the attached image.\" }`\n\n`------gU8h01zAAp3LagBr`\n\n`Content-Disposition: form-data; name=\"file\"; filename=\"picture.jpg\"`\n\n`Content-Type: image/jpeg`\n\n\n*< Binary content for file >*\n\n`------gU8h01zAAp3LagBr--`\n\n\nNOTE: Most programming languages have libraries that can be used to\nassemble multipart requests.\n\n\n<h3>Simple Uploads</h3>\n\n\nTo perform this kind of upload, you must set specific headers to tell\nSmartsheet about the file. The following three headers are required:\n\n\nHeader | Description |\n-----|-----|\n**Content-Disposition** | **attachment** to tell the API that a file is in the body of the `POST` request, followed by a semicolon, followed by **filename=** and the URL-encoded filename in quotes\n**Content-Length** | Must be set to the size of the file, in bytes. For example to determine file size using in UNIX: <p>`$ ls -l ProgressReport.docx`<br/>`5463 ProgressReport.docx`</p>\n**Content-Type** | Can be left blank if it is not known (but must be present); Smartsheet makes its best guess based on the extension of the file.\n\n\nThe following example request shows a simple upload that adds a file\nattachment to a sheet:\n\n\n`POST https://api.smartsheet.com/2.0/sheets/4509093797881732/attachments`\n\n`Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789`\n\n`Content-Disposition: attachment; filename=\"ProgressReport.docx\"`\n\n`Content-Type: application/msword`\n\n`Content-Length: 5463`\n\n\n*< Binary content for file >*\n\n\nAs shown in this example, the contents of the file is included in the body\nof the `POST` request. In most programming languages, this is done by\nreading the file from an input stream and writing it out to the output\nstream of the HTTP request.\n"
    },
    {
      "name": "automationRules",
      "x-displayName": "Automation Rules",
      "description": "Automation is a catch-all term for approvals, notifications, and update\nrequests. You can delete, update, or retrieve various automation settings\nthrough the API. You cannot create new automation rules programmatically.\n\n<h2>Disabled Reasons for Automation Rules</h2>\n\nReason | Description |\n-----|-----|\n**APPROVAL_COLUMN_MISSING** | This rule's approval status column has been deleted.\n**APPROVAL_COLUMN_WRONG_TYPE** | The approval column must be a dropdown column.\n**AUTOMATION_NOT_ENABLED_FOR_ORG** | To create or edit automated actions, you need to upgrade your organization account to a Business or Enterprise plan.\n**COLUMN_MISSING** | A column referenced by this rule has been deleted.\n**COLUMN_TYPE_INCOMPATIBLE** | A column referenced by this rule has been changed to an incompatible column type.\n**NO_POTENTIAL_RECIPIENTS** | This rule has no recipients that will be able to receive notifications based on this sheet's permission settings or this account's approved domain sharing list.\n**NO_VALID_SELECTED_COLUMNS** | All selected columns for this rule have been deleted.\n"
    },
    {
      "name": "cellImages",
      "x-displayName": "Cell Images",
      "description": "A cell image is an image that has been uploaded to a cell within a sheet.\n"
    },
    {
      "name": "cells",
      "x-displayName": "Cells",
      "description": "A collection of cells comprises each row in a sheet.\n\n<h2>Cell Links</h2>\n\nCreating or updating cell links via the **cell.linkInFromCell** attribute is a special operation.\nA given row or cell update operation may contain only link updates, or no link updates.\nAttempting to mix row/cell updates with cell link updates results in error code 1115.\nAdditionally, a [CellLink object](/api/smartsheet/openapi/schemas/celllink) can only be added to an existing cell, so the **cell.linkInFromCell** attribute is not allowed when POSTing a new row to a sheet.\n\nWhen creating a cell link, **cell.value** must be null (the data is pulled from the linked cell).\n\nA cell may not contain both a hyperlink and a cell link, so **hyperlink** and **linkInFromCell** may never both be non-null at the same time.\n\n<h2>Cell Reference</h2>\n\n<h3>Cell Value Representation</h3>\n\n[Cell objects](/api/smartsheet/openapi/cells/cell) retrieved through the Smartsheet APIs have two main attributes representing cell values: **Cell.value**, and\n**Cell.displayValue**. A third attribute, **Cell.objectValue** is currently used only for adding and updating predecessors, or for multi-contact or multi-picklist details, such as email addresses or values in a multi-picklist. An empty cell returns no value.\n\n**Cell.displayValue** is always a string and is only returned for certain column types (see below).  It represents the formatted value as it should\nbe displayed to an end-user.  For example, if a TEXT_NUMBER column is formatted as a US Dollar currency, its **value** may be a number\nlike 1234.5678, but its **displayValue** is \"$1,234.57\".\n\n**Cell.value** represents a cell's raw value and can be one of the following primitive JSON types: string, number, or Boolean,\ndepending on the column type.  An empty cell returns no value. Complex types are represented as strings, formatted as described below:\n\n<a href=\"https://help.smartsheet.com/articles/765737-project-sheet-columns-start-date-end-date-duration-complete-and-predecessors\" target=\"_blank\" rel=\"noopener noreferrer\">Help with Project Columns</a>\n\nColumn Type | Possible Types for Cell.value | Returns Cell.displayValue?\n------------|-------------------------------|---------------------------\nABSTRACT_DATETIME | string: a project date and time in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO-8601</a> format, or a free-form text value.<br/>number: see [Dates and Times](/api/smartsheet/guides/basics/dates-and-times) for how to request dates to be returned as numbers. | No.\nCHECKBOX | Boolean: **true** if the checkbox is checked, **false** if unchecked, no value if the cell hasn't been touched yet.<br/>string: a free-form text value. | No.\nCONTACT_LIST | string: an email address representing a contact, or a free-form text value. | Yes: same as **value** for free-form strings; for contacts, the contact's name if any, else their email address.\nDATE | string: a date in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO-8601</a> format, or a free-form text value.<br/>number: see [Dates and Times](/api/smartsheet/guides/basics/dates-and-times) for how to request dates to be returned as numbers. | No.\nDURATION | string: a duration value such as \"4d 6h 30m\" in the user's locale, or a free-form text value.<br/>See the <a href=\"https://help.smartsheet.com/articles/765727-enabling-dependencies-using-predecessors#toc-duration-and-predecessors\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a> for more information on durations. | Yes: same as **value**\nMULTI_CONTACT_LIST | string: only visible when using a query parameter of **level** and the value appropriate to the dashboard, report, or sheet that you are querying, otherwise the column type is TEXT_NUMBER. | Yes: same as **value**; to see actual email addresses, see below.\nMULTI_PICKLIST | string: only visible when using a query parameter of **level** and the value appropriate to the dashboard, report, or sheet that you are querying, otherwise the column type is TEXT_NUMBER. | Yes: same as **value**; to see objectValue, see below.\nPICKLIST | string: one of the picklist's column options, or a free-form text value.<br/>number: numeric values | Yes: same as **value** for strings; for number values, the number with formatting applied.\nPREDECESSOR\t| string: a comma-delimited predecessor list such as \"12FS +3d 4h, 14SS\", or a free-form text value.<br/>See the <a href=\"https://help.smartsheet.com/articles/765727-enabling-dependencies-using-predecessors#toc-duration-and-predecessors\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a> for more information on predecessors. | Yes: same as **value**\nTEXT_NUMBER\t| string: free-form text values<br/>number: numeric values | Yes: same as **value** for strings; for number values, the number with formatting applied.\n\n**Cell.objectValue** is an object representation of a cell's value and is currently used for adding or updating predecessor cell values, or for multi-contact details, such as email addresses.\n\n* For predecessors, it provides a more \"programmer friendly\" format for assembling predecessors. To update a cell's predecessors, set **objectValue** to a\n[PredecessorList object](/api/smartsheet/openapi/schemas/predecessorlist) containing [Predecessor objects](/api/smartsheet/openapi/schemas/predecessor).\n* For multi-contact or multi-picklist details, use both a level query parameter *and* an **include=objectValue** query to see email addresses rather than display names or to see multi-picklist values.\n\n<h3>Cell Value Parsing</h3>\n\nThe flexibility in cell value data types is a powerful feature in the Smartsheet application; however, it poses a challenge\nfor an API in terms of parsing. Being too flexible might result in unexpected behavior. For instance, if you write code\nto post a Date value to a Smartsheet and the API operation succeeds, you might assume that the date value you sent was interpreted\nas date. What happens if you posted your date in the wrong format? Do you really want Smartsheet to keep the malformed date\nas a string value? Probably not.\n\nTo address this problem, the Smartsheet API employs a simple scheme to indicate whether you want a more predictable and strict\ninterface or a more flexible one. By default, a cell value is expected to conform to \"strict\" rules for the type of the cell's column.\nIf an input value doesn't conform, the API returns [error code 1042](/api/smartsheet/error-codes).\n\nIf, however, you want the same flexibility as the Smartsheet Web app, you can disable the strict rules, and we'll do our best to make\nsense of it. To enable lenient parsing simply include **\"strict\": false** in the [Cell object](/api/smartsheet/openapi/cells/cell) in your request body.\n\nNOTE: How does strict cell value parsing compare to cell validation settings? Strict cell value parsing determines how string values are parsed. It is set on a per-call basis. In contrast, cell validation is part of the column definition. The <b>overrideValidation</b> property is restricted to sheet admins and does <i>not</i> override strict parsing.\n\nThe parsing rules for the various column types are as follows:\n\n**ABSTRACT_DATETIME**\n\nValue | Description |\n-----|-----|\n**lenient** | Smartsheet attempts to convert the string value to date using ISO 8601 date format, as well as several locale-specific date formats. If the value is a parsable date format, Smartsheet recognizes the date and stores it as such. All other values are simply text values.\n**strict** | The value must be a string value and a valid ISO 8601 date (YYYY-MM-DD). Alternatively, if Unix time (also known as epoch time) is used, you can use the query parameter of **numericDates** set to **true** to have Smartsheet convert epoch time to human readable dates. See [Dates and Times](/api/smartsheet/guides/basics/dates-and-times) for more information.\n\n**CHECKBOX**\n\nValue | Description |\n-----|-----|\n**lenient** | Boolean values and string values of **true** and **false** are handled the same as **strict**. All other values are saved as text values.\n**strict** | Only Boolean values (true or false) are valid.\n\n**CONTACT_LIST**\n\nValue | Description |\n-----|-----|\n**lenient** | If the value is a valid email address, Smartsheet handles it the same as **strict**. If not, Smartsheet saves the value as a text value.\n**strict** | The value must be a valid email address. If **displayValue** is set, Smartsheet uses that as the name; otherwise, if Smartsheet finds a match among the the access token owner's contacts, Smartsheet associates this cell with that existing contact.\n\nNOTE: See the [Contact List Columns](/api/smartsheet/openapi/cells) section for more information.\n\n**DATE**\n\nValue | Description |\n-----|-----|\n**lenient** | Smartsheet attempts to convert the string value to date using ISO 8601 date format, as well as several locale-specific date formats. If the value is a parsable date format, Smartsheet recognizes the date and stores it as such. All other values are simply text values.\n**strict** | The value must be a string value and a valid ISO 8601 date (YYYY-MM-DD). Alternatively, if Unix time (also known as epoch time) is used, you can use the query parameter of **numericDates** set to **true** to have Smartsheet convert epoch time to human readable dates. See [Dates and Times](/api/smartsheet/guides/basics/dates-and-times) for more information.\n\n**DURATION**\n\nValue | Description |\n-----|-----|\n**lenient** | Numeric values are treated as duration values in days. String values which are valid duration strings in the user's locale are treated as durations, and any other values are treated as free-form text values.\n**strict** | Only valid duration strings in the user's locale are valid. Information on duration strings can be found in the <a href=\"https://help.smartsheet.com/articles/765727-enabling-dependencies-using-predecessors#toc-duration-and-predecessors\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>.\n\nNOTE: You may use the query string parameter <b>projectParseLocale</b> with a [supported locale string](/api/smartsheet/openapi/serverinfo) to force parsing in the specified locale (for example, using <b>en_US</b> lets you send in English values regardless of the user's locale).\n\n**MULTI_CONTACT_LIST**\n\nValue | Description |\n-----|-----|\nN/A | Set using the **objectValue** attribute for the Cell object, which is inherently strict. See [Cell Reference](/api/smartsheet/openapi/cells).\n\n**MULTI_PICKLIST**\n\nValue | Description |\n-----|-----|\nN/A | Set using the **objectValue** attribute for the Cell object, which is inherently strict. See [Cell Reference](/api/smartsheet/openapi/cells).\n\n**PICKLIST**\n\nValue | Description |\n-----|-----|\n**lenient** | All numeric and text values are valid. Formatted numbers are parsed like TEXT_NUMBER formatted numbers.\n**strict** | The value must be a string and must be one of the options for the picklist.\n\n**PREDECESSOR**\n\nValue | Description |\n-----|-----|\nN/A | Set using the **objectValue** attribute for the Cell object, which is inherently strict. See [Cell Reference](/api/smartsheet/openapi/cells).\n\n**TEXT_NUMBER**\n\nValue | Description |\n-----|-----|\n**lenient** | All numeric and text values are valid. Formatted numbers passed as text values, such as currencies (\"$5,000\"), percentages (\"50%\"), or decimals (\"100.5\") are parsed to their numeric equivalents, based on the locale of the access token owner,  with the proper formatting enabled for the cell.\n**strict** | All numeric and text values are valid and are interpreted literally.\n\nNOTE: The Smartsheet application only supports numeric values in the range -9007199254740992 to 9007199254740992. If using strict parsing, any numeric value outside that range results in [error code 1148](/api/smartsheet/error-codes). If using lenient parsing, the value is silently converted to text.\n\n<h3>Contact List Columns</h3>\n\nWith columns of type **CONTACT_LIST**, the cell attributes **value** and **displayValue** are treated independently.\nThe contact's email address is represented by **value**, while the contact's name (and the value displayed in the cell in the Smartsheet app) is represented by **displayValue**.\n\nWhen creating or updating cells for a contact list column, the **displayValue** attribute works as follows:\n\n* If **displayValue** is non-null and non-empty, the Smartsheet cell displays the value provided.\n* If **displayValue** is an empty string, the Smartsheet cell displays the email address.\n* If **displayValue** is null or absent, Smartsheet makes a best guess effort at filling it in with a contact's name based on the email address.\n\n<h2>Hyperlinks</h2>\n\nYou can create and modify [hyperlinks](/api/smartsheet/openapi/schemas/hyperlink) by using any API operation that creates or updates cell data.\nWhen creating or updating a hyperlink, **cell.value** may be set to a string value or null.\nIf null, the cell's value is derived from the hyperlink:\n\n* If the hyperlink is a URL link, the cell's value is set to the URL itself.\n* If the hyperlink is a dashboard, report, or sheet link, the cell's value is set to the dashboard, report, or sheet name.\n\n<h3>Images in Cells</h3>\n\nFor details about working with images in cells, see [Cell Images](/api/smartsheet/openapi/cellimages).\n"
    },
    {
      "name": "columns",
      "x-displayName": "Columns",
      "description": "A column is a component of a sheet or report.\n\n<h2>Column Types</h2>\n\nSmartsheet supports the following standard column types, which are represented in a [Column](/api/smartsheet/openapi/columns/column) with a **type** attribute set to one of the following:\n\nColumn Type | Column.type Value | Notes |\n---|---|---|\nCheckbox \t\t| **CHECKBOX**\t\t| Checkbox, star, and flag types |\nContact List\t| **CONTACT_LIST**\t| List containing contacts or roles for a project. **Note:** You can use the [contactOptions](/api/smartsheet/openapi/schemas/contactoption) property to specify a pre-defined list of values for the column, which can also become lanes in card view. |\nContact List | **MULTI_CONTACT_LIST** | List where single cells can contain more than one contact. Only visible when using a query parameter of **level** and the value appropriate to the dashboard, report, or sheet that you are querying. To see email addresses behind the display names, combine an **include=objectValue** query parameter with a **level** query parameter. |\nDate\t\t\t| **DATE** |   |\nDate/Time \t\t| **ABSTRACT_DATETIME** | Represents a project sheet's start and end dates.<br/>**Only for dependency-enabled project sheets**<br/>The API does not support setting a column to this type. (This can only be done through the Smartsheet Web app when configuring a project sheet.) Additionally, the API does not support updating data in the \"End Date\" column under any circumstance, and does not support updating data in the \"Start Date\" column if \"Predecessor\" is set for that row. |\nDate/Time\t\t| **DATETIME**\t| Used only by the following system-generated columns: <ul><li>Created (Date) (**Column.systemColumnType** = **CREATED_DATE**)</li><li>Modified (Date) (**Column.systemColumnType** = **MODIFIED_DATE**)</li></ul> |\nDropdown List\t| **PICKLIST**\t| Custom, RYG, Harvey ball, priority types, etc. |\nDropdown List\t| **MULTI_PICKLIST**\t| List where single cells can contain more than one dropdown item. Only visible when using a query parameter of **level** and the value appropriate to the dashboard, report, or sheet that you are querying. To see multi-picklist values behind the display names, combine an **include=objectValue** query parameter with a **level** query parameter. |\nDuration\t\t| **DURATION**\t\t| **Only for dependency-enabled project sheets**<br/>The API does not support setting a column to this type. (This can only be done through the Smartsheet Web app when configuring a project sheet.) |\nPredecessor\t\t| **PREDECESSOR**\t| Defines what must happen first in a project flow. For more information, see the [Predecessor object](/api/smartsheet/openapi/schemas/predecessorlist). **Only for dependency-enabled project sheets** |\nText/Number\t\t| **TEXT_NUMBER**\t|   |\n\nNOTE: See the [Cell Reference](/api/smartsheet/openapi/cells) section for information on getting and setting cell values for the different column types.\n\n<h3>Symbol Columns</h3>\n\nIn addition to the basic column types above, the Smartsheet app also supports columns that display symbols. These are specialized columns of type **CHECKBOX** or **PICKLIST**,\nwhose **symbol** attribute is set to one of the values below:\n\n**Symbols for CHECKBOX columns:**\n\n![A flag symbol](./images/img_pl_flagc.png)\n\nValue | Example |\n-----|-----|\n**FLAG** | <img src=\"./images/img_pl_flagc.png\" alt=\"A flag symbol\" /> |\n**STAR** | <img src=\"./images/img_pl_starc.png\" alt=\"A star symbol\" /> |\n\n**Symbols for PICKLIST columns:**\n\nValue | Example |\n-----|-----|\n**ARROWS_3_WAY** | <img src=\"./images/img_pl_arrows3.png\" alt=\"An arrows_3_way symbol\" /> |\n**ARROWS_4_WAY** | <img src=\"./images/img_pl_arrows4.png\" alt=\"An arrows_4_way symbol\" /> |\n**ARROWS_5_WAY** | <img src=\"./images/img_pl_arrows5.png\" alt=\"An arrows_5_way symbol\" /> |\n**DECISION_SHAPES** | <img src=\"./images/img_pl_decisionshapes.png\" alt=\"A decision_shapes symbol\" /> |\n**DECISION_SYMBOLS** | <img src=\"./images/img_pl_decisionsymbols.png\" alt=\"A decision_symbols symbol\" /> |\n**DIRECTIONS_3_WAY** | <img src=\"./images/img_pl_directions3.png\" alt=\"A directions_3_way symbol\" /> |\n**DIRECTIONS_4_WAY** | <img src=\"./images/img_pl_directions4.png\" alt=\"A directions_4_way symbol\" /> |\n**EFFORT** | <img src=\"./images/img_pl_effort6Three.png\" alt=\"An effort symbol\" /> |\n**HARVEY_BALLS** | <img src=\"./images/img_pl_harvey5.png\" alt=\"A harvey_balls symbol\" /> |\n**HEARTS** | <img src=\"./images/img_pl_heart6Three.png\" alt=\"A hearts symbol\" /> |\n**MONEY** | <img src=\"./images/img_pl_money6Three.png\" alt=\"A money symbol\" /> |\n**PAIN** | <img src=\"./images/img_pl_pain6.png\" alt=\"A pain symbol\" /> |\n**PRIORITY** | <img src=\"./images/img_pl_priority.png\" alt=\"A priority symbol\" /> |\n**PRIORITY_HML** | <img src=\"./images/img_pl_priorityhml.png\" alt=\"A priority_hml symbol\" /> |\n**PROGRESS** | <img src=\"./images/img_pl_progress5Half.png\" alt=\"A progress symbol\" /> |\n**RYG** | <img src=\"./images/img_pl_ryg.png\" alt=\"An RYG symbol\" /> |\n**RYGB** | <img src=\"./images/img_pl_rygb.png\" alt=\"An RYGB symbol\" /> |\n**RYGG** | <img src=\"./images/img_pl_rygg.png\" alt=\"An RYGG symbol\" /> |\n**SIGNAL** | <img src=\"./images/img_pl_signal5.png\" alt=\"A signal symbol\" /> |\n**SKI** | <img src=\"./images/img_pl_difficulty4.png\" alt=\"A ski symbol\" /> |\n**STAR_RATING** | <img src=\"./images/img_pl_star6Three.png\" alt=\"A star_rating symbol\" />\n**VCR** | <img src=\"./images/img_pl_decisionvcr.png\" alt=\"A VCR symbol\" /> |\n**WEATHER** | <img src=\"./images/img_pl_weather5.png\" alt=\"A weather symbol\" /> |\n\nNOTE: The Smartsheet grid user interface presents several row attributes and features visually as columns, for example, attachments, discussions, row action indicator, or row number.  The API does not consider these to be columns, and does not return or otherwise expose them as columns.  The only columns returned by the API are user data columns.\n\n<h3>System Columns</h3>\n\nIn addition to the standard column types and symbols, Smartsheet has a number of system columns, which represent data that is\nfilled in by Smartsheet and whose values cannot be changed by the user. These columns are represented with standard\n[column types](/api/smartsheet/openapi/columns), with the [**Column.systemColumnType**](/api/smartsheet/openapi/columns/column) attribute set to one of the following:\n\nColumn.systemColumnType Value | Column Type | Notes\n-----|-----|-----|\n**AUTO_NUMBER** | TEXT_NUMBER | Columns of this system column type include an [AutoNumberFormat object](/api/smartsheet/openapi/schemas/autonumberformat) that describes the mask used to generate the value.\n**CREATED_BY**  | CONTACT_LIST\n**CREATED_DATE** | DATETIME\n**MODIFIED_BY** | CONTACT_LIST\n**MODIFIED_DATE** | DATETIME\n"
    },
    {
      "name": "comments",
      "x-displayName": "Comments",
      "description": "A discussion is a container for a number of individual comments in a\nthreaded conversation. For more details, see the\n[Discussion](/api/smartsheet/openapi/discussions) section.\n\n\nThis section describes operations on an *individual* comment within a\ndiscussion thread.\n\n\n* To retrieve all discussions and comments for an entire sheet, use [List\nDiscussions](/api/smartsheet/openapi/discussions/discussions-list) with the query\nparameter **include=comments**.\n\n* To retrieve all discussions and comments associated with a row, use\n[List Row Discussions](/api/smartsheet/openapi/discussions/row-discussions-list)\nwith the query parameter **include=comments**.\n\nA comment can contain one or more attachments.\n\n\n<h2>Comment Attachments</h2>\n\n\nFor details about working with a comment's attachments, see\n[Attachments](/api/smartsheet/openapi/attachments).\n"
    },
    {
      "name": "contacts",
      "x-displayName": "Contacts",
      "description": "A contact is a user's personal contact in Smartsheet (as described in the Help Center article, <a href=\"https://help.smartsheet.com/articles/796143-managing-contacts\" target=\"_blank\" rel=\"noopener noreferrer\">Managing Contacts</a>.\n"
    },
    {
      "name": "crossSheetReferences",
      "x-displayName": "Cross-sheet References",
      "description": "To create a formula that references data in another sheet, you must first create a cross-sheet\nreference between the detail sheet and the source sheet. That reference must also define the cell range.\nOnce you have created the cross-sheet reference, you can use the reference name in any formula on the detail sheet.\nTo create the formula, use Add Rows or Update Rows. Cross-sheet references that are not used by any formula are\nautomatically deleted after two hours.\n"
    },
    {
      "name": "dashboards",
      "x-displayName": "Dashboards",
      "description": "Smartsheet dashboards are a collection of widgets that can contain data from a variety of different data sources (for example, sheets, reports, or custom data). Dashboards were once called Sights(TM) and this name is still present in object names, endpoint paths, and other places.\n"
    },
    {
      "name": "discussions",
      "x-displayName": "Discussions",
      "description": "A discussion is a container for a collection of individual [comments](/api/smartsheet/openapi/comments) within a single thread. A discussion can exist on a [row](/api/smartsheet/openapi/rows) or a [sheet](/api/smartsheet/openapi/sheets).\n\nIn the UI, Smartsheet creates a discussion to contain each top-level comment and subsequent replies into a single thread.\n\nUsing the API, you can only add a comment to a discussion. If the discussion doesn't already exist, you must create it first.\nA discussion is a collection of one or more comments, each of which may contain attachments.\n\n<h2>Discussion Attachments</h2>\n\nFor details about working with the attachments within a discussion, see [Attachments](/api/smartsheet/openapi/attachments).\n<h2>Discussion Comments</h2>\n\nFor details about working with a discussion's comments, see [Comments](/api/smartsheet/openapi/comments).\n"
    },
    {
      "name": "events",
      "x-displayName": "Events",
      "description": "Smartsheet uses event objects to capture actions such as creating, updating, loading, deleting, and more for items such as sheets, reports, dashboards, attachments, and users. With **Event Reporting**, you can use the operations described here to programmatically retrieve these events.\n\n> **Note:** Event Reporting is a premium add-on available for Enterprise and Advanced Work Management plans only. For details on the add-on, please contact our <a href=\"https://www.smartsheet.com/contact/sales\" target=\"_blank\" rel=\"noopener noreferrer\">Sales Team</a>.\n\n<h2>Event types</h2>\n\nAll events derive from the [Event](/api/smartsheet/openapi/events/event) schema. Each event type overrides Event's `objectType` and `action` properties with its specific object type and a typical action performed on that object. Furthermore, each event type's `additionalDetails` object has properties specific to the event type.\n\nSee [Event types](/api/smartsheet/event-types.md) for the complete event listing, details, and example objects.\n\n<h2>System users</h2>\n\nSystem components perform some actions in Smartsheet. Therefore,\nthe `userId` property in some response payloads refers to a system user--not to a regular user. For example, the Smartsheet Events API shows\n5629504736520068 as the `userId` when an anonymous user accesses a sheet\nthat is published for anyone.\n\nThe system users are listed below. New system `userIds` may be\nincorporated to this list as new features and subsystems are incorporated\nto Smartsheet:\n\nSystem user | Description |\n-----|-----|\n1688855062570884 | Data accessed/modified by Skype action (only possible if Smartsheet account is connected to Skype) |\n2814754969413508 | Data accessed/modified by Trello import action (only possible if Smartsheet account is connected to Trello) |\n3377704922834820 | Data accessed/modified due to Smartsheet cell-link |\n3940654876256132 | Data accessed/modified by the Smartsheet Automation system |\n5066554783098756 | Access to object published to any user in the Smartsheet organization account |\n5629504736520068 | Access to Smartsheet object published to anyone |\n6192454689941380 | Data accessed/modified by the Smartsheet Notification system |\n7881304550205316 | Data accessed/modified by Smartsheet Form submission |\n"
    },
    {
      "name": "favorites",
      "x-displayName": "Favorites",
      "description": "Smartsheet allows users to \"star\" dashboards, folders, reports, sheets, workspaces, and other objects on their Home tab to mark them as favorites.\nThese API operations allow you to access the user's favorite API-supported objects, as well as create and delete favorites.\nNOTE: For documentation purposes, \"favoriteType\" is a placeholder ENUM for the various types of UI elements you can flag as a favorite. In sample code, when you see \"{favoriteType}\", just replace it with one of the following values:\n* dashboard or dashboards (aka Sight or Sights)\n* folder or folders\n* report or reports\n* sheet or sheets\n* template or templates\n* workspace or workspaces\n"
    },
    {
      "name": "folders",
      "x-displayName": "Folders",
      "description": "A folder can exist in a user's **Sheets** folder [Home](/api/smartsheet/openapi/home), in a [folder](/api/smartsheet/openapi/folders), or in a [workspace](/api/smartsheet/openapi/workspaces).\n"
    },
    {
      "name": "groupMembers",
      "x-displayName": "Group Members",
      "description": "A group member is a user that belongs to a [group](/api/smartsheet/openapi/groups).\n"
    },
    {
      "name": "groups",
      "x-displayName": "Groups",
      "description": "A group is a collection of [group members](/api/smartsheet/openapi/groupmembers).\n"
    },
    {
      "name": "home",
      "x-displayName": "Home",
      "description": "In the Smartsheet UI, the \"Home\" tab shows all objects a user has access to, including dashboards (also called Sights in the API), folders, reports, sheets, templates, and workspaces.\n> **Note:** The GET /home endpoint is deprecated. Use GET /folders/personal to get shared items and GET /workspaces/ to get workspaces.\n<h2>Home Folders</h2>\n\nFor details about working with folders in the user's **Sheets** folder (that is, at the Home level), see [Folders](/api/smartsheet/openapi/folders).\n\n<h2>Home Sheets</h2>\n\nFor details about working with sheets in the user's **Sheets** folder (that is, at the Home level), see [Sheets](/api/smartsheet/openapi/sheets).\n"
    },
    {
      "name": "imports",
      "x-displayName": "Imports",
      "description": "Import CSV or XLSX data into a new sheet.\n"
    },
    {
      "name": "proofs",
      "x-displayName": "Proofs",
      "description": "A proof is a container that holds attachments and comments. Limited to one proof and its versions per row.\nA sheet can have multiple proofs.\n"
    },
    {
      "name": "reports",
      "x-displayName": "Reports",
      "description": "A report is a filtered view of the data from one or more sheets. Like a sheet, a report is comprised of columns, rows, and cells, and may optionally contain attachments and discussions.\n\n<h2>Related content</h2>\n\nThe [Create a report from multiple sheets](/api/smartsheet/guides/reports/create-a-report.md) guide shows how to create a row report based on multiple task sheets.\n\nThe following component sections provide details on working with report components:\n\n- [Attachments](/api/smartsheet/openapi/attachments)\n- [Cells](/api/smartsheet/openapi/cells)\n- [Columns](/api/smartsheet/openapi/columns)\n- [Discussions](/api/smartsheet/openapi/discussions)\n- [Rows](/api/smartsheet/openapi/rows)\n"
    },
    {
      "name": "rows",
      "x-displayName": "Rows",
      "description": "A row is a component of a sheet or report. Each row is composed of a\ncollection of cells, and may optionally contain discussions or\nattachments.\n\nA row is comprised of a collection of cells, and may optionally contain attachments and discussions.\n\n<h2>Row Attachments</h2>\n\nFor details about working with a row's attachments, see [Attachments](/api/smartsheet/openapi/attachments).\n\n<h2>Row Cells</h2>\n\nFor details about working with a row's cells, see [Cells](/api/smartsheet/openapi/cells).\n\nFor details about working with images in cells, see [Cell Images](/api/smartsheet/openapi/cellimages).\n\n<h2>Row Discussions</h2>\n\nFor details about working with a row's discussions, see [Discussions](/api/smartsheet/openapi/discussions).\n\n<h2>Row Include Flags</h2>\n\nEndpoints which return rows (for example, [Get Sheet](/api/smartsheet/openapi/sheets/getsheet), [Get Row](/api/smartsheet/openapi/rows/row-get)) support the optional **include** query string parameter. If specified, the value of the **include** parameter is\na comma-delimited list of flags that indicate additional attributes to be included in each [Row object](/api/smartsheet/openapi/rows/row) within the response.\n\nInclude Flag | Description |\n-------------|-------|\n**attachments**\t| Includes row **attachments** array.<br/>To include discussion attachments, both **attachments** and **discussions** must be present in the include list.\n**columnType**\t| Includes **columnType** attribute in the row's [cells](/api/smartsheet/openapi/cells/cell) indicating the type of the column the cell resides in.\n**discussions**\t| Includes row **discussions** array.<br/>To include discussion attachments, both **attachments** and **discussions** must be present in the include list.\n**filters**\t\t| Includes **filteredOut** attribute indicating if the row should be displayed or hidden according to the sheet's filters.\n**format**\t\t| Includes **format** attribute on the row, its cells, or summary fields.  See [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting).\n**objectValue** | Includes **objectValue** attribute on cells containing values. For more information see [Cell Reference](/api/smartsheet/openapi/cells).\n**rowPermalink** | Includes **permalink** attribute that represents a direct link to the [row](/api/smartsheet/openapi/rows/row) in the Smartsheet application.\n**rowWriterInfo** | **DEPRECATED** Includes **createdBy** and **modifiedBy** attributes on the row, indicating the row's creator, and last modifier.\n**writerInfo** | Includes **createdBy** and **modifiedBy** attributes on the row or summary fields, indicating the row or summary field's creator, and last modifier.\n\n<h2>Specify Row Location</h2>\n\nWhen you [add a row](/api/smartsheet/openapi/rows/rows-addtosheet), the default behavior is for Smartsheet to put the new row at the bottom of the sheet. And when you [update a row](/api/smartsheet/openapi/rows/update-rows), the default behavior is to keep the row where it is. It is not necessary to use a location-specifier attribute if you want the default behavior.\n\nTo specify a location for new or updated rows other than the defaults, use the table below for reference. The table details possible row locations and provides JSON examples to help you construct one or more [Row objects](/api/smartsheet/openapi/rows/row) with location-specifier attributes.\n\nNote the following restrictions:\n\n* Use only one location-specifier attribute per request, unless you use **parentId** and **toBottom** or **siblingId** and **above**.\n* If you specify multiple rows in the request, all rows must have the same location-specifier attributes.\n* If you specify the **parentId** attribute, you cannot also specify the **siblingId** attribute.\n* If you specify the **siblingId** attribute, you cannot also specify the **parentId**, **toTop**, or **toBottom** attributes.\n* If you want to indent or outdent multiple rows, use the **parentId** attribute.\n\nDestination | Row Attributes | Examples |\n-------|--------|--------|\nTop of a sheet | **toTop** | ```{\"toTop\": true}```\nBottom of a sheet | **toBottom** | ```{\"toBottom\": true}```\nTop of an indented section a.k.a., first child row | **parentId** | ```{\"parentId\": 8896508249565060}```\nBottom of an indented section a.k.a., last child row | **parentId** +<br/>**toBottom** | ```{\"parentId\": 8896508249565060, \"toBottom\": true}```\nBelow a specific row, at the same indent level | **siblingId** | ```{\"siblingId\": 8896508249565060}```\nAbove a specific row, at the same indent level | **siblingId** +<br/>**above** | ```{\"siblingId\": 8896508249565060, \"above\": true}```\nIndent one existing row, must have a value of \"1\" | **indent** | ```{\"indent\": 1}```\nOutdent one existing row, must have a value of \"1\" | **outdent** | ```{\"outdent\": 1}```\n"
    },
    {
      "name": "search",
      "x-displayName": "Search",
      "description": "Search a specific sheet or search across all sheets that a user can access. If you have not used the public API in a while, we will need to provision your data. This could take up to 24 hours so please check back later!\n"
    },
    {
      "name": "sendViaEmail",
      "x-displayName": "Send via Email",
      "description": "The methods for sending via email rely on the type of object you want to send.\n\n<h2>Send Report</h2>\n\nFor details about sending a report via email, see [Send Report via Email](/api/smartsheet/openapi/reports/sendreportviaemail).\n\n<h2>Send Rows</h2>\n\nFor details about sending rows via email, see [Send Rows via Email](/api/smartsheet/openapi/rows/rows-send).\n\n<h2>Send Sheet</h2>\n\nFor details about sending a sheet via email, see [Send Sheet via Email](/api/smartsheet/openapi/sheets/sheet-send).\n\n<h2>Send Update Request</h2>\n\nFor details about sending an update request via email, see [Create an Update Request](/api/smartsheet/openapi/updaterequests/updaterequests-create).\n"
    },
    {
      "name": "serverInfo",
      "x-displayName": "Server Info",
      "description": "For developer convenience, the Smartsheet API provides access to application constants.\n"
    },
    {
      "name": "sharing",
      "x-displayName": "Sharing",
      "description": "Use the *Sharing* operations to control sharing of dashboards, reports, sheets, and workspaces.\n"
    },
    {
      "name": "sheetSummary",
      "x-displayName": "Sheet Summary",
      "description": "A sheet summary allows users to define, organize, and report on custom project and business metadata. Sheet summary is only available to customers with business or enterprise plans.\n"
    },
    {
      "name": "sheets",
      "x-displayName": "Sheets",
      "description": "A sheet can exist in a user's **Sheets** folder\n([Home](/api/smartsheet/openapi/home)), in a [folder](/api/smartsheet/openapi/folders), or\nin a [workspace](/api/smartsheet/openapi/workspaces). It is comprised of columns,\nrows, and cells, and may optionally contain attachments and discussions.\n\nA sheet is comprised of columns, rows, and cells, and may optionally\ncontain attachments and discussions.\n\n\n<h2>Sheet Attachments</h2>\n\n\nFor details about working with a sheet's attachments, see\n[Attachments](/api/smartsheet/openapi/attachments).\n\n\n<h2>Sheet Cells</h2>\n\n\nFor details about working with a sheet's cells, see\n[Cells](/api/smartsheet/openapi/cells).\n\n\nFor details about working with images in cells, see [Cell\nImages](/api/smartsheet/openapi/cellimages).\n\n\n<h2>Sheet Columns</h2>\n\n\nFor details about working with a sheet's columns, see\n[Columns](/api/smartsheet/openapi/columns).\n\n\n<h2>Sheet Discussions</h2>\n\n\nThere are two ways to get discussion-related information for a sheet:\n\n\nOperation | Returns\n----------|----------|\n[Get Sheet](/api/smartsheet/openapi/sheets/getsheet)<br/>(with **include** parameter value **discussions**) | Response does not contain the comments\nthat comprise each discussion.\n[List Discussions](/api/smartsheet/openapi/discussions/discussions-list)<br/>(with **include** parameter value **comments**) |  Response contains the comments that comprise each discussion.\n\n\nFor more information about working with a sheet's discussions, see\n[Discussions](/api/smartsheet/openapi/discussions).\n\n\n<h2>Sheet Rows</h2>\n\n\nFor details about working with a sheet's rows, see\n[Rows](/api/smartsheet/openapi/rows).\n"
    },
    {
      "name": "templates",
      "x-displayName": "Templates",
      "description": "A template can be used to create a sheet, as described for the [Create sheet in folder](/api/smartsheet/openapi/sheets/create-sheet-in-folder) endpoint and the [Create sheet in workspace](/api/smartsheet/openapi/sheets/create-sheet-in-workspace) endpoint.\n"
    },
    {
      "name": "tokens",
      "x-displayName": "Tokens",
      "description": "The Smartsheet API utilizes OAuth 2.0 for authentication and authorization. An Authorization HTTP header containing an access token is required to authenticate all API requests except for the requests to GET Access Token or Refresh Access Token. For more information, see Authentication.\n"
    },
    {
      "name": "updateRequests",
      "x-displayName": "Update Requests",
      "description": "Send update requests to get updated by any collaborator on key rows, regardless of whether they have a Smartsheet account or are shared to the sheet.\n"
    },
    {
      "name": "users",
      "x-displayName": "Users",
      "description": "The users API supports user CRUD operations, seat type operations, and activation/deactivation operations.\n\n> **Note:** Users are typically defined by the organization account, and then role\nwithin the organization, for example admin.\n\n<h2>Users guides</h2>\n\nTo learn more about user-related resources and how to manage them, see the [Users guide articles](/api/smartsheet/guides/users), including the [Automate user seat type management](/api/smartsheet/guides/users/automate-user-seat-type-management.md) guide.\n"
    },
    {
      "name": "webhooks",
      "x-displayName": "Webhooks",
      "description": "Smartsheet webhooks are powerful tools for building custom integrations and automating processes. Instead of constantly polling for changes, with webhooks you can configure your applications to receive real-time notifications when specific Smartsheet events occur.\n\n<h2>Webhooks guides</h2>\n\nTo learn more about Smartsheet webhooks in general, start with these [Webhooks guide](/api/smartsheet/guides/webhooks) articles:\n\n- [Webhooks overview](/api/smartsheet/guides/webhooks.md)\n- [Create an event-handling endpoint](/api/smartsheet/guides/webhooks/create-an-event-handling-endpoint.md)\n- [Launch a webhook](/api/smartsheet/guides/webhooks/launch-a-webhook.md)\n- [Webhook callbacks](/api/smartsheet/guides/webhooks/webhook-callbacks.md)\n- [Webhook verification](/api/smartsheet/guides/webhooks/webhook-verification.md)\n- [Webhook access](/api/smartsheet/guides/webhooks/webhook-access.md)\n\n<h2>Resource-specific guides</h2>\n\nTo dive into webhooks on a specific resource, check out these guides:\n\n- [Sheet webhooks](/api/smartsheet/guides/webhooks.md)\n- [User / plan-level webhooks](/api/smartsheet/guides/users/automate-user-seat-type-management.md)\n\nContinue on to dive into webhook object schemas and operations.\n"
    },
    {
      "name": "workspaces",
      "x-displayName": "Workspaces",
      "description": "Similar to a folder, a workspace is a place where you can store dashboards, reports, sheets, and templates to keep them organized. A workspace offers more functionality than a folder because you can set up sharing permissions and branding (a logo and a color scheme) at the workspace-level and a workspace can contain folders so that you can keep things within it organized. As new items are added to the workspace, they'll automatically inherit the sharing permissions and branding applied to that workspace.\n<h2>Workspace Folders</h2>\n\nFor details about working with folders in a workspace, see [Folders](/api/smartsheet/openapi/folders).\n\n<h2>Workspace Sheets</h2>\n\nFor details about working with sheets in a workspace, see [Sheets](/api/smartsheet/openapi/sheets).\n"
    }
  ],
  "paths": {
    "/contacts": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "operationId": "list-contacts",
        "summary": "List contacts",
        "description": "Gets a list of the user's Smartsheet contacts.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "tags": [
          "contacts"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_CONTACTS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/modifiedSince"
          },
          {
            "$ref": "#/components/parameters/numericDates"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "IndexResult object containing an array of Contact objects.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "List of Contacts",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Contact"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPaginatedResult<Contact> contacts = smartsheet.ContactResources.ListContacts(\n  null                // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/contacts \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPagedResult<Contact> contacts = smartsheet.contactResources().listContacts(\n        null        // PaginationParameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.contacts.listContacts({})\n  .then(function(contactsList) {\n    console.log(contactsList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List all\nresponse = smartsheet_client.Contacts.list_contacts(include_all=True)\ncontacts = response.data\n\n# Sample 2: Paginate the list (100 contacts per page)\nresponse = smartsheet_client.Contacts.list_contacts(\n  page_size=100,\n  page=1)\npages = response.total_pages\ncontacts = response.data\n"
          }
        ]
      }
    },
    "/contacts/{contactId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/contactId"
        }
      ],
      "get": {
        "summary": "Get contact",
        "description": "Gets the specified contact.",
        "operationId": "get-contact",
        "tags": [
          "contacts"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_CONTACTS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/contactInclude"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns Contact object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Contact"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nContact contact = smartsheet.ContactResources.GetContact(\n  \"AAAAATYU54QAD7_fNhTnhA\"      // string contactId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/contacts/{contactId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nContact contact = smartsheet.contactResources().getContact(\n        \"AAAAATYU54QAD7_fNhTnhA\"      // string contactId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {id: \"AAAAATYU54QAD7_fNhTnhA\"};\n\n// Get contact\nsmartsheet.contacts.getContact(options)\n  .then(function(contact) {\n    console.log(contact);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\ncontact = smartsheet_client.Contacts.get_contact(\n  'AAAAATYU54QAD7_fNhTnhA')       # contact_id\n"
          }
        ]
      }
    },
    "/events": {
      "parameters": [
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "operationId": "list-events",
        "summary": "List events",
        "description": "Fetches events for System Admin users. This includes actions such as creating, updating, loading, deleting, and more of items such as sheets, reports, dashboards, attachments, and users in your Smartsheet organization account.\n\nSee [Event types](/api/smartsheet/event-types.md) for the complete event listing, details, and example objects.\n\n> **Who can use this operation?**\n> \n> - **Plans:** Requires the Event Reporting premium add-on available for Enterprise and Advanced Work Management plans only.\n> - **Permissions:** System Admin\n\n> **Note:** You must specify exactly one of the query parameters `since` or `streamPosition`. Both are optional individually, but one is required.\n",
        "tags": [
          "events"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_EVENTS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Accept-Encoding"
          },
          {
            "$ref": "#/components/parameters/Authorization"
          },
          {
            "name": "since",
            "in": "query",
            "description": "The earliest time from which events are included in the response. Events before this time are excluded.\n\nThis parameter is required if `streamPosition` is not used.\n\nThe date-time value is resolved to the nearest hour. The value is interpreted as ISO-8601 format, unless `numericDates` is specified (see details about `numericDates` below).\n\n**Important:** To keep event responses manageable and prevent timeouts, also specify the `to` query parameter.\n\n**Important:** This parameter is intended for use when backfilling data at client startup or recovery--don't use it for fine-grained, date-based queries.\n",
            "schema": {
              "type": "string",
              "format": "date-time"
            },
            "required": false
          },
          {
            "name": "to",
            "in": "query",
            "description": "The latest time up to which events are included in the response. Events after this time are excluded.\n\nThis parameter requires using the `since` parameter. \n\nThe date-time value is resolved to the nearest hour. The value is interpreted as ISO-8601 format, unless `numericDates` is specified (see details about `numericDates` below).\n\nLogic:\n\n- If `to` is a future time, the current time is used.\n- If `to` equals the `since` time, an empty data value is returned.\n- If `to` is before the `since` time, a validation error is returned.\n\n**Important:** This parameter is intended for use when backfilling data at client startup or recovery--don't use it for fine-grained, date-based queries.\n",
            "schema": {
              "type": "string",
              "format": "date-time"
            },
            "required": false
          },
          {
            "name": "streamPosition",
            "in": "query",
            "description": "Indicates next set of events to return. Use value of\n`nextStreamPosition` returned from the previous call.\n\nThis parameter is required if `since` is not used.\n",
            "schema": {
              "type": "string",
              "example": "XyzAb1234cdefghijklmnofpq"
            },
            "required": false
          },
          {
            "name": "maxCount",
            "in": "query",
            "description": "Maximum number of events to return as response to this call.\nMust be between 1 through 10,000 (inclusive).\nDefaults to 1,000 if not specified.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 10000,
              "default": 1000
            },
            "required": false
          },
          {
            "name": "numericDates",
            "in": "query",
            "description": "If `true`, dates are accepted and returned in Unix epoch time\n(milliseconds since midnight on January 1, 1970 in UTC time).\n\nDefault is `false`, which means ISO-8601 format.\n",
            "schema": {
              "type": "boolean",
              "default": false
            },
            "required": false
          },
          {
            "name": "managedPlanId",
            "in": "query",
            "description": "The target managed plan for which to list events. Authorized if the\ncaller is a system administrator on either the target managed plan or\nthe main plan in EPM hierarchy.\n",
            "schema": {
              "type": "number"
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/StreamResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "List of Events",
                          "type": "array",
                          "items": {
                            "anyOf": [
                              {
                                "$ref": "#/components/schemas/Accesstoken_Authorize"
                              },
                              {
                                "$ref": "#/components/schemas/Accesstoken_Refresh"
                              },
                              {
                                "$ref": "#/components/schemas/Accesstoken_Revoke"
                              },
                              {
                                "$ref": "#/components/schemas/Account_BulkUpdate"
                              },
                              {
                                "$ref": "#/components/schemas/Account_DownloadLoginHistory"
                              },
                              {
                                "$ref": "#/components/schemas/Account_DownloadPublishedItemsReport"
                              },
                              {
                                "$ref": "#/components/schemas/Account_DownloadSheetAccessReport"
                              },
                              {
                                "$ref": "#/components/schemas/Account_DownloadUserList"
                              },
                              {
                                "$ref": "#/components/schemas/Account_ImportUsers"
                              },
                              {
                                "$ref": "#/components/schemas/Account_ListSheets"
                              },
                              {
                                "$ref": "#/components/schemas/Account_Rename"
                              },
                              {
                                "$ref": "#/components/schemas/Account_UpdateMainContact"
                              },
                              {
                                "$ref": "#/components/schemas/Attachment_Create"
                              },
                              {
                                "$ref": "#/components/schemas/Attachment_Delete"
                              },
                              {
                                "$ref": "#/components/schemas/Attachment_Load"
                              },
                              {
                                "$ref": "#/components/schemas/Attachment_Send"
                              },
                              {
                                "$ref": "#/components/schemas/Attachment_Update"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Activate_Domain_Strict"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Activate_Email_Based_Totp"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Activate_Mfa_Email_Based_Totp"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Activate_Mfa_Sysadmin_Totp_Fallback"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Activate_Saml_Idp_Config"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Activate_Sysadmin_Totp_Fallback"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Add_Saml_Idp"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Deactivate_Domain_Strict"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Deactivate_Email_Based_Totp"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Deactivate_Mfa_Email_Based_Totp"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Deactivate_Mfa_Sysadmin_Totp_Fallback"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Deactivate_Saml_Idp_Config"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Deactivate_Sysadmin_Totp_Fallback"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Delete_Saml_Idp"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Login"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Logout"
                              },
                              {
                                "$ref": "#/components/schemas/Authentication_Update_Saml_Idp"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_AddPublish"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_AddShare"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_AddShareMember"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_AddWorkspaceShare"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_Create"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_Delete"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_Load"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_Move"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_Purge"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_RemovePublish"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_RemoveShare"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_RemoveShareMember"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_RemoveWorkspaceShare"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_Rename"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_Restore"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_SaveAsNew"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_TransferOwnership"
                              },
                              {
                                "$ref": "#/components/schemas/Dashboard_Update"
                              },
                              {
                                "$ref": "#/components/schemas/Discussion_Create"
                              },
                              {
                                "$ref": "#/components/schemas/Discussion_Delete"
                              },
                              {
                                "$ref": "#/components/schemas/Discussion_Send"
                              },
                              {
                                "$ref": "#/components/schemas/Discussion_Sendcomment"
                              },
                              {
                                "$ref": "#/components/schemas/Discussion_Update"
                              },
                              {
                                "$ref": "#/components/schemas/Folder_Create"
                              },
                              {
                                "$ref": "#/components/schemas/Folder_Delete"
                              },
                              {
                                "$ref": "#/components/schemas/Folder_Export"
                              },
                              {
                                "$ref": "#/components/schemas/Folder_Rename"
                              },
                              {
                                "$ref": "#/components/schemas/Folder_RequestBackup"
                              },
                              {
                                "$ref": "#/components/schemas/Folder_SaveAsNew"
                              },
                              {
                                "$ref": "#/components/schemas/Form_Activate"
                              },
                              {
                                "$ref": "#/components/schemas/Form_Create"
                              },
                              {
                                "$ref": "#/components/schemas/Form_Deactivate"
                              },
                              {
                                "$ref": "#/components/schemas/Form_Delete"
                              },
                              {
                                "$ref": "#/components/schemas/Form_Update"
                              },
                              {
                                "$ref": "#/components/schemas/Group_AddMember"
                              },
                              {
                                "$ref": "#/components/schemas/Group_Create"
                              },
                              {
                                "$ref": "#/components/schemas/Group_Delete"
                              },
                              {
                                "$ref": "#/components/schemas/Group_DownloadSheetAccessReport"
                              },
                              {
                                "$ref": "#/components/schemas/Group_RemoveMember"
                              },
                              {
                                "$ref": "#/components/schemas/Group_Rename"
                              },
                              {
                                "$ref": "#/components/schemas/Group_TransferOwnership"
                              },
                              {
                                "$ref": "#/components/schemas/Group_Update"
                              },
                              {
                                "$ref": "#/components/schemas/License_Requests_Decline_License"
                              },
                              {
                                "$ref": "#/components/schemas/License_Requests_Grant_License"
                              },
                              {
                                "$ref": "#/components/schemas/Policy_Data_Egress_Activate"
                              },
                              {
                                "$ref": "#/components/schemas/Policy_Data_Egress_Create"
                              },
                              {
                                "$ref": "#/components/schemas/Policy_Data_Egress_Deactivate"
                              },
                              {
                                "$ref": "#/components/schemas/Policy_Data_Egress_Delete"
                              },
                              {
                                "$ref": "#/components/schemas/Policy_Data_Egress_Update"
                              },
                              {
                                "$ref": "#/components/schemas/Policy_Data_Retention_Activate"
                              },
                              {
                                "$ref": "#/components/schemas/Policy_Data_Retention_Create"
                              },
                              {
                                "$ref": "#/components/schemas/Policy_Data_Retention_Deactivate"
                              },
                              {
                                "$ref": "#/components/schemas/Policy_Data_Retention_Update"
                              },
                              {
                                "$ref": "#/components/schemas/Policy_Safe_Sharing_Activate"
                              },
                              {
                                "$ref": "#/components/schemas/Policy_Safe_Sharing_Add_Request_Form"
                              },
                              {
                                "$ref": "#/components/schemas/Policy_Safe_Sharing_Deactivate"
                              },
                              {
                                "$ref": "#/components/schemas/Report_AddShare"
                              },
                              {
                                "$ref": "#/components/schemas/Report_AddShareMember"
                              },
                              {
                                "$ref": "#/components/schemas/Report_AddWorkspaceShare"
                              },
                              {
                                "$ref": "#/components/schemas/Report_Create"
                              },
                              {
                                "$ref": "#/components/schemas/Report_Delete"
                              },
                              {
                                "$ref": "#/components/schemas/Report_Export"
                              },
                              {
                                "$ref": "#/components/schemas/Report_Load"
                              },
                              {
                                "$ref": "#/components/schemas/Report_Move"
                              },
                              {
                                "$ref": "#/components/schemas/Report_Purge"
                              },
                              {
                                "$ref": "#/components/schemas/Report_RemoveShare"
                              },
                              {
                                "$ref": "#/components/schemas/Report_RemoveShareMember"
                              },
                              {
                                "$ref": "#/components/schemas/Report_RemoveWorkspaceShare"
                              },
                              {
                                "$ref": "#/components/schemas/Report_Rename"
                              },
                              {
                                "$ref": "#/components/schemas/Report_Restore"
                              },
                              {
                                "$ref": "#/components/schemas/Report_SaveAsNew"
                              },
                              {
                                "$ref": "#/components/schemas/Report_SendAsAttachment"
                              },
                              {
                                "$ref": "#/components/schemas/Report_TransferOwnership"
                              },
                              {
                                "$ref": "#/components/schemas/Report_Update"
                              },
                              {
                                "$ref": "#/components/schemas/Secure_External_Access_Activate_Mfa"
                              },
                              {
                                "$ref": "#/components/schemas/Secure_External_Access_Activate_Sso_For_External_Collaborators"
                              },
                              {
                                "$ref": "#/components/schemas/Secure_External_Access_Deactivate_Mfa"
                              },
                              {
                                "$ref": "#/components/schemas/Secure_External_Access_Deactivate_Sso_For_External_Collaborators"
                              },
                              {
                                "$ref": "#/components/schemas/Secure_External_Access_Mfa_Option_Enforce_All_Plan"
                              },
                              {
                                "$ref": "#/components/schemas/Secure_External_Access_Mfa_Option_Workspace_Opt_In"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Activate_Account_Discovery"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Activate_Api_Token_Expiration_Period"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Activate_Attachment"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Activate_Calendar_Publishing"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Activate_Dashboard_Publishing"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Activate_Directory_Integration"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Activate_Images_In_Sheet_Cells"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Activate_Offline_Form_Submission"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Activate_Report_Publishing"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Activate_Sheet_Publishing"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Activate_Smartsheet_Tenant_Id"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Activate_Web_Content_Widget"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Deactivate_Account_Discovery"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Deactivate_Api_Token_Expiration_Period"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Deactivate_Attachment"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Deactivate_Calendar_Publishing"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Deactivate_Dashboard_Publishing"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Deactivate_Directory_Integration"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Deactivate_Images_In_Sheet_Cells"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Deactivate_Offline_Form_Submission"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Deactivate_Report_Publishing"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Deactivate_Sheet_Publishing"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Deactivate_Smartsheet_Tenant_Id"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Deactivate_Web_Content_Widget"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Update_Api_Token_Expiration_Period"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Update_Dashboard_Publishing_Options"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Update_Directory_Integration"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Update_Form_Access_Permissions"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Update_Group_Membership_Scope"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Update_Notifications_And_Requests"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Update_Report_Publishing_Options"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Update_Sheet_Publishing_Options"
                              },
                              {
                                "$ref": "#/components/schemas/Security_Controls_Update_Web_Content_Widget"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_AddShare"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_AddShareMember"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_AddWorkspaceShare"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_CopyRow"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_Create"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_CreateCellLink"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_Delete"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_Export"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_Load"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_Move"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_MoveRow"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_Purge"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_RemoveShare"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_RemoveShareMember"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_RemoveWorkspaceShare"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_Rename"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_RequestBackup"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_Restore"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_SaveAsNew"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_SaveAsTemplate"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_SendAsAttachment"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_SendRow"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_TransferOwnership"
                              },
                              {
                                "$ref": "#/components/schemas/Sheet_Update"
                              },
                              {
                                "$ref": "#/components/schemas/UpdateRequest_Create"
                              },
                              {
                                "$ref": "#/components/schemas/User_AcceptInvite"
                              },
                              {
                                "$ref": "#/components/schemas/User_AddToAccount"
                              },
                              {
                                "$ref": "#/components/schemas/User_Deactivate"
                              },
                              {
                                "$ref": "#/components/schemas/User_DeclineInvite"
                              },
                              {
                                "$ref": "#/components/schemas/User_DownloadSheetAccessReport"
                              },
                              {
                                "$ref": "#/components/schemas/User_Merge_Users"
                              },
                              {
                                "$ref": "#/components/schemas/User_RemoveFromAccount"
                              },
                              {
                                "$ref": "#/components/schemas/User_RemoveFromGroups"
                              },
                              {
                                "$ref": "#/components/schemas/User_RemoveShares"
                              },
                              {
                                "$ref": "#/components/schemas/User_SendInvite"
                              },
                              {
                                "$ref": "#/components/schemas/User_SendPasswordReset"
                              },
                              {
                                "$ref": "#/components/schemas/User_TransferOwnedGroups"
                              },
                              {
                                "$ref": "#/components/schemas/User_TransferOwnedItems"
                              },
                              {
                                "$ref": "#/components/schemas/User_UpdateUser"
                              },
                              {
                                "$ref": "#/components/schemas/User_View_User_Roles_And_Reports"
                              },
                              {
                                "$ref": "#/components/schemas/Workspace_AddShare"
                              },
                              {
                                "$ref": "#/components/schemas/Workspace_AddShareMember"
                              },
                              {
                                "$ref": "#/components/schemas/Workspace_Create"
                              },
                              {
                                "$ref": "#/components/schemas/Workspace_CreateRecurringBackup"
                              },
                              {
                                "$ref": "#/components/schemas/Workspace_Delete"
                              },
                              {
                                "$ref": "#/components/schemas/Workspace_DeleteRecurringBackup"
                              },
                              {
                                "$ref": "#/components/schemas/Workspace_Export"
                              },
                              {
                                "$ref": "#/components/schemas/Workspace_RemoveShare"
                              },
                              {
                                "$ref": "#/components/schemas/Workspace_RemoveShareMember"
                              },
                              {
                                "$ref": "#/components/schemas/Workspace_Rename"
                              },
                              {
                                "$ref": "#/components/schemas/Workspace_RequestBackup"
                              },
                              {
                                "$ref": "#/components/schemas/Workspace_SaveAsNew"
                              },
                              {
                                "$ref": "#/components/schemas/Workspace_TransferOwnership"
                              },
                              {
                                "$ref": "#/components/schemas/Workspace_UpdateRecurringBackup"
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "A response with this status code can occur in any one of the following conditions:\n\n- The `to` parameter is earlier than the `since` parameter.\n- Invalid request format.\n- Missing required fields.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "405": {
            "$ref": "#/components/responses/405"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "410": {
            "$ref": "#/components/responses/410"
          },
          "415": {
            "$ref": "#/components/responses/415"
          },
          "429": {
            "$ref": "#/components/responses/429"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        },
        "x-codeSamples": [
          {
            "lang": "curl",
            "label": "cURL",
            "source": "curl -i -X GET \\  \n'https://api.smartsheet.com/2.0/events?since=2025-03-24T15%3A15%3A22Z&to=2025-03-24T16%3A15%3A22Z' \\\n--header 'Accept-Encoding: deflate' \\\n--header 'Authorization: Bearer <YOUR_TOKEN_HERE>'\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript",
            "source": "const query = new URLSearchParams({\n  since: '2025-03-24T15:15:22Z',\n  to: '2025-03-24T16:15:22Z'\n}).toString();\n\nconst resp = await fetch(\n  `https://api.smartsheet.com/2.0/events?${query}`,\n  {\n    method: 'GET',\n    headers: {\n      'Accept-Encoding': 'deflate',\n      Authorization: 'Bearer <YOUR_TOKEN_HERE>'\n    }\n  }\n);\n\nconst data = await resp.text();\nconsole.log(data);\n"
          },
          {
            "lang": "Node.js",
            "label": "Node.js",
            "source": "import fetch from 'node-fetch';\n\nasync function run() {\n  const query = new URLSearchParams({\n    since: '2025-03-24T15:15:22Z',\n    to: '2025-03-24T16:15:22Z'\n  }).toString();\n\n  const resp = await fetch(\n    `https://api.smartsheet.com/2.0/events?${query}`,\n    {\n      method: 'GET',\n      headers: {\n        'Accept-Encoding': 'deflate',\n        Authorization: 'Bearer <YOUR_TOKEN_HERE>'\n      }\n    }\n  );\n\n  const data = await resp.text();\n  console.log(data);\n}\n\nrun();\n"
          },
          {
            "lang": "Python",
            "label": "Python",
            "source": "import requests\n\nurl = \"https://api.smartsheet.com/2.0/events\"\n\nquery = {\n  \"since\": \"2025-03-24T15%3A15%3A22Z\",\n  \"to\": \"2025-03-24T16%3A15%3A22Z\"\n}\n\nheaders = {\n  \"Accept-Encoding\": \"deflate\",\n  \"Authorization\": \"Bearer <YOUR_TOKEN_HERE>\"\n}\n\nresponse = requests.get(url, headers=headers, params=query)\n\ndata = response.json()\nprint(data)\n"
          },
          {
            "lang": "Go",
            "label": "Go",
            "source": "package main\n\nimport (\n  \"fmt\"\n  \"net/http\"\n  \"io/ioutil\"\n)\n\nfunc main() {\n  reqUrl := \"https://api.smartsheet.com/2.0/events\"\n  req, err := http.NewRequest(\"GET\", reqUrl, nil)\n\n  query := req.URL.Query()\n  query.Add(\"since\", \"2025-03-24T15:15:22Z\")\n  query.Add(\"to\", \"2025-03-24T16:15:22Z\")\n  req.URL.RawQuery = query.Encode()\n\n  if err != nil {\n    panic(err)\n  }\n  req.Header.Add(\"Accept-Encoding\", \"deflate\")\n  req.Header.Add(\"Authorization\", \"Bearer <YOUR_TOKEN_HERE>\")\n  res, err := http.DefaultClient.Do(req)\n  if err != nil {\n    panic(err)\n  }\n  defer res.Body.Close()\n  body, err := ioutil.ReadAll(res.Body)\n  if err != nil {\n    panic(err)\n  }\n\n  fmt.Println(res)\n  fmt.Println(string(body))\n}\n"
          },
          {
            "lang": "Java",
            "label": "Java",
            "source": "import java.net.*;\nimport java.net.http.*;\nimport java.util.*;\nimport java.nio.charset.StandardCharsets;\nimport java.util.stream.Collectors;\n\npublic class App {\n  public static void main(String[] args) throws Exception {\n    var httpClient = HttpClient.newBuilder().build();\n\n    HashMap<String, String> params = new HashMap<>();\n    params.put(\"since\", \"2025-03-24T15:15:22Z\");\n    params.put(\"to\", \"2025-03-24T16:15:22Z\");\n\n    var query = params.keySet().stream()\n      .map(key -> key + \"=\" + URLEncoder.encode(params.get(key), StandardCharsets.UTF_8))\n      .collect(Collectors.joining(\"&\"));\n\n    var host = \"https://api.smartsheet.com\";\n    var pathname = \"/2.0/events\";\n    var request = HttpRequest.newBuilder()\n      .GET()\n      .uri(URI.create(host + pathname + '?' + query))\n      .header(\"Accept-Encoding\", \"deflate\")\n      .header(\"Authorization\", \"Bearer <YOUR_TOKEN_HERE>\")\n      .build();\n\n    var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());\n\n    System.out.println(response.body());\n  }\n}\n"
          },
          {
            "lang": "C#",
            "label": "C#",
            "source": "using System;\nusing System.Net.Http;\nusing System.Threading.Tasks;\n\npublic class Program\n{\n  public static async Task Main()\n  {\n    System.Net.Http.HttpClient client = new()\n    {\n      DefaultRequestHeaders =\n      {\n        {\"Authorization\", \"Bearer <YOUR_TOKEN_HERE>\"},\n      }\n    };\n\n    using HttpResponseMessage request = await client.GetAsync(\"https://api.smartsheet.com/2.0/events?since=2025-03-24T15%3A15%3A22Z&to=2025-03-24T16%3A15%3A22Z\");\n    string response = await request.Content.ReadAsStringAsync();\n\n    Console.WriteLine(response);\n  }\n}\n"
          },
          {
            "lang": "PHP",
            "label": "PHP",
            "source": "/**\n* Requires libcurl\n*/\n\n$query = array(\n  \"since\" => \"2025-03-24T15%3A15%3A22Z\",\n  \"to\" => \"2025-03-24T16%3A15%3A22Z\",\n  \"streamPosition\" => \"XyzAb1234cdefghijklmnofpq\"\n);\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_HTTPHEADER => [\n    \"Accept-Encoding: deflate\",\n    \"Authorization: Bearer <YOUR_TOKEN_HERE>\"\n  ],\n  CURLOPT_URL => \"https://api.smartsheet.com/2.0/events?\" . http_build_query($query),\n  CURLOPT_RETURNTRANSFER => true,\n  CURLOPT_CUSTOMREQUEST => \"GET\",\n]);\n\n$response = curl_exec($curl);\n$error = curl_error($curl);\n\ncurl_close($curl);\n\nif ($error) {\n  echo \"cURL Error #:\" . $error;\n} else {\n  echo $response;\n}\n"
          }
        ]
      }
    },
    "/favorites": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/ActorId"
        }
      ],
      "get": {
        "summary": "Get favorites",
        "description": "Gets a list of all of the user's favorite items.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "get-favorites",
        "tags": [
          "favorites"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/favoriteInclude"
          }
        ],
        "responses": {
          "200": {
            "description": "IndexResult object containing an array of Favorite objects.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Favorite"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPaginatedResult<Favorite> results = smartsheet.FavoriteResources.ListFavorites(\n  null                // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/favorites \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPagedResult<Favorite> results = smartsheet.favoriteResources().listFavorites(\n        null        // PaginationParameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.favorites.listFavorites()\n  .then(function(favoritesList) {\n    console.log(favoritesList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List All\nresponse = smartsheet_client.Favorites.list_favorites(include_all=True)\nfaves = response.data\n\n# Sample 2: Paginate the list of favorites\nresponse = smartsheet_client.Favorites.list_favorites(\n  page_size=10,\n  page=1)\npages = response.total_pages\nfaves = response.data\n"
          }
        ]
      },
      "post": {
        "summary": "Add favorites",
        "description": "Adds one or more favorite items for the current user. This operation supports both single-object and bulk semantics. For more information, see Optional Bulk Operations.\nIf called with a single Favorite object, and that favorite already exists, error code 1129 is returned. If called with an array of Favorite objects, any objects specified in the array that are already marked as favorites are ignored and omitted from the response.\n",
        "operationId": "add-favorite",
        "tags": [
          "favorites"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "description": "A list of favorites to be added.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/Favorite"
                  },
                  {
                    "type": "array",
                    "title": "Array of favorites",
                    "items": {
                      "$ref": "#/components/schemas/Favorite"
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing either a single Favorite object or an array of Favorite objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "oneOf": [
                            {
                              "$ref": "#/components/schemas/Favorite"
                            },
                            {
                              "type": "array",
                              "title": "Array of favorites",
                              "items": {
                                "$ref": "#/components/schemas/Favorite"
                              }
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify favorites\nIList<Favorite> favoritesSpecification = new Favorite[]\n{\n  new Favorite\n  {\n    Type = ObjectType.SHEET,\n    ObjectId = 8400677765441412\n  }\n};\n\n// Add items to favorites\nIList<Favorite> newFavorite = smartsheet.FavoriteResources.AddFavorites(favoritesSpecification);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/favorites \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '[{\"type\": \"sheet\", \"objectId\": 8400677765441412}]'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify favorites\nFavorite favoritesSpecification = new Favorite()\n        .setObjectId(8400677765441412L)\n        .setType(FavoriteType.SHEET);\n\n// Add items to favorites\nList<Favorite> newFavorite = smartsheet.favoriteResources().addFavorites(Arrays.asList(favoritesSpecification));\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify favorites\nvar favorites = [\n  {\n    \"type\": \"sheet\",\n    \"objectId\": 8400677765441412\n  }\n];\n\n// Set options\nvar options = {\n  body: favorites\n};\n\n// Add items to favorites\nsmartsheet.favorites.addItemsToFavorites(options)\n  .then(function(newFavorite) {\n    console.log(newFavorite);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Favorites.add_favorites([\n  smartsheet.models.Favorite({\n    'type': 'sheet',\n    'object_id': 8400677765441412\n  })\n])\n"
          }
        ]
      }
    },
    "/favorites/{favoriteType}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/favoriteType"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/ActorId"
        }
      ],
      "delete": {
        "summary": "Delete multiple favorites",
        "description": "Deletes all favorites with the same type for the user.",
        "operationId": "delete-favorites-by-type",
        "tags": [
          "favorites"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/favoriteIds"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns Result object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.FavoriteResources.RemoveFavorites(\n  ObjectType.FOLDER,\n  new long[] { 2252168947361668, 2252168947361669 }     // folderIds\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/favorites/{favoriteType}?objectIds=favoriteId1,favoriteId2' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.favoriteResources().removeFavorites(\n        FavoriteType.FOLDER,\n        new HashSet(Arrays.asList(2252168947361668L, 2252168947361669L))      // long folderIds\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  queryParameters: {\n    objectIds: \"2252168947361668,2252168947361669\"\n  }\n};\n\n// Remove favoriteType from list of favorites\nsmartsheet.favorites.remove{favoriteType}FromFavorites(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Favorites.remove_favorites(\n  'folder',\n  [2252168947361668, 2252168947361669]        # folder_ids\n)\n"
          }
        ]
      }
    },
    "/favorites/{favoriteType}/{favoriteId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/favoriteType"
        },
        {
          "$ref": "#/components/parameters/favoriteId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/ActorId"
        }
      ],
      "delete": {
        "summary": "Delete favorite",
        "description": "Deletes a single favorite from the user's list of favorite items by type and ID.",
        "operationId": "delete-favorites-by-type-and-id",
        "tags": [
          "favorites"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns Result object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.FavoriteResources.RemoveFavorites(\n  ObjectType.FOLDER,\n  new long[] { 2252168947361668 }   // folderId\n);\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.favoriteResources().removeFavorites(\n        FavoriteType.FOLDER,\n        new HashSet(Arrays.asList(2252168947361668L))      // long folderId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  objectId: 2252168947361668\n};\n\n// Remove folder from list of favorites\nsmartsheet.favorites.removeFolderFromFavorites(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Favorites.remove_favorites(\n  'folder',\n  2252168947361668        # folder_id\n)\n"
          }
        ]
      },
      "get": {
        "summary": "Is favorite",
        "description": "Checks whether an item has been tagged as a favorite for the current user by type and ID.",
        "operationId": "is-favorite",
        "tags": [
          "favorites"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/favoriteInclude"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns Result object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Favorite"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl -i -X GET \\\n  'https://api.smartsheet.com/2.0/favorites/{favoriteType}/{favoriteId}?include={directId}' \\\n  -H 'Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789' \\\n  -H 'x-smar-sc-actor-id: 100012'\n"
          }
        ]
      }
    },
    "/filteredEvents": {
      "parameters": [
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "post": {
        "operationId": "list-filtered-events",
        "summary": "List filtered events",
        "description": "Fetches events related to given sheets and workspaces for non-admin users.\n\nSee [Event types](/api/smartsheet/event-types.md) for the complete event listing, details, and example objects.\n\n> **Who can use this operation?**\n> \n> - **Plans:** Requires the Event Reporting premium add-on available for Enterprise and Advanced Work Management plans only.\n> - **Permissions:** Non-admin users who have access to given sheets or workspaces.\n",
        "tags": [
          "events"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_EVENTS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Accept-Encoding"
          },
          {
            "$ref": "#/components/parameters/Authorization"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FilteredEventsRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/StreamResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "List of Events",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Event"
                          }
                        },
                        "unavailableSheetIds": {
                          "description": "List of sheet Ids specified in the request that the user does not have access to.",
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "unavailableWorkspaceIds": {
                          "description": "List of workspace Ids specified in the request that the user does not have access to.",
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "405": {
            "$ref": "#/components/responses/405"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "410": {
            "$ref": "#/components/responses/410"
          },
          "415": {
            "$ref": "#/components/responses/415"
          },
          "429": {
            "$ref": "#/components/responses/429"
          },
          "500": {
            "$ref": "#/components/responses/500"
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/folders/{folderId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/folderId"
        }
      ],
      "get": {
        "summary": "Get folder",
        "deprecated": true,
        "description": "Gets a Folder object.\n\n> **Important:** We've set a 60 requests per minute per API token limit for this operation.\n\n> **DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be removed.** See the [Get folder metadata](/api/smartsheet/openapi/folders/get-folder-metadata) and the [List folder children](/api/smartsheet/openapi/folders/get-folder-children) endpoints for replacement functionality. \n> \n> For details, refer to [Migrate from GET /folders/{id}  for folder and child metadata](/api/smartsheet/guides/updating-code/migrate-from-get-folder.md).\n",
        "tags": [
          "folders"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "operationId": "get-folder",
        "parameters": [
          {
            "$ref": "#/components/parameters/folderWorkspaceInclude"
          }
        ],
        "responses": {
          "200": {
            "description": "A single Folder object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Folder"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Omit 'include' parameter\nFolder folder = smartsheet.FolderResources.GetFolder(\n  7116448184199044,           // long folderId\n  null                        // IEnumerable<FolderInclusion> include\n);\n\n// Sample 2: Specify 'include' parameter with value of \"SOURCE\"\nFolder folder = smartsheet.FolderResources.GetFolder(\n  7116448184199044,           // long folderId\n  new FolderInclusion[] {\n    FolderInclusion.SOURCE }\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/folders/{folderId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Omit 'include' parameter\nFolder folder = smartsheet.folderResources().getFolder(\n        7116448184199044L,       // long folderId\n        null)                    // EnumSet<SourceInclusion> includes\n        );\n\n// Sample 2: Specify 'include' parameter with value of \"SOURCE\"\nFolder folder = smartsheet.folderResources().getFolder(\n        7116448184199044L,       // long folderId\n        EnumSet.of(SourceInclusion.SOURCE))\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  id: 7116448184199044 // Id of Folder\n};\n\n// Get folder\nsmartsheet.folders.getFolder(options)\n  .then(function(folder) {\n    console.log(folder);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Get folder\nfolder = smartsheet_client.Folders.get_folder(\n  7116448184199044)       # folder_id\n\n# Sample 2: Include source\nresponse = smartsheet_client.Folders.get_folder(\n  7116448184199044,       # folder_id\n  include=source)\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete folder",
        "description": "Deletes a folder.",
        "tags": [
          "folders"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "operationId": "delete-folder",
        "responses": {
          "200": {
            "description": "Returns Result object\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.FolderResources.DeleteFolder(\n  965780272637828                 // long folderId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/folders/{folderId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.folderResources().deleteFolder(\n        965780272637828L         // long folderId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  id: 965780272637828 // Id of Folder\n};\n\n// Delete folder\nsmartsheet.folders.deleteFolder(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Folders.delete_folder(\n  7960873114331012)       # folder_id\n"
          }
        ]
      },
      "put": {
        "summary": "Update folder",
        "description": "Updates a folder.",
        "operationId": "update-folder",
        "tags": [
          "folders"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type_AppJsonOnly"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FolderCreateRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Basic information about the updated Folder.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/SuccessResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/FolderListing"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set folder name\nFolder folderSpecification = new Folder\n{\n  Id = 7960873114331012,\n  Name = \"New name for folder\"\n};\n\n// Update folder\nFolder updatedFolder = smartsheet.FolderResources.UpdateFolder(folderSpecification);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/folders/{folderId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '{\"name\": \"New name for folder\"}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set folder name and id of the folder to be updated\nFolder folderSpecification = new Folder(7960873114331012L);\nfolderSpecification.setName(\"New name for folder\");\n\n// Update folder\nFolder updatedFolder = smartsheet.folderResources().updateFolder(folderSpecification);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set folder name\nvar folder = {\n  \"name\": \"New name for folder\"\n};\n\n// Set options\nvar options = {\n  id: 7960873114331012, // Id of Folder\n  body: folder\n};\n\n// Update folder\nsmartsheet.folders.updateFolder(options)\n  .then(function(updatedFolder) {\n    console.log(updatedFolder);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nupdated_folder = smartsheet_client.Folders.update_folder(\n  7960873114331012,       # folder_id\n  'New name for folder')\n"
          }
        ]
      }
    },
    "/folders/{folderId}/metadata": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "name": "folderId",
          "in": "path",
          "required": true,
          "description": "The ID of the folder",
          "schema": {
            "type": "integer",
            "format": "int64"
          }
        }
      ],
      "get": {
        "summary": "Get folder metadata",
        "description": "Gets the metadata of a folder.",
        "tags": [
          "folders"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "operationId": "get-folder-metadata",
        "parameters": [
          {
            "$ref": "#/components/parameters/includeSource"
          },
          {
            "$ref": "#/components/parameters/numericDates"
          }
        ],
        "responses": {
          "200": {
            "description": "The metadata of a folder.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FolderMetadata"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "500": {
            "$ref": "#/components/responses/500"
          },
          "503": {
            "$ref": "#/components/responses/503"
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "Folder parentFolder =\n    client.FolderResources.GetFolderMetadata(folderId);\n\nConsole.WriteLine($\"Parent Folder\\n \" + \n    $\"name: {parentFolder.Name}\\n \" +\n    $\"id: {parentFolder.Id}\\n \" +\n    $\"permalink: {parentFolder.Permalink}\\n \" +\n    $\"created at: {parentFolder.CreatedAt}\\n \" +\n    $\"modified at: {parentFolder.ModifiedAt}\\n \");\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "Folder folderMetadata =\n    client.folderResources().getFolderMetadata(folderId, null);\n\nSystem.out.println(\"Folder \" +\n    \"\\n  name: \" + folderMetadata.getName() +\n    \"\\n  id: \" + folderMetadata.getId() +\n    \"\\n  permalink: \" + folderMetadata.getPermalink() +\n    \"\\n  created at: \" + folderMetadata.getCreatedAt() +\n    \"\\n  modified at: \" + folderMetadata.getModifiedAt());\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "const folder =\n  await client.folders.getFolderMetadata({ folderId });\n\nconsole.log(\n  `Folder:`,\n  `\\n  Name: ${folder.name},`,\n  `\\n  ID: ${folder.id},`,\n  `\\n  Permalink: ${folder.permalink},`,\n  `\\n  Created At: ${folder.createdAt},`,\n  `\\n  Modified At: ${folder.modifiedAt}`\n);\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "folder_metadata = smart.Folders.get_folder_metadata(folder_id)\nassert isinstance(folder_metadata, smartsheet.models.folder.Folder)\n"
          }
        ]
      }
    },
    "/folders/{folderId}/children": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "name": "folderId",
          "in": "path",
          "required": true,
          "description": "The ID of the folder",
          "schema": {
            "type": "integer",
            "format": "int64"
          }
        }
      ],
      "get": {
        "summary": "List folder children",
        "description": "Retrieves a paginated list of immediate child resources within a specified folder.\n\n**Key Characteristics**\n\n- **Shallow representation:** It returns metadata for the direct children only, rather than the full content or nested sub-structures.\n- **Filtered by type:** The results are restricted to the resource types defined in the `childrenResourceTypes` query parameter.\n- **Paginated:** The response provides a page of results, implying that for large folders, multiple requests may be necessary to view all children.\n\n> **Note:** For pagination guidance, refer to [Token-based pagination](/api/smartsheet/guides/basics/pagination#token-based-pagination).\n",
        "tags": [
          "folders"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "operationId": "get-folder-children",
        "parameters": [
          {
            "$ref": "#/components/parameters/childrenResourceTypes"
          },
          {
            "$ref": "#/components/parameters/includeForChildren"
          },
          {
            "$ref": "#/components/parameters/numericDates"
          },
          {
            "$ref": "#/components/parameters/accessApiLevel"
          },
          {
            "$ref": "#/components/parameters/lastKey"
          },
          {
            "name": "maxItems",
            "in": "query",
            "required": false,
            "description": "The maximum number of items to return in the response.",
            "schema": {
              "type": "integer",
              "default": 100,
              "minimum": 100,
              "multipleOf": 100,
              "maximum": 1000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "An array of asset references with a pagination token if there are more results.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaginatedChildrenResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "500": {
            "$ref": "#/components/responses/500"
          },
          "503": {
            "$ref": "#/components/responses/503"
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Sample 1: Get a page of data\nstring? lastKey = null; // Use null key for first page\nTokenPaginatedResult<object> page =\n    client.FolderResources.GetFolderChildren(\n        folderId,\n        childrenResourceTypes: null,\n        include: null,\n        numericDates: null,\n        accessApiLevel: null,\n        lastKey: lastKey,\n        maxItems: null);\n\nforeach (var item in page.Data)\n{\n    switch (item)\n    {\n        case Sheet sheet:\n            sheets.Add(sheet);\n            break;\n        case Folder folder:\n            folders.Add(folder);\n            break;\n        case Report report:\n            reports.Add(report);\n            break;\n        case Sight sight:\n            sights.Add(sight);\n            break;\n        case Template template:\n            templates.Add(template);\n            break;\n    }\n\n}\nlastKey = page.LastKey; // Non-null means more items\n\n// Sample 2: Page through the data\nstring? lastKey = null; // Use null key for first page\ndo\n{\n    TokenPaginatedResult<object> page = \n        client.FolderResources.GetFolderChildren(\n            folderId,\n            childrenResourceTypes: null,\n            include: null,\n            numericDates: null,\n            accessApiLevel: null,\n            lastKey: lastKey,\n            maxItems: null);\n\n    foreach (var item in page.Data)\n    {\n        switch (item)\n        {\n            case Sheet sheet:\n                sheets.Add(sheet);\n                break;\n            // Check for other types\n        }\n    }\n\n    lastKey = page.LastKey;\n} while (!string.IsNullOrEmpty(lastKey));\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Sample 1: Get a page of data\nString lastKey = null; // Use null key for first page\nTokenPaginatedResult<Object> response = \n    client.folderResources()\n        .getFolderChildren(\n            folderId, null, null, lastKey, null);\n\nfor (Object child : response.getData()) {\n    if (child instanceof Folder folder) {\n        folders.add(folder);\n    } else if (child instanceof Report report) {\n        reports.add(report);\n    } else if (child instanceof Sheet sheet) {\n        sheets.add(sheet);\n    } else if (child instanceof Sight sight) {\n        sights.add(sight);\n    } else if (child instanceof Template template) {\n        templates.add(template);\n    }\n}\n\nlastKey = response.getLastKey(); // Non-null means more items\n\n// Sample 2: Page through the data\nString lastKey = null; // Use null key for first page\ndo {\n    TokenPaginatedResult<Object> response = \n        client.folderResources()\n            .getFolderChildren(\n                folderId, null, null, lastKey, null);\n\n    for (Object child : response.getData()) {\n        if (child instanceof Sheet sheet) {\n            sheets.add(sheet);\n        }\n        // Check for other types\n    }\n\n    lastKey = response.getLastKey();\n} while (lastKey != null && !lastKey.isBlank());\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Sample 1: Get a page of data\nlet lastKey = ''; // Use empty string for first page\nconst page = await client.folders.getFolderChildren({\n  folderId,\n  queryParameters: { lastKey },\n});\nconst children = page?.data ?? [];\nfor (const child of children) {\n  switch (child?.resourceType) {\n    case 'sheet':\n      sheets.push(child);\n      break;\n    case 'report':\n      reports.push(child);\n      break;\n    case 'sight':\n      sights.push(child);\n      break;\n    case 'folder':\n      folders.push(child);\n      break;\n    case 'template':\n      templates.push(child);\n      break;\n    default:\n      break;\n  }\n}\nlastKey = page?.lastKey; // Non-empty means more items\n\n// Sample 2: Page through the data\nlet lastKey = ''; // Use empty string for first page\ndo {\n  const page = await client.folders.getFolderChildren({\n    folderId,\n    queryParameters: { lastKey },\n  });\n  const children = page?.data ?? [];\n  for (const child of children) {\n    switch (child?.resourceType) {\n      case 'sheet':\n        sheets.push(child);\n        break;\n      // Check for other types\n      default:\n        break;\n    }\n  }\n  lastKey = page?.lastKey;\n} while (lastKey);\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Sample 1: Get a page of data\nlast_key = None # Use None for first page\nresponse = smart.Folders.get_folder_children(\n    folder_id, last_key=last_key\n)\nassert isinstance(\n    response,\n    smartsheet.models.paginated_children_result.PaginatedChildrenResult\n)\n\nfor child in response.data:\n    if type(child) is Folder:\n        folders.append(child)\n    elif type(child) is Sheet:\n        sheets.append(child)\n    elif type(child) is Report:\n        reports.append(child)\n    elif type(child) is Sight:\n        sights.append(child)\n    elif type(child) is Template:\n        templates.append(child)\n\nlast_key = getattr(response, \"last_key\", None)# Non-null means more items\n\n# Sample 2: Page through the data\nlast_key = None # Use None for first page\nwhile True:\n    response = smart.Folders.get_folder_children(\n        folder_id, last_key=last_key\n    )\n    assert isinstance(\n        response,\n        smartsheet.models.paginated_children_result.PaginatedChildrenResult\n    )\n\n    for child in response.data:\n        if type(child) is Sheet:\n            sheets.append(child)\n        // Check for other types\n\n    last_key = getattr(response, \"last_key\", None)\n    if not last_key:\n        break\n"
          }
        ]
      }
    },
    "/folders/{folderId}/copy": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/folderId"
        }
      ],
      "post": {
        "summary": "Copy folder",
        "description": "Copies a folder.\n\n> **Important:** This operation doesn't copy cell history.\n",
        "tags": [
          "folders"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "operationId": "copy-folder",
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type_AppJsonOnly"
          },
          {
            "$ref": "#/components/parameters/sheetCopyInclude"
          },
          {
            "$ref": "#/components/parameters/sheetCopyExclude"
          },
          {
            "$ref": "#/components/parameters/skipRemap"
          }
        ],
        "requestBody": {
          "description": "New folder destination specification.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": [
                  "newName"
                ],
                "allOf": [
                  {
                    "type": "object",
                    "properties": {
                      "newName": {
                        "description": "Name of the newly created folder.",
                        "type": "string",
                        "example": "newFolderName"
                      }
                    }
                  },
                  {
                    "oneOf": [
                      {
                        "type": "object",
                        "title": "Folder or workspace",
                        "description": "Copying a folder to another folder or workspace.",
                        "required": [
                          "destinationType",
                          "destinationId"
                        ],
                        "properties": {
                          "destinationType": {
                            "description": "Type of destination container.",
                            "type": "string",
                            "enum": [
                              "folder",
                              "workspace"
                            ]
                          },
                          "destinationId": {
                            "description": "The ID of the destination folder or workspace.",
                            "type": "integer",
                            "format": "int64",
                            "example": 7960873114331022
                          }
                        }
                      },
                      {
                        "type": "object",
                        "title": "Home",
                        "description": "Copying a folder to Home.\n\nCopying a folder to Home is **Deprecated** since March 25, 2025, and support will be removed.\n",
                        "required": [
                          "destinationType"
                        ],
                        "properties": {
                          "destinationType": {
                            "description": "Type of destination container.",
                            "type": "string",
                            "enum": [
                              "home"
                            ]
                          }
                        }
                      }
                    ]
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Basic information about the new Folder",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/SuccessResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/FolderListing"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination\nContainerDestination destination = new ContainerDestination {\n  DestinationId = 7960873114331012,\n  DestinationType = DestinationType.FOLDER,\n  NewName = \"newFolderName\"\n};\n\n// Sample 1: Omit 'include' and 'skipRemap' parameters\nFolder folder = smartsheet.FolderResources.CopyFolder(\n  2252168947361668,               // long folderId\n  destination,\n  null,                           // IEnumerable<FolderCopyInclusion> include\n  null                            // IEnumerable<FolderRemapExclusion> skipRemap\n);\n\n// Sample 2: Specify 'include' parameter with value of \"DATA\", and 'skipRemap' parameter with value of \"CELL_LINKS\"\nFolder folder = smartsheet.FolderResources.CopyFolder(\n  2252168947361668,               // long folderId\n  destination,\n  new FolderCopyInclusion[] {\n    FolderCopyInclusion.DATA },\n  new FolderRemapExclusion[] {\n    FolderRemapExclusion.CELL_LINKS }\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/folders/{folderId}/copy?include=data' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n  \"destinationType\": \"folder\",\n  \"destinationId\": 7960873114331012,\n  \"newName\": \"newFolderName\"\n}' \\\n-X POST\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination\nContainerDestination destination = new ContainerDestination()\n        .setDestinationType(DestinationType.FOLDER)\n        .setDestinationId(7960873114331012L)\n        .setNewName(\"newFolderName\");\n\n// Sample 1: Omit 'include' and 'skipRemap' parameters\nFolder folder = smartsheet.folderResources().copyFolder(\n        2252168947361668L,                      // long folderId\n        destination,\n        null,                                   // EnumSet<FolderCopyInclusion> includes\n        null                                    // EnumSet<FolderRemapExclusion> skipRemap\n        );\n\n// Sample 2: Specify 'include' parameter with value of \"DATA\", and 'skipRemap' parameter with value of \"CELLLINKS\"\nFolder folder = smartsheet.folderResources().copyFolder(\n        2252168947361668L,                      // long folderId\n        destination,\n        EnumSet.of(FolderCopyInclusion.DATA),\n        EnumSet.of(FolderRemapExclusion.CELLLINKS)\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination information\nvar body = {\n  destinationType: \"folder\",\n  destinationId: 7960873114331012,\n  newName: \"Folder Copy\"\n};\n\n// Specify elements to copy\nvar params = {\n  include: \"data,discussions\",\n  skipRemap: \"cellLinks\"\n};\n\n// Set options\nvar options = {\n  folderId: 2252168947361668,\n  body: body,\n  queryParameters: params\n};\n\n// Copy folder\nsmartsheet.folders.copyFolder(options)\n  .then(function(folder) {\n    console.log(folder);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Copy folder\nresponse = smartsheet_client.Folders.copy_folder(\n  2252168947361668,                           # folder_id\n  smartsheet.models.ContainerDestination({\n    'destination_id': 7960873114331012,\n    'destination_type': 'folder',\n    'new_name': 'newFolderName'\n  })\n)\n\n# Sample 2: Include filters\nresponse = smartsheet_client.Folders.copy_folder(\n  2252168947361668,                           # folder_id\n  include=filters,\n  smartsheet.models.ContainerDestination({\n    'destination_id': 7960873114331012,\n    'destination_type': 'folder',\n    'new_name': 'newFolderName'\n  })\n)\n"
          }
        ]
      }
    },
    "/folders/{folderId}/folders": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/folderId"
        }
      ],
      "get": {
        "summary": "List folders",
        "deprecated": true,
        "description": "Gets a list of folders in a given folder. The list contains an abbreviated\nFolder object for each folder.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n\n> **DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be removed.** See the [List folder children](/api/smartsheet/openapi/folders/get-folder-children) endpoint for replacement functionality.\n> \n> For details, refer to [Migrate from GET /folders/{id}  for folder and child metadata](/api/smartsheet/guides/updating-code/migrate-from-get-folder.md).\n",
        "tags": [
          "folders"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "operationId": "list-folders",
        "parameters": [
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "IndexResult object containing an array of Folder objects.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Folder"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPaginatedResult<Folder> folders = smartsheet.FolderResources.ListFolders(\n  5107651446105988,           // long folderId\n  null                        // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/folders/{folderId}/folders \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPagedResult<Folder> folders = smartsheet.folderResources().listFolders(\n        510765144610598L,               // long parentFolderId\n        null                             // PaginationParameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  folderId: 5107651446105988\n};\n\n// List folders in another folder\nsmartsheet.folders.listChildFolders(options)\n  .then(function(folderList) {\n    console.log(folderList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List all\nresponse = smartsheet_client.Folders.list_folders(\n  5107651446105988,       # folder_id\n  include_all=True)\nfolders = response.data\n\n# Sample 2: Paginate the list\nresponse = smartsheet_client.Folders.list_folders(\n  5107651446105988,       # folder_id\n  page_size=5,\n  page=1)\npages = response.total_pages\nfolders = response.data\n"
          }
        ]
      },
      "post": {
        "summary": "Create folder",
        "description": "Creates a new folder inside an existing folder.\n",
        "operationId": "create-folder-folder",
        "tags": [
          "folders"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type_AppJsonOnly"
          }
        ],
        "requestBody": {
          "description": "Folder to create.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FolderCreateRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Basic information about the created Folder.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/SuccessResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/FolderListing"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set folder name\nFolder folderSpecification = new Folder { Name = \"New folder\" };\n\n// Create folder in another folder\nFolder newFolder = smartsheet.FolderResources.CreateFolder(\n  7960873114331012,               // long destinationFolderId\n  folderSpecification\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/folders/{folderid}/folders \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"name\": \"New folder\"}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set folder name\nFolder folderSpecification = new Folder();\nfolderSpecification.setName(\"New Folder\");\n\n// Create folder in another folder\nFolder newFolder = smartsheet.folderResources().createFolder(\n        7960873114331012L,       // long destinationFolderId\n        folderSpecification\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set folder name\nvar folder = {\n  \"name\": \"New folder\"\n};\n\n// Set options\nvar options = {\n  folderId: 7960873114331012,\n  body: folder\n  };\n\n// Create folder in another folder\nsmartsheet.folders.createChildFolder(options)\n  .then(function(newFolder) {\n    console.log(newFolder);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Create folder\nresponse = smartsheet_client.Folders.create_folder_in_folder(\n  7960873114331012,       # folder_id\n  'New folder')\n\n# Sample 2: Include filters\nresponse = smartsheet_client.Folders.create_folder_in_folder(\n  7960873114331012,       # folder_id\n  include=filters,\n  'New folder')\n"
          }
        ]
      }
    },
    "/folders/{folderId}/move": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/folderId"
        }
      ],
      "post": {
        "summary": "Move folder",
        "description": "Moves a folder.",
        "tags": [
          "folders"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "operationId": "move-folder",
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "description": "New folder destination.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ContainerDestinationForMove"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing a success message, result code, and metadata of the moved folder's new container.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/SuccessResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "description": "Container ID.",
                              "type": "number"
                            },
                            "name": {
                              "description": "Container name.",
                              "type": "string"
                            },
                            "permalink": {
                              "description": "URL that represents a direct link to the container in Smartsheet.",
                              "type": "string"
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination\nContainerDestination destination = new ContainerDestination {\n  DestinationId = 7960873114331012,       // long destinationFolderId\n  DestinationType = DestinationType.FOLDER,\n};\n\n// Move folder\nFolder folder = smartsheet.FolderResources.MoveFolder(\n  4509918431602564,               // long folderId\n  destination\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/folders/{folderId}/move \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n  \"destinationType\": \"folder\",\n  \"destinationId\": 7960873114331012\n}' \\\n-X POST\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination\nContainerDestination destination = new ContainerDestination()\n        .setDestinationType(DestinationType.FOLDER)\n        .setDestinationId(7960873114331012L);\n\n// Move folder\nFolder folder = smartsheet.folderResources().moveFolder(\n        4509918431602564L,                         // long folderId\n        destination\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set destination information\nvar body = {\n  destinationType: \"folder\",\n  destinationId: 7960873114331012\n};\n\n// Set options\nvar options = {\n  folderId: 4509918431602564,\n  body: body\n};\n\n// Move folder\nsmartsheet.folders.moveFolder(options)\n  .then(function(folder) {\n    console.log(folder);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nfolder = smartsheet_client.Folders.move_folder(\n  4509918431602564,                           # folder_id to be moved\n  smartsheet.models.ContainerDestination({\n    'destination_id': 7960873114331012,     # destination folder_id\n    'destination_type': 'folder'\n  })\n)\n"
          }
        ]
      }
    },
    "/folders/{folderId}/path": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/folderId"
        }
      ],
      "get": {
        "summary": "Get folder path",
        "description": "Gets the hierarchical path of the folder, showing its location within folders and workspace, if workspace-level access is provided",
        "operationId": "get-folder-path",
        "tags": [
          "folders"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Path information for the folder",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PathFolderResponse"
                }
              }
            }
          },
          "404": {
            "description": "Folder not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/folders/{folderId}/sheets": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/folderId"
        }
      ],
      "post": {
        "summary": "Create sheet in folder",
        "description": "Creates a sheet from scratch or from the specified template in the specified folder.\n",
        "operationId": "create-sheet-in-folder",
        "tags": [
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "CREATE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          },
          {
            "$ref": "#/components/parameters/include"
          }
        ],
        "requestBody": {
          "description": "Sheet to create.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/SheetToCreate"
                  },
                  {
                    "$ref": "#/components/schemas/SheetToCreateFromTemplate"
                  }
                ]
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Create sheet in folder\n// Specify properties of the first column\nColumn columnA = new Column\n{\n  Title = \"Favorite\",\n  Primary = false,\n  Type = ColumnType.CHECKBOX,\n  Symbol = Symbol.STAR\n};\n\n// Specify properties of the second column\nColumn columnB = new Column\n{\n  Title = \"Primary Column\",\n  Primary = true,\n  Type = ColumnType.TEXT_NUMBER\n};\n\n// Create sheet in folder (specifying the 2 columns to include in the sheet)\nSheet newSheet = smartsheet.FolderResources.SheetResources.CreateSheet(\n  3734419270854532,                   // long folderId\n  new Sheet\n    {\n      Name = \"new sheet title\",\n      Columns = new Column[] { columnA, columnB }\n    }\n);\n\n// Sample 2: Create sheet in folder from template\n// Specify name for the sheet and Id of the template\nSheet sheetSpecification = new Sheet\n{\n  Name = \"new sheet title\",\n  FromId = 7679398137620356     // template Id\n};\n\n// Option 1: Omit 'include' parameter\nSheet newSheet = smartsheet.FolderResources.SheetResources.CreateSheetFromTemplate(\n  3734419270854532,               // long folderId\n  sheetSpecification,\n  null                            // IEnumerable<TemplateInclusion> include\n);\n\n// Option 2: Include ATTACHMENTS, DATA, and DISCUSSIONS\nSheet newSheet = smartsheet.FolderResources.SheetResources.CreateSheetFromTemplate(\n  3734419270854532,               // long folderId\n  sheetSpecification,\n  new TemplateInclusion[] {\n    TemplateInclusion.ATTACHMENTS,\n    TemplateInclusion.DATA,\n    TemplateInclusion.DISCUSSIONS }\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "// Sample 1: Create sheet in folder\ncurl https://api.smartsheet.com/2.0/folders/{folderId}/sheets \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"name\":\"newsheet\",\"columns\":[{\"title\":\"Favorite\",\"type\":\"CHECKBOX\",\"symbol\":\"STAR\"}, {\"title\":\"Primary Column\", \"primary\":true,\"type\":\"TEXT_NUMBER\"}]}'\n\n// Sample 2: Create sheet in folder from template\ncurl 'https://api.smartsheet.com/2.0/folders/{folderId}/sheets?include=data,attachments,discussions' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"name\":\"newsheet\", \"fromId\": 7679398137620356}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Create sheet in folder\n// Specify properties of the first column\nColumn columnA = new Column()\n        .setTitle(\"Favorite\")\n        .setType(ColumnType.CHECKBOX)\n        .setSymbol(Symbol.STAR);\n\n// Specify properties of the second column\nColumn columnB = new Column()\n        .setTitle(\"Primary Column\")\n        .setType(ColumnType.TEXT_NUMBER)\n        .setPrimary(true);\n\n// Create sheet in folder (specifying the 2 columns to include in the sheet)\nSheet newSheet = new Sheet();\n        newSheet.setName(\"new sheet title\");\n        newSheet.setColumns(Arrays.asList(columnA, columnB));\n\nsmartsheet.sheetResources().createSheetInFolder(\n        3734419270854532L,  // long folderId\n        newSheet\n        );\n\n// Sample 2: Create sheet in folder from template\n// Specify name for the sheet and Id of the template\nSheet sheet = new Sheet();\nsheet.setFromId(7679398137620356L);     // long templateId\nsheet.setName(\"newsheet\");\n\n// Omit 'include' parameter\nSheet results = smartsheet.sheetResources().createSheetInFolderFromTemplate(\n        3734419270854532L,                  // long folderId\n        sheet,\n        null                                // EnumSet<SheetTemplateInclusion> includes\n        );\n\n// Include ATTACHMENTS, DATA, and DISCUSSIONS\nSheet results = smartsheet.sheetResources().createSheetInFolderFromTemplate(\n        3734419270854532L,                 // long folderId\n        sheet,\n        EnumSet.of(\n            SheetTemplateInclusion.ATTACHMENTS,\n            SheetTemplateInclusion.DATA,\n            SheetTemplateInclusion.DISCUSSIONS)\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Create sheet in folder\n// Specify sheet properties\nvar sheet = {\n  \"name\": \"newsheet\",\n  \"columns\": [\n    {\n      \"title\": \"Favorite\",\n      \"type\": \"CHECKBOX\",\n      \"symbol\": \"STAR\"\n    },\n    {\n      \"title\": \"Primary Column\",\n      \"primary\": true,\n      \"type\": \"TEXT_NUMBER\"\n    }\n  ]\n};\n\n// Set options\nvar options = {\n  folderId: 3734419270854532,\n  body: sheet\n  };\n\n// Create sheet in folder\nsmartsheet.sheets.createSheetInFolder(options)\n  .then(function(newSheet) {\n    console.log(newSheet);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n\n// Sample 2: Create sheet in folder from template\n// Specify the directive\nvar sheet = {\n  \"name\": \"newsheet\",\n  \"fromId\": 7679398137620356\n};\n\n// Set options\nvar options = {\n  body: sheet,\n  folderId: 3734419270854532\n};\n\n// Create sheet from template in the specified folder\nsmartsheet.sheets.createSheetFromExisting(options)\n  .then(function(data) {\n    console.log(data);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Create sheet in folder\nsheet_spec = smartsheet.models.Sheet({\n  'name': 'newsheet',\n  'columns': [{\n        'title': 'Favorite',\n        'type': 'CHECKBOX',\n        'symbol': 'STAR'\n      }, {\n        'title': 'Primary Column',\n        'primary': True,\n        'type': 'TEXT_NUMBER'\n      }\n  ]\n})\nresponse = smartsheet_client.Folders.create_sheet_in_folder(\n  3734419270854532,       # folder_id\n  sheet_spec)\nnew_sheet = response.result\n\n# Sample 2: Create sheet in folder from template\nresponse = smartsheet_client.Folders.create_sheet_in_folder_from_template(\n  3734419270854532,                   # folder_id\n  smartsheet.models.Sheet({\n    'name': 'newsheet',\n    'from_id': 7679398137620356       # template_id\n  })\n)\n"
          }
        ],
        "responses": {
          "200": {
            "description": "Result object containing a Sheet object for newly created sheet, corresponding to what was specified in the request.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "oneOf": [
                            {
                              "$ref": "#/components/schemas/SheetCreated"
                            },
                            {
                              "$ref": "#/components/schemas/SheetCreatedFromTemplate"
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/folders/{folderId}/sheets/import": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/folderId"
        }
      ],
      "post": {
        "summary": "Import sheet into folder",
        "description": "Imports CSV or XLSX data into a new sheet in the specified folder.\n\nNote the following:\n* Both sheetName and the file name must use ASCII characters.\n* The source data must be basic text. To include rich formula data, import and create a sheet first, and then use Update Rows. To work with images, see Cell Images.\n* XLS is not supported. You must use XLSX.\n* Hierarchical relationships between rows in an external file won't import.\n",
        "operationId": "import-sheet-into-folder",
        "tags": [
          "imports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "CREATE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Disposition"
          },
          {
            "$ref": "#/components/parameters/parameters-Content-Type"
          },
          {
            "$ref": "#/components/parameters/sheetName"
          },
          {
            "$ref": "#/components/parameters/headerRowIndex"
          },
          {
            "$ref": "#/components/parameters/primaryColumnIndex"
          }
        ],
        "requestBody": {
          "description": "Binary content for the CSV / XLSX file.",
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing a Sheet object for imported sheet.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/SheetImported"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSheet sheet = smartsheet.FolderResources.SheetResources.ImportXlsSheet(\n  8999900887877508,       // folderId\n  \"D:/ProgressReport.xlsx\",\n  null,                   // sheetName defaults to file name unless specified\n  0,                      // headerRowIndex\n  null                    // primaryColumnIndex\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl  https://api.smartsheet.com/2.0/folders/{folderId}/sheets/import?sheetName=MarketingProgressReport&headerRowIndex=0&primaryColumnIndex=0 \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Disposition: attachment\" \\\n-H \"Content-Type: text/csv\" \\\n-X POST \\\n--data-binary @ProgressReport.csv\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSheet sheet = smartsheet.sheetResources().importXlsxInFolder(\n        8999900887877508L,           // long folderId\n        \"D:/ProgressReport.xlsx\",\n        \"MarketingProgressReport\",\n        0,                          // headerRowIndex\n        0                           // primaryColumnIndex\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Import CSV into folder\n// Set options\nvar options = {\n  folderId: 8999900887877508,\n  queryParameters: {\n    sheetName: 'MarketingProgressReport'\n  },\n  path: \"D:/ProgressReport.csv\"\n};\n\n// Import CSV as sheet into folder\nsmartsheet.sheets.importCsvSheetIntoFolder(options)\n  .then(function(attachment) {\n    console.log(attachment);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n\n//Sample 2: Import XLSX into folder\n// Set options\nvar options = {\n  folderId: 8999900887877508,\n  queryParameters: {\n    sheetName: 'MarketingProgressReport'\n  },\n  path: \"D:/ProgressReport.xlsx\"\n};\n\n// Import XLSX as sheet into Folder\nsmartsheet.sheets.importXlsxSheetIntoFolder(options)\n  .then(function(attachment) {\n    console.log(attachment);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nimported_sheet = smartsheet_client.Folders.import_xlsx_sheet(\n  8999900887877508,           # folder_id\n  'D:/ProgressReport.xlsx',\n  'MarketingProgressReport',  # sheet_name\n  header_row_index=0\n)\n"
          }
        ]
      }
    },
    "/folders/personal": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List contents",
        "deprecated": true,
        "description": "Gets a nested list of all Home objects shared to the user, including \ndashboards, folders, reports, sheets, and templates, as shown on the \"Home\"\ntab.\n\n**DEPRECATED** - This endpoint is being removed. To adapt to this change, please see [Migrate from using the Sheets folder](/api/smartsheet/guides/updating-code/migrate-from-using-the-sheets-folder).\n",
        "tags": [
          "home"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "operationId": "list-home-contents",
        "parameters": [
          {
            "$ref": "#/components/parameters/folderWorkspaceInclude"
          }
        ],
        "responses": {
          "200": {
            "description": "A single Home object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Home"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/folders/personal' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\"\n"
          }
        ]
      }
    },
    "/groups": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "operationId": "list-groups",
        "summary": "List org groups",
        "description": "Gets a list of all groups in an organization account. To fetch the members of an individual group, use the [Get Group](/api/smartsheet/openapi/groups/get-group) operation.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "tags": [
          "groups"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_USERS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/modifiedSince"
          },
          {
            "$ref": "#/components/parameters/numericDates"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "IndexResult object containing an array of [Group objects](/api/smartsheet/openapi/groups/group).\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "List of Groups",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Group"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPaginatedResult<Group> groups = smartsheet.GroupResources.ListGroups(\n  null                    // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/groups \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPagedResult<Group> groups = smartsheet.groupResources().listGroups(\n        null        // PaginationParameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.groups.listGroups()\n  .then(function(groupList) {\n    console.log(groupList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List all\nresponse = smartsheet_client.Groups.list_groups(include_all=True)\ngroups = response.data\n\n# Sample 2: Paginate the list\nresponse = smartsheet_client.Groups.list_groups(\n  page_size=10,\n  page=1)\npages = response.total_pages\ngroups = response.data\n"
          }
        ]
      },
      "post": {
        "operationId": "add-group",
        "summary": "Add group",
        "description": "Creates a new group.\n\n**_This operation is only available to group administrators and system administrators._**\n",
        "tags": [
          "groups"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "requestBody": {
          "description": "[Group object](/api/smartsheet/openapi/groups/group), limited to the following attributes:\n* name (required) -- must be unique within the organization account\n* description (optional)\n* members (optional) -- array of [GroupMember objects](/api/smartsheet/openapi/groupmembers/groupmember), each limited to the following attribute:\n    * email\n",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "description": "**name** (required)\n\nMust be unique within the organization account.\n",
                    "type": "string",
                    "example": "API-created group"
                  },
                  "description": {
                    "description": "**description** (optional)\n",
                    "type": "string",
                    "example": "Group created via API"
                  },
                  "members": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "email": {
                          "description": "Group member's email address.",
                          "type": "string",
                          "format": "email",
                          "example": "john.doe@smartsheet.com"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object, containing a [Group object](/api/smartsheet/openapi/groups/group) for the newly created group\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Group"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Create group member\nGroupMember memberSpecification = new GroupMember { Email = \"john.doe@smartsheet.com\" };\n\n// Add member to group\nGroup groupSpecification = new Group\n{\n  Name = \"API-created Group\",\n  Description = \"Group created via API\",\n  Members = new GroupMember[] { memberSpecification }\n};\n\n// Create group\nGroup newGroup = smartsheet.GroupResources.CreateGroup(groupSpecification);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/groups \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{ \"name\": \"API-created Group\", \"description\": \"Group created via API\", \"members\": [{ \"email\": \"john.doe@smartsheet.com\" }]}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Create group member\nGroupMember memberSpecification = new GroupMember();\nmemberSpecification.setEmail(\"john.doe@smartsheet.com\");\n\n// Add member to group\nGroup groupSpecification = new Group();\ngroupSpecification.setDescription(\"Group created via API\")\n        .setMembers(Arrays.asList(memberSpecification))\n        .setName(\"API-created Group\");\n\n// Create group\nGroup newGroup = smartsheet.groupResources().createGroup(groupSpecification);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify group\nvar group = {\n  \"name\": \"API-created Group\",\n  \"description\": \"Group created via API\",\n  \"members\": [\n    {\n      \"email\": \"john.doe@smartsheet.com\"\n    }\n  ]\n};\n\n// Set options\nvar options = {\n  body: group\n};\n\n// Create group\nsmartsheet.groups.createGroup(options)\n  .then(function(newGroup) {\n    console.log(newGroup);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nnew_group = smartsheet_client.Groups.create_group(\n  smartsheet.models.Group({\n    'name': 'API-created Group',\n    'description': 'Group created via API',\n    'members': smartsheet.models.GroupMember({\n      'email': 'john.doe@smartsheet.com'\n    })\n  })\n)\n"
          }
        ]
      }
    },
    "/groups/{groupId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/groupId"
        }
      ],
      "get": {
        "operationId": "get-group",
        "summary": "Get group",
        "description": "Gets information about an array of [Group Members](/api/smartsheet/openapi/groupmembers/groupmember) for the group specified in the URL.",
        "tags": [
          "groups"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_USERS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "[Group](/api/smartsheet/openapi/groups/group) object that includes the list of [GroupMember](/api/smartsheet/openapi/groupmembers/groupmember) objects\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Group"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "members": {
                          "description": "List of Group Members",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/GroupMember"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nGroup group = smartsheet.GroupResources.GetGroup(\n  6932724448552836            // long groupId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/groups/{groupId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nGroup group = smartsheet.groupResources().getGroup(\n        6932724448552836L        // long groupId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  id: 6932724448552836 // Id of Group\n};\n\n// Get group\nsmartsheet.groups.getGroup(options)\n  .then(function(group) {\n    console.log(group);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\ngroup = smartsheet_client.Groups.get_group(\n  6932724448552836)       # group_id\n# group is an instance of smartsheet.models.Group\n"
          }
        ]
      },
      "put": {
        "operationId": "update-group",
        "summary": "Update group",
        "description": "Updates the Group specified in the URL.\n\n**_This operation is only available to group administrators and system administrators._**\n",
        "tags": [
          "groups"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "requestBody": {
          "description": "Group object, limited to the following attributes:\n* description (optional)\n* name (optional) -- must be unique within the organization account\n* ownerId (optional): Id of an admin user to whom the group ownership is transferred\n",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "description": "name (Optional)\n\nMust be unique within the organization account.\n",
                    "type": "string",
                    "example": "Renamed group"
                  },
                  "description": {
                    "description": "Description (optional).",
                    "type": "string",
                    "example": "Some new description"
                  },
                  "ownerId": {
                    "description": "ownerId (optional)\n\nId of an admin user to whom the group ownership is transferred.\n",
                    "type": "number",
                    "example": 94094820842
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing the [Group object](/api/smartsheet/openapi/groups/group) for the updated group",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Group"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify the name and description of the group\nGroup groupSpecification = new Group\n{\n  Id = 2331373580117892,\n  Name = \"Renamed Group\",\n  Description = \"Some new description\"\n};\n\n// Update group\nGroup updatedGroup = smartsheet.GroupResources.UpdateGroup(groupSpecification);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/groups/{groupId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '{ \"name\": \"Renamed Group\", \"description\": \"Some new description\" }'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify the name and description of the group\nGroup groupSpecification = new Group(2331373580117892L);\n        groupSpecification.setDescription(\"Some new description\")\n        .setName(\"Renamed Group\");\n\n// Update group\nGroup updatedGroup = smartsheet.groupResources().updateGroup(groupSpecification);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify the name and description of the group\nvar group = {\n  \"name\": \"Renamed Group\",\n  \"description\": \"Some new description\"\n};\n\n// Set options\nvar options = {\n  id: 2331373580117892, // Id of Group\n  body: group\n  };\n\n// Update group\nsmartsheet.groups.updateGroup(options)\n  .then(function(updatedGroup) {\n    console.log(updatedGroup);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nupdated_group = smartsheet_client.Groups.update_group(\n  2331373580117892,       # group_id\n  smartsheet.models.Group({\n    'name': 'Renamed Group',\n    'description': 'Some new description'\n  })\n)\n"
          }
        ]
      },
      "delete": {
        "operationId": "delete-group",
        "summary": "Delete group",
        "description": "Deletes the group specified in the URL.\n\n**_This operation is only available to group administrators and system administrators._**\n",
        "tags": [
          "groups"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "**_This operation is asynchronous,_** _meaning group members may retain their sharing access for a brief period of time after the call returns. For small groups with limited sharing, the operation should complete quickly (within a few seconds). For large groups with many shares, this operation could possibly take more than a minute to complete._\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "404": {
            "$ref": "#/components/responses/404"
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.GroupResources.DeleteGroup(\n  6932724448552836            // long groupId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/groups/{groupId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.groupResources().deleteGroup(\n        6932724448552836L        // long groupId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  id: 6932724448552836 // Id of Group\n};\n\n// Delete group\nsmartsheet.groups.deleteGroup(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Groups.delete_group(\n    6932724448552836)       # group_id\n"
          }
        ]
      }
    },
    "/groups/{groupId}/members": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/groupId"
        }
      ],
      "post": {
        "operationId": "add-group-members",
        "summary": "Add group members",
        "description": "Adds one or more members to a group.\n\n**_This operation supports both single-object and bulk semantics. For more information, see Optional Bulk Operations._**\n\nIf called with a single [GroupMember object](/api/smartsheet/openapi/groupmembers/groupmember), and that group member already exists, error code **1129** is returned.\nIf called with an array of [GroupMember objects](/api/smartsheet/openapi/groupmembers/groupmember), any users specified in the array that are already group members are ignored and omitted from the response.\n\n**_This operation is only available to group administrators and system administrators._**\n",
        "tags": [
          "groupMembers"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/GroupMember"
                  },
                  {
                    "type": "array",
                    "title": "Group member array",
                    "items": {
                      "$ref": "#/components/schemas/GroupMember"
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Returns a Result object containing the members added to the group -- either a single [GroupMember](/api/smartsheet/openapi/groupmembers/groupmember) or array of [GroupMember](/api/smartsheet/openapi/groupmembers/groupmember) objects, corresponding to what was specified in the request.\n\n**_This operation is asynchronous,_** _meaning the users may not yet have sharing access to sheets for a period of time after this operation returns. For small groups with limited sharing, the operation should complete quickly (within a few seconds). For large groups with many shares, this operation could possibly take more than a minute to complete._\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "oneOf": [
                            {
                              "$ref": "#/components/schemas/GroupMember"
                            },
                            {
                              "type": "array",
                              "title": "Group member array",
                              "items": {
                                "$ref": "#/components/schemas/GroupMember"
                              }
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "If an error occurs because the request specified one or more alternate email addresses, please retry using the primary email address.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Create group member\nGroupMember memberSpecification = new GroupMember { Email = \"jane.doe@smartsheet.com\" };\n\n// Add members to group\nIList<GroupMember> newMembers = smartsheet.GroupResources.AddGroupMembers(\n  7917992160847748,           // long groupId\n  new GroupMember[] { memberSpecification }\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/groups/{groupId}/members \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d \"[{ \\\"email\\\": \\\"jane.doe@smartsheet.com\\\" }]\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Create group member\nGroupMember memberSpecification = new GroupMember();\n        memberSpecification.setEmail(\"jane.doe@smartsheet.com\");\n\n// Add members to group\nList<GroupMember> newMembers = smartsheet.groupResources().memberResources().addGroupMembers(\n        7917992160847748L,       // long groupId\n        Arrays.asList(memberSpecification)\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify group members\nvar members = [{ \"email\": \"jane.doe@smartsheet.com\" }];\n\n// Set options\nvar options = {\n  groupId: 7917992160847748,\n  body: members\n  };\n\n// Add members to group\nsmartsheet.groups.addGroupMembers(options)\n  .then(function(newMembers) {\n    console.log(newMembers);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nnew_members = smartsheet_client.Groups.add_members(\n  7917992160847748,       # group_id\n  [smartsheet.models.GroupMember({'email': 'jane.doe@smartsheet.com'})]\n)\n"
          }
        ]
      }
    },
    "/groups/{groupId}/members/{userId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/groupId"
        },
        {
          "$ref": "#/components/parameters/userId"
        }
      ],
      "delete": {
        "operationId": "delete-group-members",
        "summary": "Delete group members",
        "description": "Removes a member from a group.\n\n**_This operation is only available to group administrators and system administrators._**\n",
        "tags": [
          "groupMembers"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "**_This operation is asynchronous,_** _meaning the users may not yet have sharing access to sheets for a period of time after this operation returns. For small groups with limited sharing, the operation should complete quickly (within a few seconds). For large groups with many shares, this operation could possibly take more than a minute to complete._\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.GroupResources.RemoveGroupMember(\n  7917992160847748,           // long groupId\n  1539725208119172            // long userId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/groups/{groupId}/members/{userId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.groupResources().memberResources().deleteGroupMember(\n        7917992160847748L,       // long groupId\n        1539725208119172L)       // long userId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  groupId: 7917992160847748,\n  userId: 1539725208119172\n};\n\n// Remove member from group\nsmartsheet.groups.removeGroupMember(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Groups.remove_member(\n  7917992160847748,       # group_id\n  1539725208119172)       # group_member_id\n"
          }
        ]
      }
    },
    "/home/folders": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List folders in home",
        "deprecated": true,
        "description": "Lists the folders in your **Sheets** folder. The list contains an abbreviated Folder object for each folder.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n\n**DEPRECATED** - The Sheets folder is being replaced by workspaces. To adapt to this change, please see [Migrate from using the Sheets folder](/api/smartsheet/guides/updating-code/migrate-from-using-the-sheets-folder).\n",
        "tags": [
          "home"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "operationId": "home-list-folders",
        "parameters": [
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "IndexResult object containing an array of Folder objects.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Folder"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPaginatedResult<Folder> folders = smartsheet.HomeResources.FolderResources.ListFolders(\n  null                    // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/home/folders \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPagedResult<Folder> folders = smartsheet.homeResources().folderResources().listFolders(\n        null            // PaginationParameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.home.listFolders()\n  .then(function(folderList) {\n    console.log(folderList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  })\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List all\nresponse = smartsheet_client.Home.list_folders(include_all=True)\nhome_sheets_folders = response.data\n\n# Sample 2: Paginate the list\nresponse = smartsheet_client.Home.list_folders(\n  page_size=5,\n  page=1)\npages = response.total_pages\nfolders = response.data\n"
          }
        ]
      },
      "post": {
        "summary": "Create folder",
        "deprecated": true,
        "description": "Creates a new folder.\n\n**DEPRECATED** - This endpoint is being removed. To adapt to this change, please see [Migrate from using the Sheets folder](/api/smartsheet/guides/updating-code/migrate-from-using-the-sheets-folder).\n",
        "operationId": "create-home-folder",
        "tags": [
          "home"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "description": "Folder to create.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Folder"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing a Folder object for newly created folder.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Folder"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set folder name\nFolder folderSpecification = new Folder { Name = \"New folder\" };\n\n// Create folder in \"Sheets\" folder (Home)\nFolder newFolder = smartsheet.HomeResources.FolderResources.CreateFolder(folderSpecification);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/home/folders \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"name\": \"New folder\"}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set folder name\nFolder folderSpecification = new Folder();\nfolderSpecification.setName(\"New Folder\");\n\n// Create folder in \"Sheets\" folder (Home)\nFolder newFolder = smartsheet.homeResources().folderResources().createFolder(folderSpecification);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set folder name\nvar folder = {\n  \"name\": \"New folder\"\n};\n\n// Set options\nvar options = {\n  body: folder\n};\n\n// Create folder in \"Sheets\" folder (Home)\nsmartsheet.home.createFolder(options)\n  .then(function(newFolder) {\n    console.log(newFolder);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nnew_folder = smartsheet_client.Home.create_folder('New Folder')\n"
          }
        ]
      }
    },
    "/imageurls": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/Content-Type"
        }
      ],
      "post": {
        "operationId": "listImageUrls",
        "summary": "List image URLs",
        "description": "Posts an array of Image Url objects that can be used to retrieve the specified cell images.",
        "tags": [
          "cellImages"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ImageUrl"
                    }
                  ]
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ImageUrlMap"
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Build list of image urls\nImageUrl[] imageUrls = new ImageUrl[] { new ImageUrl { ImageId = \"jpbGklqdfZuL4Jw-kZhdZA\" } };\n\nstring temporaryUrl = smartsheet.ImageUrlResources.GetImageUrls(imageUrls).ImageUrls[0].Url;\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/imageurls \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '[{\"imageId\": \"e1znCxhuZo_soEJtUmmX_A\",\"height\":40,\"width\": 20},{\"imageId\": \"g2jdKdfhQa_abKJmPnhC_B\",\"height\":100,\"width\": 50}]'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Build list of image urls\nImageUrl imageUrl = new ImageUrl()\n        .setImageId(\"jpbGklqdfZuL4Jw-kZhdZA\");\n        List<ImageUrl> imageUrls = Arrays.asList(imageUrl);\n\n        String temporaryUrl = smartsheet.imageUrlResources().getImageUrls(imageUrls).getImageUrls().get(0).getUrl();\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  body: [{\n    imageId: \"jpbGklqdfZuL4Jw-kZhdZA\",\n    width: 256,\n    height: 256\n  }]\n};\n\n// List image URLs\nsmartsheet.images.listImageUrls(options)\n  .then(function(temporaryUrls) {\n    console.log(temporaryUrls);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nimageUrl = smartsheet.models.ImageUrl(\n  {\n    \"imageId\": 'jpbGklqdfZuL4Jw-kZhdZA',\n    \"height\": 256,\n    \"width\": 256\n  }\n)\n\nresponse = smartsheet_client.Images.get_image_urls([imageUrl])\nurl = response.image_urls[0].url\n"
          }
        ]
      }
    },
    "/reports": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "operationId": "getReports",
        "summary": "List reports",
        "description": "List all Reports accessible to the user.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "tags": [
          "reports"
        ],
        "security": [
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/modifiedSince"
          }
        ],
        "responses": {
          "200": {
            "description": "Object containing an array of all accessible reports, referenced by their ID, name, access level, and summary report flag values.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "List of all accessible reports, referenced by their ID, name, access level, and summary report flag values.",
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number",
                                "description": "The report's unique identifier.",
                                "example": 987654321
                              },
                              "name": {
                                "type": "string",
                                "description": "The report's name.",
                                "example": "Q2 Earnings"
                              },
                              "accessLevel": {
                                "$ref": "#/components/schemas/AccessLevel"
                              },
                              "permalink": {
                                "type": "string",
                                "description": "URL to the report in Smartsheet.",
                                "example": "https://app.smartsheet.com/reports/c8gJxw87cXpRCvCC5PPw6jFhFRrf5r8PxCrxvW21"
                              },
                              "isSummaryReport": {
                                "type": "boolean",
                                "description": "It is `true` if the report is a sheet summary; otherwise it is a row report."
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nPaginatedResult<Report> reports = smartsheet.ReportResources.ListReports(\n  null,               // PaginationParameters\n  null                // Nullable<DateTime> modifiedSince = null\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/reports \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nPagedResult<Report> reports = smartsheet.reportResources().listReports(\n        null,               // PaginationParameters\n        null                // Date modifiedSince\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.reports.listReports()\n  .then(function(reportList) {\n    console.log(reportList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Reports.list_reports(include_all=True)\nreports = response.data\n"
          }
        ]
      },
      "post": {
        "operationId": "createReport",
        "summary": "Create report",
        "description": "Creates a new report from scratch in the specified destination, using the provided scope, columns and report definition.",
        "tags": [
          "reports"
        ],
        "security": [
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "requestBody": {
          "description": "The report to be created.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateReport"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Returns [Result object](/api/smartsheet/openapi/schemas/result) containing a [Report object](/api/smartsheet/openapi/schemas/createreportresult) corresponding to the newly created report.\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/CreateReportResult"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "This can be caused by the following situations:\n\n- A source workspace does not exist.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1008,\n    \"message\": \"Unable to parse request. The following error occurred: Source workspace 123456789 not found.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- No primary column specified for a row report.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1055,\n    \"message\": \"One and only one column must be primary.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- No sheet name column specified for a sheet summary report.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1371,\n    \"message\": \"Summary reports require a sheet name column. Use sheetNameColumn=true to add it.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- Destination workspace does not exist.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1008,\n    \"message\": \"Unable to parse request. The following error occurred: Destination with type WORKSPACE and id 123456789 not found.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- Invalid inputs for columns, filters, summarizing criteria and grouping criteria\n"
          },
          "403": {
            "description": "This can be caused by the following situations:\n\n- Calling user is not allowed to create assets in the destination workspace.\n  ```json\n  {\n    \"errorCode\": 1004,\n    \"message\": \"You are not authorized to perform this action.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n"
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "Java",
            "label": "Java SDK",
            "source": "ReportScopeInclusion sheetScope = new ReportScopeInclusion();\nsheetScope.setAssetType(ReportAssetType.SHEET);\nsheetScope.setAssetId(2331373580117892L);\n\nReportScopeInclusion workspaceScope = new ReportScopeInclusion();\nworkspaceScope.setAssetType(ReportAssetType.WORKSPACE);\nworkspaceScope.setAssetId(7879278542455688L);\n\nList<ReportScopeInclusion> scope = new ArrayList<>();\nscope.add(sheetScope);\nscope.add(workspaceScope);\n\nReportColumn column1 = new ReportColumn();\ncolumn1.setTitle(\"Primary\");\ncolumn1.setType(ColumnType.TEXT_NUMBER);\ncolumn1.setPrimary(true);\ncolumn1.setIndex(0);\n\nReportColumn column2 = new ReportColumn();\ncolumn2.setTitle(\"Sheet name\");\ncolumn2.setType(ColumnType.TEXT_NUMBER);\ncolumn2.setIndex(1);\ncolumn2.setSheetNameColumn(true);\n\nReportColumn column3 = new ReportColumn();\ncolumn3.setTitle(\"Last modified at\");\ncolumn3.setType(ColumnType.DATETIME);\ncolumn3.setSystemColumnType(SystemColumnType.MODIFIED_DATE);\ncolumn3.setIndex(2);\n\nList<ReportColumn> columns = List.of(column1, column2, column3);\n\nReportColumnIdentifier primaryColumn = new ReportColumnIdentifier()\n        .setPrimary(true)\n        .setType(ColumnType.TEXT_NUMBER)\n        .setTitle(\"Primary Column\");\n\nReportDefinition reportDefinition = new ReportDefinition()\n        .setSummarizingCriteria(List.of(\n                new ReportSummarizingCriterion()\n                        .setAggregationType(ReportAggregationType.COUNT)\n                        .setColumn(primaryColumn)\n        ))\n        .setFilters(new ReportFilterExpression()\n                .setOperator(ReportFilterExpressionOperator.AND)\n                .setCriteria(List.of(\n                        new ReportFilterCriterion()\n                                .setColumn(primaryColumn)\n                                .setOperator(ReportFilterOperator.EQUAL)\n                                .setValues(List.of(new StringObjectValue(\"Test\")))\n                ))\n        )\n        .setGroupingCriteria(List.of(\n                new ReportGroupingCriterion()\n                        .setColumn(primaryColumn)\n                        .setSortingDirection(SortDirection.ASCENDING)\n                        .setIsExpanded(true)\n        ))\n        .setSortingCriteria(List.of(\n                new ReportSortingCriterion()\n                        .setColumn(primaryColumn)\n                        .setSortingDirection(SortDirection.ASCENDING)\n        ));\n\nCreateReportRequest createReportRequest = new CreateReportRequest()\n        .setName(\"Test report\")\n        .setIsSummaryReport(false)\n        .setDestination(new ReportDestination()\n                .setDestinationType(ReportDestinationType.WORKSPACE)\n                .setDestinationId(8947374833478L))\n        .setScope(scope)\n        .setColumns(columns)\n        .setReportDefinition(reportDefinition);\n\nCreateReportResult createdReport = smartsheet.reportResources().createReport(createReportRequest);\n"
          },
          {
            "lang": "C#",
            "label": "C# SDK",
            "source": "var scope = new List<ReportScopeInclusion>\n{\n    new ReportScopeInclusion\n    {\n        AssetType = ReportAssetType.SHEET,\n        AssetId = 2331373580117892\n    },\n    new ReportScopeInclusion\n    {\n        AssetType = ReportAssetType.WORKSPACE,\n        AssetId = 7879278542455688\n    }\n};\n\nvar columns = new List<ReportColumn>\n{\n    new ReportColumn { Title = \"Primary\", Type = ColumnType.TEXT_NUMBER, Index = 0, Primary = true },\n    new ReportColumn { Title = \"Sheet name\", Type = ColumnType.TEXT_NUMBER, Index = 1, SheetNameColumn = true },\n    new ReportColumn { Title = \"Last modified at\", Type = ColumnType.DATETIME, SystemColumnType = SystemColumnType.MODIFIED_DATE, Index = 2 }\n};\n\nReportDefinition reportDefinition = new ReportDefinition\n{\n    SummarizingCriteria = new List<ReportSummarizingCriterion>\n    {\n        new ReportSummarizingCriterion\n        {\n            AggregationType = ReportAggregationType.COUNT,\n            Column = new ReportColumnIdentifier\n            {\n                Primary = true,\n                Type = ColumnType.TEXT_NUMBER,\n                Title = \"Primary Column\",\n            }\n        }\n    },\n    Filters = new ReportFilterExpression\n    {\n        Operator = ReportFilterOperator.AND,\n        Criteria = new List<ReportFilterCriterion>\n        {\n            new ReportFilterCriterion\n            {\n                Column = new ReportColumnIdentifier\n                {\n                    Primary = true,\n                    Type = ColumnType.TEXT_NUMBER,\n                    Title = \"Primary Column\",\n                },\n                Operator = ReportFilterCriteriaOperator.EQUAL,\n                Values = new List<ReportFilterValue> { new StringReportFilterValue(\"Test\") },\n            }\n        }\n    },\n    GroupingCriteria = new List<ReportGroupingCriterion>\n    {\n        new ReportGroupingCriterion\n        {\n            Column = new ReportColumnIdentifier\n            {\n                Primary = true,\n                Type = ColumnType.TEXT_NUMBER,\n                Title = \"Primary Column\",\n            },\n            SortingDirection = SortDirection.ASCENDING,\n            IsExpanded = true\n        }\n    },\n    SortingCriteria = new List<ReportSortingCriterion>\n    {\n        new ReportSortingCriterion\n        {\n            Column = new ReportColumnIdentifier\n            {\n                Primary = true,\n                Type = ColumnType.TEXT_NUMBER,\n                Title = \"Primary Column\",\n            },\n            SortingDirection = SortDirection.ASCENDING\n        }\n    },\n};\n\nvar createReportRequest = new CreateReportRequest\n{\n    Name = \"Test report\",\n    IsSummaryReport = false,\n    Destination = new ReportDestination\n    {\n        DestinationId = 8947374833478,\n        DestinationType = ReportDestinationType.WORKSPACE\n    },\n    Scope = scope,\n    Columns = columns,\n    ReportDefinition = reportDefinition\n};\n\nvar createdReport = smartsheet.ReportResources.CreateReport(createReportRequest);\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "sheetScope = ReportScopeInclusion({\n    \"assetId\": 2331373580117892,\n    \"assetType\": ReportAssetType.SHEET\n})\n\nworkspaceScope = ReportScopeInclusion({\n    \"assetId\": 7879278542455688,\n    \"assetType\": ReportAssetType.WORKSPACE\n})\n\nscope = [sheetScope, workspaceScope]\n\ncolumns = [\n    ReportColumn({\n        \"title\": \"Primary\",\n        \"type\": ColumnType.TEXT_NUMBER,\n        \"primary\": True,\n        \"index\": 0\n    }),\n    ReportColumn({\n        \"title\": \"Sheet name\",\n        \"type\": ColumnType.TEXT_NUMBER,\n        \"sheetNameColumn\": True,\n        \"index\": 1\n    }),\n    ReportColumn({\n        \"title\": \"Last modified at\",\n        \"type\": ColumnType.DATETIME,\n        \"systemColumnType\": SystemColumnType.MODIFIED_DATE,\n        \"index\": 2\n    })\n]\n\nprimary_column = {\n    \"primary\": True,\n    \"type\": ColumnType.TEXT_NUMBER,\n    \"title\": \"Primary Column\",\n}\n\nreport_definition = ReportDefinition({\n    \"summarizingCriteria\": [\n        {\n            \"aggregationType\": ReportAggregationType.COUNT,\n            \"column\": primary_column\n        }\n    ],\n    \"filters\": {\n        \"operator\": ReportBooleanOperator.AND,\n        \"criteria\": [\n            {\n                \"column\": primary_column,\n                \"operator\": ReportFilterOperator.EQUAL,\n                \"values\": [\"Test\"],\n            }\n        ],\n    },\n    \"groupingCriteria\": [\n        {\n            \"column\": primary_column,\n            \"sortingDirection\": SortDirection.ASCENDING,\n            \"isExpanded\": True,\n        }\n    ],\n    \"sortingCriteria\": [\n        {\n            \"column\": primary_column,\n            \"sortingDirection\": SortDirection.ASCENDING,\n        }\n    ],\n})\n\ncreate_report_request = CreateReportRequest({\n    \"name\": \"Test report\",\n    \"isSummaryReport\": False,\n    \"destination\": {\n        \"destinationType\": ReportDestinationType.WORKSPACE,\n        \"destinationId\": 8947374833478\n    },\n    \"scope\": scope,\n    \"columns\": columns,\n    \"reportDefinition\": report_definition\n})\n\ncreated_report = client.Reports.create_report(create_report_request)\n"
          },
          {
            "lang": "JavaScript",
            "label": "JavaScript SDK",
            "source": "const scope = [\n    {\n        assetType: ReportAssetType.SHEET,\n        assetId: 2331373580117892\n    },\n    {\n        assetType: ReportAssetType.WORKSPACE,\n        assetId: 7879278542455688\n    }\n]\n\nconst columns = [\n    {\n        title: 'Primary',\n        type: ReportColumnType.TEXT_NUMBER,\n        index: 0\n    },\n    {\n        title: 'Sheet name',\n        type: ReportColumnType.TEXT_NUMBER,\n        sheetNameColumn: true,\n        index: 1\n    },\n    {\n        title: 'Last modified at',\n        type: ReportColumnType.DATETIME,\n        systemColumnType: SystemColumnType.MODIFIED_DATE,\n        index: 2\n    }\n]\n\nconst primaryColumn = {\n    title: \"Primary Column\",\n    type: ReportColumnType.TEXT_NUMBER,\n    primary: true\n}\n\nconst reportDefinition = {\n    filters: {\n        operator: ReportFilterOperator.AND,\n        criteria: [\n            {\n                column: primaryColumn,\n                operator: ReportFilterConditionOperator.EQUAL,\n                values: [\"Test\"]\n            }\n        ]\n    },\n    groupingCriteria: [\n        {\n            column: primaryColumn,\n            sortingDirection: ReportSortingDirection.ASCENDING,\n            isExpanded: true\n        }\n    ],\n    summarizingCriteria: [\n        {\n            column: primaryColumn,\n          aggregationType: ReportAggregationType.COUNT\n        }\n    ],\n    sortingCriteria: [\n        {\n            column: primaryColumn,\n            sortingDirection: ReportSortingDirection.ASCENDING\n        }\n    ]\n}\n\nconst createReportRequest = {\n    name: 'Test report',\n    isSummaryReport: false,\n    destination: {\n        destinationType: ReportDestinationType.WORKSPACE,\n        destinationId: 8947374833478\n    },\n    scope: scope,\n    columns: columns,\n    reportDefinition: reportDefinition\n};\n\nconst createdReport = await client.reports.createReport(createReportRequest)\n"
          }
        ]
      }
    },
    "/reports/{reportId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/Accept"
        },
        {
          "$ref": "#/components/parameters/accessApiLevel"
        },
        {
          "$ref": "#/components/parameters/reportId"
        }
      ],
      "get": {
        "summary": "Get report",
        "description": "Gets a report based on the specified ID",
        "operationId": "getReport",
        "parameters": [
          {
            "$ref": "#/components/parameters/reportInclude"
          },
          {
            "$ref": "#/components/parameters/reportExclude"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/reportLevel"
          }
        ],
        "tags": [
          "reports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The Report that was loaded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Report"
                }
              },
              "application/vnd.ms-excel": {
                "schema": {
                  "type": "string",
                  "format": "binary",
                  "description": "The Report in Excel format"
                }
              },
              "text/csv": {
                "schema": {
                  "type": "string",
                  "format": "binary",
                  "description": "The Report in CSV format"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Omit 'include', 'pageSize', and 'page' parameters\nReport report = smartsheet.ReportResources.GetReport(\n  4583173393803140,           // long reportId\n  null,                       // IEnumerable<ReportInclusion> include\n  null,                       // int pageSize\n  null                        // int page\n);\n\n// Sample 2: Specify 'include' parameter with value of \"ATTACHMENTS\" and \"DISCUSSIONS\", 'pageSize' parameter with value of \"500\", and 'page' of value \"2\"\nReport report = smartsheet.ReportResources.GetReport(\n  4583173393803140,           // long reportId\n  new ReportInclusion[] {\n    ReportInclusion.ATTACHMENTS,\n    ReportInclusion.DISCUSSIONS\n  },\n  500,                        // int pageSize\n  2                           // int page\n);\n\n// Sample 3: Get report as Excel\nsmartsheet.ReportResources.GetReportAsExcel(\n  3882962191181700,               // long reportId\n  outputStream                    // BinaryWriter\n);\n\n// Sample 4: Get report as CSV\nsmartsheet.ReportResources.GetReportAsCSV(\n  3882962191181700,           // long reportId\n  outputStream                // BinaryWriter\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "// Sample 1: Get report\ncurl https://api.smartsheet.com/2.0/reports/{reportId}?level=3&include=objectValue \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n\n// Sample 2: Get report as Excel\ncurl https://api.smartsheet.com/2.0/reports/{reportId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Accept: application/vnd.ms-excel\" \\\n-o output.xlsx\n\n// Sample 3: Get report as CSV\ncurl https://api.smartsheet.com/2.0/reports/{reportId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Accept: text/csv\" \\\n-o output.csv\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Omit 'include', 'pageSize', and 'page' parameters\nReport report = smartsheet.reportResources().getReport(\n        4583173393803140L,      // long reportId\n        null,                   // EnumSet<ReportInclusion> includes\n        null,                   // int pageSize\n        null                    // int page\n        );\n\n// Sample 2: Specify 'include' parameter with value of \"ATTACHMENTS\" and \"DISCUSSIONS\", 'pageSize' parameter with value of \"500\", and 'page' of value \"2\"\nReport report = smartsheet.reportResources().getReport(\n        4583173393803140L,      // long reportId\n        EnumSet.of(\n            ReportInclusion.ATTACHMENTS,\n            ReportInclusion.DISCUSSIONS),\n        500,                    // int pageSize\n        2                       // int page\n        );\n\n// Sample 3: Get report as Excel\nsmartsheet.reportResources().getReportAsExcel(\n        3882962191181700L,       // long reportId\n        outputStream\n        );\n\n// Sample 4: Get report as CSV\nsmartsheet.reportResources().getReportAsCsv(\n        3882962191181700L,       // long reportId\n        outputStream\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Get report\n// Set options\nvar options = {\n  id: 4583173393803140 // Id of Report\n};\n\n// Get report\nsmartsheet.reports.getReport(options)\n  .then(function(report) {\n    console.log(report);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n\n// Sample 2: Get report as Excel\nvar fs = require(\"fs\")\n\n// Set options\nvar options = {\n  id: 3882962191181700 // Id of Report\n};\n\n// Get sheet\nsmartsheet.reports.getReportAsExcel(options)\n  .then(function(fileContents) {\n    // Write report to file\n    fs.writeFile('output.xlsx', fileContents, 'binary', (err) => {\n      if (err) throw err;\n      console.log('The report has been saved!');\n    });\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n\n// Sample 3: Get report as CSV\nvar fs = require(\"fs\")\n\n// Set options\nvar options = {\n  id: 3882962191181700 // Id of Report\n};\n\n// Get sheet\nsmartsheet.reports.getReportAsCSV(options)\n  .then(function(fileContents) {\n    // Write report to file\n    fs.writeFile('output.csv', fileContents, (err) => {\n      if (err) throw err;\n      console.log('The report has been saved!');\n    });\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Get report\nreport = smartsheet_client.Reports.get_report(\n  4583173393803140)       # report_id\n\n# Sample 2: Get report as Excel\n# Download file with filename suggested by API\nsmartsheet_client.Reports.get_report_as_excel(\n  3882962191181700,       # report_id\n  download_folder_path\n)\n\n# Specify custom filename for the downloaded file\nsmartsheet_client.Reports.get_report_as_excel(\n  3882962191181700,       # report_id\n  download_folder_path,\n  'MyFileName.xslx'\n)\n\n# Sample 3: Get report as CSV\n# Download file with filename suggested by API\nsmartsheet_client.Reports.get_report_as_csv(\n  3882962191181700,       # report_id\n  download_folder_path\n)\n\n# Specify custom filename for the downloaded file\nsmartsheet_client.Reports.get_report_as_csv(\n  3882962191181700,       # report_id\n  download_folder_path,\n  'CallMeAl.csv'\n)\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete report",
        "description": "Deletes a report based on the specified ID",
        "operationId": "deleteReport",
        "tags": [
          "reports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "DELETE_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Generic response result",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C#",
            "label": "C# SDK",
            "source": "smartsheet.ReportResources.DeleteReport(\n  4583173393803140,           // long reportId\n);\n"
          },
          {
            "lang": "Java",
            "label": "Java SDK",
            "source": "smartsheet.reportResources().deleteReport(\n        4583173393803140L,      // long reportId\n        );\n"
          },
          {
            "lang": "JavaScript",
            "label": "JavaScript SDK",
            "source": "var options = {\n  reportId: 4583173393803140 // Id of Report\n};\n\n// Delete report\nsmartsheet.reports.deleteReport(options)\n  .then(function(result) {\n    console.log(result);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "smartsheet_client.Reports.delete_report(\n  4583173393803140)       # report_id\n"
          }
        ]
      }
    },
    "/reports/{reportId}/columns": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/reportId"
        }
      ],
      "post": {
        "summary": "Add report columns",
        "description": "Add columns to a report specified by a report ID. The source sheet columns are matched in these ways:\n\n- [`type`, `title`] for **regular columns**\n- [`type`, `systemColumnType`] for **system columns**\n- [`type=TEXT_NUMBER`, `sheetNameColumn=true`] for the special **sheet name report column**\n\n**Note:** All indexes of the columns must be equal. The columns will be added at the specified index, and existing columns at that index or greater will be shifted to the right. For example, if there are 5 columns in the report and a new column is added with index 2, the new column will be added at position 3 and the existing columns that were at positions 3 and 4 will be shifted to positions 4 and 5, respectively.\n\n**Note:** You can combine multiple `CHECKBOX` columns or multiple `PICKLIST` columns from different sheets into a single report column, even if their underlying symbols differ. However, you can't combine a `CHECKBOX` column with a `PICKLIST` column, because they're different types.\n\n**Note:** The system column type `AUTO_NUMBER` is matched together with columns having the same `title` and `type=TEXT_NUMBER`.\n",
        "operationId": "addReportColumns",
        "tags": [
          "reports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "requestBody": {
          "description": "List of report columns to be added.",
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "maxItems": 400,
                "items": {
                  "$ref": "#/components/schemas/AddReportColumn"
                },
                "example": [
                  {
                    "title": "Sheet Name",
                    "type": "TEXT_NUMBER",
                    "sheetNameColumn": true,
                    "index": 0
                  },
                  {
                    "title": "Item selected",
                    "type": "CHECKBOX",
                    "index": 0
                  },
                  {
                    "title": "Created by",
                    "type": "CONTACT_LIST",
                    "systemColumnType": "CREATED_BY",
                    "index": 0
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Returns [Result object](/api/smartsheet/openapi/schemas/result) containing the [Report column objects](/api/smartsheet/openapi/reports/reportcolumn) that were added.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/ReportColumn"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "This can be caused by the following situations:\n\n- Request body exceeds maximum of 100 items.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1008,\n    \"message\": \"Unable to parse request. The following error occurred: Maximum of 100 items allowed in property $.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- Column limit exceeded.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1373,\n    \"message\": \"Column limit of 400 exceeded. Report currently has 380 columns, attempting to add 30.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- Duplicate system columns are specified.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1134,\n    \"message\": \"Duplicate system column type among input columns.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- Duplicate non-system report columns are specified.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1369,\n    \"message\": \"Duplicate title TestColumn and type TEXT_NUMBER among input columns.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- Column already exists in the report.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1372,\n    \"message\": \"Column with type {0} and {1} already exists in the report.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n- Attempting to change the report columns of a program report, which is currently unsupported by API.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1146,\n    \"message\": \"Unsupported operation: Program reports currently cannot be modified via API.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "This can be caused by the following situations:\n\n- Caller does not have EDITOR or ADMIN permissions to the report.\n  ```json\n  {\n    \"errorCode\": 1004,\n    \"message\": \"You are not authorized to perform this action.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "This can be caused by the following situations:\n\n- Report does not exist.\n  ```json\n  {\n    \"errorCode\": 1006,\n    \"message\": \"Not Found.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "Java",
            "label": "Java SDK",
            "source": "// Add 3 columns to a report\n\n// Checkbox column\nReportColumn column1 = new ReportColumn();\ncolumn1.setTitle(\"Item selected\");\ncolumn1.setType(ColumnType.CHECKBOX);\ncolumn1.setIndex(4);\n\n// Sheet name column\nReportColumn column2 = new ReportColumn();\ncolumn2.setTitle(\"Sheet name\");\ncolumn2.setType(ColumnType.TEXT_NUMBER);\ncolumn2.setIndex(4);\ncolumn2.setSheetNameColumn(true);\n\n// Modified at system column\nReportColumn column3 = new ReportColumn();\ncolumn3.setTitle(\"Last modified at\");\ncolumn3.setType(ColumnType.DATETIME);\ncolumn3.setSystemColumnType(SystemColumnType.MODIFIED_DATE);\ncolumn3.setIndex(4);\n\nList<ReportColumn> columns = List.of(column1, column2, column3);\n\nList<ReportColumn> createdColumns = smartsheet.reportResources().addReportColumns(4583173393803140L, columns);\n"
          },
          {
            "lang": "C#",
            "label": "C# SDK",
            "source": "// Add 3 columns to a report\n\nvar columns = new List<ReportColumn>\n{\n    // Checkbox column\n    new ReportColumn { Title = \"Item selected\", Type = ColumnType.CHECKBOX, Index = 4 },\n    // Sheet name column\n    new ReportColumn { Title = \"Sheet name\", Type = ColumnType.TEXT_NUMBER, Index = 4, SheetNameColumn = true },\n    // Modified at system column\n    new ReportColumn { Title = \"Last modified at\", Type = ColumnType.DATETIME, SystemColumnType = SystemColumnType.MODIFIED_DATE, Index = 4 }\n};\n\nvar createdColumns = smartsheet.ReportResources.AddReportColumns(4583173393803140, columns);\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "# Add 3 columns to a report\n\ncolumns = [\n    # Checkbox column\n    ReportColumn({\n        \"title\": \"Item selected\",\n        \"type\": ColumnType.CHECKBOX,\n        \"index\": 4\n    }),\n    # Sheet name column\n    ReportColumn({\n        \"title\": \"Sheet name\",\n        \"type\": ColumnType.TEXT_NUMBER,\n        \"sheetNameColumn\": True,\n        \"index\": 4\n    }),\n    # Modified at system column\n    ReportColumn({\n        \"title\": \"Last modified at\",\n        \"type\": ColumnType.DATETIME,\n        \"systemColumnType\": SystemColumnType.MODIFIED_DATE,\n        \"index\": 4\n    })\n]\n\ncreated_columns = client.Reports.add_report_columns(\n    report_id=4583173393803140,\n    report_columns=columns\n)\n"
          },
          {
            "lang": "JavaScript",
            "label": "JavaScript SDK",
            "source": "// Add 3 columns to a report\n\nconst columns = [\n    // Checkbox column\n    {\n        title: 'Item selected',\n        type: ReportColumnType.CHECKBOX,\n        index: 4\n    },\n    // Sheet name column\n    {\n        title: 'Sheet name',\n        type: ReportColumnType.TEXT_NUMBER,\n        sheetNameColumn: true,\n        index: 4\n    },\n    // Modified at system column\n    {\n        title: 'Last modified at',\n        type: ReportColumnType.DATETIME,\n        systemColumnType: SystemColumnType.MODIFIED_DATE,\n        index: 4\n    }\n]\n\nconst options = {\n    reportId: 4583173393803140,\n    body: columns\n};\n\nconst createdColumns = await client.reports.addReportColumns(options);\n"
          }
        ]
      }
    },
    "/reports/{reportId}/definition": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/reportId"
        }
      ],
      "put": {
        "summary": "Update report definition",
        "description": "Create or entirely replace the definition for the specified report.\n",
        "operationId": "updateReportDefinition",
        "tags": [
          "reports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "requestBody": {
          "description": "The new report definition.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReportDefinition"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation's success level.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "400": {
            "description": "This can be caused by the following situations:\n\n- The filters contain more than 3 levels of filter expressions.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1008,\n    \"message\": \"Unable to parse request. The following error occurred: More than 3 levels of filter expressions defined.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- A column that is not part of the report was referenced in summarizing or sorting criteria.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1374,\n    \"message\": \"Unknown column with type TEXT_NUMBER and system column type SHEET_NAME referenced in aggregation or sorting criteria.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "This can be caused by the following situations:\n\n- Caller does not have `EDITOR` or `ADMIN` permissions to the report.\n  ```json\n  {\n    \"errorCode\": 1004,\n    \"message\": \"You are not authorized to perform this action.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "This can be caused by the following situations:\n\n- Report does not exist.\n  ```json\n  {\n    \"errorCode\": 1006,\n    \"message\": \"Not Found.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Generic error payload.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C#",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nReportDefinition definition = new ReportDefinition\n    {\n        SummarizingCriteria = new List<ReportSummarizingCriterion>\n        {\n            new ReportSummarizingCriterion\n            {\n                AggregationType = ReportAggregationType.COUNT,\n                Column = new ReportColumnIdentifier\n                {\n                    Primary = true,\n                    Type = ColumnType.TEXT_NUMBER,\n                    Title = \"Primary Column\",\n                }\n            }\n        },\n        Filters = new ReportFilterExpression\n        {\n            Operator = ReportFilterOperator.AND,\n            Criteria = new List<ReportFilterCriterion>\n            {\n                new ReportFilterCriterion\n                {\n                    Column = new ReportColumnIdentifier\n                    {\n                        Primary = true,\n                        Type = ColumnType.TEXT_NUMBER,\n                        Title = \"Primary Column\",\n                    },\n                    Operator = ReportFilterCriteriaOperator.EQUAL,\n                    Values = new List<ReportFilterValue> { new StringReportFilterValue(\"Test\") },\n                }\n            }\n        },\n        GroupingCriteria = new List<ReportGroupingCriterion>\n        {\n            new ReportGroupingCriterion\n            {\n                Column = new ReportColumnIdentifier\n                {\n                    Primary = true,\n                    Type = ColumnType.TEXT_NUMBER,\n                    Title = \"Primary Column\",\n                },\n                SortingDirection = SortDirection.ASCENDING,\n                IsExpanded = true\n            }\n        },\n        SortingCriteria = new List<ReportSortingCriterion>\n        {\n            new ReportSortingCriterion\n            {\n                Column = new ReportColumnIdentifier\n                {\n                    Primary = true,\n                    Type = ColumnType.TEXT_NUMBER,\n                    Title = \"Primary Column\",\n                },\n                SortingDirection = SortDirection.ASCENDING\n            }\n        },\n    };\n\n    smartsheet.ReportResources.UpdateReportDefinition(\n        4583173393803140, // report ID\n        definition\n    );\n"
          },
          {
            "lang": "Java",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nReportColumnIdentifier primaryColumn = new ReportColumnIdentifier()\n        .setPrimary(true)\n        .setType(ColumnType.TEXT_NUMBER)\n        .setTitle(\"Primary Column\");\n\nReportDefinition definition = new ReportDefinition()\n        .setSummarizingCriteria(List.of(\n                new ReportSummarizingCriterion()\n                        .setAggregationType(ReportAggregationType.COUNT)\n                        .setColumn(primaryColumn)\n        ))\n        .setFilters(new ReportFilterExpression()\n                .setOperator(ReportFilterExpressionOperator.AND)\n                .setCriteria(List.of(\n                        new ReportFilterCriterion()\n                                .setColumn(primaryColumn)\n                                .setOperator(ReportFilterOperator.EQUAL)\n                                .setValues(List.of(new StringObjectValue(\"Test\")))\n                ))\n        )\n        .setGroupingCriteria(List.of(\n                new ReportGroupingCriterion()\n                        .setColumn(primaryColumn)\n                        .setSortingDirection(SortDirection.ASCENDING)\n                        .setIsExpanded(true)\n        ))\n        .setSortingCriteria(List.of(\n                new ReportSortingCriterion()\n                        .setColumn(primaryColumn)\n                        .setSortingDirection(SortDirection.ASCENDING)\n        ));\n\nsmartsheet.reportResources().updateReportDefinition(\n        4583173393803140L, // report ID\n        definition\n);\n"
          },
          {
            "lang": "JavaScript",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nconst primaryColumn = {\n    title: \"Primary Column\",\n    type: ReportColumnType.TEXT_NUMBER,\n    primary: true\n}\n\nconst reportDefinition = {\n    filters: {\n        operator: ReportFilterOperator.AND,\n        criteria: [\n            {\n                column: primaryColumn,\n                operator: ReportFilterConditionOperator.EQUAL,\n                values: [\"Test\"]\n            }\n        ]\n    },\n    groupingCriteria: [\n        {\n            column: primaryColumn,\n            sortingDirection: ReportSortingDirection.ASCENDING,\n            isExpanded: true\n        }\n    ],\n    summarizingCriteria: [\n        {\n            column: primaryColumn,\n          aggregationType: ReportAggregationType.COUNT\n        }\n    ],\n    sortingCriteria: [\n        {\n            column: primaryColumn,\n            sortingDirection: ReportSortingDirection.ASCENDING\n        }\n    ]\n}\n\nconst options = {\n    reportId: 4583173393803140,\n    body: reportDefinition\n}\n\nawait smartsheet.reports.updateReportDefinition(options);\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nprimary_column = {\n    \"primary\": True,\n    \"type\": ColumnType.TEXT_NUMBER,\n    \"title\": \"Primary Column\",\n}\n\nreport_definition = ReportDefinition({\n    \"summarizingCriteria\": [\n        {\n            \"aggregationType\": ReportAggregationType.COUNT,\n            \"column\": primary_column\n        }\n    ],\n    \"filters\": {\n        \"operator\": ReportBooleanOperator.AND,\n        \"criteria\": [\n            {\n                \"column\": primary_column,\n                \"operator\": ReportFilterOperator.EQUAL,\n                \"values\": [\"Test\"],\n            }\n        ],\n    },\n    \"groupingCriteria\": [\n        {\n            \"column\": primary_column,\n            \"sortingDirection\": SortDirection.ASCENDING,\n            \"isExpanded\": True,\n        }\n    ],\n    \"sortingCriteria\": [\n        {\n            \"column\": primary_column,\n            \"sortingDirection\": SortDirection.ASCENDING,\n        }\n    ],\n})\n\nclient.Reports.update_report_definition(\n    report_id=4583173393803140,\n    report_definition=report_definition\n)\n"
          }
        ]
      }
    },
    "/reports/{reportId}/emails": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/reportId"
        }
      ],
      "post": {
        "summary": "Send report via email",
        "description": "Sends the report as a PDF attachment via email to the designated recipients",
        "operationId": "sendReportViaEmail",
        "tags": [
          "reports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "SHARE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SheetEmail"
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify recipients\nRecipient[] recipientSpecification = new Recipient[] {\n  new Recipient { Email = \"john.doe@smartsheet.com\" },\n  new Recipient { GroupId = 2258118617917316 }\n};\n\n// Configure email\nSheetEmail sheetEmail = new SheetEmail {\n  SendTo = recipientSpecification,\n  Subject = \"Check this report out!\",\n  Message = \"Here is the report I mentioned in our meeting\",\n  CcMe = false,\n  Format = SheetEmailFormat.PDF,\n  FormatDetails = new FormatDetails { PaperSize = PaperSize.A4 }\n};\n\n// Send report via email\nsmartsheet.ReportResources.SendReport (8130994621441924, sheetEmail);       // long reportId\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/reports/{reportId}/emails \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"sendTo\" : [{\"email\": \"john.doe@smartsheet.com\"}, {\"groupId\": 2258118617917316}], \"subject\": \"Check these rows out!\", \"message\": \"Here are the rows I mentioned in our meeting\", \"ccMe\": false, \"format\": \"PDF\", \"formatDetails\": {\"paperSize\": \"A4\"}}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify an individual recipient\nRecipientEmail recipientEmail = new RecipientEmail()\n        .setEmail(\"john.doe@smartsheet.com\");\n\n// Specify a group recipient\nRecipientGroup recipientGroup = new RecipientGroup()\n        .setGroupId(2258118617917316L);\n\n// Set recipients\nList<Recipient> recipientList = Arrays.asList(\n        recipientEmail,\n        recipientGroup\n        );\n\n// Set format details\nFormatDetails formatDetails = new FormatDetails()\n        .setPaperSize(PaperSize.A0);\n\n// Configure email\nSheetEmail emailSpecification = new SheetEmail();\nemailSpecification.setFormat(SheetEmailFormat.PDF);\nemailSpecification.setFormatDetails(formatDetails)\n        .setSendTo(recipientList)\n        .setSubject(\"Check this report out!\")\n        .setMessage(\"Here is the report I mentioned in our meeting\")\n        .setCcMe(false);\n\n// Send report via email\nsmartsheet.reportResources().sendReport(\n        8130994621441924L,      // long reportId\n        emailSpecification\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Configure email\nvar email = {\n  \"sendTo\": [\n    {\n      \"email\": \"john.doe@smartsheet.com\"\n    },\n    {\n      \"groupId\": 2258118617917316\n    }\n  ],\n  \"subject\": \"Check these rows out!\",\n  \"message\": \"Here are the rows I mentioned in our meeting\",\n  \"ccMe\": false,\n  \"format\": \"PDF\",\n  \"formatDetails\": {\n    \"paperSize\": \"A4\"\n  }\n};\n\n// Set options\nvar options = {\n  body: email,\n  reportId: 8130994621441924\n};\n\n// Send report via email\nsmartsheet.reports.sendReportViaEmail(options)\n  .then(function(data) {\n    console.log(data);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Reports.send_report(\n  8130994621441924,       # report_id\n  smartsheet.models.SheetEmail({\n    'send_to': smartsheet.models.Recipient({\n      'email': 'john.doe@smartsheet.com'\n    }),\n    'subject': 'Check this report out!',\n    'message': 'Here is the report I mentioned in our meeting.',\n    'cc_me': False,\n    'format': 'PDF',\n    'format_details': smartsheet.models.FormatDetails({\n      'paper_size': 'A4'\n    })\n  })\n)\n"
          }
        ],
        "responses": {
          "200": {
            "description": "Result Object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Result"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/reports/{reportId}/path": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/reportId"
        }
      ],
      "get": {
        "summary": "Get report path",
        "description": "Gets the hierarchical path of the report, showing its location within folders and workspace, if workspace-level access is provided",
        "operationId": "get-report-path",
        "tags": [
          "reports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Path information for the report",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PathReportResponse"
                }
              }
            }
          },
          "404": {
            "description": "Report not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/reports/{reportId}/publish": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/reportId"
        }
      ],
      "get": {
        "summary": "Gets a report's publish settings",
        "description": "Get a Report's publish settings based on the specified ID",
        "operationId": "getReportPublish",
        "tags": [
          "reports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The Report's publish settings",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReportPublish"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.ReportResources.GetPublishStatus(\n  3901932860401540    // reportId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/reports/{reportId}/publish \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.reportResources().getPublishStatus(\n        3901932860401540L    // reportId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  reportId: 3901932860401540\n};\n\n// Get report publish status\nsmartsheet.reports.getReportPublishStatus(options)\n  .then(function(status) {\n    console.log(status);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nstatus = smartsheet_client.Reports.get_publish_status(\n  1653067851556740)       # report_id\n"
          }
        ]
      },
      "put": {
        "summary": "Set a report's publish status",
        "description": "Sets the publish status of the report and returns the new status, including the URL of any enabled publishing.",
        "operationId": "SetReportPublish",
        "tags": [
          "reports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReportPublish"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "ReportPublish object",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ItemResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/ReportPublish"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nReportPublish reportPublish = new ReportPublish();\nreportPublish.ReadOnlyFullEnabled = true;\nreportPublish.ReadOnlyFullAccessibleBy = \"ALL\";\nsmartsheet.ReportResources.UpdatePublishStatus(\n  1653087851556740,    // reportId\n  reportPublish\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/reports/{reportId}/publish \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '{\"readOnlyFullEnabled\": true, \"readOnlyFullAccessibleBy\": \"ORG\"}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nReportPublish reportPublish = new ReportPublish();\nreportPublish.setReadOnlyFullEnabled(true);\nreportPublish.setReadOnlyFullAccessibleBy(\"ALL\");\nsmartsheet.reportResources().updatePublishStatus(\n        1653087851556740L,    // reportId\n        reportPublish\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  reportId: 1653087851556740,\n  body: {\n    readOnlyFullEnabled: true,\n    readOnlyFullAccessibleBy: \"ALL\"\n  }\n};\n\n// Set report publish status\nsmartsheet.reports.setReportPublishStatus(options)\n  .then(function(status) {\n    console.log(status);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Reports.set_publish_status(\n  1653067851556740,       # report_id\n  smartsheet.models.ReportPublish({\n    'read_only_full_enabled': True\n  })\n)\n"
          }
        ]
      }
    },
    "/reports/{reportId}/scope": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/AcceptAppJSONOnly"
        },
        {
          "$ref": "#/components/parameters/reportId"
        }
      ],
      "post": {
        "summary": "Add report scope",
        "description": "Adds source sheets for inclusion in the specified report by specifying individual sheets or their parent workspaces.\n\nSpecifying a workspace creates a dynamic scope—-the report automatically includes all sheets in that workspace and updates whenever sheets are added or removed from it.\n\n> **Note:** You can have up to 30,000 source sheets per report.\n",
        "operationId": "addReportScope",
        "tags": [
          "reports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "requestBody": {
          "description": "An array of objects representing sheets and/or workspaces for adding source sheets to the report.",
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "maxItems": 100,
                "items": {
                  "$ref": "#/components/schemas/ReportScope"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation's success level.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "400": {
            "description": "This can be caused by the following situations:\n\n- Request body exceeds maximum of 100 items.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1008,\n    \"message\": \"Unable to parse request. The following error occurred: Maximum of 100 items allowed in property $.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- Sheets per report limit exceeded (for pro plan users currently).\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1368,\n    \"message\": \"You have reached the limit of {sheet_limit} sheets for the report.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- A source workspace does not exist.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1008,\n    \"message\": \"Unable to parse request. The following error occurred: Source workspace {id} not found.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n"
          },
          "403": {
            "description": "This can be caused by the following situations:\n\n- Caller does not have EDITOR or ADMIN permissions to the report.\n  ```json\n  {\n    \"errorCode\": 1004,\n    \"message\": \"You are not authorized to perform this action.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n"
          },
          "404": {
            "description": "This can be caused by the following situations:\n\n- Report does not exist.\n  ```json\n  {\n    \"errorCode\": 1006,\n    \"message\": \"Not Found.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n"
          },
          "default": {
            "description": "Generic error payload.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C#",
            "label": "C# SDK",
            "source": "// Add sheet and workspace to report scope\nvar scopes = new List<ReportScopeInclusion>\n{\n    new ReportScopeInclusion\n    {\n        AssetType = ReportAssetType.SHEET,\n        AssetId = 2331373580117892\n    },\n    new ReportScopeInclusion\n    {\n        AssetType = ReportAssetType.WORKSPACE,\n        AssetId = 7879278542455688\n    }\n};\n\nsmartsheet.ReportResources.AddReportScope(\n    4583173393803140,     // reportId\n    scopes\n);\n"
          },
          {
            "lang": "JavaScript",
            "label": "JavaScript SDK",
            "source": "// Specify scope to add\nvar body = [\n  {\n    assetType: ReportAssetType.SHEET,\n    assetId: 2331373580117892\n  },\n  {\n    assetType: ReportAssetType.WORKSPACE,\n    assetId: 7879278542455688\n  }\n];\n\n// Set options\nvar options = {\n  reportId: 4583173393803140,\n  body: body\n};\n\n// Add report scope\nsmartsheet.reports.addReportScope(options)\n  .then(function(result) {\n    console.log(result);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Java",
            "label": "Java SDK",
            "source": "// Create scope for sheet\nReportScopeInclusion sheetScope = new ReportScopeInclusion();\nsheetScope.setAssetType(ReportAssetType.SHEET);\nsheetScope.setAssetId(2331373580117892L);\n\n// Create scope for workspace\nReportScopeInclusion workspaceScope = new ReportScopeInclusion();\nworkspaceScope.setAssetType(ReportAssetType.WORKSPACE);\nworkspaceScope.setAssetId(7879278542455688L);\n\n// Add scopes to list\nList<ReportScopeInclusion> scopes = new ArrayList<>();\nscopes.add(sheetScope);\nscopes.add(workspaceScope);\n\n// Add report scope\nsmartsheet.reportResources().addReportScope(\n    4583173393803140L,  // reportId\n    scopes\n);\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "# Create scope for sheet\nsheetScope = ReportScopeInclusion({\n    \"assetId\": 2331373580117892,\n    \"assetType\": ReportAssetType.SHEET\n})\n\n# Create scope for workspace\nworkspaceScope = ReportScopeInclusion({\n    \"assetId\": 7879278542455688,\n    \"assetType\": ReportAssetType.WORKSPACE\n})\n    \n# Create scope list\nscopes = [sheetScope, workspaceScope]\n\n# Add report scope\nresponse = client.Reports.add_report_scope(\n    report_id=4583173393803140,\n    scopes=scopes\n)\n"
          }
        ]
      },
      "delete": {
        "summary": "Remove report scope",
        "description": "Removes source sheets from the specified report by specifying individual sheets or their parent workspaces.",
        "operationId": "removeReportScope",
        "tags": [
          "reports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "requestBody": {
          "description": "An array of objects representing sheets and/or workspaces for removing source sheets from the report.",
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "maxItems": 100,
                "items": {
                  "$ref": "#/components/schemas/ReportScope"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation's success level.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "400": {
            "description": "This can be caused by the following situations:\n\n- Request body exceeds maximum of 100 items.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1008,\n    \"message\": \"Unable to parse request. The following error occurred: Maximum of 100 items allowed in property $.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- A source workspace does not exist.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1008,\n    \"message\": \"Unable to parse request. The following error occurred: Source workspace {id} not found.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n"
          },
          "403": {
            "description": "This can be caused by the following situations:\n\n- Caller does not have EDITOR or ADMIN permissions to the report.\n  ```json\n  {\n    \"errorCode\": 1004,\n    \"message\": \"You are not authorized to perform this action.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n"
          },
          "404": {
            "description": "This can be caused by the following situations:\n\n- Report does not exist.\n  ```json\n  {\n    \"errorCode\": 1006,\n    \"message\": \"Not Found.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n"
          },
          "default": {
            "description": "Generic error payload.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C#",
            "label": "C# SDK",
            "source": "// Remove sheet and workspace from report scope\nvar scopes = new List<ReportScopeInclusion>\n{\n    new ReportScopeInclusion\n    {\n        AssetType = ReportAssetType.SHEET,\n        AssetId = 2331373580117892\n    },\n    new ReportScopeInclusion\n    {\n        AssetType = ReportAssetType.WORKSPACE,\n        AssetId = 7879278542455688\n    }\n};\n\nsmartsheet.ReportResources.RemoveReportScope(\n    4583173393803140,     // reportId\n    scopes\n);\n"
          },
          {
            "lang": "JavaScript",
            "label": "JavaScript SDK",
            "source": "// Specify scope to remove\nvar body = [\n  {\n    assetType: ReportAssetType.SHEET,\n    assetId: 2331373580117892\n  },\n  {\n    assetType: ReportAssetType.WORKSPACE,\n    assetId: 7879278542455688\n  }\n];\n\n// Set options\nvar options = {\n  reportId: 4583173393803140,\n  body: body\n};\n\n// Remove report scope\nsmartsheet.reports.removeReportScope(options)\n  .then(function(result) {\n    console.log(result);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Java",
            "label": "Java SDK",
            "source": "// Create scope for sheet\nReportScopeInclusion sheetScope = new ReportScopeInclusion();\nsheetScope.setAssetType(ReportAssetType.SHEET);\nsheetScope.setAssetId(2331373580117892L);\n\n// Create scope for workspace\nReportScopeInclusion workspaceScope = new ReportScopeInclusion();\nworkspaceScope.setAssetType(ReportAssetType.WORKSPACE);\nworkspaceScope.setAssetId(7879278542455688L);\n\n// Add scopes to list\nList<ReportScopeInclusion> scopes = new ArrayList<>();\nscopes.add(sheetScope);\nscopes.add(workspaceScope);\n\n// Remove report scope\nsmartsheet.reportResources().removeReportScope(\n    4583173393803140L,  // reportId\n    scopes\n);\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "# Create scope for sheet\nsheetScope = ReportScopeInclusion({\n    \"assetId\": 2331373580117892,\n    \"assetType\": ReportAssetType.SHEET\n})\n\n# Create scope for workspace\nworkspaceScope = ReportScopeInclusion({\n    \"assetId\": 7879278542455688,\n    \"assetType\": ReportAssetType.WORKSPACE\n})\n\n# Create scope list\nscopes = [sheetScope, workspaceScope]\n\n# Remove report scope\nresponse = client.Reports.remove_report_scope(\n    report_id=4583173393803140,\n    scopes=scopes\n)\n"
          }
        ]
      }
    },
    "/reports/{reportId}/shares": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/reportId"
        }
      ],
      "post": {
        "summary": "Share report",
        "description": "Shares a Report with the specified users and groups.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "share-report",
        "tags": [
          "sharing",
          "reports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "SHARE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/sendEmail"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/Share"
                  },
                  {
                    "type": "array",
                    "title": "Array of shares",
                    "items": {
                      "$ref": "#/components/schemas/Share"
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing either a single Share object or an array of Share objects, corresponding\nto what was specified in the request. All shares have scope=ITEM.\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "oneOf": [
                            {
                              "$ref": "#/components/schemas/Share"
                            },
                            {
                              "type": "array",
                              "title": "Array of shares",
                              "items": {
                                "$ref": "#/components/schemas/Share"
                              }
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "If called with a single Share object, and that user or group share already exists, error code 1025 is returned.\nIf called with an array of Share objects, and one or more user or group shares in the array already exist,\nthey are ignored and omitted from the response.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify share (to one user as Editor)\nShare[] shareSpecification = new Share[] { new Share\n  {\n    Email = \"jane.doe@smartsheet.com\",\n    AccessLevel = AccessLevel.EDITOR\n  }\n};\n\n// Share report\nIList<Share> addressList = smartsheet.ReportResources.ShareResources.ShareTo(\n  665829219035012,            // long reportId\n  shareSpecification,\n  true                        // Nullable<bool> sendEmail\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/reports/{reportId}/shares?sendEmail=true' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '[{\"email\": \"jane.doe@smartsheet.com\", \"accessLevel\": \"EDITOR\"}]'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify share (to one user as Editor)\nShare shareSpecification = new Share()\n        .setEmail(\"jane.doe@smartsheet.com\")\n        .setAccessLevel(AccessLevel.EDITOR);\n\n// Share report\nList<Share> addressList = smartsheet.reportResources().shareResources().shareTo(\n        665829219035012L,        // long reportId\n        Arrays.asList(shareSpecification),\n        true                     // Boolean sendEmail\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify share (to one user as Editor)\nvar share = [\n  {\n    \"email\": \"jane.doe@smartsheet.com\",\n    \"accessLevel\": \"EDITOR\"\n  }\n];\n\n// Set options\nvar options = {\n  reportId: 665829219035012,\n  body: share\n  };\n\n// Share report\nsmartsheet.reports.share(options)\n  .then(function(addressList) {\n    console.log(addressList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Reports.share_report(\n  665829219035012,        # report_id\n  smartsheet.models.Share({\n    'access_level': 'EDITOR',\n    'email': 'jane.doe@smartsheet.com'\n  })\n)\n"
          }
        ]
      },
      "get": {
        "summary": "List report shares",
        "description": "Gets a list of all users and groups to whom the specified Report is shared, and their access level.\n\nThis operation supports query string parameters for pagination of results.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "list-report-shares",
        "tags": [
          "sharing",
          "reports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/sharingInclude"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "IndexResult object containing an array of Share objects. By default, this operation returns only item-level shares (scope=ITEM). Use the sharingInclude parameter to request that workspace-level shares (include=workspaceShares) also be returned.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Share"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPaginatedResult<Share> shares = smartsheet.ReportResources.ShareResources.ListShares(\n  665829219035012,        // long reportId\n  null,                   // PaginationParameters\n  null                    // ShareScope shareScope\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/reports/{reportId}/shares \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPagedResult<Share> shares = smartsheet.reportResources().shareResources().listShares(\n        665829219035012L,        // long reportId\n        null,                    // PaginationParameters\n        true                     // Boolean includeWorkspaceShares\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  reportId: 665829219035012\n};\n\n// List report shares\nsmartsheet.reports.listShares(options)\n  .then(function(shareList) {\n    console.log(shareList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List all\nresponse = smartsheet_client.Reports.list_shares(include_all=True)\nshares = response.result\n\n# Sample 2: Paginate the list\nresponse = smartsheet_client.Reports.list_shares(\n  page_size=10,\n  page=1)\npages = response.total_pages\nshares = response.result\n"
          }
        ]
      }
    },
    "/reports/{reportId}/shares/{shareId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/reportId"
        },
        {
          "$ref": "#/components/parameters/shareId"
        },
        {
          "$ref": "#/components/parameters/accessApiLevel"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Get report share",
        "description": "Gets the share specified in the URL.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "share-report-get",
        "tags": [
          "sharing",
          "reports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns Share object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Share"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nShare share = smartsheet.ReportResources.ShareResources.GetShare(\n  6932724448552836,               // long reportId\n  \"AQAISF82FOeE\"                  // string shareId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/reports/{reportId}/shares/{shareId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nShare share = smartsheet.reportResources().shareResources().getShare(\n        665829219035012L,        // long reportId\n        \"AAAQSF82F1eE\"           // string shareId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  reportId: 6932724448552836,\n  shareId: \"AQAISF82FOeE\"\n};\n\n// Get report share\nsmartsheet.reports.getShare(options)\n  .then(function(share) {\n    console.log(share);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nshare = smartsheet_client.Reports.get_share(\n  6932724448552836,       # report_id\n  'AAAQSF82F1eE')         # share_id\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete report share",
        "description": "Deletes the share specified in the URL.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "delete-report-share",
        "tags": [
          "sharing",
          "reports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "SHARE_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns Result object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Result"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.ReportResources.ShareResources.DeleteShare(\n  665829219035012,            // long reportId\n  \"AAAQSF82F1eE\"              // string shareId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/reports/{reportId}/shares/{shareId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.reportResources().shareResources().deleteShare(\n        665829219035012L,        // long reportId\n        \"AAAQSF82F1eE\"           // string shareId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  reportId: 665829219035012,\n  shareId: \"AAAQSF82F1eE\"\n};\n\n// Delete report share\nsmartsheet.reports.deleteShare(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Reports.delete_share(\n  665829219035012,        # report_id\n  'AAAQSF82F1eE')         # share_id\n"
          }
        ]
      },
      "put": {
        "summary": "Update report share",
        "description": "Updates the access level of a user or group for the specified report.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "update-report-share",
        "tags": [
          "sharing",
          "reports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "SHARE_SHEETS"
            ]
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "accessLevel": {
                    "$ref": "#/components/schemas/AccessLevel"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing the modified Share object",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "object",
                          "items": {
                            "$ref": "#/components/schemas/Share"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set the access level to Viewer\nShare shareSpecification = new Share\n{\n  Id = \"AAAFeF82FOeE\",\n  AccessLevel = AccessLevel.VIEWER\n};\n\n// Update report share\nShare updatedShare = smartsheet.ReportResources.ShareResources.UpdateShare(\n  665829219035012,            // long reportId\n  shareSpecification\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/reports/{reportId}/shares/{shareId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '{\"accessLevel\": \"VIEWER\"}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set the access level to Viewer\nShare shareSpecification = new Share();\n        shareSpecification.setAccessLevel(AccessLevel.VIEWER)\n        .setId(\"AAAFeF82FOeE\");   // string shareId\n\n// Update report share\nShare updatedShare = smartsheet.reportResources().shareResources().updateShare(\n        665829219035012L,                   // long reportId\n        shareSpecification\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set the access level to Viewer\nvar share = {\"accessLevel\": \"VIEWER\"};\n\n// Set options\nvar options = {\n  reportId: 665829219035012,\n  shareId: \"AAAFeF82FOeE\",\n  body: share\n  };\n\n// Update report share\nsmartsheet.reports.updateShare(options)\n  .then(function(updatedShare) {\n    console.log(updatedShare);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nupdated_share = smartsheet_client.Reports.update_share(\n  665829219035012,        # report_id\n  'AAAFeF82FOeE',         # share_id\n  smartsheet.models.Share({\n    'access_level': 'VIEWER'\n  })\n)\n"
          }
        ]
      }
    },
    "/search": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Search everything",
        "description": "Searches all sheets that the user can access, for the specified text.\n\n> **Important:** If you have't used the public API in a while, we will need to provision your data. This could take up to 24 hours so please check back later!\n",
        "tags": [
          "search"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "operationId": "list-search",
        "parameters": [
          {
            "$ref": "#/components/parameters/query"
          },
          {
            "$ref": "#/components/parameters/location"
          },
          {
            "$ref": "#/components/parameters/modifiedSince"
          },
          {
            "$ref": "#/components/parameters/parameters-include"
          },
          {
            "$ref": "#/components/parameters/scopes"
          }
        ],
        "responses": {
          "200": {
            "description": "Object that contains an array of matching items and the total count of those items.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResult"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set search criteria\nstring query = \"stuff\";\n\n// Search everything\nSearchResult results = smartsheet.SearchResources.Search(query);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/search?query=stuff' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set search criteria\nString query = \"stuff\";\n\n// Search everything\nSearchResult results = smartsheet.searchResources().search(query);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  query: \"stuff\"\n};\n\n// Search everything\nsmartsheet.search.searchAll(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Set search criteria\nquery = 'stuff'\n\n# Search everything\nresult = smartsheet_client.Search.search(query)\n# result is a smartsheet.models.SearchResult object\n"
          }
        ]
      }
    },
    "/search/sheets/{sheetId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Search sheet",
        "description": "Gets a list of the user's search results in a sheet, based on a query.\n\nThe list contains an abbreviated row object for each query-matching row in the sheet. \n\n> **Important:** If you have't used the public API in a while, we will need to provision your\ndata. This could take up to 24 hours so please check back later!\n\n> **Note:** Newly created or recently updated data may not be immediately discoverable\nvia search.\n",
        "tags": [
          "search"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "operationId": "list-search-sheet",
        "parameters": [
          {
            "$ref": "#/components/parameters/query"
          }
        ],
        "responses": {
          "200": {
            "description": "Object that contains an array of matching items in the sheet and the total count of those items.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResult"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/serverinfo": {
      "get": {
        "summary": "Gets application constants",
        "description": "Gets application constants.",
        "operationId": "serverinfo-get",
        "tags": [
          "serverInfo"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServerInfo"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nServerInfo serverInfo = smartsheet.ServerInfoResources.GetServerInfo();\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/serverinfo\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nServerInfo serverInfo = smartsheet.serverInfoResources().getServerInfo();\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.server.getInfo()\n  .then(function(serverInfo) {\n    console.log(serverInfo);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\ninfo = smartsheet_client.Server.server_info()\n"
          }
        ]
      }
    },
    "/shares": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        }
      ],
      "get": {
        "summary": "List asset shares",
        "description": "Retrieves a list of all users and groups to whom the specified asset is shared, and their access level. This operation supports query string parameters for pagination of results. \n\n> **Note:** For pagination guidance, refer to [Token-based pagination](/api/smartsheet/guides/basics/pagination#token-based-pagination).\n",
        "operationId": "list-asset-shares",
        "tags": [
          "sharing"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES",
              "SHARE_SHEETS",
              "SHARE_SIGHTS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/assetType"
          },
          {
            "$ref": "#/components/parameters/assetId"
          },
          {
            "$ref": "#/components/parameters/maxItems"
          },
          {
            "$ref": "#/components/parameters/lastKey"
          },
          {
            "$ref": "#/components/parameters/sharingInclude"
          }
        ],
        "responses": {
          "200": {
            "description": "Object containing an array of [Share response](/api/smartsheet/openapi/sharing/shareresponse) objects. By default, this operation returns only item-level shares \n(scope=ITEM). Use the sharingInclude parameter to request that workspace level shares also be returned.\n\nThe response result will always exist, but the list may be empty if there are no shares for the specified asset.\n",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "result"
                  ],
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "lastKey": {
                          "$ref": "#/components/schemas/LastKey"
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "items": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/ShareResponse"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/shares?assetId=1234567890&assetType=sheet \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// List all shares for an asset\nconst listOptions = {\n  queryParameters: {\n    assetType: 'sheet',\n    assetId: 1234567890,\n    maxItems: 100\n  }\n};\n\nconst shares = await smartsheet.sharing.listAssetShares(listOptions);\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "# List all shares for an asset\nshares = smartsheet.Sharing.list_asset_shares(\n    asset_type='sheet',\n    asset_id=1234567890,\n    max_items=100\n)\n"
          }
        ]
      },
      "post": {
        "summary": "Share asset",
        "description": "Shares an asset with the specified users and/or groups.\n\n**One (and only one) of the following is required (alongside accessLevel)**:\n  - email\n  - groupId\n",
        "operationId": "share-asset",
        "tags": [
          "sharing"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES",
              "SHARE_SHEETS",
              "SHARE_SIGHTS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/assetType"
          },
          {
            "$ref": "#/components/parameters/assetId"
          },
          {
            "$ref": "#/components/parameters/sendEmail"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/CreateShareRequest"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing an array of [Share response](/api/smartsheet/openapi/sharing/shareresponse) objects, corresponding to what was specified in the request.\n\nIf the users and/or groups are already shared to the specified asset, they will be omitted from the response. \nAn empty response indicates that all the users and/or groups in the request are already shared to the asset.\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/SuccessResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/ShareResponse"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "4XX errors typically indicate client input validation failures.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/shares?assetType=sheet&assetId=1234567890' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '[{\"email\": \"jane.doe@smartsheet.com\", \"accessLevel\": \"EDITOR\"}]'\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Share asset with users\nconst shareOptions = {\n  queryParameters: {\n    assetType: 'sheet',\n    assetId: 1234567890,\n    sendEmail: true\n  },\n  body: [{\n    email: 'jane.doe@smartsheet.com',\n    accessLevel: 'EDITOR',\n    message: 'Please review this sheet'\n  }]\n};\n\nconst result = await smartsheet.sharing.shareAsset(shareOptions);\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "# Share asset with users\nshare = smartsheet.models.Share()\nshare.email = 'jane.doe@smartsheet.com'\nshare.access_level = 'EDITOR'\nshare.message = 'Please review this sheet'\n\nresult = smartsheet.Sharing.share_asset(\n    share_obj=[share],\n    asset_type='sheet',\n    asset_id=1234567890,\n    send_email=True\n)\n"
          }
        ]
      }
    },
    "/shares/{shareId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        }
      ],
      "get": {
        "summary": "Get asset share",
        "description": "Retrieves a specific share for the specified asset.\n",
        "operationId": "get-asset-share",
        "tags": [
          "sharing"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES",
              "SHARE_SHEETS",
              "SHARE_SIGHTS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/shareId"
          },
          {
            "$ref": "#/components/parameters/assetType"
          },
          {
            "$ref": "#/components/parameters/assetId"
          }
        ],
        "responses": {
          "200": {
            "description": "The share specified by the shareId.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShareResponse"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/shares/AbcdEFGhIjKlmNoPqRstUvWxyZ?assetId=1234567890&assetType=sheet \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Get a specific share\nconst shareOptions = {\n  shareId: 'AbcdEFGhIjKlmNoPqRstUvWxyZ',\n  queryParameters: {\n    assetType: 'sheet',\n    assetId: 1234567890\n  }\n};\n\nconst share = await smartsheet.sharing.getAssetShare(shareOptions);\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "# Get a specific share\nshare = smartsheet.Sharing.get_asset_share(\n    asset_type='sheet',\n    asset_id=1234567890,\n    share_id='AbcdEFGhIjKlmNoPqRstUvWxyZ'\n)\n"
          }
        ]
      },
      "patch": {
        "summary": "Update asset share",
        "description": "Updates the share for a specified asset.\n\n> **Note:** This operation doesn't support asset ownership transfer.\n",
        "operationId": "update-asset-share",
        "tags": [
          "sharing"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES",
              "SHARE_SHEETS",
              "SHARE_SIGHTS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/shareId"
          },
          {
            "$ref": "#/components/parameters/assetType"
          },
          {
            "$ref": "#/components/parameters/assetId"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateShareRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing a [Share response](/api/smartsheet/openapi/sharing/shareresponse) object, corresponding to what was specified in the request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShareResponse"
                }
              }
            }
          },
          "400": {
            "description": "4XX errors typically indicate client input validation failures.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify share (to one user as Editor)\nShare[] shareSpecification = new Share[] { new Share\n  {\n    Email = \"jane.doe@smartsheet.com\",\n    AccessLevel = AccessLevel.EDITOR\n  }\n};\n\n// Share sheet\nIList<Share> addressList = smartsheet.SheetResources.ShareResources.ShareTo(\n  4583614634583940,               // sheetId\n  shareSpecification,\n  true                            // Nullable<bool> sendEmail\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/shares/abcDefgHjiKlmnoPqRstuVwxyZ?assetType=sheet&assetId=1234567890' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PATCH \\\n-d '{\"accessLevel\": \"ADMIN\"}'\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Update share access level\nconst updateOptions = {\n  shareId: 'abcDefgHjiKlmnoPqRstuVwxyZ',\n  queryParameters: {\n    assetType: 'sheet',\n    assetId: 1234567890\n  },\n  body: {\n    accessLevel: 'ADMIN'\n  }\n};\n\nconst updatedShare = await smartsheet.sharing.updateAssetShare(updateOptions);\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "# Update share access level\nshare = smartsheet.models.Share()\nshare.access_level = 'ADMIN'\n\nupdated_share = smartsheet.Sharing.update_asset_share(\n    share_obj=share,\n    asset_type='sheet',\n    asset_id=1234567890,\n    share_id='abcDefgHjiKlmnoPqRstuVwxyZ'\n)\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete asset share",
        "description": "Deletes the share for a specified asset.",
        "operationId": "delete-asset-share",
        "tags": [
          "sharing"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES",
              "SHARE_SHEETS",
              "SHARE_SIGHTS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/shareId"
          },
          {
            "$ref": "#/components/parameters/assetType"
          },
          {
            "$ref": "#/components/parameters/assetId"
          }
        ],
        "responses": {
          "200": {
            "description": "Result object indicating a successful deletion of the share for the specified asset.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SuccessResult"
                }
              }
            }
          },
          "400": {
            "description": "4XX errors typically indicate client input validation failures.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/shares/abcDefgHjiKlmnoPqRstuVwxyZ?assetType=sheet&assetId=1234567890' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Delete a share\nconst deleteOptions = {\n  shareId: 'abcDefgHjiKlmnoPqRstuVwxyZ',\n  queryParameters: {\n    assetType: 'sheet',\n    assetId: 1234567890\n  }\n};\n\nconst result = await smartsheet.sharing.deleteAssetShare(deleteOptions);\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "# Delete a share\nresult = smartsheet.Sharing.delete_asset_share(\n    asset_type='sheet',\n    asset_id=1234567890,\n    share_id='abcDefgHjiKlmnoPqRstuVwxyZ'\n)\n"
          }
        ]
      }
    },
    "/sheets": {
      "parameters": [
        {
          "$ref": "#/components/parameters/accessApiLevel"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List sheets",
        "description": "Gets a list of all sheets that the user has access to. The list contains an abbreviated Sheet object for each sheet.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "list-sheets",
        "tags": [
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/sheetInclude"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/modifiedSince"
          },
          {
            "$ref": "#/components/parameters/numericDates"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/schemas-Sheet"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Omit 'include' parameter and pagination parameters\nPaginatedResult<Sheet> sheets = smartsheet.SheetResources.ListSheets(\n  null,               // IEnumerable<SheetInclusion> includes\n  null,               // PaginationParameters\n  null                // Nullable<DateTime> modifiedSince\n);\n\n// Sample 2: Specify 'include' parameter with value of \"SOURCE\", and 'includeAll' parameter with value of 'true'\nPaginatedResult<Sheet> sheets = smartsheet.SheetResources.ListSheets(\n  new SheetInclusion[] { SheetInclusion.SOURCE },\n  new PaginationParameters(\n    true,           // includeAll\n    null,           // int pageSize\n    null)           // int page\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Omit 'include' parameter and pagination parameters\nPagedResult<Sheet> sheets = smartsheet.sheetResources().listSheets(\n        null,           // EnumSet<SourceInclusion> includes\n        null,           // PaginationParameters\n        null            // Date modifiedSince\n        );\n\n// Sample 2: Specify pagination parameter 'includeAll'\nPaginationParameters parameters = new PaginationParameters()\n        .setIncludeAll(true);\n\n// Specify 'include' parameter with value of \"SOURCE\", and 'includeAll' parameter with value of 'true'\nPagedResult<Sheet> sheets = smartsheet.sheetResources().listSheets(EnumSet.of(SourceInclusion.SOURCE), parameters, modifiedSince);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sheets.listSheets()\n  .then(function(sheetList) {\n    console.log(sheetList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List All\nresponse = smartsheet_client.Sheets.list_sheets(include_all=True)\nsheets = response.data\n\n# Sample 2: Paginate the list of sheets\nresponse = smartsheet_client.Sheets.list_sheets(\n  page_size=10,\n  page=1)\npages = response.total_pages\nsheets = response.data\n"
          }
        ]
      },
      "post": {
        "summary": "Create sheet in \"Sheets\" folder",
        "deprecated": true,
        "description": "Creates a sheet from scratch or from the specified template in the user's\nSheets folder (Home).\n\nFor subfolders, use Create Sheet in Folder.\n\n**DEPRECATED** - The Sheets folder is being replaced by workspaces. To adapt to this change, please see [Migrate from using the Sheets folder](/api/smartsheet/guides/updating-code/migrate-from-using-the-sheets-folder).\n",
        "operationId": "create-sheet-in-sheets-folder",
        "tags": [
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "CREATE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          },
          {
            "$ref": "#/components/parameters/include"
          }
        ],
        "requestBody": {
          "description": "Sheet to create.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/SheetToCreate"
                  },
                  {
                    "$ref": "#/components/schemas/SheetToCreateFromTemplate"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing a Sheet object for newly created sheet, corresponding to what was specified in the request.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "oneOf": [
                            {
                              "$ref": "#/components/schemas/SheetCreated"
                            },
                            {
                              "$ref": "#/components/schemas/SheetCreatedFromTemplate"
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Create sheet\n// Specify properties of the first column\nColumn columnA = new Column\n{\n  Title = \"Favorite\",\n  Primary = false,\n  Type = ColumnType.CHECKBOX,\n  Symbol = Symbol.STAR\n};\n\n// Specify properties of the second column\nColumn columnB = new Column\n{\n  Title = \"Primary Column\",\n  Primary = true,\n  Type = ColumnType.TEXT_NUMBER\n};\n\n// Create sheet in \"Sheets\" folder (specifying the 2 columns to include in the sheet)\nSheet newSheet = smartsheet.SheetResources.CreateSheet(new Sheet\n{\n  Name = \"newsheet\",\n  Columns = new Column[] { columnA, columnB }\n}\n);\n\n// Sample 2: Create sheet from template\n// Specify name for the sheet and Id of the template\nSheet sheetSpecification = new Sheet\n{\n  Name = \"new sheet title\",\n  FromId = 7679398137620356     // template Id\n};\n\n// Option 1: Omit 'include' parameter\nSheet newSheet = smartsheet.SheetResources.CreateSheetFromTemplate(\n  sheetSpecification,\n  null                            // IEnumerable<TemplateInclusion> include\n);\n\n// Option 2: Include ATTACHMENTS, DATA, and DISCUSSIONS\nSheet newSheet = smartsheet.SheetResources.CreateSheetFromTemplate(\n  sheetSpecification,\n  new TemplateInclusion[] {\n    TemplateInclusion.ATTACHMENTS,\n    TemplateInclusion.DATA,\n    TemplateInclusion.DISCUSSIONS }\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "// Sample 1: Create sheet\ncurl https://api.smartsheet.com/2.0/sheets \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"name\":\"newsheet\",\"columns\":[{\"title\":\"Favorite\",\"type\":\"CHECKBOX\",\"symbol\":\"STAR\"}, {\"title\":\"Primary Column\", \"primary\":true,\"type\":\"TEXT_NUMBER\"}]}'\n\n\n// Sample 2: Create sheet from template\ncurl 'https://api.smartsheet.com/2.0/sheets?include=data,attachments,discussions' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"name\":\"newsheet\", \"fromId\": templateId}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Create sheet\n// Specify properties of the first column\nColumn columnA = new Column()\n        .setTitle(\"Favorite\")\n        .setType(ColumnType.CHECKBOX)\n        .setSymbol(Symbol.STAR);\n\n// Specify properties of the second column\nColumn columnB = new Column()\n        .setTitle(\"Primary Column\")\n        .setType(ColumnType.TEXT_NUMBER)\n        .setPrimary(true);\n\n// Create sheet in \"Sheets\" folder (specifying the 2 columns to include in the sheet)\nSheet newSheet = new Sheet();\n        newSheet.setName(\"newsheet\");\n        newSheet.setColumns(Arrays.asList(columnA, columnB));\n\nsmartsheet.sheetResources().createSheet(newSheet);\n\n// Sample 2: Create sheet from template\n// Specify name for the sheet and Id of the template\n        Sheet sheet = new Sheet();\n        sheet.setFromId(7679398137620356L);     // long templateId\n        sheet.setName(\"newsheet\");\n\n// Option 1: Omit 'include' parameter\n        Sheet results = smartsheet.sheetResources().createSheetFromTemplate(sheet,\n        null                                    // EnumSet<SheetTemplateInclusion> includes\n        );\n\n// Option 2: Include ATTACHMENTS, DATA, and DISCUSSIONS\n        Sheet results = smartsheet.sheetResources().createSheetFromTemplate(\n        sheet,\n        EnumSet.of(\n        SheetTemplateInclusion.ATTACHMENTS,\n        SheetTemplateInclusion.DATA,\n        SheetTemplateInclusion.DISCUSSIONS)\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Create sheet\n// Specify sheet properties\nvar sheet = {\n  \"name\": \"newsheet\",\n  \"columns\": [\n    {\n      \"title\": \"Favorite\",\n      \"type\": \"CHECKBOX\",\n      \"symbol\": \"STAR\"\n    },\n    {\n      \"title\": \"Primary Column\",\n      \"primary\": true,\n      \"type\": \"TEXT_NUMBER\"\n    }\n  ]\n};\n\n// Set options\nvar options = {\n  body: sheet\n};\n\n// Create sheet in \"Sheets\" folder\nsmartsheet.sheets.createSheet(options)\n  .then(function(newSheet) {\n    console.log(newSheet);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n\n// Sample 2: Create sheet from template\n// Specify the directive\nvar sheet = {\n  \"fromId\": 7679398137620356,\n  \"name\": \"newsheet\"\n  };\n\n// Set options\nvar options = {\n  body: sheet\n};\n\n// Create sheet from template\nsmartsheet.sheets.createSheetFromExisting(options)\n  .then(function(newSheet) {\n    console.log(newSheet);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Create sheet\nsheet_spec = smartsheet.models.Sheet({\n  'name': 'newsheet',\n  'columns': [{\n      'title': 'Favorite',\n      'type': 'CHECKBOX',\n      'symbol': 'STAR'\n    }, {\n      'title': 'Primary Column',\n      'primary': True,\n      'type': 'TEXT_NUMBER'\n    }\n  ]\n})\nresponse = smartsheet_client.Home.create_sheet(sheet_spec)\nnew_sheet = response.result\n\n# Sample 2: Create sheet from template\nresponse = smartsheet_client.Home.create_sheet_from_template(\n  smartsheet.models.Sheet({\n    'name': 'newsheet',\n    'from_id': 7679398137620356     # template_id\n  })\n)\nnew_sheet = response.result\n"
          }
        ]
      }
    },
    "/sheets/import": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "post": {
        "summary": "Import sheet from CSV / XLSX",
        "deprecated": true,
        "description": "Imports CSV or XLSX data into a new sheet in the top-level \"Sheets\" folder.\n\nNote the following:\n\n* Both sheetName and the file name must use ASCII characters.\n\n* The source data must be basic text. To include rich formula data, import\nand create a sheet first, and then use Update Rows. To work with images, see\nCell Images.\n\n* XLS is not supported. You must use XLSX.\n\n* Hierarchical relationships between rows in an external file won't import.\n\n**DEPRECATED** - The Sheets folder is being replaced by workspaces. To adapt to this change, please see [Migrate from using the Sheets folder](/api/smartsheet/guides/updating-code/migrate-from-using-the-sheets-folder).\n",
        "operationId": "import-sheet-into-sheets-folder",
        "tags": [
          "imports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "CREATE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Disposition"
          },
          {
            "$ref": "#/components/parameters/parameters-Content-Type"
          },
          {
            "$ref": "#/components/parameters/sheetName"
          },
          {
            "$ref": "#/components/parameters/headerRowIndex"
          },
          {
            "$ref": "#/components/parameters/primaryColumnIndex"
          }
        ],
        "requestBody": {
          "description": "Binary content for the CSV / XLSX file.",
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing a Sheet object for imported sheet.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/SheetImported"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSheet sheet = smartsheet.SheetResources.ImportXlsSheet(\n  \"D:/ProgressReport.xlsx\",\n  null,         // sheetName defaults to file name unless specified\n  0,            // headerRowIndex\n  null          // primaryColumnIndex\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl  https://api.smartsheet.com/2.0/sheets/import?sheetName=MarketingProgressReport&headerRowIndex=0&primaryColumnIndex=0 \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Disposition: attachment\" \\\n-H \"Content-Type: text/csv\" \\\n-X POST \\\n--data-binary @ProgressReport.csv\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSheet sheet = smartsheet.sheetResources().importXlsx(\n        \"D:/ProgressReport.xlsx\",\n        \"MarketingProgressReport\",\n        0,      // headerRowIndex\n        0       // primaryColumnIndex\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Import sheet from CSV\n// Set options\nvar options = {\n  queryParameters: {\n      sheetName: 'MarketingProgressReport'\n  },\n  path: \"D:/ProgressReport.csv\"\n};\n\n// Import CSV as sheet\nsmartsheet.sheets.importCsvSheet(options)\n  .then(function(attachment) {\n      console.log(attachment);\n  })\n  .catch(function(error) {\n      console.log(error);\n  });\n\n// Sample 2: Import sheet from XLSX\n// Set options\nvar options = {\n  queryParameters: {\n    sheetName: 'MarketingProgressReport'\n  },\n  path: \"D:/ProgressReport.xlsx\"\n};\n\n// Import XLSX as sheet\nsmartsheet.sheets.importXlsxSheet(options)\n  .then(function(attachment) {\n    console.log(attachment);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nimported_sheet = smartsheet_client.Sheets.import_xlsx_sheet(\n  'D:/ProgressReport.xlsx',\n  'MarketingProgressReport',  # sheet_name\n  header_row_index=0\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/sheetId"
        }
      ],
      "get": {
        "summary": "Get sheet",
        "description": "Gets a sheet in the format specified, based on the sheet Id.",
        "operationId": "getSheet",
        "parameters": [
          {
            "$ref": "#/components/parameters/Accept"
          },
          {
            "$ref": "#/components/parameters/accessApiLevel"
          },
          {
            "$ref": "#/components/parameters/parameters-sheetInclude"
          },
          {
            "$ref": "#/components/parameters/sheetExclude"
          },
          {
            "$ref": "#/components/parameters/sheetColumnIds"
          },
          {
            "$ref": "#/components/parameters/sheetFilterId"
          },
          {
            "$ref": "#/components/parameters/sheetIfVersionAfter"
          },
          {
            "$ref": "#/components/parameters/sheetLevel"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/paperSize"
          },
          {
            "$ref": "#/components/parameters/sheetRowIds"
          },
          {
            "$ref": "#/components/parameters/sheetRowNumbers"
          },
          {
            "$ref": "#/components/parameters/sheetRowsModifiedSince"
          }
        ],
        "tags": [
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The Sheet that was loaded.",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/Sheet"
                    },
                    {
                      "$ref": "#/components/schemas/SheetVersion"
                    }
                  ]
                }
              },
              "application/pdf": {
                "schema": {
                  "type": "string",
                  "format": "binary",
                  "description": "The Sheet in PDF format."
                }
              },
              "application/vnd.ms-excel": {
                "schema": {
                  "type": "string",
                  "format": "binary",
                  "description": "The Sheet in Excel format."
                }
              },
              "text/csv": {
                "schema": {
                  "type": "string",
                  "format": "binary",
                  "description": "The Sheet in CSV format."
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Get sheet\n// Omit all parameters\nSheet sheet = smartsheet.SheetResources.GetSheet(\n  4583173393803140,           // sheetId\n  null,                       // IEnumerable<SheetLevelInclusion> includes\n  null,                       // IEnumerable<SheetLevelExclusion> excludes\n  null,                       // IEnumerable<long> rowIds\n  null,                       // IEnumerable<int> rowNumbers\n  null,                       // IEnumerable<long> columnIds\n  null,                       // Nullable<long> pageSize\n  null                        // Nullable<long> page\n);\n\n// Sample 2: Get sheet as Excel\nsmartsheet.SheetResources.GetSheetAsExcel(\n  4583173393803140,           // sheetId\n  outputStream\n);\n\n// Sample 3: Get sheet as PDF\nsmartsheet.SheetResources.GetSheetAsPDF(\n  4583173393803140,               // sheetId\n  outputStream,\n  PaperSize.A1\n);\n\n// Sample 4: Get sheet as CSV\nsmartsheet.SheetResources.GetSheetAsCSV(\n  4583173393803140,               // sheetId\n  outputStream\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "// Sample 1: Get sheet\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}?level=2&include=objectValue \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n\n// Sample 2: Get sheet as Excel\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Accept: application/vnd.ms-excel\" \\\n-o output.xlsx\n\n// Sample 3: Get sheet as PDF\ncurl 'https://api.smartsheet.com/2.0/sheets/{sheetId}?paperSize=A1' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Accept: application/pdf\"\n-o  output.pdf\n\n// Sample 4: Get sheet as CSV\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Accept: text/csv\" \\\n-o output.csv\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Get sheet\n// Omit all parameters\nSheet sheet = smartsheet.sheetResources().getSheet(\n        4583173393803140L,      // long sheetId\n        null,                   // EnumSet<SheetInclusion> includes\n        null,                   // EnumSet<ObjectExclusion> excludes\n        null,                   // Set<Long> rowIds\n        null,                   // Set<Integer> rowNumbers\n        null,                   // Set<Long> columnIds\n        null,                   // Integer pageSize\n        null                    // Integer page\n        );\n\n// Sample 2: Get sheet as Excel\nsmartsheet.sheetResources().getSheetAsExcel(\n        4583173393803140L,       // long sheetId\n        outputStream\n        );\n\n// Sample 3: Get sheet as PDF\nsmartsheet.sheetResources().getSheetAsPDF(\n        4583173393803140L,       // long sheetId\n        outputStream,\n        PaperSize.A1\n        );\n\n// Sample 4: Get sheet as CSV\nsmartsheet.sheetResources().getSheetAsCSV(\n        4583173393803140L,       // long sheetId\n        outputStream\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Get sheet\n// Set options\nvar options = {\n  id: 4583173393803140 // Id of Sheet\n};\n\n// Get sheet\nsmartsheet.sheets.getSheet(options)\n  .then(function(sheetInfo) {\n    console.log(sheetInfo);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n\n// Sample 2: Get sheet as Excel\nvar fs = require(\"fs\")\n\n// Set options\nvar options = {\n  id: 169681224483716 // Id of Sheet\n};\n\n// Get sheet\nsmartsheet.sheets.getSheetAsExcel(options)\n  .then(function(fileContents) {\n    // Write sheet to file\n    fs.writeFile('output.xlsx', fileContents, 'binary', (err) => {\n      if (err) throw err;\n      console.log('The sheet has been saved!');\n    });\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n\n// Sample 3: Get sheet as PDF\nvar fs = require(\"fs\")\n\n// Set options\nvar options = {\n  id: 169681224483716 // Id of Sheet\n};\n\n// Get sheet\nsmartsheet.sheets.getSheetAsPDF(options)\n  .then(function(fileContents) {\n    // Write sheet to file\n    fs.writeFile('output.pdf', fileContents, 'binary', (err) => {\n      if (err) throw err;\n      console.log('The sheet has been saved!');\n    });\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n\n// Sample 4: Get sheet as CSV\nvar fs = require(\"fs\")\n\n// Set options\nvar options = {\n  id: 4583173393803140 // Id of Sheet\n};\n\n// Get sheet\nsmartsheet.sheets.getSheetAsCSV(options)\n  .then(function(fileContents) {\n    // Write sheet to file\n    fs.writeFile('output.csv', fileContents, (err) => {\n      if (err) throw err;\n      console.log('The sheet has been saved!');\n    });\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Get sheet\nsheet = smartsheet_client.Sheets.get_sheet(\n  4583173393803140)           # sheet_id\n\n# Sample 2: Get sheet as Excel\nsmartsheet_client.Sheets.get_sheet_as_excel(\n  1531988831168388,           # sheet_id\n  download_directory_path)\n\n# Sample 3: Get sheet as PDF\nsmartsheet_client.Sheets.get_sheet_as_pdf(\n  1531988831168388,           # sheet_id\n  download_directory_path,\n  'A1')                       # paperSize\n\n# Sample 4: Get sheet as CSV\nsmartsheet_client.Sheets.get_sheet_as_csv(\n  1531988831168388,           # sheet_id\n  download_directory_path)\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete sheet",
        "description": "Deletes the sheet specified in the URL.",
        "operationId": "deleteSheet",
        "tags": [
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "DELETE_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SuccessResult"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.SheetResources.DeleteSheet(\n  1531988831168388            // sheetId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sheetResources().deleteSheet(\n        1531988831168388L        // long sheetId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  id: 1531988831168388 // Id of Sheet\n};\n\n// Delete sheet\nsmartsheet.sheets.deleteSheet(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Sheets.delete_sheet(\n  1531988831168388)       # sheet_id\n"
          }
        ]
      },
      "put": {
        "summary": "Update sheet",
        "description": "Updates the sheet specified in the URL.\nTo modify sheet contents, see [Add Rows](/api/smartsheet/openapi/rows/rows-addtosheet), [Update Rows](/api/smartsheet/openapi/rows/update-rows), [Add Columns](/api/smartsheet/openapi/columns/columns-addtosheet), and [Update Column](/api/smartsheet/openapi/columns/column-updatecolumn).\nThis operation can be used to update an individual user's sheet settings. If the request body contains only the **userSettings** attribute, this operation may be performed even if the user only has read-only access to the sheet (for example, the user has viewer permissions or the sheet is read-only).",
        "operationId": "updateSheet",
        "parameters": [
          {
            "$ref": "#/components/parameters/accessApiLevel"
          }
        ],
        "tags": [
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_SHEETS"
            ]
          }
        ],
        "requestBody": {
          "description": "[Sheet object](/api/smartsheet/openapi/sheets/sheet) limited to the following attributes:\n* **name** (optional).\n* **projectSettings** (optional): [ProjectSettings object](/api/smartsheet/openapi/schemas/projectsettings), containing at least one of the **projectSettings** attributes, for updating this sheet's project settings and dependencies.\n* **userSettings** (optional): [SheetUserSettings object](/api/smartsheet/openapi/schemas/sheetusersettings) for updating these user's settings for the sheet.\nNOTE:\n* Attributes not specified in **projectSettings** are not updated.\n* If **projectSettings.nonWorkingDays** is specified as an empty array, all non-working days are removed from the project sheet.\n",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateSheet"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Returns [Result object](/api/smartsheet/openapi/schemas/result) containing a [Sheet object](/api/smartsheet/openapi/sheets/sheet) for the updated sheet.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Sheet"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify updated sheet properties\nSheet sheetSpecification = new Sheet\n{\n  Id = 4583173393803140,\n  Name = \"New Sheet Name\",\n  UserSettings = new SheetUserSettings{CriticalPathEnabled = true}\n};\n\n// Update sheet\nSheet updatedSheet = smartsheet.SheetResources.UpdateSheet(sheetSpecification);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '{\"name\":\"New Sheet Name\",\n  \"userSettings\": {\"criticalPathEnabled\": true},\n  \"projectSettings\":{\n    \"workingDays\": [\"MONDAY\", \"TUESDAY\", \"WEDNESDAY\"],\n    \"nonWorkingDays\": [\"2018-01-01\"],\n    \"lengthOfDay\": 6\n  } \\\n}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify updated sheet properties\nSheet sheetSpecification = new Sheet();\nsheetSpecification.setUserSettings(new SheetUserSettings().setCriticalPathEnabled(true))\n        .setName(\"New Sheet Name\")\n        .setId(7960873114331012L);\n\n// Update sheet\nSheet updatedSheet = smartsheet.sheetResources().updateSheet(sheetSpecification);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify updated sheet properties\nvar sheet = {\n  \"name\": \"New Sheet Name\",\n  \"userSettings\": {\n    \"criticalPathEnabled\": true,\n  }\n};\n\n// Set options\nvar options = {\n  id: 7960873114331012, // Id of Sheet\n  body: sheet\n  };\n\n// Update sheet\nsmartsheet.sheets.updateSheet(options)\n  .then(function(updatedSheet) {\n    console.log(updatedSheet);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nupdated_sheet = smartsheet_client.Sheets.update_sheet(\n  4583173393803140,       # sheet_id\n  smartsheet.models.Sheet({\n    'name': 'New Sheet Name',\n    'user_settings': smartsheet.models.SheetUserSettings({\n      'critical_path_enabled': True\n    })\n  })\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/attachments": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List attachments",
        "description": "Gets a list of all attachments that are on the sheet, including sheet, row, and discussion-level attachments.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "attachments-listOnSheet",
        "tags": [
          "attachments"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          }
        ],
        "responses": {
          "200": {
            "description": "OK.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of attachments",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Attachment"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPaginatedResult<Attachment> attachments = smartsheet.SheetResources.AttachmentResources.ListAttachments(\n  9283173393803140,           // sheetId\n  null                        // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/attachments \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination\nPagedResult<Attachment> attachments = smartsheet.sheetResources().attachmentResources().listAttachments(\n        9283173393803140L,               // long sheetId\n        null                             // PaginationParameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 9283173393803140\n};\n\n// List attachments\nsmartsheet.sheets.listAttachments(options)\n  .then(function(attachmentsList) {\n    console.log(attachmentsList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List All\nresponse = smartsheet_client.Attachments.list_all_attachments(\n  9283173393803140,       # sheet_id\n  include_all=True)\nattachments = response.data\n\n# Sample 2: Paginate the list of attachments\nresponse = smartsheet_client.Attachments.list_all_attachments(\n  9283173393803140,       # sheet_id\n  page_size=10,\n  page=1)\npages = response.total_pages\nattachments = response.data\n"
          }
        ]
      },
      "post": {
        "summary": "Attach file or URL to sheet",
        "description": "Attaches a file to the sheet. The URL can be any of the following:\n\n* Normal URL (attachmentType \"LINK\")\n* Box.com URL (attachmentType \"BOX_COM\")\n* Dropbox URL (attachmentType \"DROPBOX\")\n* Egnyte URL (attachmentType \"EGNYTE\")\n* Evernote URL (attachmentType \"EVERNOTE\")\n* Google Drive URL (attachmentType \"GOOGLE_DRIVE\")\n* OneDrive URL (attachmentType \"ONEDRIVE\")\n\n> **Important:** Smartsheet Gov allows only the following attachment types:\n> - BOX_COM\n> - FILE\n> - GOOGLE_DRIVE\n> - LINK\n> - ONEDRIVE\n\n> **Important:** The file size limit is 30mb.\n\nFor multipart uploads please use \"multipart/form-data\" content type.\n\n> **Note:** Posting a file attachment is resource-intensive and is limited to **30 requests per minute per API token**. For details, see [Rate limiting](/api/smartsheet/guides/advanced-topics/scalability-options#rate-limiting).\n",
        "operationId": "attachments-attachToSheet",
        "tags": [
          "attachments"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            },
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "filename": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            },
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/URLAttachmentRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Attachment"
                        }
                      }
                    }
                  ],
                  "properties": {
                    "version": {
                      "description": "New version of the sheet. Applicable only for operations which update sheet data.",
                      "type": "number",
                      "nullable": true
                    }
                  }
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nAttachment attachment = smartsheet.SheetResources.AttachmentResources.AttachFile(\n  9283173393803140,           // sheetId\n  filePath,\n  \"application/msword\"\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/attachments \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/msword\" \\\n-H 'Content-Disposition: attachment; filename=\"ProgressReport.docx\"' \\\n-H \"Content-Length: FILE_SIZE\" \\\n-X POST \\\n--data-binary @ProgressReport.docx\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify file to be attached\nFile file = new File(\"/Users/jdoe/Documents/ProgressReport.docx\");\n\n// Attach file to sheet\n        Attachment attachment = smartsheet.sheetResources().attachmentResources().attachFile(\n        9283173393803140L,       // long sheetId\n        file,\n        \"application/msword\"\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Enable FileStream\nvar fs = require(\"fs\")\n\n// Set options\nvar options = {\n  sheetId: 1694401624483716,\n  fileSize: 20765,\n  fileName: \"ProgressReport.docx\",\n  fileStream: fs.createReadStream(\"/Users/jdoe/Documents/ProgressReport.docx\")\n};\n\n// Attach file to sheet\nsmartsheet.sheets.addFileAttachment(options)\n  .then(function(attachment) {\n      console.log(attachment);\n  })\n  .catch(function(error) {\n      console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nupdated_attachment = smartsheet_client.Attachments.attach_file_to_sheet(\n  9283173393803140,       # sheet_id\n  ('ProgressReport.docx',\n    open('/path/to/ProgressReport.docx', 'rb'),\n    'application/msword')\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/attachments/{attachmentId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/attachmentId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Get attachment",
        "description": "Fetches a temporary URL that allows you to download an attachment. The urlExpiresInMillis attribute tells you how long the URL is valid.\n",
        "operationId": "attachments-get",
        "tags": [
          "attachments"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Attachment"
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nAttachment attachment = smartsheet.SheetResources.AttachmentResources.GetAttachment(\n  9283173393803140,               // sheetId\n  4583173393803140                // attachmentId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/attachments/{attachmentId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nAttachment attachment = smartsheet.sheetResources().attachmentResources().getAttachment(\n        9283173393803140L,       // long sheetId\n        4583173393803140L        // long attachmentId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 9283173393803140,\n  attachmentId: 4583173393803140\n};\n\n// Get attachment\nsmartsheet.sheets.getAttachment(options)\n  .then(function(attachment) {\n      console.log(attachment);\n  })\n  .catch(function(error) {\n      console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nattachment = smartsheet_client.Attachments.get_attachment(\n  9283173393803140,       # sheet_id\n  4583173393803140)       # attachment_id\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete attachment",
        "description": "Deletes the attachment specified in the URL.\n",
        "operationId": "attachments-delete",
        "tags": [
          "attachments"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.SheetResources.AttachmentResources.DeleteAttachment(\n  9283173393803140,           // sheetId\n  7169782752536452            // attachmentId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/attachments/{attachmentId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sheetResources().attachmentResources().deleteAttachment(\n        9283173393803140L,       // long sheetId\n        7169782752536452L        // sheetAttachmentId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  attachmentId: 7169782752536452,\n};\n\n// Delete attachment\nsmartsheet.sheets.deleteAttachment(options)\n  .then(function(results) {\n      console.log(results);\n  })\n  .catch(function(error) {\n      console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Attachments.delete_attachment(\n  9283173393803140,       # sheet_id\n  7169782752536452)       # attachment_id\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/attachments/{attachmentId}/versions": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/attachmentId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List versions",
        "description": "Gets a list of all versions of the given attachmentId in order from newest to oldest.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "attachments-versionList",
        "tags": [
          "attachments"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          }
        ],
        "responses": {
          "200": {
            "description": "OK.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of attachments",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Attachment"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPaginatedResult<Attachment> attachments = smartsheet.SheetResources.AttachmentResources.VersioningResources.ListVersions(\n  2252168947361668,               // sheetId\n  5510069950408580,               // attachmentId\n  null                            // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/attachments/{attachmentId}/versions \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination\nPagedResult<Attachment> attachments = smartsheet.sheetResources().attachmentResources().versioningResources().listAllVersions(\n        2252168947361668L,       // long sheetId\n        5510069950408580L,       // long attachmentId\n        null                     // PaginationParameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  attachmentId: 5510069950408580\n};\n\n// List versions of the attachment\nsmartsheet.sheets.listAttachmentVersions(options)\n  .then(function(versionList) {\n    console.log(versionList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List all\nresponse = smartsheet_client.Attachments.list_attachment_versions(\n  2252168947361668,       # sheet_id\n  5510069950408580,       # attachment_id\n  include_all=True)\nversions = response.data\n\n# Sample 2: Paginate the list\nresponse = smartsheet_client.Attachments.list_attachment_versions(\n  2252168947361668,       # sheet_id\n  5510069950408580,       # attachment_id\n  page_size=5,\n  page=1)\npages = response.total_pages\nversions = response.data\n"
          }
        ]
      },
      "post": {
        "summary": "Attach new version",
        "description": "Uploads a new version of a file to a sheet or row. This operation can be performed using a simple upload or a multipart upload.\n\n> **Important:** The file size limit is 30mb.\n",
        "operationId": "attachments-versionUpload",
        "tags": [
          "attachments"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            },
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "filename": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Attachment"
                        }
                      }
                    }
                  ],
                  "properties": {
                    "version": {
                      "description": "New version of the sheet. Applicable only for operations which update sheet data.",
                      "type": "number",
                      "nullable": true
                    }
                  }
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nAttachment attachment = smartsheet.SheetResources.AttachmentResources.VersioningResources.AttachNewVersion(\n  9283173393803140,               // sheetId\n  0123456789123456,               // attachmentId\n  filePath,\n  \"application/msword\"\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/attachments/{attachmentId}/versions \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/msword\" \\\n-H 'Content-Disposition: attachment; filename=\"ProgressReport.docx\"' \\\n-H \"Content-Length: FILE_SIZE\" \\\n-X POST \\\n--data-binary @ProgressReport.docx\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify the new file to be attached\nFile file = new File(\"/Users/jdoe/Documents/ProgressReport.docx\");\n\n// Attach new version of the file\n        Attachment attachment = smartsheet.sheetResources().attachmentResources().versioningResources().attachNewVersion(\n        9283173393803140L,       // long sheetId\n        0123456789123456L,       // long attachmentId\n        file,\n        \"application/msword\"\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Enable FileStream\nvar fs = require(\"fs\")\n\n// Set options\nvar options = {\n  sheetId: 9283173393803140,\n  attachmentId: 0123456789123456,\n  fileSize: 17291,\n  fileName: \"ProgressReport.docx\",\n  fileStream: fs.createReadStream(\"/Users/jdoe/Documents/ProgressReport.docx\")\n};\n\n// Attach new version\nsmartsheet.sheets.attachNewVersion(options)\n  .then(function(updatedAttachment) {\n    console.log(updatedAttachment);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Attachments.attach_new_version(\n  9283173393803140,       # sheet_id\n  0123456789123456,       # attachment_id\n  ('ProgressReport.docx',\n    open('/path/to/ProgressReport.docx', 'rb'),\n    'application/msword')\n)\n\nupdated_attachment = response.result\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete all versions",
        "description": "Deletes all versions of the attachment corresponding to the specified attachmentId. For attachments with\nmultiple versions, this effectively deletes the attachment from the object that it’s attached to.\n",
        "operationId": "attachments-versionsDelete",
        "tags": [
          "attachments"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.SheetResources.AttachmentResources.VersioningResources.DeleteAllVersions(\n  9283173393803140,               // sheetId\n  0123456789123456                // attachmentId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/attachments/{attachmentId}/versions \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sheetResources().attachmentResources().versioningResources().deleteAllVersions(\n        9283173393803140L,       // long sheetId\n        0123456789123456L        // long attachmentId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  attachmentId: 5510069950408580\n};\n\n// Delete all versions of the attachment\nsmartsheet.sheets.deleteAllAttachmentVersions(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Attachments.delete_attachment_versions(\n  9283173393803140,       # sheet_id\n  0123456789123456)       # attachment_id\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/automationrules": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "operationId": "automationrules-list",
        "summary": "List all automation rules",
        "description": "Returns all automation rules associated with the specified sheet.\n\nMultistep workflows are not returned via the API.\n\nInstead, you'll see an error 400 - 1266: This rule is not accessible through the API.\n\nOnly single-action notifications, approval requests, or update requests qualify.\n\nFor users of Smartsheet for Slack, note that Slack notifications are not\nreturned.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "tags": [
          "automationRules"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of AutomationRule objects.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of Automation Rules",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/AutomationRule"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nPaginatedResult<AutomationRule> AutomationRules = smartsheet.SheetResources.AutomationRuleResources.ListAutomationRules(\n  9283173393803140,  // sheetId\n  null               // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/automationrules \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 9283173393803140\n};\n\n// List automation rules\nsmartsheet.sheets.listAutomationRules(options)\n    .then(function(automationRulesList) {\n      console.log(automationRulesList);\n    })\n    .catch(function(error) {\n      console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List All\nresponse = smartsheet_client.Sheets.list_automation_rules(\n  9283173393803140,       # sheet_id\n  include_all=True)\nautomation_rules = response.data\n\n# Sample 2: Paginate the list of automation rules\nresponse = smartsheet_client.Sheets.list_automation_rules(\n  9283173393803140,       # sheet_id\n  page_size=10,\n  page=1)\npages = response.total_pages\nautomation_rules = response.data\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/automationrules/{automationRuleId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/automationRuleId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Get an automation rule",
        "description": "Returns the specified automation rule, including any action values.\n",
        "operationId": "automationrule-get",
        "tags": [
          "automationRules"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "AutomationRule object",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/AutomationRule"
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nAutomationRule automationRule = smartsheet.SheetResources.GetAutomationRule(\n  9283173393803140,              // sheetId\n  789994550205316                // automationRuleId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/automationrules/{automationRuleId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 9283173393803140,\n  automationRuleId: 789994550205316\n};\n\n// Get automation rule\nsmartsheet.sheets.getAutomationRule(options)\n    .then(function(automationRule) {\n      console.log(automationRule);\n    })\n    .catch(function(error) {\n      console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nautomation_rule = smartsheet_client.Sheets.get_automation_rule(\n  4478580756375428,       # sheet_id\n  4220838007334788)       # automation_rule_id\n"
          }
        ]
      },
      "put": {
        "summary": "Update an automation rule",
        "description": "Updates an existing automation rule.\n\nWhen sending an AutomationRule, you must always specify **action.type** and it must match the existing rule type.\n",
        "operationId": "automationrule-update",
        "tags": [
          "automationRules"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AutomationRule"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing the updated AutomationRule object",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/AutomationRule"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set recipient\nRecipient recipient = new Recipient\n{\n  Email = \"jane.roe@smartsheet.com\"\n};\n\n// Specify the changes\nAutomationRule autoRule = new AutomationRule\n{\n  Id = 789994550205316,\n  Action = new AutomationAction\n  {\n    Recipients = new[] { recipient },\n    Type = AutomationActionType.NOTIFICATION_ACTION,\n    Frequency = AutomationActionFrequency.WEEKLY\n  }\n};\n\n// Update the automation rule\nAutomationRule automationRule = smartsheet.SheetResources.UpdateAutomationRule(\n  4583173393803140,  // sheetId\n  autoRule\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/automationrules/{automationRuleId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X PUT \\\n-d '{\n    \"action\": {\n        \"type\": \"APPROVAL_REQUEST_ACTION\",\n        \"recipients\": [{\n            \"email\": \"jane.roe@smartsheet.com\"\n        }],\n        \"frequency\": \"WEEKLY\"\n    }\n}'\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify the changes\nvar body = {\n  \"name\": \"Approval Request\",\n  \"action\": {\n    \"type\": \"APPROVAL_REQUEST_ACTION\",\n    \"recipients\": [\n      {\n        \"email\": \"jane.roe@smartsheet.com\"\n      }\n    ],\n    \"frequency\": \"WEEKLY\",\n    \"includeAllColumns\": true,\n    \"includeAttachments\": true,\n    \"includeDiscussions\": true,\n    \"notifyAllSharedUsers\": false\n  }\n};\n\n// Set options\nvar options = {\n  sheetId: 4583173393803140,\n  automationRuleId: 789994550205316,\n  body: body\n};\n\n// Update the automation rule\nsmartsheet.sheets.updateAutomationRule(options)\n    .then(function(updatedAutomationRule) {\n      console.log(updatedAutomationRule);\n    })\n    .catch(function(error) {\n      console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nautomation_spec = smartsheet.models.AutomationRule({\n  'enabled': False,                # Disable Automation Rule\n  'name': 'New Name',              # Change Name of Automation Rule\n  'action': {\n    'type': 'NOTIFICATION_ACTION'  # Action/Type must always be included\n  }\n})\n\nresponse = smartsheet_client.Sheets.update_automation_rule(\n  4478580756375428,                # sheet_id\n  4220838007334788,                # automation_rule_id\n  automation_spec)\n\nupdated_automation = response.result\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete an automation rule",
        "description": "Deletes an automation rule.\n",
        "operationId": "automationrule-delete",
        "tags": [
          "automationRules"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Result object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Result"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nAutomationRule automationRule = smartsheet.SheetResources.AutomationRuleResources.DeleteAutomationRule(\n  9283173393803140,               // sheetId\n  789004550205316                 // automationRuleId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/automationrules/{automationRuleId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 9283173393803140,\n  automationRuleId: 789004550205316\n};\n\n// Delete automation rule\nsmartsheet.sheets.deleteAutomationRule(options)\n    .then(function(results) {\n      console.log(results);\n    })\n    .catch(function(error) {\n      console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Sheets.delete_automation_rule(\n  4478580756375428,       # sheet_id\n  4220838007334788)       # automation_rule_id\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/columns": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List columns",
        "description": "Gets a list of all columns belonging to the specified sheet.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "columns-listOnSheet",
        "parameters": [
          {
            "$ref": "#/components/parameters/columnsLevel"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          }
        ],
        "tags": [
          "columns"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns IndexResult object containing an array of Column objects.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "An array of columns that can be any of the supported types.",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Column"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit 'include' parameter and pagination parameters\nPaginatedResult<Column> columns = smartsheet.SheetResources.ColumnResources.ListColumns(\n  9283173393803140,               // sheetId\n  null,                           // IEnumerable<ColumnInclusion> include\n  null,                           // PaginationParameters\n  2                               // int compatibilityLevel\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/columns \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit 'include' parameter and pagination parameters\nPagedResult<Column> columns = smartsheet.sheetResources().columnResources().listColumns(\n        9283173393803140L,                   // long sheetId\n        null,                                // EnumSet<ColumnInclusion> includes\n        null                                 // PaginationParameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 9283173393803140\n};\n\n// List columns\nsmartsheet.sheets.getColumns(options)\n  .then(function(columnList) {\n    console.log(columnList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          }
        ]
      },
      "post": {
        "summary": "Add columns",
        "description": "Inserts one or more columns into the specified sheet.\n\n> **Note:** This operation can also be performed using a [simple upload](/api/smartsheet/openapi/attachments)  or a [multipart upload](/api/smartsheet/openapi/attachments). For more information, see [Post an Attachment](/api/smartsheet/openapi/attachments).\n",
        "operationId": "columns-addToSheet",
        "tags": [
          "columns"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "description": "An object defining attributes for a column or an array of objects defining attributes for multiple columns.\n\n> **Note:** If you're creating multiple columns in the same call, you must use the same index value for each column. For example, you could set `index` to `1` to add the columns after the first column (it's `index` value is `0`).\n",
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/ColumnCreateRequestObject"
                  },
                  {
                    "type": "array",
                    "title": "Column array",
                    "items": {
                      "$ref": "#/components/schemas/ColumnCreateRequestObject"
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Returns [Result object](/api/smartsheet/openapi/schemas/result) containing the newly created columns -- either a single [Column object](/api/smartsheet/openapi/columns/column) or an array of Column objects, corresponding to what was specified in the request.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Column"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Create a column\nColumn columnA = new Column\n{\n  Title = \"This is a new multi-picklist column\",\n  Index = 0,\n  Type = ColumnType.MULTI_PICKLIST,\n  Options = new string[] { \"Cat\", \"Rat\", \"Bat\" }\n};\n\n// Create another column\nColumn columnB = new Column\n{\n  Title = \"New Date Column\",\n  Index = 4,\n  Type = ColumnType.DATE\n};\n\n// Add columns to the sheet\nIList<Column> addedColumns = smartsheet.SheetResources.ColumnResources.AddColumns(\n  2252168947361668,   // sheet Id\n  new Column[] { columnA, columnB }\n);\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Create columns\nColumn column1 = new Column()\n        .setTitle(\"New Multi-Picklist Column 1\")\n        .setType(ColumnType.MULTI_PICKLIST)\n        .setIndex(4)\n        .setOptions(Arrays.asList(\"First\", \"Second\", \"Third\"));\n\n        Column column2 = new Column()\n        .setTitle(\"New Date Column\")\n        .setType(ColumnType.DATE)\n        .setFormula(\"=data@row\")\n        .setValidation(true)\n        .setIndex(4);\n\n// Add columns to the sheet\n        List<Column> newColumns = smartsheet.sheetResources().columnResources().addColumns(\n        2252168947361668L,       // long sheetId\n        Arrays.asList(column1, column2)\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify new columns\nvar column = [\n  {\n    \"title\": \"New Picklist Column 1\",\n    \"type\": \"PICKLIST\",\n    \"options\": [\n      \"First\",\n      \"Second\",\n      \"Third\"\n    ],\n    \"index\": 4\n  },\n  {\n    \"title\": \"New Date Column\",\n    \"type\": \"DATE\",\n    \"formula\": \"=data@row\",\n    \"validation\": true,\n    \"index\": 4\n  }\n];\n\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  body: column\n  };\n\n// Add columns to the sheet\nsmartsheet.sheets.addColumn(options)\n  .then(function(newColumns) {\n      console.log(newColumns);\n  })\n  .catch(function(error) {\n      console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Create the columns\ncolumn1 = smartsheet.models.Column({\n  'title': 'New Picklist Column 1',\n  'type': 'PICKLIST',\n  'options': [\n    'First',\n    'Second',\n    'Third'\n  ],\n  'index': 4\n})\n\ncolumn2 = smartsheet.models.Column({\n  'title': 'New Date Column',\n  'type': 'DATE',\n  'formula': '=data@row',\n  'validation': 'True',\n  'index': 4\n})\n\n# Add columns to the sheet\nnew_columns = smartsheet_client.Sheets.add_columns(\n  2252168947361668,       # sheet_id\n  [column1, column2])\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/columns/{columnId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/columnId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Get column",
        "description": "Gets the definition of the specified column. \n\n> **Note:** If you need to get the values of individual cells within the column, use [Get sheet](#operation/getSheet) or [Get row](#operation/row-get).\n",
        "operationId": "column-get",
        "parameters": [
          {
            "$ref": "#/components/parameters/sheetLevel"
          }
        ],
        "tags": [
          "columns"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Column"
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Omit 'include' parameter\nColumn column = smartsheet.SheetResources.ColumnResources.GetColumn(\n  9283173393803140,               // sheetId\n  7960873114331012,               // columnId\n  null                            // IEnumerable<ColumnInclusion> includes\n);\n\n// Sample 2: Specify 'include' parameter with value of \"FILTERS\"\nColumn column = smartsheet.SheetResources.ColumnResources.GetColumn(\n  9283173393803140,               // sheetId\n  7960873114331012,               // columnId\n  new ColumnInclusion[] { ColumnInclusion.FILTERS }\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/columns/{columnId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Omit 'include' parameter\nColumn column = smartsheet.sheetResources().columnResources().getColumn(\n        9283173393803140L,       // long sheetId\n        7960873114331012L,       // long columnId\n        null                     // EnumSet<ColumnInclusion> includes\n        );\n\n// Sample 2: Specify 'include' parameter with value of \"FILTERS\"\n        Column column = smartsheet.sheetResources().columnResources().getColumn(\n        9283173393803140L,       // long sheetId\n        7960873114331012L,       // long columnId\n        EnumSet.of(ColumnInclusion.FILTERS)\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 9283173393803140,\n  columnId: 7960873114331012\n};\n\n// Get column\nsmartsheet.sheets.getColumns(options)\n  .then(function(column) {\n    console.log(column);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\ncolumn = smartsheet_client.Sheets.get_column(\n  9283173393803140,       # sheet_id\n  7960873114331012,       # column_id\n  level=1)\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete column",
        "description": "Deletes the specified column.",
        "operationId": "column-delete",
        "tags": [
          "columns"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.SheetResources.ColumnResources.DeleteColumn(\n  9283173393803140,               // sheetId\n  0123456789012345                // columnId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/columns/{columnId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sheetResources().columnResources().deleteColumn(\n        9283173393803140L,       // long sheetId\n        0123456789012345L        // long columnId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 9283173393803140,\n  columnId: 0123456789012345\n};\n\n// Delete column\nsmartsheet.sheets.deleteColumn(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Sheets.delete_column(\n  9283173393803140,       # sheet_id\n  0123456789012345)       # column_id\n"
          }
        ]
      },
      "put": {
        "summary": "Update column",
        "description": "Updates properties of the column, moves the column, or renames the column.\n\n> **Important:**\n>\n> - You cannot change the `type` of a Primary Column.\n>\n> - If you change the `type`, all cells in the column are converted to\nthe new column type, and column validation is cleared.\n>\n> - The `type` property is optional when moving or renaming a column, but it's required when changing `symbol`, `systemColumnType`, `options`, `contactOptions`, or `autoNumberFormat`.\n>\n> - When setting a column type of `PICKLIST` or `MULTI_PICKLIST`, you must follow a one update per API call rule. For these column types, you must set the column type first, before making any additional constraints (such as setting `validation` to `true`) in subsequent calls.\n>\n> - Column `options` are forbidden in the request body when the body specifies a `symbol` update.\n>\n> - While dependencies are enabled on a sheet, you can't change the `type` of any calendar column, Gantt column, or Resource Management column. Such columns have a `tags` array that contains at least one of the following enum values:\n>\n>   - CALENDAR_END_DATE\n>   - CALENDAR_START_DATE\n>   - CARD_DONE\n>   - GANTT_ALLOCATION\n>   - GANTT_ASSIGNED_RESOURCE\n>   - GANTT_DISPLAY_LABEL\n>   - GANTT_DURATION\n>   - GANTT_END_DATE\n>   - GANTT_PERCENT_COMPLETE\n>   - GANTT_PREDECESSOR\n>   - GANTT_START_DATE\n>   - BASELINE_START_DATE\n>   - BASELINE_END_DATE\n>   - BASELINE_VARIANCE\n",
        "operationId": "column-updateColumn",
        "tags": [
          "columns"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_SHEETS"
            ]
          }
        ],
        "requestBody": {
          "description": "Attributes to change in the column, depending on its type or the type you're changing it to.\n",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ColumnUpdateRequestObject"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Returns [Result object](/api/smartsheet/openapi/schemas/result) containing the [Column object](/api/smartsheet/openapi/columns/column) that was modified.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Column"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify column properties\nColumn columnSpecification = new Column\n{\n  Id = 5005385858869124,\n  Title = \"First Column\",\n  Index = 0,\n  Type = ColumnType.PICKLIST,\n  Options = new string[] { \"One\", \"Two\"}\n};\n\n// Update column\nColumn updatedColumn = smartsheet.SheetResources.ColumnResources.UpdateColumn(\n  2252168947361668,   // sheetId\n  columnSpecification\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/columns/{columnId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X PUT \\\n-d '{\"title\": \"New multi-select dropdown column\", \"index\": 0, \"type\": \"MULTI_PICKLIST\", \"options\": [\"One\", \"Two\"]}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify column properties\nColumn columnSpecification = new Column(5005385858869124L)\n        .setTitle(\"First Column\")\n        .setIndex(0)\n        .setType(ColumnType.PICKLIST)\n        .setOptions(Arrays.asList(\"One\", \"Two\"));\n\n// Update column\n        Column updatedColumn = smartsheet.sheetResources().columnResources().updateColumn(\n        2252168947361668L,   // sheetId\n        columnSpecification\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify column properties\nvar column = {\n  \"index\": 0,\n  \"title\": \"First Column\",\n  \"type\": \"PICKLIST\",\n  \"options\": [\"One\", \"Two\"]\n};\n\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  columnId: 5005385858869124,\n  body: column\n  };\n\n// Update column\nsmartsheet.sheets.updateColumn(options)\n  .then(function(updatedColumn) {\n    console.log(updatedColumn);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Specify column properties\ncolumn_spec = smartsheet.models.Column({\n  'title': 'First Column',\n  'type': 'PICKLIST',\n  'options': [\"One\", \"Two\"],\n  'index': 0\n})\n\n# Update column\nresponse = smartsheet_client.Sheets.update_column(\n  2252168947361668,       # sheet_id\n  5005385858869124,       # column_id\n  column_spec)\n\nupdated_column = response.result\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/comments/{commentId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/commentId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Get a comment",
        "description": "Gets the comment specified by commentId.\n",
        "operationId": "comment-get",
        "tags": [
          "comments"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Comment"
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nComment comment = smartsheet.SheetResources.CommentResources.GetComment(\n  2252168947361668,               // sheetId\n  48569348493401200               // commentId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/comments/{commentId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nComment comment = smartsheet.sheetResources().commentResources().getComment(\n        2252168947361668L,       // long sheetId\n        4856934849340120L        // long commentId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  commentId: 48569348493401200\n};\n\n// Get comment\nsmartsheet.sheets.getComment(options)\n  .then(function(comment) {\n    console.log(comment);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\ncomment = smartsheet_client.Discussions.get_discussion_comment(\n  2252168947361668,       # sheet_id\n  4856934849340120        # comment_id\n)\n"
          }
        ]
      },
      "put": {
        "summary": "Edit a comment",
        "description": "Updates the text of a comment. NOTE: Only the user that created the comment is permitted to update it.\n",
        "operationId": "comment-edit",
        "tags": [
          "comments"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CommentCreateRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Comment"
                        }
                      }
                    }
                  ],
                  "properties": {
                    "version": {
                      "description": "New version of the Sheet. Applicable only for operations which update sheet data.",
                      "type": "number",
                      "nullable": true
                    }
                  }
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify edited comment properties\nComment commentSpecification = new Comment\n{\n  Id = 7144101943502724,\n  Text = \"This is the updated comment text\"\n}\n\n// Edit comment\nComment updatedComment = smartsheet.SheetResources.DiscussionResources.CommentResources.UpdateComment(\n  3285357287499652,          // sheetId\n  commentSpecification\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/comments/{commentId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X PUT \\\n-d '{\"text\":\"This is the updated comment text.\"}'\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify text\nvar body = {\n  text: \"This is the updated comment text.\"\n};\n\n// Set options\nvar options = {\n  sheetId: 3285357287499652,\n  commentId: 7144101943502724,\n  body: body\n};\n\n// Edit comment\nsmartsheet.sheets.editComment(options)\n  .then(function(updatedComment) {\n    console.log(updatedComment);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\ncomment = smartsheet_client.Discussions.update_comment(\n  3285357287499652,       # sheet_id\n  7144101943502724,       # comment_id\n  smartsheet.models.Comment({\n    'text': 'This is the updated comment text'}))\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete a comment",
        "description": "Deletes the comment specified in the URL.\n",
        "operationId": "comment-delete",
        "tags": [
          "comments"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    }
                  ],
                  "properties": {
                    "version": {
                      "description": "New version of the Sheet. Applicable only for operations which update sheet data.",
                      "type": "number",
                      "nullable": true
                    }
                  }
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.SheetResources.CommentResources.DeleteComment(\n  2252168947361668,           // sheetId\n  4952999001909124            // commentId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/comments/{commentId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X 'DELETE'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sheetResources().commentResources().deleteComment(\n        2252168947361668L,       // long sheetId\n        4952999001909124L        // long commentId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  commentId: 4952999001909124\n};\n\n// Delete comment\nsmartsheet.sheets.deleteComment(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Discussions.delete_discussion_comment(\n  2252168947361668,       # sheet_id\n  4952999001909124)       # comment_id\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/comments/{commentId}/attachments": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/commentId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "post": {
        "summary": "Attach file or URL to comment",
        "description": "Attaches a file to the comment. The URL can be any of the following:\n\n* Normal URL (attachmentType \"LINK\")\n* Box.com URL (attachmentType \"BOX_COM\")\n* Dropbox URL (attachmentType \"DROPBOX\")\n* Egnyte URL (attachmentType \"EGNYTE\")\n* Evernote URL (attachmentType \"EVERNOTE\")\n* Google Drive URL (attachmentType \"GOOGLE_DRIVE\")\n* OneDrive URL (attachmentType \"ONEDRIVE\")\n\n> **Important:** Smartsheet Gov allows only the following attachment types:\n> - BOX_COM\n> - FILE\n> - GOOGLE_DRIVE\n> - LINK\n> - ONEDRIVE\n\n> **Important:** The file size limit is 30mb.\n\nThis operation can be performed using a simple upload or a multipart upload.\n\n> **Note:** Posting a file attachment is resource-intensive and is limited to **30 requests per minute per API token**. For details, see [Rate limiting](/api/smartsheet/guides/advanced-topics/scalability-options#rate-limiting).\n",
        "operationId": "attachments-attachToComment",
        "tags": [
          "attachments"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            },
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "filename": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            },
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/URLAttachmentRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Attachment"
                        }
                      }
                    }
                  ],
                  "properties": {
                    "version": {
                      "description": "New version of the sheet. Applicable only for operations which update sheet data.",
                      "type": "number",
                      "nullable": true
                    }
                  }
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nAttachment attachment = smartsheet.SheetResources.CommentResources.AttachmentResources.AttachFile(\n  9283173393803140,           // sheetId\n  1234567890234568,           // commentId\n  filePath,\n  \"application/msword\"\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/comments/{commentId}/attachments \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/msword\" \\\n-H 'Content-Disposition: attachment; filename=\"ProgressReport.docx\"' \\\n-H \"Content-Length: FILE_SIZE\" \\\n-X POST \\\n--data-binary @ProgressReport.docx\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify file to be attached\nFile file = new File(\"/Users/jdoe/Documents/ProgressReport.docx\");\n\n// Attach file to comment\n        Attachment attachment = smartsheet.sheetResources().commentResources().attachmentResources().attachFile(\n        9283173393803140L,       // long sheetId\n        1234567890234568L,       // long commentId\n        file,\n        \"application/msword\"\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Enable FileStream\nvar fs = require(\"fs\")\n\n// Set options\nvar options = {\n  sheetId: 1696803624483716,\n  commentId: 7722333183016324,\n  fileSize: 20765,\n  fileName: \"ProgressReport.docx\",\n  fileStream: fs.createReadStream(\"/Users/jdoe/Documents/ProgressReport.docx\")\n};\n\n// Attach file to comment\nsmartsheet.sheets.addCommentFileAttachment(options)\n  .then(function(attachment) {\n      console.log(attachment);\n  })\n  .catch(function(error) {\n      console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nupdated_attachment = smartsheet_client.Attachments.attach_file_to_comment(\n  9283173393803140,       # sheet_id\n  1234567890234568,       # comment_id\n  ('ProgressReport.docx',\n    open('/path/to/ProgressReport.docx', 'rb'),\n    'application/msword')\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/copy": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/Content-Type"
        },
        {
          "$ref": "#/components/parameters/sheetCopyInclude"
        },
        {
          "$ref": "#/components/parameters/sheetCopyExclude"
        }
      ],
      "post": {
        "summary": "Copy sheet",
        "description": "Creates a copy of the specified sheet.\n",
        "operationId": "copy-sheet",
        "tags": [
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "CREATE_SHEETS"
            ]
          }
        ],
        "requestBody": {
          "description": "Destination where to create a copy of the specified sheet.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ContainerDestinationForCopy"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/SheetCopyMoveResponse"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination\nContainerDestination destination = new ContainerDestination {\n  DestinationId = 3791509922310020,               // long destinationFolderId\n  DestinationType = DestinationType.FOLDER,\n  NewName = \"newSheetName\"\n};\n\n// Sample 1: Omit 'include' parameter\nSheet sheet = smartsheet.SheetResources.CopySheet(\n  9283173393803140,                               // sheetId\n  destination,\n  null                                            // IEnumerable<SheetCopyInclusion> include\n);\n\n// Sample 2: Specify 'include' parameter with value of \"data\"\nSheet sheet = smartsheet.SheetResources.CopySheet(\n  9283173393803140,                               // sheetId\n  destination,\n  new SheetCopyInclusion[] { SheetCopyInclusion.DATA }\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/sheets/{sheetId}/copy?include=data,attachments' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n  \"destinationType\": \"folder\",\n  \"destinationId\": 7960873114331012,\n  \"newName\": \"newSheetName\"\n}' \\\n-X POST\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination\nContainerDestination destination = new ContainerDestination()\n        .setDestinationType(DestinationType.FOLDER)\n        .setDestinationId(9283173393803140L)\n        .setNewName(\"newSheetName\");\n\n// Sample 1: Omit 'include' parameter\nSheet sheet = smartsheet.sheetResources().copySheet(\n        4583173393803140L,                          // long sheetId\n        destination,\n        null                                        // EnumSet<SheetCopyInclusion> includes\n        );\n\n// Sample 2: Specify 'include' parameter with value of \"data\"\nSheet sheet = smartsheet.sheetResources().copySheet(\n        4583173393803140L,                         // long sheetId\n        destination,\n        EnumSet.of(SheetCopyInclusion.DATA)\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set destination information\nvar body = {\n  destinationType: \"home\",\n  newName: \"newSheetName\"\n};\n\n// Set elements to copy\nvar params = {\n  include: \"attachments,data\",\n  includeAll: true\n};\n\n// Set options\nvar options = {\n  sheetId: 7254137655060356,\n  body: body,\n  queryParameters: params\n};\n\n// Copy sheet\nsmartsheet.sheets.copySheet(options)\n  .then(function(copiedSheet) {\n    console.log(copiedSheet);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Copy sheet\nresponse = smartsheet_client.Sheets.copy_sheet(\n  4583173393803140,                               # sheet_id\n  smartsheet.models.ContainerDestination({\n    'destination_type': 'folder',               # folder, workspace, or home\n    'destination_id': 9283173393803140,         # folder_id\n    'new_name': 'newSheetName'\n  })\n)\n\n# Sample 2: Copy sheet with attachments and discussions\nresponse = smartsheet_client.Sheets.copy_sheet(\n  4583173393803140,       # sheet_id\n  include='attachments,discussions'\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/crosssheetreferences": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "post": {
        "summary": "Create cross-sheet references",
        "description": "Adds a cross-sheet reference between two sheets and defines the data range for formulas. Each distinct data range requires a new cross-sheet reference.",
        "operationId": "add-crosssheet-reference",
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "tags": [
          "crossSheetReferences"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "CREATE_SHEETS"
            ]
          }
        ],
        "requestBody": {
          "description": "CrossSheetReference object to create",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/CrossSheetReferenceRequestWithColumnIds"
                  },
                  {
                    "$ref": "#/components/schemas/CrossSheetReferenceRequestWithRowIds"
                  },
                  {
                    "$ref": "#/components/schemas/CrossSheetReferenceRequestWithColumnAndRowIds"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing a CrossSheetReference object, corresponding to what was specified in the request.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/CrossSheetReference"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nCrossSheetReference xref = new CrossSheetReference();\nxref.Name = \"Sample Time Log Sheet Range 1\";\nxref.SourceSheetId = 154378742065028;\nxref.StartRowId = 4089096300717956;\nxref.EndRowId = 2681721417164676;\nxref.StartColumnId = 824812248557444;\nxref.EndColumnId = 824812248557444;\nCrossSheetReference newXRef = smartsheet.SheetResources.CrossSheetReferenceResources.CreateCrossSheetReference(\n    1755440242550660,   //sheetId\n    xref\n  );\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/crosssheetreferences \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\n  \"name\": \"Sample Time Log Sheet Range 1\",\n  \"sourceSheetId\": 154378742065028,\n  \"startRowId\": 4089096300717956,\n  \"endRowId\": 2681721417164676,\n  \"startColumnId\": 824812248557444,\n  \"endColumnId\": 824812248557444\n}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nCrossSheetReference xref = new CrossSheetReference();\n        xref.setName(\"Sample Time Log Sheet Range 1\");\n        xref.setSourceSheetId(154378742065028L);\n        xref.setStartRowId(4089096300717956L);\n        xref.setEndRowId(2681721417164676L);\n        xref.setStartColumnId(824812248557444L);\n        xref.setEndColumnId(824812248557444L);\n\nCrossSheetReference newXRef = smartsheet.sheetResources().crossSheetReferenceResources().createCrossSheetReference(\n        1755440242550660,   //sheetId\n        xref\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nvar body = {\n  name: \"my cross sheet reference\",\n  sourceSheetId: 154378742065028,\n  startRowId: 4089096300717956,\n  endRowId: 2681721417164676,\n  \"startColumnId\": 824812248557444,\n  \"endColumnId\": 824812248557444\n};\n\nsmartsheet.sheets.createCrossSheetReference({sheetId: 456745674567, body: body})\n  .then((result) => {\n    console.log(\"success\");\n    console.log(JSON.stringify(result));\n  })\n  .catch((error) => {\n    console.log(\"error\");\n    console.log(JSON.stringify(error));\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nxref = smartsheet.models.CrossSheetReference({\n    'name': 'Sample Time Log Sheet Range 1',\n    'source_sheet_id': 154378742065028,\n    'start_row_id': 4089096300717956,\n    'end_row_id': 2681721417164676,\n    'start_column_id': 824812248557444,\n    'end_column_id': 824812248557444\n})\nresult = smartsheet_client.Sheets.create_cross_sheet_reference(\n  1755440242550660, xref)\n"
          }
        ]
      },
      "get": {
        "summary": "List cross-sheet references",
        "description": "Lists all cross-sheet references for the sheet.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "list-crosssheet-references",
        "tags": [
          "crossSheetReferences"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "IndexResult object containing an array of CrossSheetReference objects.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/CrossSheetReference"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n//Sample 1: List all\nsmartsheet.SheetResources.CrossSheetReferenceResources.ListCrossSheetReferences(\n    9283173393803140, // sheetId\n    null              // PaginationParameters\n  );\n\n//Sample 2: Paginate the list\nPaginationParameters paginationParameters = new PaginationParameters(\n    false,  // includeAll\n    100,    // pageSize\n    1       // page\n  );\nsmartsheet.SheetResources.CrossSheetReferenceResources.ListCrossSheetReferences(\n    9283173393803140,   // sheetId\n    paginationParameters\n  );\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/crosssheetreferences \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n//Sample 1: List all\nsmartsheet.sheetResources().crossSheetReferenceResources().listCrossSheetReferences(\n        9283173393803140L,  // sheetId\n        null    // PaginationParameters\n        );\n\n//Sample 2: Paginate the list\nPaginationParameters paginationParameters = new PaginationParameters(\n        false,  // includeAll\n        100,    // pageSize\n        1       // page\n        );\nsmartsheet.sheetResources().crossSheetReferenceResources().listCrossSheetReferences(\n        9283173393803140L,  // sheetId\n        paginationParameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sheets.listCrossSheetReferences({sheetId: 9283173393803140})\n  .then((result) => {\n    console.log(\"success\");\n    console.log(JSON.stringify(result));\n  })\n  .catch((error) => {\n    console.log(\"error\");\n    console.log(JSON.stringify(error));\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List All\nresult = smartsheet_client.Sheets.list_cross_sheet_references(\n  9283173393803140)\n\n# Sample 2: Paginate the list of cross-sheet references\nresponse = smartsheet_client.Sheets.list_cross_sheet_references(\n  9283173393803140,       # sheet_id\n  page_size=10,\n  page=1)\npages = response.total_pages\ncrosssheetreferences = response.data\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/crosssheetreferences/{crossSheetReferenceId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/crossSheetReferenceId"
        }
      ],
      "get": {
        "summary": "Get cross-sheet reference",
        "description": "Gets the cross-sheet reference specified in the URL.",
        "operationId": "get-crosssheet-reference",
        "tags": [
          "crossSheetReferences"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "CrossSheetReference object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CrossSheetReference"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nCrossSheetReference xref = smartsheet.SheetResources.CrossSheetReferenceResources.GetCrossSheetReference(\n    9283173393803140, // sheetId\n    8157685695702916  // crossSheetReferenceId\n  );\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/crosssheetreferences/{crossSheetReferenceId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nCrossSheetReference xref = smartsheet.sheetResources().crossSheetReferenceResources().getCrossSheetReference(\n        9283173393803140L, // sheetId\n        8157685695702916L  // crossSheetReferenceId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sheets.getCrossSheetReference({sheetId: 9283173393803140, crossSheetReferenceId: 8157685695702916})\n  .then((result) => {\n    console.log(\"success\");\n    console.log(JSON.stringify(result));\n  })\n  .catch((error) => {\n    console.log(\"error\");\n    console.log(JSON.stringify(error));\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresult = smartsheet_client.Sheets.get_cross_sheet_reference(\n    9283173393803140, # sheet_id\n    8157685695702916  # cross_sheet_reference_id\n  )\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/discussions": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List discussions",
        "description": "Gets a list of all discussions associated with the specified sheet. Remember that discussions are containers\n\nfor the conversation thread. To see the entire thread, use the include=comments parameter.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "discussions-list",
        "tags": [
          "discussions"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/discussionInclude"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          }
        ],
        "responses": {
          "200": {
            "description": "OK.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of discussions",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Discussion"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Omit 'include' parameter and pagination parameters\nPaginatedResult<Discussion> results = smartsheet.SheetResources.DiscussionResources.ListDiscussions(\n  9283173393803140,               // sheetId\n  null,                           // IEnumerable<DiscussionInclusion> include\n  null                            // PaginationParameters\n);\n\n// Sample 2: Specify 'include' parameter with values of 'COMMENTS' and 'ATTACHMENTS', and 'includeAll' parameter with value of 'true'\nPaginatedResult<Discussion> results = smartsheet.SheetResources.DiscussionResources.ListDiscussions(\n  9283173393803140,               // sheetId\n  new DiscussionInclusion[] { DiscussionInclusion.COMMENTS, DiscussionInclusion.ATTACHMENTS },\n  new PaginationParameters(\n    true,                       // includeAll\n    null,                       // int pageSize\n    null)                       // int page\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/sheets/{sheetId}/discussions?include=comments,attachments' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Omit 'include' parameter and pagination parameters\nPagedResult<Discussion> results = smartsheet.sheetResources().discussionResources().listDiscussions(\n        9283173393803140L,   // long sheetId\n        null,                // PaginationParameters\n        null                 // EnumSet<DiscussionInclusion> includes\n        );\n\n// Sample 2: Specify pagination parameter 'includeAll'\nPaginationParameters parameters = new PaginationParameters()\n        .setIncludeAll(true);\n\n// List discussions (specify 'include' parameter with values of 'COMMENTS' and 'ATTACHMENTS', and 'includeAll' parameter with value of 'true')\nPagedResult<Discussion> results = smartsheet.sheetResources().discussionResources().listDiscussions(\n        9283173393803140L,   // long sheetId\n        parameters,\n        EnumSet.of(DiscussionInclusion.COMMENTS, DiscussionInclusion.ATTACHMENTS)\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 3138415114905476\n};\n\n// List discussions\nsmartsheet.sheets.getDiscussions(options)\n  .then(function(discussionList) {\n    console.log(discussionList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List all\nresponse = smartsheet_client.Discussions.get_all_discussions(\n  9283173393803140,       # sheet_id\n  include_all=True)\ndiscussions = response.data\n\n# Sample 2: Paginate the list\nresponse = smartsheet_client.Discussions.get_all_discussions(\n  9283173393803140,       # sheet_id\n  page_size=10,\n  page=1)\npages = response.total_pages\ndiscussions = response.data\n"
          }
        ]
      },
      "post": {
        "summary": "Create discussion",
        "description": "Creates a new discussion on a sheet. To create a discussion with an attachment please use \"multipart/form-data\" content type.\n",
        "operationId": "discussions-create",
        "tags": [
          "discussions"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DiscussionCreateRequest"
              }
            },
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/DiscussionWithAttachmentCreateRequest"
              },
              "encoding": {
                "discussion": {
                  "contentType": "application/json"
                },
                "file": {
                  "contentType": "application/octet-stream"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Discussion"
                        }
                      }
                    }
                  ],
                  "properties": {
                    "version": {
                      "description": "New version of the sheet. Applicable only for operations which update sheet data.",
                      "type": "number",
                      "nullable": true
                    }
                  }
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Example request: create discussion on sheet (without attachment)\n\n// Create discussion (including the comment)\nDiscussion discussionSpecification = new Discussion\n{\n  Comment = new Comment\n  {\n    Text = \"This text is the body of the first comment\"\n  },\n  Comments = null         // workaround for SDK issue\n};\n\n// Add discussion to sheet\nDiscussion newDiscussion = smartsheet.SheetResources.DiscussionResources.CreateDiscussion(\n  9283173393803140,                   // sheetId\n  discussionSpecification\n);\n\n// Example request: create discussion on sheet (with attachment)\n\n// Create discussion (including the comment)\nDiscussion discussionSpecification = new Discussion\n{\n  Comment = new Comment\n  {\n    Text = \"This text is the body of the first comment\"\n  },\n  Comments = null         // workaround for SDK issue\n};\n\n// Add discussion (including comment with attachment) to sheet\nDiscussion newDiscussion = smartsheet.SheetResources.DiscussionResources.CreateDiscussionWithAttachment(\n  9283173393803140,                   // sheetId\n  discussionSpecification,\n  filePath,\n  \"application/octet-stream\"\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "# Example request: create discussion on sheet (without attachment)\n\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}/discussions \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"comment\": {\"text\":\"This text is the body of the first comment\"}}'\n\n# Example request: create discussion on sheet (with attachment)\n\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}/discussions \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: multipart/form-data\" \\\n-X POST \\\n-F 'discussion={ \"comment\": { \"text\": \"This text is the body of the first comment\" } };type=application/json' \\\n-F \"file=@file_to_attach;type=application/octet-stream\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Example request: create discussion on sheet (without attachment)\n\n// Create comment\nComment commentSpecification = new Comment()\n        .setText(\"This text is the body of the first comment\");\n\n// Create discussion (including the comment)\n        Discussion discussionSpecification = new Discussion()\n        .setComment(commentSpecification)\n        .setComments(null);     // workaround for SDK issue\n\n// Add discussion to sheet\n        Discussion newDiscussion = smartsheet.sheetResources().discussionResources().createDiscussion(\n        9283173393803140L,       // long sheetId\n        discussionSpecification\n        );\n\n// Example request: create discussion on sheet (with attachment)\n\n// Create comment\n        Comment commentSpecification = new Comment()\n        .setText(\"This text is the body of the first comment\");\n\n// Create discussion (including the comment)\n        Discussion discussionSpecification = new Discussion()\n        .setComment(commentSpecification)\n        .setComments(null);     // workaround for SDK issue\n\n        File file = new File(filePath);\n\n// Add discussion (including comment with attachment) to sheet\n        Discussion newDiscussion = smartsheet.sheetResources().discussionResources().createDiscussionWithAttachment(\n        9283173393803140L,       // long sheetId\n        discussionSpecification,\n        file,\n        \"application/octet-stream\"\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Example request: create discussion on sheet (without attachment)\n\n// Specify discussion\nvar discussion = {\n  \"comment\": {\n    \"text\": \"This text is the body of the first comment\"\n  }\n};\n\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  body: discussion\n  };\n\n// Add discussion to sheet\nsmartsheet.sheets.createDiscussion(options)\n  .then(function(newDiscussion) {\n    console.log(newDiscussion);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n\n// Example request: create discussion on sheet (with attachment)\n\n// Multipart operations are not supported by the Node SDK. Instead, see instructions to Create Discussion on Sheet, and then Attach File to Comment.\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Example request: create discussion on sheet (without attachment)\n\nresponse = smartsheet_client.Discussions.create_discussion_on_sheet(\n  9283173393803140,           # sheet_id\n  smartsheet.models.Discussion({\n    'comment': smartsheet.models.Comment({\n      'text': 'This text is the body of the first comment'\n    })\n  })\n)\n\n# Example request: create discussion on sheet (with attachment)\n\nresponse = smartsheet_client.Discussions.create_discussion_on_sheet_with_attachment(\n  9283173393803140,           # sheet_id\n  smartsheet.models.Discussion({\n    'comment': smartsheet.models.Comment({\n      'text': 'This text is the body of the first comment'\n    })\n  }),\n  ('photo.jpg', open('/path/to/photo.jpg', 'rb'), 'image/jpeg')\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/discussions/{discussionId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/discussionId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Get discussion",
        "description": "Gets the discussion specified by discussionId.\n",
        "operationId": "discussion-get",
        "tags": [
          "discussions"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Discussion"
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nDiscussion discussion = smartsheet.SheetResources.DiscussionResources.GetDiscussion(\n  9283173393803140,               // sheetId\n  0123456789012345                // discussionId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/discussions/{discussionId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nDiscussion discussion = smartsheet.sheetResources().discussionResources().getDiscussion(\n        9283173393803140L,       // long sheetId\n        0123456789012345L        // long discussionId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  discussionId: 2331373580117892\n};\n\n// Get discussion\nsmartsheet.sheets.getDiscussions(options)\n  .then(function(discussion) {\n    console.log(discussion);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\ndiscussion = smartsheet_client.Discussions.get_discussion(\n  9283173393803140,       # sheet_id\n  0123456789012345)       # discussion_id\n\n# discussion is an instance of smartsheet.models.Discussion\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete a discussion",
        "description": "Deletes the discussion specified in the URL.\n",
        "operationId": "discussion-delete",
        "tags": [
          "discussions"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.SheetResources.DiscussionResources.DeleteDiscussion(\n  9283173393803140,               // sheetId\n  0123456789012345                // discussionId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/discussions/{discussionId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\\\n-X 'DELETE'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sheetResources().discussionResources().deleteDiscussion(\n        9283173393803140L,       // long sheetId\n        0123456789012345L        // long discussionId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  discussionId: 991393444325252\n};\n\n// Delete discussion\nsmartsheet.sheets.deleteDiscussion(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Discussions.delete_discussion(\n  9283173393803140,       # sheet_id\n  0123456789012345)       # discussion_id\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/discussions/{discussionId}/attachments": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/discussionId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List discussion attachments",
        "description": "Gets a list of all attachments that are in the discussion.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "discussion-listAttachments",
        "tags": [
          "attachments",
          "discussions"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          }
        ],
        "responses": {
          "200": {
            "description": "OK.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of attachments",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Attachment"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPaginatedResult<Attachment> attachments = smartsheet.SheetResources.DiscussionResources.AttachmentResources.ListAttachments(\n  9283173393803140,               // sheetId\n  1234567890123456,               // discussionId\n  null                            // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/discussions/{discussionId}/attachments \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination\nPagedResult<Attachment> attachments = smartsheet.sheetResources().discussionResources().attachmentResources().getAttachments(\n        9283173393803140L,       // long sheetId\n        1234567890123456L,       // long discussionId\n        null                     // PaginationParameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  discussionId: 3962273862576004\n};\n\n// List discussion attachments\nsmartsheet.sheets.listDiscussionAttachments(options)\n  .then(function(attachmentsList) {\n      console.log(attachmentsList);\n  })\n  .catch(function(error) {\n      console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List All\nresponse = smartsheet_client.Attachments.list_discussion_attachments(\n  9283173393803140,       # sheet_id\n  1234567890123456,       # discussion_id\n  include_all=True)\nattachments = response.data\n\n# Sample 2: Paginate the list\nresponse = smartsheet_client.Attachments.list_discussion_attachments(\n  9283173393803140,       # sheet_id\n  1234567890123456,       # discussion_id\n  page_size=10,\n  page=1)\npages = response.total_pages\nattachments = response.data\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/discussions/{discussionId}/comments": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/discussionId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "post": {
        "summary": "Create a comment",
        "description": "Adds a comment to a discussion. To create a comment with an attachment please use \"multipart/form-data\" content type.\n",
        "operationId": "comments-create",
        "tags": [
          "comments"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CommentCreateRequest"
              }
            },
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/CommentCreateRequestWithAttachment"
              },
              "encoding": {
                "comment": {
                  "contentType": "application/json"
                },
                "file": {
                  "contentType": "application/octet-stream"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Comment"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Example request: add comment (without attachment)\n\n// Create comment\nComment commentSpecification = new Comment\n{\n  Text = \"This is a new comment.\"\n};\n\n// Add comment to discussion\nComment newComment = smartsheet.SheetResources.DiscussionResources.CommentResources.AddComment(\n  2252168947361668,               // sheetId\n  3962273862576004,               // discussionId\n  commentSpecification\n);\n\n// Example request: add comment (with attachment)\n\n// Create comment\nComment commentSpecification = new Comment\n{\n  Text = \"This is a new comment.\"\n};\n\n// Add comment (with attachment) to discussion\nComment newComment = smartsheet.SheetResources.DiscussionResources.CommentResources.AddCommentWithAttachment(\n  2252168947361668,                   // sheetId\n  3962273862576004,                   // discussionId\n  commentSpecification,\n  filePath,\n  \"application/octet-stream\"\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "# Example request: add comment (without attachment)\n\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}/discussions/{discussionId}/comments \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"text\":\"This is a new comment.\"}'\n\n# Example request: add comment (with attachment)\n\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}/discussions/{discussionId}/comments \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: multipart/form-data\" \\\n-X POST \\\n-F 'comment={ \"text\":\"This is a new comment.\" };type=application/json' \\\n-F \"file=@insurance_benefits.pdf;type=application/octet-stream\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Example request: add comment (without attachment)\n\n// Create comment\nComment commentSpecification = new Comment()\n        .setText(\"This is a new comment.\");\n\n// Add comment to discussion\n        Comment newComment = smartsheet.sheetResources().discussionResources().commentResources().addComment(\n        2252168947361668L,       // long sheetId\n        3962273862576004L,       // long discussionId\n        commentSpecification\n        );\n\n// Example request: add comment (with attachment)\n\n// Create comment\n        Comment commentSpecification = new Comment()\n        .setText(\"This is a new comment.\");\n\n// Add comment (with attachment) to discussion\n        File file = new File(filePath);\n        smartsheet.sheetResources().discussionResources().commentResources().addCommentWithAttachment(\n        2252168947361668L,       // long sheetId\n        3962273862576004L,       // long discussionId\n        commentSpecification,\n        file,\n        \"application/octet-stream\"\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Example request: add comment (without attachment)\n\n// Specify comment\nvar comment = { \"text\": \"This is a new comment.\" };\n\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  discussionId: 3962273862576004,\n  body: comment\n  };\n\n// Add comment to discussion\nsmartsheet.sheets.addDiscussionComment(options)\n  .then(function(newComment) {\n    console.log(newComment);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n\n// Example request: add comment (with attachment)\n\n// Multipart operations are not supported by the Node SDK. Instead, see instructions to Add Comment, and then Attach File to Comment.\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Example request: add comment (without attachment)\n\nresponse = smartsheet_client.Discussions.add_comment_to_discussion(\n  2252168947361668,       # sheet_id\n  3962273862576004,       # discussion_id\n  smartsheet.models.Comment({\n    'text': 'This is a new comment.'\n  })\n)\n\n# Example request: add comment (with attachment)\n\n# Create comment\ncomment = smartsheet.models.Comment({\n  'text': 'This is a new comment.'\n})\n\n# Add comment (with attachment) to discussion\nresponse = smartsheet_client.Discussions.add_comment_to_discussion_with_attachment(\n  2252168947361668,           # sheet_id\n  3962273862576004,           # discussion_id\n  comment,\n  ('image.png', open('/path/to/image.png', 'rb'), 'image/png')\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/emails": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/Content-Type"
        }
      ],
      "post": {
        "summary": "Send sheet via email",
        "description": "Sends the sheet as a PDF attachment via email to the designated recipients.",
        "operationId": "sheet-send",
        "tags": [
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "SHARE_SHEETS"
            ]
          }
        ],
        "requestBody": {
          "description": "[SheetEmail object](/api/smartsheet/openapi/sendviaemail/sheetemail)\n",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SheetEmail"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify recipients\nRecipient[] recipients = new Recipient[] {\n  new Recipient { Email = \"john.doe@smartsheet.com\" },\n  new Recipient { GroupId = 2258118617917316 }\n};\n\n// Configure email\nSheetEmail sheetEmail = new SheetEmail {\n  SendTo = recipients,\n  Subject = \"Check this report out!\",\n  Message = \"Here are the rows I mentioned in our meeting\",\n  CcMe = false,\n  Format = SheetEmailFormat.PDF,\n  FormatDetails = new FormatDetails { PaperSize = PaperSize.A4 }\n};\n\n// Send sheet via email\nsmartsheet.SheetResources.SendSheet(4293147074291588, sheetEmail);      // sheetId\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/emails \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"sendTo\" : [{\"email\": \"john.doe@smartsheet.com\"}, {\"groupId\": 2258118617917316}], \"subject\": \"Check these rows out!\", \"message\": \"Here is the Sheet I mentioned in our meeting.\", \"ccMe\": false, \"format\": \"PDF\", \"formatDetails\": {\"paperSize\": \"A4\"}}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify individual recipient\nRecipientEmail recipientEmail = new RecipientEmail.AddRecipientEmailBuilder()\n        .setEmail(\"john.doe@smartsheet.com\")\n        .build();\n\n// Specify group recipient\nRecipientGroup recipientGroup = new RecipientGroup.AddRecipientGroupBuilder()\n        .setGroupId(2258118617917316L)\n        .build();\n\n// Set recipients\nList<Recipient> recipients = Arrays.asList(recipientEmail,recipientGroup);\n\n// Set format details\nFormatDetails formatDetails = new FormatDetails();\nformatDetails.setPaperSize(PaperSize.A0);\n\n// Configure email\nSheetEmail email = new SheetEmail.AddSheetEmailBuilder()\n        .setSendTo(recipients)\n        .setSubject(\"Check these rows out!\")\n        .setMessage(\"Here are the rows I mentioned in our meeting\")\n        .setCcMe(false)\n        .setFormat(SheetEmailFormat.PDF)\n        .setFormatDetails(formatDetails)\n        .build();\n\n// Send sheet via email\nsmartsheet.sheetResources().sendSheet(4293147074291588L, email);        // sheetId\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Configure email\nvar email = {\n  \"sendTo\": [\n    {\n      \"email\": \"john.doe@smartsheet.com\"\n    },\n    {\n      \"groupId\": 2258118617917316\n    }\n  ],\n  \"subject\": \"Check these rows out!\",\n  \"message\": \"Here are the rows I mentioned in our meeting\",\n  \"ccMe\": false,\n  \"format\": \"PDF\",\n  \"formatDetails\": {\n    \"paperSize\": \"A4\"\n  }\n};\n\n// Set options\nvar options = {\n  body: email,\n  sheetId: 2252168947361668\n};\n\n// Send sheet via email\nsmartsheet.sheets.sendSheetViaEmail(options)\n  .then(function(data) {\n    console.log(data);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Sheets.send_sheet(\n  4293147074291588,           # sheet_id\n  smartsheet.models.SheetEmail({\n    'send_to': [\n      smartsheet.models.Recipient({'email': 'john.doe@smartsheet.com'}),\n      smartsheet.models.Recipient({'group_id': 2258118617917316})\n    ],\n    'subject': 'Check these rows out!',\n    'message': 'Here are the rows I mentioned in our meeting.',\n    'cc_me': False,\n    'format': 'PDF',\n    'format_details': smartsheet.models.FormatDetails({\n      'paper_size': 'A4'\n    })\n  })\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/move": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/Content-Type"
        }
      ],
      "post": {
        "summary": "Move sheet",
        "description": "Moves the specified sheet to a new location.\nWhen a sheet that is shared to one or more users and/or groups is moved into or out of a workspace, those sheet-level shares are preserved.\n",
        "operationId": "move-sheet",
        "tags": [
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "CREATE_SHEETS"
            ]
          }
        ],
        "requestBody": {
          "description": "Destination to move the specified sheet.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ContainerDestinationForMove"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/SheetCopyMoveResponse"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination\nContainerDestination destination = new ContainerDestination {\n  DestinationId = 7960873114331012,           // destinationFolderId\n  DestinationType = DestinationType.FOLDER,\n};\n\n// Move sheet\nSheet sheet = smartsheet.SheetResources.MoveSheet(\n  4583173393803140,                           // sheetId\n  destination\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/move \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n  \"destinationType\": \"folder\",\n  \"destinationId\": 7960873114331012\n}' \\\n-X POST\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination\nContainerDestination destination = new ContainerDestination();\n        destination.setDestinationType(DestinationType.FOLDER)\n        .setDestinationId(7960873114331012L);\n\n// Move sheet\nSheet sheet = smartsheet.sheetResources().moveSheet(\n        4583173393803140L,                         // long sheetId\n        destination\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set destination information\nvar body = {\n  destinationType: \"folder\",\n  destinationId: 7960873114331012\n};\n\n// Set options\nvar options = {\n  sheetId: 4583173393803140,\n  body: body\n};\n\n// Move sheet\nsmartsheet.sheets.moveSheet(options)\n  .then(function(movedSheet) {\n    console.log(movedSheet);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsheet = smartsheet_client.Sheets.move_sheet(\n  4583173393803140,                       # sheet_id\n  smartsheet.models.ContainerDestination({\n    'destination_type': 'folder',       # folder, workspace, or home\n    'destination_id': 7960873114331012  # folder_id\n  })\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/path": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/sheetId"
        }
      ],
      "get": {
        "summary": "Get sheet path",
        "description": "Gets the hierarchical path of the sheet, showing its location within folders and workspace, if workspace-level access is provided",
        "operationId": "get-sheet-path",
        "tags": [
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Path information for the sheet",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PathSheetResponse"
                }
              }
            }
          },
          "404": {
            "description": "Sheet not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/sheets/{sheetId}/proofs": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          }
        ],
        "summary": "List proofs",
        "description": "Gets a list of all proofs for a given sheet.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "proofs-getAllProofs",
        "tags": [
          "proofs"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "OK.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of all proofs",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Proof"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/proofs \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/proofs/{proofId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/proofId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "parameters": [
          {
            "$ref": "#/components/parameters/proofInclude"
          }
        ],
        "summary": "Get proof",
        "description": "Gets the proof specified in the URL. Returns the proof, which is optionally populated with discussion and attachment objects.\n",
        "operationId": "proofs-get",
        "tags": [
          "proofs"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Proof"
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/proofs/{proofId}?include=attachments,discussions \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete proof",
        "description": "Deletes the proof including all versions. The proofId must be for the original version.\n",
        "operationId": "proofs-delete",
        "tags": [
          "proofs"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/sheets/{sheetId}/proofs/{proofId}' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          }
        ]
      },
      "put": {
        "summary": "Update proof status",
        "description": "Sets the proof status as either complete or incomplete.\n",
        "operationId": "proofs-update",
        "tags": [
          "proofs"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateProofStatusRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Proof"
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/proofs/{proofId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Disposition: attachment; filename=\"abc.bmp\"\" \\\n-X PUT\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/proofs/{proofId}/attachments": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/proofId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List proof attachments",
        "description": "Gets a list of all attachments that are in the proof, excluding discussion-level attachments in the proof.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "proofs-listAttachments",
        "tags": [
          "proofs"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          }
        ],
        "responses": {
          "200": {
            "description": "OK.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of proof attachments",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Attachment"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/proofs/{proofId}/attachments \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          }
        ]
      },
      "post": {
        "summary": "Attach file to proof",
        "description": "Attaches a file to the proof.\n\n> **Important:** The file size limit is 30mb.\n\n> **Note:** Posting a file attachment is resource-intensive and is limited to **30 requests per minute per API token**. For details, see [Rate limiting](/api/smartsheet/guides/advanced-topics/scalability-options#rate-limiting).\n",
        "operationId": "proofs-attachToProof",
        "tags": [
          "proofs"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Attachment"
                        }
                      }
                    }
                  ],
                  "properties": {
                    "version": {
                      "description": "New version of the sheet. Applicable only for operations which update sheet data.",
                      "type": "number",
                      "nullable": true
                    }
                  }
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/proofs/{proofId}/attachments \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: image/gif\" \\\n-H \"Content-Disposition: attachment; filename=\"giphy.gif\"\" \\\n-X POST \\\n--data-binary \"@home/giphy.gif\"\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/proofs/{proofId}/discussions": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/proofId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List proof discussions",
        "description": "Gets a list of all discussions that are in the proof.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "proofs-listDiscussions",
        "tags": [
          "proofs"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/discussionInclude"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          }
        ],
        "responses": {
          "200": {
            "description": "OK.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of proof discussions",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Discussion"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Create proof discussion",
        "description": "Creates a discussion on a proof.\n",
        "operationId": "proofs-createDiscussion",
        "tags": [
          "proofs"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DiscussionCreateRequest"
              }
            },
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/DiscussionWithAttachmentCreateRequest"
              },
              "encoding": {
                "discussion": {
                  "contentType": "application/json"
                },
                "file": {
                  "contentType": "application/octet-stream"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Discussion"
                        }
                      }
                    }
                  ],
                  "properties": {
                    "version": {
                      "description": "New version of the sheet. Applicable only for operations which update sheet data.",
                      "type": "number",
                      "nullable": true
                    }
                  }
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "// Sample 1: create proof discussion (without attachment)\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}/proofs/{proofId}/discussions \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: multipart/form-data \\\n-X POST \\\n--data-binary \"@/home/Downloads/test_b (4).pdf\"\n\n// Sample 2: create proof discussion (with attachment)\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}/proofs/{proofId}/discussions \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: multipart/form-data \\\n-X POST \\\n-F 'discussion={ \"comment\": { \"text\": \"This text is the body of the first comment\" } };type=application/json' \\\n-F \"file=@/home/Downloads/test_b (4).pdf;type=application/octet-stream\"\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/sheets/{sheetId}/proofs/{proofId}/discussions' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/proofs/{proofId}/requestactions": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/proofId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List proof request actions",
        "description": "Gets a summarized list of all request actions associated with the specified proof.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "proofs-listRequestActions",
        "tags": [
          "proofs"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          }
        ],
        "responses": {
          "200": {
            "description": "OK.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of proof request actions",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/ProofRequestAction"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/proofs/{proofId}/requestactions \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/proofs/{proofId}/requests": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/proofId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "delete": {
        "summary": "Delete proof requests",
        "description": "Deletes all proof requests in a proof.\n",
        "operationId": "proofs-deleteProofRequests",
        "tags": [
          "proofs"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/proofs/{proofId}/requests \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          }
        ]
      },
      "post": {
        "summary": "Create proof request",
        "description": "Creates a proof request.\n",
        "operationId": "proofs-createProofRequests",
        "tags": [
          "proofs"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProofRequestBody"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/ProofRequest"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/proofs/{proofId}/requests \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\n  \"sendTo\": [{\n    \"email\": \"john.doe@smartsheet.com\"\n  }],\n  \"subject\": \"This is a test.\"\n}'\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/proofs/{proofId}/versions": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/proofId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List proof versions",
        "description": "Gets a list of all versions of the given proofId in order from newest to oldest.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "proofs-getVersions",
        "tags": [
          "proofs"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          }
        ],
        "responses": {
          "200": {
            "description": "OK.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of proof versions",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Proof"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/proofs/{proofId}/versions \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete proof version",
        "description": "Deletes a proof version. Proof ID must be a current version proof ID.\n",
        "operationId": "proofs-deleteVersion",
        "tags": [
          "proofs"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/proofs/{proofId}/versions \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          }
        ]
      },
      "post": {
        "summary": "Create proof version",
        "description": "Creates a proof version. Proof ID must be for the original proof.\n",
        "operationId": "proofs-createVersion",
        "tags": [
          "proofs"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            },
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "filename": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            },
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/URLAttachmentRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Proof"
                        }
                      }
                    }
                  ],
                  "properties": {
                    "version": {
                      "description": "New version of the sheet. Applicable only for operations which update sheet data.",
                      "type": "number",
                      "nullable": true
                    }
                  }
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/proofs/{proofId}/versions \\\n-H \"Content-Disposition: attachment; filename=\"error.gif\"\" \\\n-H \"Content-Type: image/gif\" \\\n-X POST \\\n--data-binary \"@/home/Downloads/giphy.gif\"\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/publish": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Get sheet publish status",
        "description": "Gets the sheet's 'Publish' settings.\n",
        "operationId": "get-sheetPublish",
        "tags": [
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SheetPublish"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSheetPublish status = smartsheet.SheetResources.GetPublishStatus(\n  4583173393803140            // sheetId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/publish \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSheetPublish status = smartsheet.sheetResources().getPublishStatus(\n        4583173393803140L,       // long sheetId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 4583614634583940\n};\n\n// Get sheet publish status\nsmartsheet.sheets.getPublishStatus(options)\n  .then(function(status) {\n    console.log(status);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Sheets.get_publish_status(\n  4583173393803140)       # sheet_id\nstatus = response.result\n# status is a smartsheet.models.SheetPublish object\n"
          }
        ]
      },
      "put": {
        "summary": "Set sheet publish status",
        "description": "Sets the publish status of the sheet and returns the new status, including the URLs of any enabled publishings.\n",
        "operationId": "set-sheetPublish",
        "tags": [
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "description": "SheetPublish object.\n\nFor Read Only, if you do not specify a value for **readOnlyFullAccessibleBy**, the value defaults\nto the organization-level 'Sheet Publishing' setting (if the sheet owner belongs to an organization account)\nor to **ALL** (if the sheet owner does not belong to an organization account).\n\nFor Read Write, if you do not specify a value for **readWriteAccessibleBy**, the value defaults\nto the organization-level 'Sheet Publishing' setting (if the sheet owner belongs to an organization account)\nor to **ALL** (if the sheet owner does not belong to an organization account).\n",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SheetPublishRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/SheetPublish"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify sheet publish status properties\nSheetPublish publishSpecification = new SheetPublish\n{\n  ReadOnlyLiteEnabled = true,\n  ReadOnlyFullEnabled = false,\n  ReadWriteEnabled = false,\n  IcalEnabled = false\n};\n\n// Set sheet publish status\nSheetPublish updatedStatus = smartsheet.SheetResources.UpdatePublishStatus(\n  4583614634583940,       // sheetId\n  publishSpecification\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/publish \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '{\"readOnlyLiteEnabled\": true,\"readOnlyFullEnabled\": false,\"readWriteEnabled\": false,\"icalEnabled\": false}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify sheet publish status properties\nSheetPublish publishSpecification = new SheetPublish()\n        .setIcalEnabled(false)\n        .setReadOnlyFullEnabled(false)\n        .setReadWriteEnabled(false)\n        .setReadOnlyLiteEnabled(true);\n\n// Set sheet publish status\nSheetPublish updatedStatus = smartsheet.sheetResources().updatePublishStatus(\n        4583614634583940L,       // long sheetId\n        publishSpecification\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify publish status\nvar publishStatus = {\n  \"readOnlyLiteEnabled\": true,\n  \"readOnlyFullEnabled\": false,\n  \"readWriteEnabled\": false,\n  \"icalEnabled\": false\n};\n\n// Set options\nvar options = {\n  sheetId: 4583614634583940,\n  body: publishStatus\n  };\n\n// Set publish status\nsmartsheet.sheets.setPublishStatus(options)\n  .then(function(updatedStatus) {\n    console.log(updatedStatus);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# With the Python SDK, if fewer than all four flags are set, current status is retrieved and merged with the flags that _are_ set with this method call.\n\nupdated_status = smartsheet_client.Sheets.set_publish_status(\n  4583173393803140,       # sheet_id\n  smartsheet.models.SheetPublish({\n    'read_only_lite_enabled': True\n  })\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/rows": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "post": {
        "summary": "Add rows",
        "description": "Inserts one or more rows into the sheet specified in the URL. If you want to insert the rows in any position but the default, use [location-specifier attributes](/api/smartsheet/openapi/rows) (that is, toTop, toBottom, parentId, siblingId, above, indent, outdent). See language tabs for variations in syntax.\n\nNote: This operation does not add rows with cells that have images. However, you can upload an image to a cell *after* the cell exists in a sheet. To do so, call the operation described in the [Add Image to Cell](/api/smartsheet/openapi/cellimages/addimagetocell) page.\n\nThis operation supports both single-object and bulk semantics. For more information, see [Optional Bulk Operations](/api/smartsheet/guides/advanced-topics/scalability-options#bulk-operations).\n",
        "operationId": "rows-addToSheet",
        "tags": [
          "rows"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/accessApiLevel"
          },
          {
            "$ref": "#/components/parameters/Content-Type"
          },
          {
            "$ref": "#/components/parameters/allowPartialSuccess"
          },
          {
            "$ref": "#/components/parameters/overrideValidation"
          }
        ],
        "requestBody": {
          "description": "[Row object](/api/smartsheet/openapi/rows/row) or an array of Row objects, with the following attributes:\n * One or more [location-specifier attributes](/api/smartsheet/openapi/rows) (required)\n * **expanded** (optional)\n * **format** (optional)\n * **cells** (optional) -- if specified, must be an array of [Cell objects](/api/smartsheet/openapi/cells/cell), where each object is limited to the following attributes:\n   * **columnId** (required)\n   * One of the following (required):\n      * **formula**: the formula for the cell. For cross-sheet formulas, you must first define a [cross-sheet reference](/api/smartsheet/openapi/crosssheetreferences)\n      * **value**\n      * **objectValue:** See cell [objectValue](/api/smartsheet/openapi/cells/cell#path=objectvalue) for the various object value schemas.\n   * When **value** is specified\n      * [hyperlink](/api/smartsheet/openapi/schemas/widgethyperlink) (optional) with exactly one of the following attributes set:\n        * **reportId**\n        * **sheetId**\n        * **url**\n      * [linkInFromCell]() (optional) with all of the following attributes set:\n        * **columnId**\n        * **rowId**\n        * **sheetId**\n      * **strict** (optional)\n   * **format** (optional)\n   * **overrideValidation** (optional)\n * **locked** (optional) - **true** to lock the row or **false** to unlock the row.\n\nSee [Column Types](/api/smartsheet/openapi/columns) for more information.\n\n**NOTES:**\n* Column Ids must be valid for the sheet to which the row belongs, and must only be used once for each row in the operation.\n* Cells of a project sheet in the \"Finish Date\" column cannot be updated via API.\n* Cells of a project sheet in the \"Start Date\" column cannot be updated via API for rows that contain a value in the \"Predecessor\" column.\n* Max length for a cell value is 4000 characters after which truncation occurs without warning. Empty string values are converted to null.\n* When adding or updating rows, there is a 500 row limit for each API call.  \n* Calculation errors or problems with a formula do not cause the API call to return an error code. Instead, the response contains the same value as in the UI, such as cell.value = \"#CIRCULAR REFERENCE\".\n* If you are adding or updating a row using *linkInFromCell*, you cannot use *overrideValidation* as a query param. In this case, you must pass *overrideValidation* in the body as a cell update field. Additionally, *linkInFromCell* requires a *value* of null.\n* Any one sheet can have up to 500,000 inbound cell links. (Smartsheet Gov has an inbound cell link limit of 100,000.) \n* If you want to clear a cell link, you can either pass *value* as an empty string or set the *value* to the current value and omit *linkInFromCell*.\n",
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/Row"
                  },
                  {
                    "type": "array",
                    "title": "Row array",
                    "items": {
                      "$ref": "#/components/schemas/Row"
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Returns [Result object](/api/smartsheet/openapi/schemas/result) containing the newly created rows -- either a single [Row object](/api/smartsheet/openapi/rows/row) or array of Row objects, corresponding to what was specified in the request, as well as the new version of the sheet.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/AddedRowResponseListItem"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "When **allowPartialSuccess=false** (or not specified):\n\nIf an error occurs, the [Error object](/api/smartsheet/openapi/schemas/error) returned contains a **detail** attribute set to an object with the following attribute:\n* **index**: the array index of the row that caused the error (0 if a single Row was passed in)\n\nIf any error occurs, the entire request fails (no rows are added), and the error response returned describes the first problem that was encountered. For example:\n```\n{\n  \"errorCode\": 1042,\n  \"message\": \"The cell value in column 5504245941200772 did not conform to the strict requirements for type CHECKBOX.\"\n  \"detail\": {\n    \"index\": 4\n  }\n}\n```\n\nWhen **allowPartialSuccess=true**:\n\nWhen partial success is enabled, and one or more of the objects in the request fail to be added/updated/deleted, a standard [Result object](/api/smartsheet/openapi/schemas/result) is returned, but with a **message** of **'PARTIAL_SUCCESS'** (instead of **'SUCCESS'**), and a **resultCode** of **3**. Additionally, the object contains a **failedItems** attribute -- an array of [BulkItemFailure objects](/api/smartsheet/openapi/schemas/bulkitemfailure) that contains an item for each object in the request that failed to be added/updated/deleted.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify cell values for first row\nCell[] cellsToInsert = new Cell[]\n{\n  new Cell\n  {\n    ColumnId = addedColumns[0].Id,\n    ObjectValue = new MultiPicklistObjectValue(new string[] {\"Bat\", \"Cat\"})\n  }\n};\nRow rowA = new Row\n{\n  ToTop = true,\n  Cells = cellsToInsert\n};\n\n// Specify cell values of second row\nCell[] cellsB = new Cell[] {\n  new Cell\n  {\n    ColumnId = 7960873114331012,\n    Value = true\n  },\n  new Cell\n  {\n    ColumnId = 642523719853956,\n    Value = \"New status\"\n  }\n};\n\n// Specify contents of second row\nRow rowB = new Row\n{\n  ToTop = true,\n  Cells = cellsB\n};\n\n// Add rows to sheet\nIList<Row> newRows = smartsheet.SheetResources.RowResources.AddRows(\n  2331373580117892,               // sheetId\n  new Row[] { rowA, rowB }        // IEnumerable<Row> rowsToAdd\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/rows \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '[{\"toTop\":true, \"cells\": [ {\"columnId\": 7960873114331012, \"value\": true}, {\"columnId\": 642523719853956, \"value\": \"New status\", \"strict\": false} ] }, {\"toTop\":true, \"cells\": [ {\"columnId\": 7960873114331012, \"value\": true}, {\"columnId\": 642523719853956, \"value\": \"New status\", \"strict\": false} ] }]'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify cell values for first row\nList<Cell> rowACells = Arrays.asList(\n        new Cell(7960873114331012L)   // column Id\n        .setValue(true),\n        new Cell(642523719853956L)    // column Id\n        .setValue(\"New status\")\n        );\n\n// Specify contents of first row\nRow rowA = new Row();\nrowA.setCells(rowACells)\n        .setToBottom(true);\n\n// Specify cell values for second row\nList<Cell> rowBCells = Arrays.asList(\n        new Cell(7960873114331012L)\n        .setValue(true),\n        new Cell(642523719853956L)\n        .setValue(\"New status\")\n        );\n\n// Specify contents of second row\nRow rowB = new Row();\nrowB.setCells(rowBCells)\n        .setToBottom(true);\n\n// Add rows to sheet\nList<Row> newRows = smartsheet.sheetResources().rowResources().addRows(\n        1639534409607044L,    // sheet Id\n        Arrays.asList(rowA, rowB));\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify rows\nvar row = [\n  {\n    \"toTop\": true,\n    \"cells\": [\n      {\n        \"columnId\": 7960873114331012,\n        \"value\": true\n      },\n      {\n        \"columnId\": 642523719853956,\n        \"value\": \"New status\",\n        \"strict\": false\n      }\n    ]\n  },\n  {\n    \"toTop\": true,\n    \"cells\": [\n      {\n        \"columnId\": 7960873114331012,\n        \"value\": true\n      },\n      {\n        \"columnId\": 642523719853956,\n        \"value\": \"New status\",\n        \"strict\": false\n      }\n    ]\n  }\n];\n\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  body: row\n  };\n\n// Add rows to sheet\nsmartsheet.sheets.addRows(options)\n  .then(function(newRows) {\n    console.log(newRows);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Specify cell values for one row\nrow_a = smartsheet.models.Row()\nrow_a.to_top = True\nrow_a.cells.append({\n  'column_id': 7960873114331012,\n  'value': True\n})\nrow_a.cells.append({\n  'column_id': 642523719853956\n  'value': 'New Status',\n  'strict': False\n})\n\n# Specify cell values for another row\nrow_b = smartsheet.models.Row()\nrow_b.to_top = True\nrow_b.cells.append({\n  'column_id': 7960873114331012,\n  'value': True\n})\nrow_b.cells.append({\n  'column_id': 642523719853956\n  'value': 'New Status',\n  'strict': False\n})\n\n# Add rows to sheet\nresponse = smartsheet_client.Sheets.add_rows(\n  2331373580117892,       # sheet_id\n  [row_a, row_b])\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete rows",
        "description": "Deletes one or more rows from the sheet specified in the URL.",
        "operationId": "delete-rows",
        "tags": [
          "rows"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/rowIds"
          },
          {
            "$ref": "#/components/parameters/ignoreRowsNotFound"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns [Result object](/api/smartsheet/openapi/schemas/result) containing row Ids corresponding to all rows that were successfully deleted (including any child rows of rows specified in the URL).",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "array",
                          "items": {
                            "type": "number"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404"
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify 'ignoreRowsNotFound' parameter with value of 'true'\nsmartsheet.SheetResources.RowResources.DeleteRows(\n  2252168947361668,                                    // sheetId\n  new long[] { 207098194749316, 207098194749317 },     // rowIds\n  true                                                 // Boolean ignoreRowsNotFound\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/sheets/{sheetId}/rows?ids={rowId1},{rowId2},{rowId3}&ignoreRowsNotFound=true' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify 'ignoreRowsNotFound' parameter with value of 'true'\nsmartsheet.sheetResources().rowResources().deleteRows(\n        2252168947361668L,               // long sheetId\n        new HashSet(Arrays.asList(\n        207098194749316L,            // long rowId,\n        207098194749317L,            // long additional rowId\n        207098194749318L,)           // long additional rowId\n        true                             // Boolean ignoreRowsNotFound\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  rowId: 207098194749316\n};\n\n// Delete row\nsmartsheet.sheets.deleteRow(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Sheets.delete_rows(\n  2252168947361668,                       # sheet_id\n  [207098194749316, 207098194749317])     # row_ids\n"
          }
        ]
      },
      "put": {
        "summary": "Update rows",
        "description": "Updates cell values in the specified rows, expands/collapses the specified rows, or modifies the position of specified rows (including indenting/outdenting). For detailed information about changing row positions, see [location-specifier attributes](/api/smartsheet/openapi/rows).\n\nNote: This operation does not handle adding images to cells. However, you can upload an image to a cell by calling the operation described in the [Add Image to Cell](/api/smartsheet/openapi/cellimages/addimagetocell) page.\n",
        "operationId": "update-rows",
        "tags": [
          "rows"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/accessApiLevel"
          },
          {
            "$ref": "#/components/parameters/Content-Type"
          },
          {
            "$ref": "#/components/parameters/allowPartialSuccess"
          },
          {
            "$ref": "#/components/parameters/overrideValidation"
          }
        ],
        "requestBody": {
          "description": "[Row object](/api/smartsheet/openapi/rows/row) or an array of Row objects, with the following attributes:\n* **id** (required)\n* One or more [location-specifier attributes](/api/smartsheet/openapi/rows) (optional)\n* **expanded** (optional)\n* **format** (optional)\n* **cells** (optional) -- if specified, must be an array of [Cell objects](/api/smartsheet/openapi/cells/cell), where each object is limited to the following attributes:\n  * **columnId** (required)\n  * One of the following (required):\n    * **formula**: the formula for the cell. For cross-sheet formulas, you must first define a [cross-sheet reference](/api/smartsheet/openapi/crosssheetreferences)\n    * **value**: a desired value, a label for a **hyperlink** you're inserting (see below), or an empty string `\"\"` if you're linking to another cell (see **linkInFromCell** below).\n    * **objectValue:** See cell [objectValue](/api/smartsheet/openapi/cells/cell#path=objectvalue) for the various object value schemas.\n  * **hyperlink**: (optional) a link to a report, sheet, or URL. Note, you must set the **value** attribute (e.g., set to a label you want or set to an empty string `\"\"` to use the linked item's title). Specify the one attribute applicable to the item you're linking:\n      * **reportId**\n      * **sheetId**\n      * **url**\n  * **linkInFromCell** (optional) links in another cell's value. Smartsheet synchronizes the source cell into this cell. Note, the synchronization may take several minutes. Set all of the following attributes:\n    * **columnId**\n    * **rowId**\n    * **sheetId**\n  * **strict** (optional) - Set it `false` for lenient value parsing; default is `true`. See [Cell value parsing](/api/smartsheet/openapi/cells) for details.\n  * **format** (optional)\n  * **image** (optional) -- object for setting a cell image's attributes, such as its alternate text (e.g., `altText = string`).\n  * **overrideValidation** (optional)\n* **locked** (optional) - **true** to lock the row or **false** to unlock the row.\n\nSee [Column Types](/api/smartsheet/openapi/columns) for more information.\n\n**Note:**\n* Column Ids must be valid for the sheet to which the row belongs, and must only be used once for each row in the operation.\n* Cells of a project sheet in the \"Finish Date\" column cannot be updated via API.\n* Cells of a project sheet in the \"Start Date\" column cannot be updated via API for rows that contain a value in the \"Predecessor\" column.\n* Max length for a cell value is 4000 characters after which truncation occurs without warning. Empty string values are converted to null.\n* Calculation errors or problems with a formula do not cause the API call to return an error code. Instead, the response contains the same value as in the UI, such as cell.value = \"#CIRCULAR REFERENCE\".\n",
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/Row"
                  },
                  {
                    "type": "array",
                    "title": "Row array",
                    "items": {
                      "$ref": "#/components/schemas/Row"
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Returns [Result object](/api/smartsheet/openapi/schemas/result) containing an array of the updated rows.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/UpdateRowsObject"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "When **allowPartialSuccess=false** (or not specified):\n\nIf an error occurs, the [Error object](/api/smartsheet/openapi/schemas/error) returned contains a **detail** attribute set to an object with the following attribute:\n* **index**: the array index of the row that caused the error (0 if a single Row was passed in)\n* **rowId**: the id of the row that caused the error (omitted if the row was missing an Id)\n\nIf any error occurs, the entire request fails (no rows are added), and the error response returned describes the first problem that was encountered. For example:\n```\n{\n\"errorCode\": 1042,\n\"message\": \"The cell value in column 5504245941200772 did not conform to the strict requirements for type CHECKBOX.\"\n\"detail\": {\n  \"index\": 4\n  \"rowId\": 6572427401553796\n  }\n}\n```\nWhen **allowPartialSuccess=true**:\n\nWhen partial success is enabled, and one or more of the objects in the request fail to be added/updated/deleted, a standard [Result object](/api/smartsheet/openapi/schemas/result) is returned, but with a **message** of **'PARTIAL_SUCCESS'** (instead of **'SUCCESS'**), and a **resultCode** of **3**. Additionally, the object contains a **failedItems** attribute -- an array of [BulkItemFailure objects](/api/smartsheet/openapi/schemas/bulkitemfailure) that contains an item for each object in the request that failed to be added/updated/deleted.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify updated value for first cell\nvar cellToUpdateA = new Cell\n{\n  ColumnId = 7518312134403972,\n  Value = \"new value\"\n};\n\n// Specify updated value for second cell\nvar cellToUpdateB = new Cell\n{\n  ColumnId = 1888812600190852,\n  Value = \"A\"\n};\n\n// Identify row and add new cell values to it\nvar rowToUpdate = new Row\n{\n  Id = 6572427401553796,\n  Cells = new Cell[] { cellToUpdateA, cellToUpdateB }\n};\n\nIList<Row> updatedRow = smartsheet.SheetResources.RowResources.UpdateRows(\n  2068827774183300,    // sheet Id\n  new Row[] {rowToUpdate}\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/rows \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '[{\"id\": \"6572427401553796\", \"cells\": [{\"columnId\": 7518312134403972,\"image\": {\"altText\": \"New Alt Text\"},\"value\": \"new value\"}, {\"columnId\": 1888812600190852,\"value\": \"A\"}]}, {\"id\": \"2068827774183300\", \"cells\": [{\"columnId\": 7518312134403972,\"value\": \"desc_updated\"}, {\"columnId\": 1888812600190852,\"value\": \"B\"}, {\"columnId\": 6552023773538180,\"objectValue\": {\"objectType\": \"MULTI_CONTACT\",\"values\": [{\"objectType\": \"CONTACT\",\"email\": \"john.doe@smartsheet.com\",\"name\": \"John Doe\"}, {\"objectType\": \"CONTACT\",\"email\": \"jane.roe@smartsheet.com\",\"name\": \"Jane Roe\"}]}}]}]'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify updated cell values for first row\nCell cellA = new Cell(7518312134403972L)   // column Id\n        .setValue(\"new value\");\n\nCell cellB = new Cell(6392412227561348L)   // column Id\n        .setValue(123);\n\nRow rowA = new Row(2068827774183300L);\n        rowA.setCells(Arrays.asList(cellA, cellB));\n\n// Specify updated cell values for second row\nCell cellC = new Cell(7518312134403972L)\n        .setValue(\"desc_updated\");\n\nCell cellD = new Cell(6392412227561348L)\n        .setValue(456);\n\nRow rowB = new Row(6572427401553796L);\n        rowB.setCells(Arrays.asList(cellC, cellD));\n\n// Update rows in sheet\nList<Row> updatedRows = smartsheet.sheetResources().rowResources().updateRows(\n        1639534409607044L,                      // long sheetId\n        Arrays.asList(rowA, rowB)\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify updated cell values\nvar row = [\n  {\n    \"id\": \"6572427401553796\",\n    \"cells\": [\n      {\n        \"columnId\": 7518312134403972,\n        \"value\": \"new value\"\n      },\n      {\n        \"columnId\": 1888812600190852,\n        \"value\": \"A\"\n      }\n    ]\n  },\n  {\n    \"id\": \"2068827774183300\",\n    \"cells\": [\n      {\n        \"columnId\": 7518312134403972,\n        \"value\": \"desc_updated\"\n      },\n      {\n        \"columnId\": 1888812600190852,\n        \"value\": \"B\"\n      }\n    ]\n  }\n];\n\n// Set options\nvar options = {\n  sheetId: 2068827774183300,\n  body: row\n  };\n\n// Update rows in sheet\nsmartsheet.sheets.updateRow(options)\n  .then(function(updatedRows) {\n    console.log(updatedRows);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Build new cell value\nnew_cell = smartsheet.models.Cell()\nnew_cell.column_id = 7036894123976580\nnew_cell.value = \"new value\"\nnew_cell.strict = False\n\n# Build the row to update\nnew_row = smartsheet.models.Row()\nnew_row.id = 6809535313667972\nnew_row.cells.append(new_cell)\n\n# Update rows\nupdated_row = smartsheet_client.Sheets.update_rows(\n  2068827774183300,      # sheet_id\n  [new_row])\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/rows/emails": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "post": {
        "summary": "Send rows via email",
        "description": "Sends one or more rows via email.",
        "operationId": "rows-send",
        "tags": [
          "rows"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "SHARE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "description": "The columns included for each row in the email are populated according to the following rules:\n* If the **columnIds** attribute of the MultiRowEmail object is specified as an array of column Ids, those specific columns are included.\n* If the **columnIds** attribute of the MultiRowEmail object is omitted, all columns except hidden columns shall be included.\n* If the **columnIds** attribute of the MultiRowEmail object is specified as empty, no columns shall be included. (**Note:** In this case, either **includeAttachments=true** or **includeDiscussions=true** must be specified.)\n",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MultiRowEmail"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify recipients\nRecipient[] recipients = new Recipient[] {\n  new Recipient { Email = \"recipient@smartsheet.com\" }\n};\n\n// Configure email\nMultiRowEmail multiRowEmail = new MultiRowEmail {\n  SendTo = recipients,\n  Subject = \"some subject\",\n  Message = \"some message\",\n  CcMe = false,\n  RowIds = new long[] { 6327127650920324, 3404239197235076 },\n  ColumnIds = new long[] { 5190835902932868, 3791509922310020 },\n  IncludeAttachments = false,\n  IncludeDiscussions = false\n};\n\n// Send rows via email\nsmartsheet.SheetResources.RowResources.SendRows(4293147074291588, multiRowEmail);       // sheetId\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/rows/emails \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\n  \"sendTo\": [\n    {\"email\": \"recipient@smartsheet.com\"}\n  ],\n  \"subject\": \"Check these rows out!\",\n  \"message\": \"Here are the rows I mentioned in our meeting\",\n  \"ccMe\": false,\n  \"rowIds\": [\n    6327127650920324, 3404239197235076\n  ],\n  \"columnIds\": [\n    5190835902932868, 3791509922310020\n  ],\n  \"includeAttachments\": false,\n  \"includeDiscussions\": false\n}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify recipients\nRecipientEmail recipientEmail = new RecipientEmail.AddRecipientEmailBuilder()\n        .setEmail(\"recipient@smartsheet.com\")\n        .build();\n\nList<Recipient> recipients = new ArrayList<Recipient>();\nrecipients.add(recipientEmail);\n\n// Configure email\nMultiRowEmail multiRowEmail = new MultiRowEmail.AddMultiRowEmailBuilder()\n        .setSendTo(recipients)\n        .setSubject(\"some subject\")\n        .setMessage(\"some message\")\n        .setCcMe(false)\n        .setRowIds(Arrays.asList(6327127650920324L, 3404239197235076L)\n        .setColumnIds(Arrays.asList(5190835902932868L, 3791509922310020L)\n        .setIncludeAttachments(false)\n        .setIncludeDiscussions(false)\n        .build();\n\n// Send rows via email\nsmartsheet.sheetResources().rowResources().sendRows(4293147074291588L, multiRowEmail);   // sheetId\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Configure email\nvar email = {\n  \"sendTo\": [\n    {\n      \"email\": \"john.doe@smartsheet.com\"\n    },\n    {\n      \"groupId\": 2258118617917316\n    }\n  ],\n  \"subject\": \"Check these rows out!\",\n  \"message\": \"Here are the rows I mentioned in our meeting\",\n  \"ccMe\": false,\n  \"includeDiscussions\": false,\n  \"includeAttachments\": true,\n  \"rowIds\": [\n    1049041315358596,\n    5552640942729092\n  ]\n};\n\n// Set options\nvar options = {\n  \"body\": email,\n  \"sheetId\": 2252168947361668\n};\n\n// Send row via email\nsmartsheet.sheets.sendRows(options)\n  .then(function(data) {\n    console.log(data);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Configure email\nemail = smartsheet.models.MultiRowEmail()\nemail.send_to = smartsheet.models.Recipient({\n  'email': 'john.doe@smartsheet.com'\n})\nemail.row_ids = [6327127650920324, 3404239197235076]\nemail.column_ids = [5190835902932868, 3791509922310020]\n\n# Send rows via email\nresponse = smartsheet_client.Sheets.send_rows(\n  4293147074291588,       # sheet_id\n  email)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/rows/copy": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "post": {
        "summary": "Copy rows to another sheet",
        "description": "Copies rows from the sheet specified in the URL to (the bottom of) another sheet.",
        "operationId": "copy-rows",
        "tags": [
          "rows"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          },
          {
            "$ref": "#/components/parameters/copyRowsInclude"
          },
          {
            "$ref": "#/components/parameters/ignoreRowsNotFoundForCopyRows"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CopyOrMoveRowDirective"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "CopyOrMoveRowResult object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CopyOrMoveRowResult"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination sheet\nCopyOrMoveRowDestination destination = new CopyOrMoveRowDestination { SheetId = 2258256056870788 };\n\n// Specify rows to be copied (and destination sheet)\nCopyOrMoveRowDirective directive = new CopyOrMoveRowDirective { RowIds = new long[] { 145417762563972, 8026717110462340 }, To = destination };\n\n// Sample 1: Omit 'include' and 'ignoreRowsNotFound' parameters\nCopyOrMoveRowResult results = smartsheet.SheetResources.RowResources.CopyRowsToAnotherSheet(\n  4583173393803140,           // sheetId\n  directive,\n  null,                       // IEnumerable<CopyRowInclusion> include\n  null                        // Nullable<bool> ignoreRowsNotFound\n);\n\n// Sample 2: Specify 'include' parameter with value of \"CHILDREN\", and 'ignoreRowsNotFound' parameter with value of 'true'\nCopyOrMoveRowResult results = smartsheet.SheetResources.RowResources.CopyRowsToAnotherSheet(\n  4583173393803140,           // sheetId\n  directive,\n  new CopyRowInclusion[] {\n    CopyRowInclusion.CHILDREN },\n  true\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/rows/copy \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{ \"rowIds\": [145417762563972, 8026717110462340], \"to\": {\"sheetId\": 2258256056870788} }'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination sheet\nCopyOrMoveRowDestination destination = new CopyOrMoveRowDestination()\n        .setSheetId(2258256056870788L);\n\n// Specify rows to be copied (and destination sheet)\nCopyOrMoveRowDirective directive = new CopyOrMoveRowDirective()\n        .setRowIds(Arrays.asList(145417762563972L, 8026717110462340L))\n        .setTo(destination);\n\n// Sample 1: Omit 'include' and 'ignoreRowsNotFound' parameters\nCopyOrMoveRowResult results = smartsheet.sheetResources().rowResources().copyRows(\n        4583173393803140L,                        // long sheetId\n        null,                                     // EnumSet<RowCopyInclusion> includes\n        true,                                     // Boolean ignoreRowsNotFound\n        directive\n        );\n\n// Sample 2: Specify 'include' parameter with value of \"CHILDREN\", and 'ignoreRowsNotFound' parameter with value of 'true'\nCopyOrMoveRowResult results = smartsheet.sheetResources().rowResources().copyRows(\n        4583173393803140L,                        // long sheetId\n        EnumSet.of(RowCopyInclusion.CHILDREN),\n        true,\n        directive\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify the directive\nvar copyRow = {\n  \"rowIds\": [145417762563972,8026717110462340],\n  \"to\": {\n    \"sheetId\": 2258256056870788\n  }\n};\n\n// Set options\nvar options = {\n  sheetId: 4583173393803140,\n  body: copyRow\n  };\n\n// Copy rows\nsmartsheet.sheets.copyRowToAnotherSheet(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Sheets.copy_rows(\n  4583173393803140,               # sheet_id of rows to be copied\n  smartsheet.models.CopyOrMoveRowDirective({\n    'row_ids': [145417762563972, 8026717110462340],\n    'to': smartsheet.models.CopyOrMoveRowDestination({\n      'sheet_id': 2258256056870788\n    })\n  })\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/rows/move": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "post": {
        "summary": "Move rows to another sheet",
        "description": "Moves rows from the sheet specified in the URL to (the bottom of) another sheet.",
        "operationId": "move-rows",
        "tags": [
          "rows"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          },
          {
            "$ref": "#/components/parameters/moveRowsInclude"
          },
          {
            "$ref": "#/components/parameters/ignoreRowsNotFoundForMoveRows"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CopyOrMoveRowDirective"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "CopyOrMoveRowResult object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CopyOrMoveRowResult"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination sheet\nCopyOrMoveRowDestination destination = new CopyOrMoveRowDestination { SheetId = 2258256056870788 };\n\n// Specify rows to be moved (and destination sheet)\nCopyOrMoveRowDirective directive = new CopyOrMoveRowDirective { RowIds = new long[] { 145417762563972, 8026717110462340 }, To = destination };\n\n// Sample 1: Omit 'include' and 'ignoreRowsNotFound' parameters\nCopyOrMoveRowResult results = smartsheet.SheetResources.RowResources.MoveRowsToAnotherSheet(\n  4583173393803140,               // sheetId\n  directive,\n  null,                           // IEnumerable<MoveRowInclusion> include\n  null                            // Nullable<bool> ignoreRowsNotFound\n);\n\n// Sample 2: Specify 'include' parameter with value of \"ATTACHMENTS\" and \"DISCUSSIONS\", and 'ignoreRowsNotFound' parameter with value of 'true'\nCopyOrMoveRowResult results = smartsheet.SheetResources.RowResources.MoveRowsToAnotherSheet(\n  4583173393803140,               // sheetId\n  directive,\n  new MoveRowInclusion[] {\n    MoveRowInclusion.ATTACHMENTS,\n    MoveRowInclusion.DISCUSSIONS },\n  true                            // Nullable<bool> ignoreRowsNotFound\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/rows/move \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{ \"rowIds\": [145417762563972, 8026717110462340], \"to\": {\"sheetId\": 2258256056870788} }'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination sheet\nCopyOrMoveRowDestination destination = new CopyOrMoveRowDestination()\n        .setSheetId(2258256056870788L);\n\n// Specify rows to be moved (and destination sheet)\nCopyOrMoveRowDirective directive = new CopyOrMoveRowDirective()\n        .setRowIds(Arrays.asList(145417762563972L, 8026717110462340L))\n        .setTo(destination);\n\n// Sample 1: Omit 'include' and 'ignoreRowsNotFound' parameters\nCopyOrMoveRowResult results = smartsheet.sheetResources().rowResources().moveRows(\n        4583173393803140L,                  // long sheetId\n        null,                               // EnumSet<RowMoveInclusion> includes\n        true,                               // Boolean ignoreRowsNotFound\n        directive\n        );\n\n// Sample 2: Specify 'include' parameter with value of \"ATTACHMENTS\" and \"DISCUSSIONS\", and 'ignoreRowsNotFound' parameter with value of 'true'\nCopyOrMoveRowResult results = smartsheet.sheetResources().rowResources().moveRows(\n        4583173393803140L,                  // long sheetId\n        EnumSet.of(\n        RowMoveInclusion.ATTACHMENTS,\n        RowMoveInclusion.DISCUSSIONS),\n        true,                               // Boolean ignoreRowsNotFound\n        directive\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify the directive\nvar moveRow = {\n  \"rowIds\": [145417762563972,8026717110462340],\n  \"to\": {\n    \"sheetId\": 2258256056870788\n  }\n};\n\n// Set options\nvar options = {\n  sheetId: 4583173393803140,\n  body: moveRow\n  };\n\n// Move rows\nsmartsheet.sheets.moveRowToAnotherSheet(options)\n  .then(function(movedRow) {\n    console.log(movedRow);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Sheets.move_rows(\n  4583173393803140,           # sheet_id of rows to be moved\n  smartsheet.models.CopyOrMoveRowDirective({\n    'row_ids': [145417762563972, 8026717110462340],\n    'to': smartsheet.models.CopyOrMoveRowDestination({\n      'sheet_id': 2258256056870788\n    })\n  })\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/rows/{rowId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/rowId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Get row",
        "description": "Gets the row specified in the URL.",
        "operationId": "row-get",
        "parameters": [
          {
            "$ref": "#/components/parameters/accessApiLevel"
          },
          {
            "$ref": "#/components/parameters/rowInclude"
          },
          {
            "$ref": "#/components/parameters/sheetExclude"
          },
          {
            "$ref": "#/components/parameters/sheetLevel"
          }
        ],
        "tags": [
          "rows"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns [Row object]() populated according to the specified parameters.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "description": "Row ID.",
                      "type": "number"
                    },
                    "sheetId": {
                      "description": "Parent sheet ID.",
                      "type": "number"
                    },
                    "rowNumber": {
                      "description": "Row number within the sheet.",
                      "type": "number",
                      "minimum": 1
                    },
                    "expanded": {
                      "description": "Indicates whether the row is expanded or collapsed.",
                      "type": "boolean"
                    },
                    "cells": {
                      "description": "Cells objects.",
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/cellObjectForRows"
                      }
                    },
                    "createdAt": {
                      "$ref": "#/components/schemas/Timestamp"
                    },
                    "modifiedAt": {
                      "$ref": "#/components/schemas/Timestamp"
                    }
                  }
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit 'include' parameter and pagination parameters\nRow row = smartsheet.SheetResources.RowResources.GetRow(\n  4583173393803140,               // sheetId\n  2361756178769796,               // rowId\n  null,                           // IEnumerable<RowInclusion> include\n  null                            // IEnumerable<RowExclusion> exclude\n);\n\n// Specify 'include' parameter with values of \"COLUMNS\" and \"COLUMN_TYPE\", and 'exclude' parameter with value of \"NONEXISTENT_CELLS\"\nRow row = smartsheet.SheetResources.RowResources.GetRow(\n  4583173393803140,               // sheetId\n  2361756178769796,               // rowId\n  new RowInclusion[] {\n    RowInclusion.COLUMNS,\n    RowInclusion.COLUMN_TYPE },\n  new ObjectExclusion[] { ObjectExclusion.NONEXISTENT_CELLS }\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/sheets/{sheetId}/rows/{rowId}?include=discussions,attachments,columns,columnType' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Omit 'include' parameter and pagination parameters\nRow row = smartsheet.sheetResources().rowResources().getRow(\n        4583173393803140L,       // long sheetId\n        2361756178769796L,       // long rowId\n        null,                    // EnumSet<RowInclusion> includes\n        null                     // EnumSet<ObjectExclusion> excludes\n        );\n\n// Sample 2: Specify 'include' parameter with values of \"COLUMNS\" and \"COLUMN_TYPE\", and 'exclude' parameter with value of \"NONEXISTENT_CELLS\"\nRow row = smartsheet.sheetResources().rowResources().getRow(\n        4583173393803140L,       // long sheetId\n        2361756178769796L,       // long rowId\n        EnumSet.of(\n        RowInclusion.COLUMNS,\n        RowInclusion.COLUMN_TYPE),\n        EnumSet.of(\n        ObjectExclusion.NONEXISTENT_CELLS)\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 4583173393803140,\n  rowId: 2361756178769796\n};\n\n// Get row\nsmartsheet.sheets.getRow(options)\n  .then(function(row) {\n    console.log(row);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Get row\nrow = smartsheet_client.Sheets.get_row(\n  4583173393803140,       # sheet_id\n  2361756178769796        # row_id\n)\n\n# Sample 2: Include discussions, attachments, columns, and columnType\nrow = smartsheet_client.Sheets.get_row(\n  4583173393803140,       # sheet_id\n  2361756178769796,       # row_id\n  include='discussions,attachments,columns,columnType'\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/rows/{rowId}/attachments": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/rowId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List row attachments",
        "description": "Gets a list of all attachments that are on the row, including row and discussion-level attachments.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "attachments-listOnRow",
        "tags": [
          "attachments"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          }
        ],
        "responses": {
          "200": {
            "description": "OK.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of attachments",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Attachment"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPaginatedResult<Attachment> attachments = smartsheet.SheetResources.RowResources.AttachmentResources.ListAttachments(\n  2252168947361668,               // sheetId\n  4293147074291588,               // rowId\n  null                            // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/rows/{rowId}/attachments \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination\nPagedResult<Attachment> attachments = smartsheet.sheetResources().rowResources().attachmentResources().getAttachments(\n        2252168947361668L,       // long sheetId\n        4293147074291588L,       // long rowId\n        null                     // PaginationParameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  rowId: 4293147074291588\n};\n\n// List row attachments\nsmartsheet.sheets.getRowAttachments(options)\n  .then(function(attachmentsList) {\n      console.log(attachmentsList);\n  })\n  .catch(function(error) {\n      console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List all\nresponse = smartsheet_client.Attachments.list_row_attachments(\n  2252168947361668,       # sheet_id\n  4293147074291588,       # row_id\n  include_all=True)\nattachments = response.data\n\n# Sample 2: Paginate the list\nresponse = smartsheet_client.Attachments.list_row_attachments(\n  2252168947361668,       # sheet_id\n  4293147074291588,       # row_id\n  page_size=10,\n  page=1)\npages = response.total_pages\nattachments = response.data\n"
          }
        ]
      },
      "post": {
        "summary": "Attach file or URL to row",
        "description": "Attaches a file to the row. The URL can be any of the following:\n\n* Normal URL (attachmentType \"LINK\")\n* Box.com URL (attachmentType \"BOX_COM\")\n* Dropbox URL (attachmentType \"DROPBOX\")\n* Egnyte URL (attachmentType \"EGNYTE\")\n* Evernote URL (attachmentType \"EVERNOTE\")\n* Google Drive URL (attachmentType \"GOOGLE_DRIVE\")\n* OneDrive URL (attachmentType \"ONEDRIVE\")\n\n> **Important:** Smartsheet Gov allows only the following attachment types:\n> - BOX_COM\n> - FILE\n> - GOOGLE_DRIVE\n> - LINK\n> - ONEDRIVE\n\n> **Important:** The file size limit is 30mb.\n\nFor multipart uploads please use \"multipart/form-data\" content type.\n\n> **Note:** Posting a file attachment is resource-intensive and is limited to **30 requests per minute per API token**. For details, see [Rate limiting](/api/smartsheet/guides/advanced-topics/scalability-options#rate-limiting).\n",
        "operationId": "row-attachments-attachFile",
        "tags": [
          "attachments"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            },
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "filename": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            },
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/URLAttachmentRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Attachment"
                        }
                      }
                    }
                  ],
                  "properties": {
                    "version": {
                      "description": "New version of the sheet. Applicable only for operations which update sheet data.",
                      "type": "number",
                      "nullable": true
                    }
                  }
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nAttachment attachment = smartsheet.SheetResources.RowResources.AttachmentResources.AttachFile(\n  9283173393803140,           // sheetId\n  0123456789012345,           // rowId\n  filePath,\n  \"application/msword\"\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/rows/{rowId}/attachments \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/msword\" \\\n-H 'Content-Disposition: attachment; filename=\"ProgressReport.docx\"' \\\n-H \"Content-Length: FILE_SIZE\" \\\n-X POST \\\n--data-binary @ProgressReport.docx\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify file to be attached\nFile file = new File(\"/Users/jdoe/Documents/ProgressReport.docx\");\n\n// Attach file to row\n        Attachment attachment = smartsheet.sheetResources().rowResources().attachmentResources().attachFile(\n        9283173393803140L,       // long sheetId\n        0123456789012345L,       // long rowId\n        file,\n        \"application/msword\"\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Enable FileStream\nvar fs = require(\"fs\")\n\n// Set options\nvar options = {\n  sheetId: 1696803624483716,\n  rowId: 1049041355358596,\n  fileSize: 20765,\n  fileName: \"ProgressReport.docx\",\n  fileStream: fs.createReadStream(\"/Users/jdoe/Documents/ProgressReport.docx\")\n};\n\n// Attach file to row\nsmartsheet.sheets.addRowFileAttachment(options)\n  .then(function(attachment) {\n      console.log(attachment);\n  })\n  .catch(function(error) {\n      console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nupdated_attachment = smartsheet_client.Attachments.attach_file_to_row(\n  9283173393803140,       # sheet_id\n  0123456789012345,       # row_id\n  ('ProgressReport.docx',\n    open('/path/to/ProgressReport.docx', 'rb'),\n    'application/msword')\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/rows/{rowId}/columns/{columnId}/cellimages": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/rowId"
        },
        {
          "$ref": "#/components/parameters/columnId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "post": {
        "summary": "Add image to cell",
        "description": "Uploads an image to the specified cell within a sheet.",
        "operationId": "addImageToCell",
        "tags": [
          "cellImages"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          },
          {
            "$ref": "#/components/parameters/Content-Disposition"
          },
          {
            "$ref": "#/components/parameters/Content-Length"
          },
          {
            "$ref": "#/components/parameters/altText"
          },
          {
            "$ref": "#/components/parameters/overrideValidation"
          }
        ],
        "requestBody": {
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Row"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nImage image = new Image\n  {\n    AltText = \"Caution Sign\",\n    Height = 16,\n    Width = 16\n  };\n\nsmartsheet.SheetResources.RowResources.CellResources.AddImageToCell(\n  1696831624483716, // sheetId\n  1049441315358596, // rowId\n  74761903175665540, // columnId\n  \"/Users/jdoe/Documents/images/img_pl_decisionshapesHold.png\",\n  \"image\"\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/sheets/{sheetId}/rows/{rowId}/columns/{columnId}/cellimages?altText=my%20image' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: image/jpeg\" \\\n-H 'Content-Disposition: attachment; filename=\"picture.jpg\"' \\\n-H \"Content-Length: FILE_SIZE\" \\\n-X POST \\\n--data-binary @picture.jpg\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nImage image = new Image()\n        .setAltText(\"Caution sign\")\n        .setHeight(16L)\n        .setWidth(16L);\n\n        smartsheet.sheetResources().rowResources().cellResources().addImageToCell(\n        1639534409607044L,      // sheetId\n        1049441315358596L,      // rowId\n        74761903175665540L,      // columnId\n        \"/Users/jdoe/Documents/images/img_pl_decisionshapesHold.png\",\n        \"image\"\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Enable FileStream\nvar fs = require(\"fs\")\n\n// Set options\nvar options = {\n  sheetId: 1696831624483716,\n  rowId: 1049441315358596,\n  columnId: 74761903175665540,\n  fileSize: 458,    // Must be exact bytes; no rounding\n  fileName: \"img_pl_decisionshapesHold.png\",\n  fileStream: fs.createReadStream(\"/Users/jroe/Documents/images/img_pl_decisionshapesHold.png\"),\n  queryParameters: {\n    \"altText\": \"Caution sign\",\n    \"overrideValidation\": true\n  }\n};\n\n// Add image to cell\nsmartsheet.sheets.addImageToCell(options)\n  .then(function(image) {\n    console.log(image);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsheet_id = 1696831624483716\ncolumn_id = 74761903175665540\nrow_id = 1049441315358596\ncaution_pic = \"/Users/jdoe/Documents/images/img_pl_decisionshapesHold.png\"\nfile_type = \"png\"\nsmartsheet_client.Cells.add_image_to_cell(sheet_id, row_id, column_id, caution_pic, file_type)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/rows/{rowId}/columns/{columnId}/history": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/rowId"
        },
        {
          "$ref": "#/components/parameters/columnId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List cell history",
        "description": "Gets the cell modification history.\n\n> **Note:** Fetching cell history is resource-intensive and is limited to **30 requests per minute per API token**. For details, see [Rate limiting](/api/smartsheet/guides/advanced-topics/scalability-options#rate-limiting).\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "cellHistory-get",
        "parameters": [
          {
            "$ref": "#/components/parameters/cellHistoryInclude"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/sheetLevel"
          }
        ],
        "tags": [
          "cells"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "OK.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "List of cell history objects",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/CellHistory"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Omit 'include' parameter and pagination parameters\nPaginatedResult<CellHistory> results = smartsheet.SheetResources.RowResources.CellResources.GetCellHistory(\n  9283173393803140,               // sheetId\n  0123456789012345,               // rowId\n  4567890123456789,               // columnId\n  null,                           // IEnumerable<CellInclusion> includes\n  null                            // PaginationParameters\n);\n\n// Sample 2: Specify 'include' parameter with value of \"COLUMN_TYPE\" and 'includeAll' parameter with value of 'true'\nPaginatedResult<CellHistory> results = smartsheet.SheetResources.RowResources.CellResources.GetCellHistory(\n  9283173393803140,               // sheetId\n  0123456789012345,               // rowId\n  4567890123456789,               // columnId\n  new CellInclusion[] { CellInclusion.COLUMN_TYPE },\n  new PaginationParameters(\n    true,                       // Boolean includeAll\n    null,                       // int pageSize\n    null)                       // int page\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/sheets/{sheetId}/rows/{rowId}/columns/{columnId}/history?include=columnType' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination\nPagedResult<CellHistory> cellHistory = smartsheet.sheetResources().rowResources().cellResources().getCellHistory(\n        9283173393803140L,       // long sheetId\n        0123456789012345L,       // long rowId\n        4567890123456789L,       // long columnId\n        null                     // PaginationParameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 9283173393803140,\n  rowId: 0123456789012345,\n  columnId: 4567890123456789\n};\n\n// Get cell history\nsmartsheet.sheets.getCellHistory(options)\n  .then(function(history) {\n      console.log(history);\n  })\n  .catch(function(error) {\n      console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Get history\nresponse = smartsheet_client.Cells.get_cell_history(\n  9283173393803140,       # sheet_id\n  0123456789012345,       # row_id\n  4567890123456789,       # column_id\n  include_all=True)\nrevisions = response.data\n\n# Sample 2: Paginate the list\nresponse = smartsheet_client.Cells.get_cell_history(\n  9283173393803140,       # sheet_id\n  0123456789012345,       # row_id\n  4567890123456789,       # column_id\n  page_size=5,\n  page=1)\npages = response.total_pages\nrevisions = response.data\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/rows/{rowId}/discussions": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/rowId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List discussions with a row",
        "description": "Gets a list of all discussions associated with the specified row. Remember that discussions are containers\n\nfor the conversation thread. To see the entire thread, use the `include=comments` parameter.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "row-discussions-list",
        "tags": [
          "discussions"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/discussionInclude"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          }
        ],
        "responses": {
          "200": {
            "description": "OK.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of discussions",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Discussion"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Omit 'include' parameter and pagination parameters\nPaginatedResult<Discussion> results = smartsheet.SheetResources.RowResources.DiscussionResources.ListDiscussions(\n  2252168947361668,                   // sheetId\n  4293147074291588,                   // rowId\n  null,                               // IEnumerable<DiscussionInclusion> include\n  null                                // PaginationParameters\n);\n\n// Sample 2: Specify 'include' parameter with values of 'COMMENTS' and 'ATTACHMENTS', and 'includeAll' parameter with value of 'true'\nPaginatedResult<Discussion> results = smartsheet.SheetResources.RowResources.DiscussionResources.ListDiscussions(\n  2252168947361668,                   // sheetId\n  4293147074291588,                   // rowId\n  new DiscussionInclusion[] { DiscussionInclusion.COMMENTS, DiscussionInclusion.ATTACHMENTS },\n  new PaginationParameters(\n    true,                           // includeAll\n    null,                           // int pageSize\n    null)                           // int page\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/sheets/{sheetId}/rows/{rowId}/discussions?include=comments,attachments' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Omit 'include' parameter and pagination parameters\nPagedResult<Discussion> results = smartsheet.sheetResources().rowResources().discussionResources().listDiscussions(\n        2252168947361668L,       // long sheetId\n        4293147074291588L,       // long rowId\n        null,                    // PaginationParameters\n        null                     // EnumSet<DiscussionInclusion> includes\n        );\n\n// Sample 2: Specify pagination parameter 'includeAll'\nPaginationParameters parameters = new PaginationParameters()\n        .setIncludeAll(true);\n\n// Get all row discussions (specify 'include' parameter with values of 'COMMENTS' and 'ATTACHMENTS', and 'includeAll' parameter with value of 'true')\nPagedResult<Discussion> results = smartsheet.sheetResources().rowResources().discussionResources().listDiscussions(\n        2252168947361668L,       // long sheetId\n        4293147074291588L,       // long rowId\n        parameters,\n        EnumSet.of(DiscussionInclusion.COMMENTS, DiscussionInclusion.ATTACHMENTS)\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  rowId: 4293147074291588\n};\n\n// List row discussions\nsmartsheet.sheets.getRowDiscussions(options)\n  .then(function(discussionList) {\n    console.log(discussionList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List all\nresponse = smartsheet_client.Discussions.get_row_discussions(\n  2252168947361668,               # sheet_id\n  4293147074291588,               # row_id\n  include_all=True)\ndiscussions = response.data\n\n# Sample 2: Paginate the list\nresponse = smartsheet_client.Discussions.get_row_discussions(\n  2252168947361668,               # sheet_id\n  4293147074291588,               # row_id\n  page_size=10)\npages = response.total_pages          # starts on page 1 by default\ndiscussions = response.data\n"
          }
        ]
      },
      "post": {
        "summary": "Create a discussion on a row",
        "description": "Creates a new discussion on a row. To create a discussion with an attachment please use \"multipart/form-data\" content type.\n",
        "operationId": "row-discussions-create",
        "tags": [
          "discussions"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DiscussionCreateRequest"
              }
            },
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/DiscussionWithAttachmentCreateRequest"
              },
              "encoding": {
                "discussion": {
                  "contentType": "application/json"
                },
                "file": {
                  "contentType": "application/octet-stream"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Discussion"
                        }
                      }
                    }
                  ],
                  "properties": {
                    "version": {
                      "description": "New version of the sheet. Applicable only for operations which update sheet data.",
                      "type": "number",
                      "nullable": true
                    }
                  }
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Example request: create discussion on row (without attachment)\n\n// Create discussion (including the comment)\nDiscussion discussionSpecification = new Discussion\n{\n  Comment = new Comment\n    {\n      Text = \"This text is the body of the first comment\"\n    },\n  Comments = null         // workaround for SDK issue\n};\n\n// Add discussion to row\nDiscussion newDiscussion = smartsheet.SheetResources.RowResources.DiscussionResources.CreateDiscussion(\n  9283173393803140,               // sheetId\n  0123456789012345,               // rowId\n  discussionSpecification\n);\n\n// Example request: create discussion on row (with attachment)\n\n// Create discussion (including the comment)\nDiscussion discussionSpecification = new Discussion\n{\n  Comment = new Comment\n  {\n    Text = \"This text is the body of the first comment\"\n  },\n  Comments = null         // workaround for SDK issue\n};\n\n// Add discussion to row\nDiscussion newDiscussion = smartsheet.SheetResources.RowResources.DiscussionResources.CreateDiscussionWithAttachment(\n  9283173393803140,                   // sheetId\n  0123456789012345,                   // rowId\n  discussionSpecification,\n  filePath,\n  \"application/octet-stream\"\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "# Example request: create discussion on row (without attachment)\n\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}/rows/{rowId}/discussions \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"comment\": {\"text\":\"This text is the body of the first comment\"}}'\n\n# Example request: create discussion on row (with attachment)\n\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}/rows/{rowId}/discussions \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: multipart/form-data\" \\\n-X POST \\\n-F 'discussion={ \"comment\": { \"text\": \"This text is the body of the first comment\" } };type=application/json' \\\n-F \"file=@insurance_benefits.pdf;type=application/octet-stream\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Example request: create discussion on row (without attachment)\n\n// Create comment\nComment commentSpecification = new Comment()\n        .setText(\"This text is the body of the first comment\");\n\n// Create discussion (including the comment)\n        Discussion discussionSpecification = new Discussion()\n        .setComment(commentSpecification)\n        .setComments(null);     // workaround for SDK issue\n\n// Add discussion to row\n        Discussion newDiscussion = smartsheet.sheetResources().rowResources().discussionResources().createDiscussion(\n        9283173393803140L,       // sheetId\n        0123456789012345L,       // rowId\n        discussionSpecification\n        );\n\n// Example request: create discussion on row (with attachment)\n\n// Create comment\n        Comment commentSpecification = new Comment()\n        .setText(\"This text is the body of the first comment\");\n\n// Create discussion (including the comment)\n        Discussion discussionSpecification = new Discussion()\n        .setComment(commentSpecification)\n        .setComments(null);     // workaround for SDK issue\n\n// Set file path\n        File file = new File(filePath);\n\n// Add discussion to row\n        Discussion newDiscussion = smartsheet.sheetResources().rowResources().discussionResources().createDiscussionWithAttachment(\n        9283173393803140L,       // long sheetId\n        0123456789012345L,       // long rowId\n        discussionSpecification,\n        file,\n        \"application/octet-stream\"\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Example request: create discussion on row (without attachment)\n\n// Specify discussion\nvar discussion = {\n  \"comment\": {\n    \"text\": \"This text is the body of the first comment\"\n  }\n};\n\n// Set options\nvar options = {\n  sheetId: 2252168947361668,\n  rowId: 4293147074291588,\n  body: discussion\n  };\n\n// Add discussion to row\nsmartsheet.sheets.createRowDiscussion(options)\n  .then(function(newDiscussion) {\n    console.log(newDiscussion);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n\n// Example request: create discussion on row (with attachment)\n\n// Multipart operations are not supported by the Node SDK. Instead, see instructions to Create Discussion on Row, and then Attach File to Comment.\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Example request: create discussion on row (without attachment)\n\nresponse = smartsheet_client.Discussions.create_discussion_on_row(\n  9283173393803140,           # sheet_id\n  0123456789012345,           # row_id\n  smartsheet.models.Discussion({\n    'comment': smartsheet.models.Comment({\n      'text': 'This text is the body of the first comment'\n    })\n  })\n)\n\n# Example request: create discussion on row (with attachment)\n\n# Add discussion to row\nresponse = smartsheet_client.Discussions.create_discussion_on_row_with_attachment(\n  9283173393803140,       # sheet_id\n  0123456789012345,       # row_id\n  smartsheet.models.Discussion({\n    'comment': smartsheet.models.Comment({\n      'text': 'This text is the body of the first comment'\n    })\n  }),\n  ('photo.jpg', open('/path/to/photo.jpg', 'rb'), 'image/jpeg')\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/rows/{rowId}/proofs": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/rowId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "post": {
        "summary": "Create proof",
        "description": "Creates a proof on a row.\n",
        "operationId": "proofs-create",
        "tags": [
          "proofs"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Proof"
                        }
                      }
                    }
                  ],
                  "properties": {
                    "version": {
                      "description": "New version of the sheet. Applicable only for operations which update sheet data.",
                      "type": "number",
                      "nullable": true
                    }
                  }
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/rows/{rowId}/proofs \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Disposition: attachment; filename=\"giphy.gif\"\" \\\n-H \"Content-Type: image/gif\" \\\n--data-binary @giphy.gif \\\n-X POST\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/sentupdaterequests": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Lists sent update requests",
        "description": "Lists summarized sent update requests on the sheet.\n\nFor comprehensive details on a sent update request, refer to [Get sent update request](/api/smartsheet/openapi/updaterequests/sentupdaterequest-get).\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "sentupdaterequests-list",
        "tags": [
          "updateRequests"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of sent update request indexes.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "List of sent update request indexes.",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/SentUpdateRequestListItem"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: list sent update requests\n\nPaginatedResult<SentUpdateRequest> results = smartsheet.SheetResources.UpdateRequestResources.ListSentUpdateRequests(\n    1639534409607044,       // sheetId\n    null                    // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "# Example request: list sent update requests\n\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}/sentupdaterequests \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: list sent update requests\n\nPagedResult<SentUpdateRequest> results = smartsheet.sheetResources().updateRequestResources().listSentUpdateRequests(\n    1639534409607044L,      // long sheetId\n    null                    // PaginationParameters\n);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: list sent update requests\n\n// Set options\nvar options = {\n    sheetId: 1639534409607044\n};\n\n// List sent update requests\nsmartsheet.sheets.getAllSentUpdateRequests(options)\n    .then(function(requestsList) {\n        console.log(requestsList);\n    })\n    .catch(function(error) {\n        console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List sent update requests\nresponse = smartsheet_client.Sheets.list_sent_update_requests(\n  5190835902932868)      # sheet_id\nupdate_requests = response.data\n\n# Sample 2: Paginate the list of sent update requests\nresponse = smartsheet_client.Sheets.list_sent_update_requests(\n  5190835902932868,      # sheet_id\n  page_size=10,\n  page=1)\npages = response.total_pages\nupdate_requests = response.data\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/sentupdaterequests/{sentUpdateRequestId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "name": "sentUpdateRequestId",
          "in": "path",
          "required": true,
          "description": "ID of the sent update request",
          "schema": {
            "type": "string"
          }
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Get sent update request",
        "description": "Gets the specified sent update request on the sheet.\n",
        "operationId": "sentupdaterequest-get",
        "tags": [
          "updateRequests"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "SentUpdateRequest object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SentUpdateRequest"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: get sent update request\n\nSentUpdateRequest results = smartsheet.SheetResources.UpdateRequestResources.GetSentUpdateRequest(\n    3285357287499652,      // sheetId\n    2303451729291140       // sentUpdateRequestId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "# Example request: get sent update request\n\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}/sentupdaterequests/{sentUpdateRequestId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: get sent update request\n\nSentUpdateRequest results = smartsheet.sheetResources().updateRequestResources().getSentUpdateRequest(\n    1639534409607044L,      // long sheetId\n    67287475611524L         // long sentUpdateRequestId\n);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: get sent update request\n\n// Set options\nvar options = {\n    sheetId: 1639534409607044,\n    sentUpdateRequestId: 67287475611524\n};\n\n// Get sent update request\nsmartsheet.sheets.getSentUpdateRequest(options)\n    .then(function(updateRequest) {\n        console.log(updateRequest);\n    })\n    .catch(function(error) {\n        console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Example request: get sent update request\n\nresponse = smartsheet_client.Sheets.get_sent_update_request(\n    5190835902932868,       # sheet_id\n    7510551698925444        # update_request_id\n)\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete sent update request",
        "description": "Deletes the specified sent update request.\n\n**Delete operation is supported only when the specified sent update request is in the pending status.\nDeleting a sent update request that was already completed by recipient is not allowed.**\n",
        "operationId": "sentupdaterequest-delete",
        "tags": [
          "updateRequests"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_SHEETS",
              "WRITE_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Result object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Result"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: delete sent update request\n\nsmartsheet.SheetResources.UpdateRequestResources.DeleteSentUpdateRequest(\n    3285357287499652,      // sheetId\n    2303451729291140       // sentUpdateRequestId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "# Example request: delete sent update request\n\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}/sentupdaterequests/{sentUpdateRequestId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: delete sent update request\n\nsmartsheet.sheetResources().updateRequestResources().deleteSentUpdateRequest(\n    1639534409607044L,      // long sheetId\n    965780272637828L        // long sentUpdateRequestId\n);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: delete sent update request\n\n// Set options\nvar options = {\n    sheetId: 1639534409607044,\n    sentUpdateRequestId: 965780272637828\n};\n\n// Delete sent update request\nsmartsheet.sheets.deleteSentUpdateRequest(options)\n    .then(function(result) {\n        console.log(result);\n    })\n    .catch(function(error) {\n        console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Example request: delete sent update request\n\nsmartsheet_client.Sheets.delete_sent_update_request(\n    5190835902932868,   # sheet_id\n    381297098024836     # sent_update_request_id\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/summary": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Get sheet summary",
        "description": "Returns object containing array of summary fields. Allows for pagination of results.",
        "operationId": "list-summary-fields",
        "tags": [
          "sheetSummary"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/sheetSummaryInclude"
          },
          {
            "$ref": "#/components/parameters/sheetSummaryExclude"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SheetSummary"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.SheetResources.SummaryResources.GetSheetSummary(\n  1421228469708676,    // sheetId\n  new List<SummaryFieldInclusion> { SummaryFieldInclusion.FORMAT, SummaryFieldInclusion.WRITER_INFO },\n  new List<SummaryFieldExclusion> { SummaryFieldExclusion.DISPLAY_VALUE }\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/summary?include=writerInfo \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sheetResources().summaryResources().getSheetSummary(\n        1421228469708676L,    // long sheetId\n        EnumSet.of(SummaryFieldInclusion.FORMAT, SummaryFieldInclusion.WRITERINFO),\n        EnumSet.of(SummaryFieldExclusion.DISPLAYVALUE)\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nvar options = {\n  sheetId: 1421228469708676\n};\n\nsmartsheet.sheets.getSummary(options)\n  .then(function(summary) {\n    console.log(summary);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Sheets.get_sheet_summary(\n    1421228469708676,    # sheet_id\n    include='format,writerInfo',\n    exclude='displayValue'\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/summary/fields": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Get summary fields",
        "description": "Returns object containing array of summary fields. \n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "list-summary-fields-paginated",
        "tags": [
          "sheetSummary"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/sheetSummaryInclude"
          },
          {
            "$ref": "#/components/parameters/sheetSummaryExclude"
          }
        ],
        "responses": {
          "200": {
            "description": "OK.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "List of Summary Fields",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/SummaryField"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nPaginationParameters paginationParameters = new PaginationParameters(\n  false,    // includeAll\n  100,    // pageSize\n  1    // page\n);\nsmartsheet.SheetResources.SummaryResources.GetSheetSummaryFields(\n  1421228469708676,    // sheetId\n  new List<SummaryFieldInclusion> { SummaryFieldInclusion.FORMAT, SummaryFieldInclusion.WRITER_INFO },\n  new List<SummaryFieldExclusion> { SummaryFieldExclusion.DISPLAY_VALUE },\n  paginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/summary/fields \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nPaginationParameters paginationParameters = new PaginationParameters(\n        false,    // includeAll\n        100,    // pageSize\n        1    // page\n        );\nsmartsheet.sheetResources().summaryResources().getSheetSummaryFields(\n        1421228469708676L,    // long sheetId\n        EnumSet.of(SummaryFieldInclusion.FORMAT, SummaryFieldInclusion.WRITERINFO),\n        EnumSet.of(SummaryFieldExclusion.DISPLAYVALUE),\n        paginationParameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nvar options = {\n  sheetId: 1421228469708676\n};\n\nsmartsheet.sheets.getSummaryFields(options)\n  .then(function(summary) {\n    console.log(summary);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Sheets.get_sheet_summary_fields(\n    1421228469708676,    # sheet_id\n    include='format,writerInfo',\n    exclude='displayValue',\n    100,    # page_size\n    1,    # page\n    False    # include_all\n)\n"
          }
        ]
      },
      "put": {
        "summary": "Update summary fields",
        "description": "Updates the summary fields for the given sheet.",
        "operationId": "update-summary-fields",
        "tags": [
          "sheetSummary"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/renameIfConflict"
          }
        ],
        "requestBody": {
          "description": "Array of SummaryField objects",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/SummaryFieldCreateRequest"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "description": "A list of updated summary fields",
                      "properties": {
                        "result": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/SummaryField"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSummaryField summaryField = new SummaryField();\nsummaryField.Type = ColumnType.TEXT_NUMBER;\nsummaryField.ObjectValue = new StringObjectValue(\"Sally Smart\");\nsummaryField.Index = 2;\nsummaryField.Title = \"Author\";\n\nsmartsheet.SheetResources.SummaryResources.UpdateSheetSummaryFields(\n  1421228469708676,    // sheetId\n  new SummaryField[] { summaryField },\n  false    // renameIfConflict\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/summary/fields \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '[{\n  \"id\": 5629723890335892,\n  \"type\": \"CONTACT_LIST\",\n  \"objectValue\": {\n    \"objectType\": \"CONTACT\",\n    \"email\": \"jane.roe@smartsheet.com\",\n    \"name\": \"Jane Roe\"\n  },\n  \"index\": 2,\n  \"title\": \"Author\"\n}]'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSummaryField summaryField = new SummaryField();\nsummaryField.setType(ColumnType.TEXT_NUMBER);\nsummaryField.setObjectValue(new StringObjectValue(\"Sally Smart\"));\nsummaryField.setIndex(2);\nsummaryField.setTitle(\"Author\");\n\nsmartsheet.sheetResources().summaryResources().updateSheetSummaryFields(\n        1421228469708676L,    // long sheetId\n        Arrays.asList(summaryField),\n        false    // renameIfConflict\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nvar options = {\n  sheetId: 1421228469708676,\n  body: [{\n    id: 5629723890335892,\n    objectValue: 'Accepted'\n  }]\n};\n\nsmartsheet.sheets.updateSummaryFields(options)\n  .then(function(summary) {\n    console.log(summary);\n  }).catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsummary_field1 = smartsheet.models.SummaryField()\nsummary_field1.type = ColumnType.TEXT_NUMBER\nsummary_field1.object_value = smartsheet.models.StringObjectValue('Sally Smart')\nsummary_field1.index = 2\nsummary_field1.title = 'Author'\n\nsmartsheet_client.Sheets.update_sheet_summary_fields(\n    1421228469708676,    # sheet_id\n    [summary_field1],\n    False    # rename_if_conflict\n)\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete summary fields",
        "description": "Deletes summary fields from the specified sheet.",
        "operationId": "delete-summary-fields",
        "tags": [
          "sheetSummary"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/sheetSummaryFieldIds"
          },
          {
            "$ref": "#/components/parameters/ignoreSummaryFieldsNotFound"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "description": "A list of fieldIds corresponding to all summary fields that were successfully deleted.",
                      "properties": {
                        "result": {
                          "type": "array",
                          "items": {
                            "type": "number"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.SheetResources.SummaryResources.DeleteSheetSummaryFields(\n  1421228469708676,    // sheetId\n  new long[] { 1421228469708676, 1421228469708676, 1421228469708676 },    // summaryFieldIds\n  true    // ignoreSummaryFieldsNotFound\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/summary/fields?ids={fieldId1},{fieldId2},{fieldId3} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sheetResources().summaryResources().deleteSheetSummaryFields(\n        1421228469708676L,    // long sheetId\n        new HashSet(Arrays.asList(1421228469708676L, 1421228469708676L, 1421228469708676L)),    // long summaryFieldIds\n        true    // ignoreSummaryFieldsNotFound\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nvar options = {\n  sheetId: 1421228469708676,\n  queryParameters: {\n    ids: '207098194749316',\n    '100091196549967',\n    '450360473006272'\n  }\n};\n\nsmartsheet.sheets.deleteSummaryFields(options)\n  .then(function(summary) {\n    console.log(summary);\n  }).catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Sheets.delete_sheet_summary_fields(\n    1421228469708676,    # sheet_id\n    [1421228469708676, 1421228469708676, 1421228469708676],    # summary_field_ids\n    True    # ignore_summary_fields_not_found\n)\n"
          }
        ]
      },
      "post": {
        "summary": "Add summary fields",
        "description": "Creates one or more summary fields for the specified sheet.",
        "operationId": "add-summary-fields",
        "tags": [
          "sheetSummary"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/renameIfConflict"
          }
        ],
        "requestBody": {
          "description": "Array of SummaryField objects",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/SummaryFieldCreateRequest"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "description": "A list of created summary fields",
                      "properties": {
                        "result": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/SummaryField"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSummaryField summaryField = new SummaryField();\nsummaryField.Type = ColumnType.TEXT_NUMBER;\nsummaryField.ObjectValue = new StringObjectValue(\"Sally Smart\");\nsummaryField.Index = 2;\nsummaryField.Title = \"Author\";\n\nsmartsheet.SheetResources.SummaryResources.AddSheetSummaryFields(\n  1421228469708676,    // sheetId\n  new SummaryField[] { summaryField },\n  false    // renameIfConflict\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/summary/fields \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '[{\n  \"type\": \"TEXT_NUMBER\",\n  \"objectValue\": \"Sally Smart\",\n  \"index\": 2,\n  \"title\": \"Author\"\n}]'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSummaryField summaryField = new SummaryField();\nsummaryField.setType(ColumnType.TEXT_NUMBER);\nsummaryField.setObjectValue(new StringObjectValue(\"Sally Smart\"));\nsummaryField.setIndex(2);\nsummaryField.setTitle(\"Author\");\n\nsmartsheet.sheetResources().summaryResources().addSheetSummaryFields(\n        1421228469708676L,    // long sheetId\n        Arrays.asList(summaryField),\n        false    // renameIfConflict\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nvar options = {\n  sheetId: 1421228469708676,\n  body: [{\n    type: 'TEXT_NUMBER',\n    objectValue: 'Sally Smart',\n    index: 2,\n    title: 'Author'\n  }]\n};\n\nsmartsheet.sheets.addSummaryFields(options)\n  .then(function(summary) {\n    console.log(summary);\n  }).catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsummary_field1 = smartsheet.models.SummaryField()\nsummary_field1.type = ColumnType.TEXT_NUMBER\nsummary_field1.object_value = smartsheet.models.StringObjectValue('Sally Smart')\nsummary_field1.index = 2\nsummary_field1.title = 'Author'\n\nsmartsheet_client.Sheets.add_sheet_summary_fields(\n    1421228469708676,    # sheet_id\n    [summary_field1],\n    False    # rename_if_conflict\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/summary/fields/{fieldId}/images": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/summaryFieldId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "post": {
        "summary": "Add image to sheet summary",
        "description": "Adds an image to the summary field.",
        "operationId": "add-image-summaryField",
        "tags": [
          "sheetSummary"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          },
          {
            "$ref": "#/components/parameters/Content-Disposition"
          },
          {
            "$ref": "#/components/parameters/Content-Length"
          },
          {
            "$ref": "#/components/parameters/altText"
          },
          {
            "$ref": "#/components/parameters/overrideValidation"
          }
        ],
        "requestBody": {
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/SummaryFieldAddImage"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.SheetResources.SummaryResources.AddSheetSummaryFieldImage(\n  1421228469708676,    // sheetId\n  5629723890335892,    // fieldId\n  \"picture.jpg\",    // file\n  \"image/jpeg\",    // contentType\n  \"my image\"    // altText\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/summary/fields/{fieldId}/images?altText=my%20image \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: image/jpeg\" \\\n-H 'Content-Disposition: attachment; filename=\"picture.jpg\"' \\\n-X POST \\\n--data-binary @picture.jpg\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sheetResources().summaryResources().addSheetSummaryFieldImage(\n        1421228469708676L,    // long sheetId\n        5629723890335892L,    // long fieldId\n        \"picture.jpg\",    // file\n        \"image/jpeg\",    // contentType\n        \"my image\"    // altText\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nvar options = {\n  sheetId: 1421228469708676,\n  fieldId: 5629723890335892,\n  path: 'C:/picture.jpg',\n  fileName: 'picture.jpg'\n};\n\nsmartsheet.sheets.addSummaryFieldImage(options)\n  .then(function(summary) {\n    console.log(summary);\n  }).catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Sheets.add_sheet_summary_field_image(\n    1421228469708676,    # sheet_id\n    5629723890335892,    # field_id\n    \"picture.jpg\",       # file\n    \"image/jpeg\",        # file_type\n    \"my image\"           # alt_text\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/updaterequests": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List update requests",
        "description": "Gets a summarized list of all update requests that have future schedules associated with the specified sheet.\n\nOnly the following fields are returned in the response:\n\n* **id**\n* **ccMe**\n* **createdAt**\n* **message**\n* **modifiedAt**\n* **schedule**\n* **sendTo**\n* **sentBy**\n* **subject**\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "operationId": "updaterequests-list",
        "tags": [
          "updateRequests"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of UpdateRequest objects.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of UpdateRequest objects",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/UpdateRequest"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: list update requests\n\nPaginatedResult<UpdateRequest> results = smartsheet.SheetResources.UpdateRequestResources.ListUpdateRequests(\n    1639534409607044,       // sheetId\n    null                    // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "# Example request: list update requests\n\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}/updaterequests \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: list update requests\n\nPagedResult<UpdateRequest> results = smartsheet.sheetResources().updateRequestResources().listUpdateRequests(\n    1639534409607044L,      // long sheetId\n    null                    // PaginationParameters\n);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: list update requests\n\n// Set options\nvar options = {\n    sheetId: 1639534409607044\n};\n\n// List update requests\nsmartsheet.sheets.getAllUpdateRequests(options)\n    .then(function(requestsList) {\n        console.log(requestsList);\n    })\n    .catch(function(error) {\n        console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List update requests\nresponse = smartsheet_client.Sheets.list_update_requests(\n  5190835902932868)      # sheet_id\nupdate_requests = response.data\n\n# Sample 2: Paginate the list of update requests\nresponse = smartsheet_client.Sheets.list_update_requests(\n  5190835902932868,       # sheet_id\n  page_size=10,\n  page=1)\npages = response.total_pages\nupdate_requests = response.data\n"
          }
        ]
      },
      "post": {
        "summary": "Create an update request",
        "description": "Creates an update request for the specified rows within the sheet. An email notification (containing a link to the update request) is sent to the specified recipients according to the specified schedule.\n\nThe recipients of an update request must be specified by using email addresses only. Sending an update request to a group is not supported.\n\nThe following attributes have the following values when not specified:\n* **ccMe:** false\n* **message:** Please update the following rows in my online sheet.\n* **subject:** Update Request: {Sheet Name}\n\nWhen the Schedule object is not specified, the request is sent to the recipients immediately.\n\nIf an error occurs because the request specified one or more *alternate email addresses*,\nplease retry using the primary email address.\n",
        "operationId": "updaterequests-create",
        "tags": [
          "updateRequests"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing the newly created UpdateRequest object.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/UpdateRequest"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: create update request\n\n// Specify recipients\nRecipient[] recipientSpecification = new Recipient[] {\n    new Recipient { Email = \"recipient1@smartsheet.com\"}\n};\n\n// Configure update request\nUpdateRequest updateRequestSpecification = new UpdateRequest\n{\n    SendTo = recipientSpecification,\n    Subject = \"Sample Monthly Update Request\",\n    Message = \"Please update my online sheet.\",\n    CcMe = true,\n    RowIds = new long[] { 1123834706323332, 5627434333693828 },\n    ColumnIds = new long[] { 4549065498224516, 2297265684539268 },\n    IncludeAttachments = true,\n    IncludeDiscussions = true\n};\n\n// Send update request via email\nUpdateRequest newUpdateRequest = smartsheet.SheetResources.UpdateRequestResources.CreateUpdateRequest(\n    3285357287499652,       // sheetId\n    updateRequestSpecification\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "# Example request: create update request\n\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}/updaterequests \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\n  \"sendTo\": [\n    {\"email\": \"recipient1@smartsheet.com\"},\n    {\"email\": \"recipient2@smartsheet.com\"}\n  ],\n  \"subject\": \"Sample Monthly Update Request\",\n  \"message\": \"Please update my online sheet.\",\n  \"ccMe\": false,\n  \"rowIds\": [4508292249610116, 2256492435924868],\n  \"columnIds\": [4508284196546436, 2256484382861188],\n  \"includeAttachments\": false,\n  \"includeDiscussions\": false\n}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: create update request\n\n// Specify recipients\nRecipientEmail recipientA = new RecipientEmail()\n    .setEmail(\"recipient1@smartsheet.com\");\n\nRecipientEmail recipientB = new RecipientEmail()\n    .setEmail(\"recipient2@smartsheet.com\");\n\nList<Recipient> recipients = Arrays.asList(recipientA, recipientB);\n\n// Specify parameters for update request\nUpdateRequest updateRequest = new UpdateRequest();\nupdateRequest.setRowIds((Arrays.asList(3344087179913092L, 7847686807283588L));\nupdateRequest.setSendTo(recipients)\n    .setSubject(\"Sample Monthly Update Request\")\n    .setMessage(\"Please update my online sheet.\")\n    .setColumnIds(Arrays.asList(1735559124150148L, 1735559124150148L))\n    .setIncludeAttachments(false)\n    .setIncludeDiscussions(false);\n\n// Create update request\nsmartsheet.sheetResources().updateRequestResources().createUpdateRequest(\n    1639534409607044L,      // long sheetId\n    updateRequest\n);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: create update request\n\n// Set body\nvar body = {\n  rowIds: [\n    1049041315358596,\n    5552640942729092\n  ],\n  includeAttachments: true,\n  includeDiscussions: false,\n  sendTo: [\n    {\n      email: \"jane.roe@smartsheet.com\"\n    }\n  ],\n  subject: \"Sample Monthly Update Request\",\n  message: \"Please update my online sheet.\",\n  schedule: {\n    type: \"DAILY\",\n    startAt: \"2016-04-01T00:00:00Z\",\n    endAt: \"2018-12-31T00:00:00Z\",\n    dayDescriptors: [\n      \"WEEKDAY\"\n    ]\n  }\n};\n\n// Set options\nvar options = {\n  sheetId: 1696801624483716,\n  body: body\n};\n\n// Create update request\nsmartsheet.sheets.createUpdateRequest(options)\n  .then(function(updatedRequest) {\n    console.log(updatedRequest);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Example request: create update request\n\n# Configure update request\nrequest = smartsheet.models.UpdateRequest()\nrequest.send_to = [{'email': 'someone@smartsheet.com'}]\nrequest.subject = 'Please update based on meeting'\nrequest.message = 'Hello, please checkout my update request'\nrequest.cc_me = False\nrequest.include_discussions = False\nrequest.include_attachments = False\nrequest.row_ids = [6809535313667972]\nrequest.column_ids = [7036894123976580]\n\n# Send update request\naction = smartsheet_client.Sheets.create_update_request(\n  5190835902932868,           # sheet_id\n  request\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/updaterequests/{updateRequestId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "name": "updateRequestId",
          "in": "path",
          "required": true,
          "description": "ID of the Update Request",
          "schema": {
            "type": "string"
          }
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Get an update request",
        "description": "Gets the specified update request for the sheet that has a future schedule.\n\nThe rowIds and columnIds in the returned UpdateRequest object represent the list at the time\nthe update request was created or last modified. The lists may contain Ids of rows or columns\nthat are no longer valid (for example, they have been removed from the sheet).\n",
        "operationId": "updaterequests-get",
        "tags": [
          "updateRequests"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "UpdateRequest object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateRequest"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: get update request\n\nUpdateRequest results = smartsheet.SheetResources.UpdateRequestResources.GetUpdateRequest(\n    3285357287499652,      // sheetId\n    2409350321989508       // updateRequestId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "# Example request: get update request\n\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}/updaterequests/{updateRequestId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: get update request\n\nUpdateRequest results = smartsheet.sheetResources().updateRequestResources().getUpdateRequest(\n    1639534409607044L,      // long sheetId\n    965780272637828L        // long updateRequestId\n);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: get update request\n\n// Set options\nvar options = {\n    sheetId: 3285357287499652,\n    updateRequestId: 2409350321989508\n};\n\n// Get update request\nsmartsheet.sheets.getUpdateRequest(options)\n    .then(function(updateRequest) {\n        console.log(updateRequest);\n    })\n    .catch(function(error) {\n        console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Example request: get update request\n\nresponse = smartsheet_client.Sheets.get_update_request(\n    5190835902932868,       # sheet_id\n    7510551698925444        # update_request_id\n)\n"
          }
        ]
      },
      "put": {
        "summary": "Update an update request",
        "description": "Changes the specified update request for the sheet.\n\n**Making changes to update requests that do not have future scheduled delivery is not allowed.**\n\nThe UpdateRequest object in the request body must specify one or more of the following attributes:\n\n* **ccMe:** Boolean\n* **columnIds:** number[]\n* **includeAttachments:** Boolean\n* **includeDiscussions:** Boolean\n* **message:** string\n* **schedule:** Schedule object\n* **sendTo:** Recipient[]\n* **subject:** string\n\nIf an error occurs because the request specified one or more *alternate email addresses*,\nplease retry using the primary email address.\n",
        "operationId": "updaterequests-update",
        "tags": [
          "updateRequests"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "responses": {
          "200": {
            "description": "Result object containing the modified UpdateRequest object",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/UpdateRequest"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: change update request\n\n// Identify the update request you want to change\nUpdateRequest updateRequestSpecification = new UpdateRequest\n{\n    Id = 7178482007467908,        // long updateRequestId\n    Subject = \"Sample Monthly Update Request\",\n    Message = \"Please update my online sheet.\"\n};\n\n// Change update request\nUpdateRequest updatedUpdateRequest = smartsheet.SheetResources.UpdateRequestResources.UpdateUpdateRequest(\n    3285357287499652,          // sheetId\n    updateRequestSpecification\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "# Example request: change update request\n\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}/updaterequests/{updateRequestId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '{\n  \"subject\": \"Sample Monthly Update Request\",\n  \"message\": \"Please update my online sheet.\"\n}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nExample request: change update request\n\nUpdateRequest updateRequest = new UpdateRequest();\nupdateRequest.setId(3294745817573252L);\nupdateRequest.setColumnIds(Arrays.asList(1735559124150148L, 1735559124150148L));\nupdateRequest.setIncludeAttachments(true);\nsmartsheet.sheetResources().updateRequestResources().updateUpdateRequest(\n    3294745817573252L,  // long sheetId\n    updateRequest\n);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: change update request\n\n// Set text\nvar body = {\n    subject: \"Sample Monthly Update Request\"\n};\n\n// Set options\nvar options = {\n    sheetId: 3285357287499652,\n    updateRequestId: 7178482007467908,\n    body: body\n};\n\n// Change update request\nsmartsheet.sheets.changeUpdateRequest(options)\n    .then(function(updatedRequest) {\n        console.log(updatedRequest);\n    })\n    .catch(function(error) {\n        console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Example request: change update request\n\n# Update required request fields\nrequest = smartsheet.models.UpdateRequest()\nrequest.subject = 'Sample Monthly Update Request'\nrequest.column_ids = [7036894123976580]\nrequest.include_attachments = True\n\n# Change update request\naction = smartsheet_client.Sheets.update_update_request(\n    3294745817573252,       # sheet_id\n    7820135625975684,       # update_request_id\n    request\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete an update request",
        "description": "Terminates the future scheduled delivery of the update request specified in the URL.\n",
        "operationId": "updaterequests-delete",
        "tags": [
          "updateRequests"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_SHEETS",
              "WRITE_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Result object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Result"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: delete update request\n\nsmartsheet.SheetResources.UpdateRequestResources.DeleteUpdateRequest(\n    3285357287499652,      // sheetId\n    2409350321989508       // updateRequestId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "# Example request: delete update request\n\ncurl https://api.smartsheet.com/2.0/sheets/{sheetId}/updaterequests/{updateRequestId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: delete update request\n\nsmartsheet.sheetResources().updateRequestResources().deleteUpdateRequest(\n    1639534409607044L,      // long sheetId\n    965780272637828L        // long updateRequestId\n);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n# Example request: delete update request\n\n// Set options\nvar options = {\n    sheetId: 3285357287499652,\n    updateRequestId: 2409350321989508\n};\n\n// Delete update request\nsmartsheet.sheets.deleteUpdateRequest(options)\n    .then(function(result) {\n        console.log(result);\n    })\n    .catch(function(error) {\n        console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Example request: delete update request\n\nsmartsheet_client.Sheets.delete_update_request(\n    5190835902932868,        # sheet_id\n    7444581001258884         # update_request_id\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/shares": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/accessApiLevel"
        }
      ],
      "post": {
        "summary": "Share sheet",
        "description": "Shares a sheet with the specified users and groups.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "share-sheet",
        "tags": [
          "sharing",
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "SHARE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/sendEmail"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/Share"
                  },
                  {
                    "type": "array",
                    "title": "Array of shares",
                    "items": {
                      "$ref": "#/components/schemas/Share"
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing either a single Share object or an array of Share objects, corresponding to what\nwas specified in the request. All shares have scope=ITEM.\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "oneOf": [
                            {
                              "$ref": "#/components/schemas/Share"
                            },
                            {
                              "type": "array",
                              "title": "Array of shares",
                              "items": {
                                "$ref": "#/components/schemas/Share"
                              }
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "If called with a single Share object, and that user or group share already exists, error code 1025 is returned.\nIf called with an array of Share objects, and one or more user or group shares in the array already exist,\nthey are ignored and omitted from the response.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify share (to one user as Editor)\nShare[] shareSpecification = new Share[] { new Share\n  {\n    Email = \"jane.doe@smartsheet.com\",\n    AccessLevel = AccessLevel.EDITOR\n  }\n};\n\n// Share sheet\nIList<Share> addressList = smartsheet.SheetResources.ShareResources.ShareTo(\n  4583614634583940,               // sheetId\n  shareSpecification,\n  true                            // Nullable<bool> sendEmail\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/sheets/{sheetId}/shares?sendEmail=true' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '[{\"email\": \"jane.doe@smartsheet.com\", \"accessLevel\": \"EDITOR\"}]'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify share (to one user as Editor)\nShare shareSpecification = new Share()\n        .setEmail(\"jane.doe@smartsheet.com\")\n        .setAccessLevel(AccessLevel.EDITOR);\n\n// Share sheet\nList<Share> addressList = smartsheet.sheetResources().shareResources().shareTo(\n        4583614634583940L,                    // long sheetId\n        (Arrays.asList(shareSpecification)),\n        true                                  // Boolean sendEmail\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify share (to one user as Editor)\nvar share = [\n  {\n    \"email\": \"jane.doe@smartsheet.com\",\n    \"accessLevel\": \"EDITOR\"\n  }\n];\n\n// Set options\nvar options = {\n  sheetId: 4583614634583940,\n  body: share\n  };\n\n// Share sheet\nsmartsheet.sheets.share(options)\n  .then(function(addressList) {\n    console.log(addressList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Sheets.share_sheet(\n  4583614634583940,       # sheet_id\n  smartsheet.models.Share({\n    'access_level': 'EDITOR',\n    'email': 'jane.doe@smartsheet.com'\n  }),\n  True                    # sendEmail\n)\n"
          }
        ]
      },
      "get": {
        "summary": "List sheet shares",
        "description": "Gets a list of all users and groups to whom the specified Sheet is shared, and their access level. \n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "list-sheet-shares",
        "tags": [
          "sharing",
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/sharingInclude"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "IndexResult object containing an array of Share objects. By default, this operation returns only item-level shares (scope=ITEM). Use the sharingInclude parameter to request that workspace-level shares (include=workspaceShares) also be returned.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Share"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPaginatedResult<Share> shares = smartsheet.SheetResources.ShareResources.ListShares(\n  4583614634583940,               // sheetId\n  null                            // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/shares \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPagedResult<Share> shares = smartsheet.sheetResources().shareResources().listShares(\n        4583614634583940L,       // long sheetId\n        null,                    // PaginationParameters\n        true                     // Boolean includeWorkspaceShares\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 4583614634583940\n};\n\n// List sheet shares\nsmartsheet.sheets.listShares(options)\n  .then(function(shareList) {\n    console.log(shareList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List all\nresponse = smartsheet_client.Sheets.list_shares(\n  4583614634583940,       # sheet_id\n  include_all=True)\nshares = response.data\n\n# Sample 2: Paginate the list\nresponse = smartsheet_client.Sheets.list_shares(\n  4583614634583940,       # sheet_id\n  page_size=10,\n  page=1)\npages = response.total_pages\nshares = response.data\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/shares/{shareId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/shareId"
        },
        {
          "$ref": "#/components/parameters/accessApiLevel"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Get sheet share",
        "description": "Gets the share specified in the URL.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "share-sheet-get",
        "tags": [
          "sharing",
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns Share object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Share"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nShare share = smartsheet.SheetResources.ShareResources.GetShare(\n  4583614634583940,           // sheetId\n  \"AQAISF82FOeE\"              // string shareId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/shares/{shareId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nShare share = smartsheet.sheetResources().shareResources().getShare(\n        4583614634583940L,       // long sheetId\n        \"AAAASuWWFOeE\"           // string shareId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 4583614634583940,\n  shareId: \"AQAISF82FOeE\"\n};\n\n// Get sheet share\nsmartsheet.sheets.getShare(options)\n  .then(function(share) {\n    console.log(share);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nshare = smartsheet_client.Sheets.get_share(\n  4583614634583940,       # sheet_id\n  'AAAASuWWFOeE')         # share_id\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete sheet share",
        "description": "Deletes the share specified in the URL.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "delete-sheet-share",
        "tags": [
          "sharing",
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "SHARE_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns Result object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Result"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.SheetResources.ShareResources.DeleteShare(\n  4583614634583940,               // sheetId\n  \"AAAASuWWFOeE\"                  // string shareId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/shares/{shareId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sheetResources().shareResources().deleteShare(\n        4583614634583940L,       // long sheetId\n        \"AAAASuWWFOeE\"           // string shareId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 4583614634583940,\n  shareId: \"AAAASuWWFOeE\"\n};\n\n// Delete sheet share\nsmartsheet.sheets.deleteShare(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Sheets.delete_share(\n  4583614634583940,       # sheet_id\n  'AAAFeF82FOeE')         # share_id\n"
          }
        ]
      },
      "put": {
        "summary": "Update sheet share",
        "description": "Updates the access level of a user or group for the specified sheet.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "update-sheet-share",
        "tags": [
          "sharing",
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "SHARE_SHEETS"
            ]
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "accessLevel": {
                    "$ref": "#/components/schemas/AccessLevel"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Returns Result object containing the modified Share object.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "object",
                          "items": {
                            "$ref": "#/components/schemas/Share"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set the access level to Viewer\nShare shareSpecification = new Share\n{\n  Id = \"AAAFeF82FOeE\",\n  AccessLevel = AccessLevel.VIEWER\n};\n\n// Update sheet share\nShare updatedShare = smartsheet.SheetResources.ShareResources.UpdateShare(\n  4583614634583940,               // sheetId\n  shareSpecification\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/shares/{shareId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '{\"accessLevel\": \"VIEWER\"}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set the access level to Viewer\nShare shareSpecification = new Share()\n        .setEmail(\"jane.doe@smartsheet.com\")\n        .setAccessLevel(AccessLevel.EDITOR);\n\n// Update sheet share\nShare updatedShare = smartsheet.sheetResources().shareResources().updateShare(\n        4583614634583940L,       // long sheetId\n        shareSpecification\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set access level to Viewer\nvar shareSpecification = {\"accessLevel\": \"VIEWER\"};\n\n// Set options\nvar options = {\n  sheetId: 1696801624483716,\n  shareId: \"AAAHAYImFOeE\",\n  body: shareSpecification\n};\n\n// Update sheet share\nsmartsheet.sheets.updateShare(options)\n  .then(function(updatedShare) {\n    console.log(updatedShare);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nupdated_share = smartsheet_client.Sheets.update_share(\n  4583614634583940,       # sheet_id\n  'AAAFeF82FOeE',         # share_id\n  smartsheet.models.Share({\n    'access_level': 'VIEWER'\n  })\n)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/sort": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/Content-Type"
        }
      ],
      "post": {
        "summary": "Sort rows in sheet",
        "description": "Sorts the rows of a sheet, either in ascending or descending order.",
        "operationId": "rows-sort",
        "tags": [
          "rows"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/sortRows"
          }
        ],
        "requestBody": {
          "description": "[SortSpecifier](/api/smartsheet/openapi/schemas/sortspecifier) with the following attribute:\n* **sortCriteria** -- [SortCriterion](/api/smartsheet/openapi/schemas/sortcriterion) array in priority order. Specifies sort order.\n",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SortSpecifier"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Returns [Sheet object](/api/smartsheet/openapi/sheets/sheet), populated according to the specified parameters.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Sheet"
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSortCriterion criterion = new SortCriterion\n{\n  ColumnId = 4583173393803140,    // columnId\n  Direction = SortDirection.DESCENDING\n};\nSortSpecifier specifier = new SortSpecifier\n{\n  SortCriteria = new SortCriterion[] { criterion }\n};\n\nSheet sheet = smartsheet.SheetResources.SortSheet(\n    4583173393803140,    // sheetId\n    specifier\n  );\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/sort \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"sortCriteria\": [{\"columnId\": 4583173393803140, \"direction\": \"DESCENDING\"}]}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSortCriterion criterion = new SortCriterion();\ncriterion.setColumnId(4583173393803140L);    // long columnId\ncriterion.setDirection(SortDirection.DESCENDING);\nSortSpecifier specifier = new SortSpecifier();\nspecifier.setSortCriteria(Arrays.asList(criterion));\n\nSheet sheet = smartsheet.sheetResources().sortSheet(\n        4583173393803140L,    // long sheetId\n        specifier\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify sort criteria\nvar body = {\n  sortCriteria: [\n    {\n      columnId: 4583173393803140,\n      direction: \"DESCENDING\"\n    }\n  ]\n};\n\n// Sort rows\nsmartsheet.sheets.sortRowsInSheet({sheetId: 9283173393803140, body: body})\n  .then((result) => {\n      console.log(\"success\");\n      console.log(JSON.stringify(result));\n  })\n  .catch((error) => {\n      console.log(\"error\");\n      console.log(JSON.stringify(error));\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsort_specifier = smartsheet.models.SortSpecifier({\n    'sort_criteria': [smartsheet.models.SortCriterion({\n        'column_id': 4583173393803140,\n        'direction': 'DESCENDING'\n    })]\n})\nsheet = smartsheet_client.Sheets.sort_sheet(9283173393803140, sort_specifier)\n"
          }
        ]
      }
    },
    "/sheets/{sheetId}/version": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sheetId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Get sheet version",
        "description": "Gets the sheet version without loading the entire sheet.\nThe following actions increment sheet version:\n* add/modify cell value\n* add/modify discussion/comment\n* add/modify row\n* add/remove/update version attachment\n* cell updated via cell link\n* change formatting\n",
        "operationId": "get-sheetVersion",
        "tags": [
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SheetVersion"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nInteger version = smartsheet.SheetResources.GetSheetVersion(\n  1531988831168388            // sheetId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sheets/{sheetId}/version \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nInteger version = smartsheet.sheetResources().getSheetVersion(\n        1531988831168388L        // long sheetId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sheetId: 1531988831168388\n};\n\n// Get sheet version\nsmartsheet.sheets.getSheetVersion(options)\n  .then(function(version) {\n    console.log(version);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nversion = smartsheet_client.Sheets.get_sheet_version(\n  1531988831168388)       # sheet_id\n"
          }
        ]
      }
    },
    "/sights": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "operationId": "list-sights",
        "summary": "List dashboards",
        "description": "Gets a list of all dashboards that the user has access to.\n\n> **Note:** For pagination guidance, refer to [Token-based pagination](/api/smartsheet/guides/basics/pagination#token-based-pagination).\n",
        "tags": [
          "dashboards"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SIGHTS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/numericDates"
          },
          {
            "$ref": "#/components/parameters/lastKey"
          },
          {
            "name": "paginationType",
            "in": "query",
            "required": false,
            "description": "Specifies the type of pagination to use. When set to 'token', enables token-based pagination.\n",
            "schema": {
              "type": "string",
              "enum": [
                "token"
              ]
            }
          },
          {
            "name": "maxItems",
            "in": "query",
            "required": false,
            "description": "The maximum number of items to return in the response. The actual number of items returned may be less than maxItems.\n\nIf the total number of dashboards the user has access to exceeds maxItems, the response will include a lastKey field. This key can be used as a parameter in subsequent requests to retrieve additional items beyond those already returned.\n",
            "schema": {
              "type": "integer",
              "default": 100,
              "minimum": 1,
              "maximum": 1000
            }
          },
          {
            "name": "includeAll",
            "in": "query",
            "required": false,
            "description": "If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified).\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#deprecated-includeall-and-offset-based-pagination-for-dashboards), this request parameter will no longer be supported.**\n\nRefer to the following articles for examples of using token-based pagination: \n\n- [Pagination](/api/smartsheet/guides/basics/pagination#token-based-pagination)\n- [Pagination - SDK examples](/api/smartsheet/guides/basics/pagination-sdk-examples)\n",
            "schema": {
              "type": "boolean",
              "default": false,
              "deprecated": true
            }
          },
          {
            "name": "modifiedSince",
            "deprecated": true,
            "in": "query",
            "required": false,
            "description": "When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#deprecated-includeall-and-offset-based-pagination-for-dashboards), this request parameter will no longer be supported.**\n",
            "schema": {
              "$ref": "#/components/schemas/Timestamp"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "description": "Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#deprecated-includeall-and-offset-based-pagination-for-dashboards), this request parameter will no longer be supported.**\n\nRefer to the following article for examples of using token-based pagination: \n\n- [Pagination](/api/smartsheet/guides/basics/pagination#token-based-pagination)\n- [Pagination - SDK examples](/api/smartsheet/guides/basics/pagination-sdk-examples)\n",
            "schema": {
              "type": "number",
              "default": 1,
              "deprecated": true
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "required": false,
            "description": "The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a\npage size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#deprecated-includeall-and-offset-based-pagination-for-dashboards), this request parameter will no longer be supported.**\n\nRefer to the following article for examples of using token-based pagination: \n\n- [Pagination](/api/smartsheet/guides/basics/pagination#token-based-pagination)\n- [Pagination - SDK examples](/api/smartsheet/guides/basics/pagination-sdk-examples)\n",
            "schema": {
              "type": "number",
              "default": 100,
              "deprecated": true
            }
          }
        ],
        "responses": {
          "200": {
            "description": "IndexResult object containing an array of Dashboard objects with a subset of attributes.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "lastKey": {
                          "$ref": "#/components/schemas/LastKey"
                        },
                        "data": {
                          "description": "List of Dashboards",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/SightListItem"
                          }
                        },
                        "pageNumber": {
                          "description": "The current page in the full result set that the data array represents.\n\nNOTE when a page number greater than totalPages is requested, the last page is instead returned.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#deprecated-includeall-and-offset-based-pagination-for-dashboards), this response property will not be part of the response.**\n",
                          "type": "number",
                          "example": 1,
                          "readOnly": true,
                          "deprecated": true
                        },
                        "pageSize": {
                          "description": "The number of items in a page. Omitted if there is no limit to page size (and hence, all results are included). Unless otherwise specified, this defaults to 100 for most endpoints.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#deprecated-includeall-and-offset-based-pagination-for-dashboards), this response property will not be part of the response.**\n",
                          "type": "number",
                          "example": 50,
                          "nullable": true,
                          "readOnly": true,
                          "deprecated": true
                        },
                        "totalPages": {
                          "description": "The total number of pages in the full result set.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#deprecated-includeall-and-offset-based-pagination-for-dashboards), this response property will not be part of the response.**\n",
                          "type": "number",
                          "example": 25,
                          "readOnly": true,
                          "deprecated": true
                        },
                        "totalCount": {
                          "description": "The total number of items in the full result set.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#deprecated-includeall-and-offset-based-pagination-for-dashboards), this response property will not be part of the response.**\n",
                          "type": "number",
                          "example": 136,
                          "readOnly": true,
                          "deprecated": true
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nPaginatedResult<Sight> sights = smartsheet.SightResources.ListSights(\n  null,       // PaginationParameters\n  null        // Nullable<DateTime> modifiedSince\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sights \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nPagedResult<Sight> sights = smartsheet.sightResources().listSights(\n        null,       // PaginationParameters\n        null        // Date modifiedSince\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sights.listSights()\n  .then(function(sights) {\n    console.log(sights.data);\n  })\n  .catch(function(error) {\n    console.log(error);\n  })\n"
          }
        ]
      }
    },
    "/sights/{sightId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/sightId"
        }
      ],
      "get": {
        "summary": "Get Dashboard",
        "description": "Gets the specified dashboard.",
        "operationId": "get-sight",
        "parameters": [
          {
            "$ref": "#/components/parameters/accessApiLevel"
          },
          {
            "$ref": "#/components/parameters/sightInclude"
          },
          {
            "$ref": "#/components/parameters/sightLevel"
          },
          {
            "$ref": "#/components/parameters/numericDates"
          }
        ],
        "tags": [
          "dashboards"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SIGHTS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Dashboard object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Sight"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSight sight = smartsheet.SightResources.GetSight(\n  6327127650920324        // long sightId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sights/{sightId}?level=4 \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSight sight = smartsheet.sightResources().getSight(\n        6327127650920324L       // long sightId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sightId: 6327127650920324\n};\n\n// Get dashboard\nsmartsheet.sights.getSight(options)\n  .then(function(sight) {\n    console.log(sight);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Get dashboard\nsight = smartsheet_client.Sights.get_sight(\n  6327127650920324)     # sightId\n\n# Sample 2: Determine whether a user has Commenter permissions for a dashboard\nresponse = smartsheet_client.Sights.get_sight(\n  6327127650920324,       # sightId\n  accessApiLevel=1)\n"
          }
        ]
      },
      "put": {
        "summary": "Update dashboard",
        "description": "Updates (renames) the specified dashboard.",
        "operationId": "update-sight",
        "parameters": [
          {
            "$ref": "#/components/parameters/numericDates"
          },
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "tags": [
          "dashboards"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_SIGHTS"
            ]
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SightName"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing the updated Dashboard object.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ItemResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Sight"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSight sight = smartsheet.SightResources.UpdateSight(\n  new Sight {\n    Id = 5363568917931908,    // sightId\n    Name = \"New Dashboard Name\"\n  }\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sights/{sightId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '{\"name\": \"New Dashboard Name\"}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSight sight = new Sight();\nsight.setId(5363568917931908L);    // long sightId\nsight.setName(\"New Dashboard Name\");\nSight updatedSight = smartsheet.sightResources().updateSight(sight);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set property to change\nvar body = {\n  name: \"New Dashboard Name\"\n};\n\n// Set options\nvar options = {\n  sightId: 5363568917931908,\n  body: body\n};\n\n// Update Dashboard\nsmartsheet.sights.updateSight(options)\n  .then(function(updatedSight) {\n    console.log(updatedSight);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nupdated_sight = smartsheet_client.Sights.update_sight(\n  5363568917931908,           # sight_id\n  smartsheet.models.Sight({\n    'name': 'New Dashboard Name'\n  })\n)\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete dashboard",
        "description": "Deletes the dashboard specified in the URL.",
        "operationId": "delete-sight",
        "tags": [
          "dashboards"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "DELETE_SIGHTS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Generic response result",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.SightResources.DeleteSight(\n  5077532685952900            // sightId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sights/{sightId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sightResources().deleteSight(\n        3100061023397764L       // long sightId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sightId: 5363568917931908\n};\n\n// Delete Dashboard\nsmartsheet.sights.deleteSight(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Sights.delete_sight(3404239197235076)     # sight_id\n"
          }
        ]
      }
    },
    "/sights/{sightId}/copy": {
      "parameters": [
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "post": {
        "summary": "Copy dashboard",
        "description": "Creates a copy of the specified dashboard.",
        "operationId": "copy-sight",
        "tags": [
          "dashboards"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "CREATE_SIGHTS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Authorization"
          },
          {
            "$ref": "#/components/parameters/Content-Type"
          },
          {
            "$ref": "#/components/parameters/sightId"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ContainerDestinationForCopy"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing a dashboard with a subset of attributes for the newly created dashboard.\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ItemResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/SightResult"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination\nContainerDestination destination = new ContainerDestination\n{\n  DestinationId = 3791509922310020,               // long destinationFolderId\n  DestinationType = DestinationType.FOLDER,\n  NewName = \"newDashboardName\"\n};\n\n// Copy Dashboard\nSight sight = smartsheet.SightResources.CopySight(\n  6327127650920324,                               // long sightId\n  destination\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sights/{sightId}/copy \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n  \"destinationType\": \"workspace\",\n  \"destinationId\": 7960873114331012,\n  \"newName\": \"newDashboardName\"\n}' \\\n-X POST\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination\nContainerDestination destination = new ContainerDestination()\n        .setDestinationType(DestinationType.FOLDER)\n        .setDestinationId(3791509922310020L)\n        .setNewName(\"newDashboardName\");\n\n// Copy Dashboard\nSight sight = smartsheet.sightResources().copySight(\n        6327127650920324L,                          // long sightId\n        destination\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify new dashboard properties\nvar body = {\n  destinationType: \"home\",\n  newName: \"newDashboardName\"\n};\n\n// Set options\nvar options = {\n  sightId: 6327127650920324,\n  body: body\n};\n\n// Copy Dashboard\nsmartsheet.sights.copySight(options)\n  .then(function(copiedSight) {\n    console.log(copiedSight);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nnew_sight = smartsheet_client.Sights.copy_sight(\n  6327127650920324,                           # sight_id\n  smartsheet.models.ContainerDestination({\n    'destination_type': 'folder',           # folder, workspace, or home\n    'destination_id': 3791509922310020,     # folder_id\n    'new_name': 'newDashboardName'\n  })\n)\n"
          }
        ]
      }
    },
    "/sights/{sightId}/move": {
      "parameters": [
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "post": {
        "summary": "Move dashboard",
        "description": "Moves the specified dashboard to a new location.",
        "operationId": "move-sight",
        "tags": [
          "dashboards"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "CREATE_SIGHTS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Authorization"
          },
          {
            "$ref": "#/components/parameters/Content-Type"
          },
          {
            "$ref": "#/components/parameters/sightId"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ContainerDestinationForMove"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing a Dashboard object with a subset of attributes for the moved dashboard.\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ItemResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/SightResult"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination\nContainerDestination destination = new ContainerDestination\n{\n  DestinationId = 8460057768683396,               // long destinationFolderId\n  DestinationType = DestinationType.FOLDER\n};\n\n// Move Dashboard\nSight sight = smartsheet.SightResources.MoveSight(\n  5077532685952900,                               // long sightId\n  destination\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sights/{sightId}/move \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n  \"destinationType\": \"folder\",\n  \"destinationId\": workspace_or_folder_id\n}' \\\n-X POST\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify destination\nContainerDestination destination = new ContainerDestination()\n        .setDestinationType(DestinationType.FOLDER)\n        .setDestinationId(7960873114331012L);\n\n// Move Dashboard\nSight sight = smartsheet.sightResources().moveSight(\n        4583173393803140L,                          // long sightId\n        destination\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set destination\nvar body = {\n  destinationType: \"folder\",\n  destinationId: 8460057768683396\n};\n\n// Set options\nvar options = {\n  sightId: 5077532685952900,\n  body: body\n};\n\n// Move Dashboard\nsmartsheet.sights.moveSight(options)\n  .then(function(movedSight) {\n    console.log(movedSight);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Sights.move_sight(\n  5363568917931908,                           # sight_id\n  smartsheet.models.ContainerDestination({\n    'destination_type': 'folder',           # folder, workspace, or home\n    'destination_id': 8460057768683396      # destination folder_id\n  })\n)\n"
          }
        ]
      }
    },
    "/sights/{sightId}/path": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/sightIdNumber"
        }
      ],
      "get": {
        "summary": "Get dashboard path",
        "description": "Gets the hierarchical path of the dashboard, showing its location within folders and workspace, if workspace-level access is provided",
        "operationId": "get-sight-path",
        "tags": [
          "dashboards"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SIGHTS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Path information for the dashboard",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PathSightResponse"
                }
              }
            }
          },
          "404": {
            "description": "Dashboard not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/sights/{sightId}/publish": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/sightId"
        }
      ],
      "get": {
        "summary": "Get dashboard publish status",
        "description": "Gets the dashboard 'publish' settings.",
        "operationId": "get-sight-publish-status",
        "tags": [
          "dashboards"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SIGHTS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "SightPublish object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SightPublish"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSightPublish publish = smartsheet.SightResources.GetPublishStatus(\n    5363568917931908    // sightId\n  );\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sights/{sightId}/publish \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSightPublish publish = smartsheet.sightResources().getPublishStatus(\n        5363568917931908L    // long sightId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sightId: 5363568917931908\n};\n\n// Get dashboard publish status\nsmartsheet.sights.getSightPublishStatus(options)\n  .then(function(status) {\n    console.log(status);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nstatus = smartsheet_client.Sights.get_publish_status(\n  5363568917931908)       # sight_id\n"
          }
        ]
      },
      "put": {
        "summary": "Set dashboard publish status",
        "description": "Publishes or unpublishes a dashboard.",
        "operationId": "set-sight-publish-status",
        "tags": [
          "dashboards"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_SIGHTS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SightPublish"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SightPublish object",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ItemResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/SightPublish"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSightPublish publish = new SightPublish();\npublish.ReadOnlyFullEnabled = true;\nsmartsheet.SightResources.SetPublishStatus(\n  5363568917931908,    // sightId\n  publish\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sights/{sightId}/publish \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '{\n  \"readOnlyFullEnabled\": true,\n  \"readOnlyFullAccessibleBy\": \"ALL\"\n}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSightPublish publish = new SightPublish();\npublish.setReadOnlyFullEnabled(true);\nsmartsheet.sightResources().setPublishStatus(\n        5363568917931908L,    // long sightId\n        publish\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify property to change\nvar body = {\n  readOnlyFullEnabled: false\n};\n\n// Set options\nvar options = {\n  sightId: 5363568917931908,\n  body: body\n};\n\n// Set dashboard publish status\nsmartsheet.sights.setSightPublishStatus(options)\n  .then(function(newStatus) {\n    console.log(newStatus);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Sights.set_publish_status(\n  5363568917931908,       # sight_id\n  smartsheet.models.SightPublish({\n    'read_only_full_enabled': True\n  })\n)\n"
          }
        ]
      }
    },
    "/sights/{sightId}/shares": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/accessApiLevel"
        },
        {
          "$ref": "#/components/parameters/sightId"
        }
      ],
      "post": {
        "summary": "Share dashboard",
        "description": "Shares a dashboard with the specified users and groups.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "share-sight",
        "tags": [
          "dashboards",
          "sharing"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "SHARE_SIGHTS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/sendEmail"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Share"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing either a single Share object or an array of Share objects, corresponding to what was\nspecified in the request. All shares have scope=ITEM.\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "oneOf": [
                            {
                              "$ref": "#/components/schemas/Share"
                            },
                            {
                              "type": "array",
                              "title": "Array of shares",
                              "items": {
                                "$ref": "#/components/schemas/Share"
                              }
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "If called with a single Share object, and that user or group share already exists, error code 1025 is returned.\nIf called with an array of Share objects, and one or more user or group shares in the array already exist,\nthey are ignored and omitted from the response.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nShare share = new Share {\n  Type = ShareType.USER,\n  AccessLevel = AccessLevel.EDITOR,\n  Email = \"jane.doe@smartsheet.com\"\n}\nList<Share> sightShares = smartsheet.SightResources.ShareResources.ShareTo(\n  6327127650920324,             // sightId\n  new Share[] { share },        // IEnumerable<Share> shares\n  true                          // bool sendEmail\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/sights/{sightId}/shares?sendEmail=true' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '[{\"email\": \"jane.doe@smartsheet.com\", \"accessLevel\": \"VIEWER\"}]'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify share (to one user as Viewer)\nShare shareSpecification = new Share()\n        .setEmail(\"jane.doe@smartsheet.com\")\n        .setAccessLevel(AccessLevel.VIEWER);\n\n// Share dashboard\nList<Share> addressList = smartsheet.sightResources().shareResources().shareTo(\n        4583614634583940L,                    // long sightId\n        (Arrays.asList(shareSpecification)),\n        true                                  // Boolean sendEmail\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify share (to one user as Viewer)\nvar share = [\n  {\n    \"email\": \"jane.doe@smartsheet.com\",\n    \"accessLevel\": \"VIEWER\"\n  }\n];\n\n// Set options\nvar options = {\n  sightId: 6327127650920324,\n  body: share\n};\n\n// Share dashboard\nsmartsheet.sights.share(options)\n  .then(function(addressList) {\n    console.log(addressList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Sights.share_sight(\n  6327127650920324,       # sight_id\n  smartsheet.models.Share({\n    'access_level': 'VIEWER',\n    'email': 'jane.doe@smartsheet.com'\n  }),\n  True                    # sendEmail\n)\n"
          }
        ]
      },
      "get": {
        "summary": "List dashboard shares",
        "description": "Gets a list of all users and groups to whom the specified dashboard is shared, and their access level.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "list-sight-shares",
        "tags": [
          "dashboards",
          "sharing"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SIGHTS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/sharingInclude"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "IndexResult object containing an array of Share objects. By default, this operation returns only item-level shares (scope=ITEM). Use the sharingInclude parameter to request that workspace-level shares (scope=WORKSPACE) also be returned.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Share"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nPaginatedResult<Share> shares = smartsheet.SightResources.ShareResources.ListShares(\n  6327127650920324,       // sightId\n  null,                   // Pagination parameters\n  ShareScope.Item         // ShareScope shareScope\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sights/{sightId}/shares \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n//Sample 1: List all\nsmartsheet.sightResources().shareResources().listShares(\n        6327127650920324L,    // long sightId\n        null,    // PaginationParameters\n        true    // includeWorkspaceShares\n        );\n\n//Sample 2: Paginate the list\nPaginationParameters paginationParameters = new PaginationParameters(\n        false,  // includeAll\n        100,    // pageSize\n        1   // page\n        );\nsmartsheet.sightResources().shareResources().listShares(\n        6327127650920324L,    // long sightId\n        paginationParameters,\n        true    // includeWorkspaceShares\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sightId: 6327127650920324\n}\n\n// List dashboard shares\nsmartsheet.sights.listShares(options)\n  .then(function(shareList) {\n    console.log(shareList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List all\nresponse = smartsheet_client.Sights.list_shares(\n  6327127650920324,       # sight_id\n  include_all=True)\nshares = response.data\n\n# Sample 2: Paginate the list\nresponse = smartsheet_client.Sights.list_shares(\n  6327127650920324,       # sight_id\n  page_size=10,\n  page=1)\npages = response.total_pages\nshares = response.data\n"
          }
        ]
      }
    },
    "/sights/{sightId}/shares/{shareId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/sightId"
        },
        {
          "$ref": "#/components/parameters/shareId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Get dashboard share",
        "description": "Gets a list of all users and groups to whom the specified dashboard is\nshared, and their access level.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "share-sight-get",
        "parameters": [
          {
            "$ref": "#/components/parameters/accessApiLevel"
          }
        ],
        "tags": [
          "dashboards",
          "sharing"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SIGHTS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns Share object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Share"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nShare share = smartsheet.SightResources.ShareResources.GetShare(\n  6327127650920324,           // long sightId\n  \"AAABbMomFOeE\"              // string shareId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sights/{sightId}/shares/{shareId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nShare share = smartsheet.sightResources().shareResources().getShare(\n        6327127650920324L,           // long sightId\n        \"AAABbMomFOeE\"              // string shareId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sightId: 6327127650920324,\n  shareId: \"AAABbMomFOeE\"\n}\n\n// Get dashboard share\nsmartsheet.sights.getShare(options)\n  .then(function(share) {\n    console.log(share);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nshare = smartsheet_client.Sights.get_share(\n  6327127650920324,       # sight_id\n  'AAACOqOmFOeE')         # share_id\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete dashboard share",
        "description": "Deletes the share specified in the URL.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "delete-sight-share",
        "tags": [
          "dashboards",
          "sharing"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "SHARE_SIGHTS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns Result object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Result"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.SightResources.ShareResources.DeleteShare(\n  6327127650920324,     // sightId\n  \"AAABbMomFOeE\"        // string shareId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sights/{sightId}/shares/{shareId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sightResources().shareResources().deleteShare(\n        6327127650920324L,           // long sightId\n        \"AAABbMomFOeE\"               // string shareId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  sightId: 6327127650920324,\n  shareId: \"AAABbMomFOeE\"\n}\n\n// Delete dashboard share\nsmartsheet.sights.deleteShare(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Sights.delete_share(\n  6327127650920324,       # sight_id\n  'AAACOqOmFOeE')         # share_id\n"
          }
        ]
      },
      "put": {
        "summary": "Update dashboard share",
        "description": "Updates the access level of a user or group for the specified dashboard.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "update-sight-share",
        "parameters": [
          {
            "$ref": "#/components/parameters/accessApiLevel"
          }
        ],
        "tags": [
          "dashboards",
          "sharing"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "SHARE_SIGHTS"
            ]
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "accessLevel": {
                    "$ref": "#/components/schemas/AccessLevel"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Returns Result object containing the modified Share object.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "object",
                          "items": {
                            "$ref": "#/components/schemas/Share"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nShare updatedShare = smartsheet.SightResources.ShareResources.UpdateShare(\n  6327127650920324,          // sightId\n  new Share {                // Share share\n    Id = \"AAALRqomFOeE\",     // string shareId\n    AccessLevel = AccessLevel.VIEWER  // AccessLevel accessLevel\n  }\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/sights/{sightId}/shares/{shareId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '{\"accessLevel\": \"VIEWER\"}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set the access level to Viewer\nShare shareSpecification = new Share();\n        shareSpecification.setAccessLevel(AccessLevel.VIEWER)\n        .setId(\"AAAFeF82FOeE\");   // string shareId\n\n// Update dashboard share\nShare updatedShare = smartsheet.sightResources().shareResources().updateShare(\n        6327127650920324L,       // long sightId\n        shareSpecification\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set access level to Viewer\nvar shareSpecification = {\"accessLevel\": \"VIEWER\"};\n\n// Set options\nvar options = {\n  sightId: 6327127650920324,\n  shareId: \"AAALRqomFOeE\",\n  body: shareSpecification\n};\n\n// Update dashboard share\nsmartsheet.sights.updateShare(options)\n  .then(function(updatedShare) {\n    console.log(updatedShare);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nupdated_share = smartsheet_client.Sights.update_share(\n  6327127650920324,       # sight_id\n  'AAALRqomFOeE',         # share_id\n  smartsheet.models.Share({\n    'access_level': 'VIEWER'\n  })\n)\n"
          }
        ]
      }
    },
    "/templates": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List user-created templates",
        "deprecated": true,
        "description": "Gets a list of user-created templates that the user has access to.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n\n> **DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** \n> \n> As an alternative , you can use the [`GET /workspaces/{workspaceId}/children`](/api/smartsheet/openapi/workspaces/get-workspace-children) and [`GET /folders/{folderId}/children`](/api/smartsheet/openapi/folders/get-folder-children) endpoints with the `childrenResourceTypes=sheets,templates` parameter, to list templates specific to a workspace or folder.\n> \n> Refer to these articles for details on using the above-mentioned endpoints:\n>\n> - [Migrate from GET /folders/{id}  for folder and child metadata](/api/smartsheet/guides/updating-code/migrate-from-get-folder.md)\n> - [Migrate from GET /workspaces/{id} for workspace and child metadata](/api/smartsheet/guides/updating-code/migrate-from-get-workspace)\n",
        "operationId": "templates-list",
        "tags": [
          "templates"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/accessApiLevel"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of Templates",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Template"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPaginatedResult<Template> templates = smartsheet.TemplateResources.ListUserCreatedTemplates(\n  null                // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/templates \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPagedResult<Template> templates = smartsheet.templateResources().listUserCreatedTemplates(\n        null        // PaginationParameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.templates.listUserCreatedTemplates()\n  .then(function(templateList) {\n    console.log(templateList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# List all templates and paginate the response\nresponse = smartsheet_client.Templates.list_user_created_templates(\n  page_size=10,\n  page=1)\npages = response.total_pages\ntemplates = response.data\n"
          }
        ]
      }
    },
    "/templates/public": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List public templates",
        "deprecated": true,
        "description": "Gets a list of public templates that the user has access to.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.**\n",
        "operationId": "templates-listPublic",
        "tags": [
          "templates"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/accessApiLevel"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "name": "level",
            "in": "query",
            "required": false,
            "description": "Level of public template types. 0 refers to only Sheet types, 1 refers to all types.",
            "schema": {
              "type": "number",
              "enum": [
                0,
                1
              ],
              "default": 0
            }
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of Templates",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Template"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "/token": {
      "parameters": [
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "post": {
        "summary": "Gets or refreshes an access token",
        "description": "Gets or refreshes an access token, as part of the OAuth process.",
        "operationId": "tokens-getOrRefresh",
        "tags": [
          "tokens"
        ],
        "parameters": [
          {
            "name": "Content-Type",
            "in": "header",
            "description": "Required for POST and PUT requests. Defines the structure for the response.\n",
            "schema": {
              "type": "string",
              "enum": [
                "application/x-www-form-urlencoded"
              ]
            }
          },
          {
            "in": "query",
            "name": "client_id",
            "schema": {
              "type": "string"
            },
            "description": "The client ID you obtained when you registered your app.",
            "required": true
          },
          {
            "in": "query",
            "name": "client_secret",
            "schema": {
              "type": "string"
            },
            "description": "(Optional) Must use either this value or hash. Plain text method for sending this value. For example, client_secret={app_secret}. Encryption occurs at the HTTPS level."
          },
          {
            "in": "query",
            "name": "code",
            "schema": {
              "type": "string"
            },
            "description": "Authorization code acquired after user selects \"Allow\" in the Web login UI."
          },
          {
            "in": "query",
            "name": "grant_type",
            "schema": {
              "type": "string",
              "enum": [
                "authorization_code",
                "refresh_token"
              ]
            },
            "required": true,
            "description": "Must be set to \"authorization_code\"."
          },
          {
            "in": "query",
            "name": "hash",
            "schema": {
              "type": "string"
            },
            "description": "(Optional) Must use either this value or client_secret. SHA-256 hash of your app secret concatenated with a pipe and the authorization code. For example, hash={SHA_256(app_secret|code)}."
          },
          {
            "in": "query",
            "name": "refresh_token",
            "schema": {
              "type": "string"
            },
            "description": "refresh_token value that came with the access token."
          },
          {
            "in": "query",
            "name": "redirect_url",
            "schema": {
              "type": "string"
            },
            "deprecated": true,
            "description": "**Deprecated** If supplied, must match the redirect URI you registered for your app."
          }
        ],
        "responses": {
          "200": {
            "description": "An access token",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Token"
                }
              }
            }
          },
          "default": {
            "description": "Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Get access token\n// Option 1: Use a hash\nToken token = oauth.ObtainNewToken(\n  authResult      // AuthorizationResult authResult\n);\n\n// Option 2: Use plain text\n// In progress\n\n// Sample 2: Refresh access token\nToken tokenRefreshed = oauth.RefreshToken(token);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "// Sample 1: Get access token\n// Option 1: Use a hash\ncurl https://api.smartsheet.com/2.0/token \\\n-d 'grant_type=authorization_code&code={your_code}&client_id={your_client_id}&hash={SHA_256(app_secret|code)}' \\\n-X POST\n\n// Option 2: Use plain text\ncurl https://api.smartsheet.com/2.0/token \\\n-d 'grant_type=authorization_code&code={your_code}&client_id={your_client_id}&client_secret={app_secret}' \\\n-X POST\n\n// Sample 2: Refresh access token\n// Option 1: Use a hash\ncurl https://api.smartsheet.com/2.0/token \\\n-d 'grant_type=refresh_token&refresh_token={your_refresh_token}&client_id={your_client_id}&hash={SHA_256(app_secret|refresh_token)}' \\\n-X POST\n\n// Option 2: Use plain text\ncurl https://api.smartsheet.com/2.0/token \\\n-d 'grant_type=refresh_token&refresh_token={your_refresh_token}&client_id={your_client_id}&client_secret={app_secret}' \\\n-X POST\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Get access token\n// Option 1: Use a hash\n// Create hash\nvar hash =\n  crypto.createHash('sha256')\n    .update('9samp7le3for71you' + '|' + 'sample6p9qisx6a')\n        // ('Your App Secret' + '|' + 'Received Authorization Code')\n    .digest('hex');\n\n// Set options\nvar options = {\n  queryParameters: {\n    client_id: '1samp48lel5for68you',   // Your App Client ID\n    code: 'sample6p9qisx6a',            // Received Authorization Code\n    hash: hash\n  },\n  contentType: 'application/x-www-form-urlencoded'\n};\n\n// Get access token\nsmartsheet.tokens.getAccessToken(options)\n  .then(function(token) {\n  console.log(token);\n})\n.catch(function(error) {\n    console.log(error);\n  });\n\n// Option 2: Use plain text\n// In progress\n\n// Sample 2: Refresh access token\n// Create hash\nvar hash =\n  crypto.createHash('sha256')\n    .update('9samp7le3for71you' + '|' + 'sample6p9qisx6a')\n        // ('Your App Secret' + '|' + 'Your App Refresh Token')\n    .digest('hex');\n\n// Set options\nvar options = {\n  queryParameters: {\n    client_id: '1samp48lel5for68you',   // Your App Client ID\n    refresh_token: 'e9x352a9mp4151le2505',\n    hash: hash\n  },\n  contentType: 'application/x-www-form-urlencoded'\n};\n\n// Refresh access token\nsmartsheet.tokens.refreshAccessToken(options)\n  .then(function(updatedToken) {\n      console.log(updatedToken);\n  })\n  .catch(function(error) {\n      console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nimport requests\n\nurl = \"https://api.smartsheet.com/2.0/token?client_id=string&client_secret=string&code=string&grant_type=authorization_code&hash=string&refresh_token=string&redirect_url=string\"\n\nquery = {\n  \"client_id\": \"string\",\n  \"client_secret\": \"string\",\n  \"code\": \"string\",\n  \"grant_type\": \"authorization_code\",\n  \"hash\": \"string\",\n  \"refresh_token\": \"string\",\n  \"redirect_url\": \"string\"\n}\n\nheaders = {\"Content-Type\": \"application/x-www-form-urlencoded\"}\n\nresponse = requests.post(url, headers=headers, params=query)\n\ndata = response.json()\nprint(data)\n"
          }
        ]
      },
      "delete": {
        "summary": "Revoke access token",
        "description": "Revokes the access token used to make this request. The access token is no longer valid, and subsequent API calls made using the token fail.",
        "operationId": "tokens-delete",
        "tags": [
          "tokens"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Authorization"
          },
          {
            "name": "deleteAllForApiClient",
            "in": "query",
            "schema": {
              "type": "boolean",
              "default": false
            },
            "description": "The client ID and user ID is fetched based on the token that is used to make this API call. A value of true deletes all tokens associated to the given client ID and user ID.",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Result"
                }
              }
            }
          },
          "default": {
            "description": "Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.TokenResources.RevokeAccessToken();\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/token \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.tokenResources().revokeAccessToken();\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.tokens.revokeAccessToken({})\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Token.revoke_access_token()\n"
          }
        ]
      }
    },
    "/users": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "operationId": "list-users",
        "summary": "List users",
        "description": "Gets a list of users in the organization account. To filter by email, use the optional email query string parameter to specify a list of users' email addresses.\n\nFor **System admins**, the following User object attributes are included in the response (else, they are omitted from the response):\n\n* **admin**\n* **groupAdmin**\n* **isInternal**\n* **licensedSheetCreator**\n* **resourceViewer**\n* **seatType** - Shows when you specify either or both the `planId` and `seatType` query parameters.\n* **seatTypeLastChangedAt**\n* **sheetCount** (SUNSET) - The `sheetCount` attribute now holds the value `-1` and is included only if the retrieved user's `status` is `ACTIVE`.\n* **status**\n\n> **Note:** If the API request is submitted by a **System Admin** of an **Enterprise account**, and <a href=\"https://help.smartsheet.com/articles/1392225-customizing-a-welcome-message-upgrade-screen-enterprise-only\" target=\"_blank\" rel=\"noopener noreferrer\">Custom Welcome Screen</a> is enabled, the following [User object](/api/smartsheet/openapi/users/user) attributes are included in the response (else, they are omitted from the response):\n> \n> **customWelcomeScreenViewed** (omitted if the user has never viewed the <a href=\"https://help.smartsheet.com/articles/1392225-customizing-a-welcome-message-upgrade-screen-enterprise-only\" target=\"_blank\" rel=\"noopener noreferrer\">Custom Welcome Screen</a>)\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "tags": [
          "users"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_USERS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/emailInclude"
          },
          {
            "$ref": "#/components/parameters/lastLoginInclude"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/numericDates"
          },
          {
            "$ref": "#/components/parameters/planId-query"
          },
          {
            "name": "displayContributorSeatType",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "example": true
            },
            "description": "When `true` and there's no `seatType` filter, it displays `seatType` as `CONTRIBUTOR` for all free-tier plans users.\n"
          },
          {
            "$ref": "#/components/parameters/seatType"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "IndexResult object containing an array of [User objects](/api/smartsheet/openapi/users/user).\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "List of User Objects",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/User"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// List users with CONTRIBUTOR seat types displayed\nPaginatedResult<User> response = smartsheet.UserResources.ListUsers(\n    emails: null,\n    includes: null,\n    paging: null,\n    displayContributorSeatType: true\n);\n\n// Process the results\nforeach (User user in response.Data)\n{\n    Console.WriteLine($\"User: {user.Name} ({user.Email})\");\n    Console.WriteLine($\"  Seat Type: {user.SeatType}\");  // Will show CONTRIBUTOR instead of VIEWER\n    Console.WriteLine($\"  Status: {user.Status}\");\n    if (user.SeatTypeLastChangedAt != null)\n    {\n        Console.WriteLine($\"  Seat Type Changed: {user.SeatTypeLastChangedAt}\");\n    }\n}\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/users?email=john.doe@smartsheet.com&include=lastLogin' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// List users with CONTRIBUTOR seat types displayed\nPagedResult<User> response = smartsheet.userResources()\n    .listUsers(\n        null,                    // email filter\n        null,                    // planId filter\n        null,                    // seatType filter\n        true,                    // displayContributorSeatType\n        null                     // pagination parameters\n);\n\nfor (User user : response.getData()) {\n    System.out.println(\"User: \" + user.getName() + \" (\" + user.getEmail() + \")\");\n    System.out.println(\"  Seat Type: \" + user.getSeatType());  // Will show CONTRIBUTOR instead of VIEWER\n    System.out.println(\"  Status: \" + user.getStatus());\n    if (user.getSeatTypeLastChangedAt() != null) {\n        System.out.println(\"  Seat Type Changed: \" + user.getSeatTypeLastChangedAt());\n    }\n}\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// List users with CONTRIBUTOR seat types displayed\nconst options = {\n  queryParameters: {\n    displayContributorSeatType: true,\n    includeAll: true\n  }\n};\n\nclient.users.listAllUsers(options)\n  .then((response) => {\n    console.log(`Total users: ${response.totalCount}`);\n\n    response.data.forEach((user) => {\n      console.log(`\\nUser: ${user.name} (${user.email})`);\n      console.log(`  Seat Type: ${user.seatType}`);  // Will show CONTRIBUTOR instead of VIEWER\n      console.log(`  Status: ${user.status}`);\n\n      if (user.seatTypeLastChangedAt) {\n        console.log(`  Seat Type Changed: ${user.seatTypeLastChangedAt}`);\n      }\n    });\n  })\n  .catch((error) => {\n    console.error('Error listing users:', error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = client.Users.list_users(display_contributor_seat_type=True)\n\n# Process the results\nfor user in response.data:\n    print(f\"User: {user.name} ({user.email})\")\n    print(f\"  Seat Type: {user.seat_type}\")  # Will show CONTRIBUTOR instead of VIEWER\n    print(f\"  Status: {user.status}\")\n    if user.seat_type_last_changed_at:\n        print(f\"  Seat Type Changed: {user.seat_type_last_changed_at}\")\n"
          }
        ]
      },
      "post": {
        "operationId": "add-user",
        "summary": "Add user",
        "description": "Adds a user to the organization account.\n\n> **Who can use this operation?**\n>\n> **Permissions:** System Admin\n\nIf successful, and user auto provisioning (UAP) is on, and user matches the auto provisioning rules, user is added to the org. If UAP is off, or user does not match UAP rules, user is invited to the org and must explicitly accept the invitation to join.\n\n> **Note:** On user model plans, this operation sets `licensedSheetCreator` to `true`, regardless of the value provided in the request body.\n\n> **Note:** In some specific scenarios, supplied attributes such as firstName and lastName may be ignored. For example, if you are inviting an existing Smartsheet user to join your organization account, and the invited user has not yet accepted your invitation, any supplied firstName and lastName are ignored.\n",
        "tags": [
          "users"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/sendEmail"
          }
        ],
        "requestBody": {
          "description": "The User to be created",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/User"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing the newly created [User object](/api/smartsheet/openapi/users/user).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/User"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "If an error occurs because the request specified the alternate email address (that is, not the primary email address) of an existing Smartsheet user (to invite the user into the org), the Error object returned contains a detail attribute set to an array of objects, each object in the array having the following attributes:\n\n  * alternateEmailAddress: User's alternate email address that was specified in the request\n  * primaryEmailAddress: User's primary email address that must instead be specified for the operation\n\nFor example:\n\n```javascript\n{\n  \"errorCode\": 5xxx,\n  \"message\": \"The specified email address (u1+1@smartsheet.com) is an alternate address for a user with the primary email address of u1@smartsheet.com. Please retry using their primary address.\"\n  \"detail\": [\n      {\n        \"alternateEmailAddress\": \"u1+1@smartsheet.com\",\n        \"primaryEmailAddress\": \"u1@smartsheet.com\"\n      }\n  ]\n}\n```\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set user properties\nUser userSpecification = new User\n{\n  Email = \"john.doe@smartsheet.com\",\n  Admin = false,\n  LicensedSheetCreator = true,\n  FirstName = \"John\",\n  LastName = \"Doe\"\n};\n\n// Add user\nUser newUser = smartsheet.UserResources.AddUser(\n  userSpecification,\n  true,                   // Nullable<bool> sendEmail\n  null                    // Nullable<bool> allowInviteAccountAdmin\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/users?sendEmail=true' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"firstName\": \"John\", \"lastName\": \"Doe\", \"email\": \"john.doe@smartsheet.com\", \"admin\": false, \"licensedSheetCreator\": true}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set user properties\nUser userSpecification = new User();\nuserSpecification.setAdmin(false)\n        .setEmail(\"john.doe@smartsheet.com\")\n        .setFirstName(\"John\")\n        .setLastName(\"Doe\")\n        .setLicensedSheetCreator(true);\n\n// Add user\nUser newUser = smartsheet.userResources().addUser(userSpecification);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify user properties\nvar user = {\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"email\": \"john.doe@smartsheet.com\",\n  \"admin\": false,\n  \"licensedSheetCreator\": true\n};\n\n// Set options\nvar options = {\n  body: user\n};\n\n// Add user\nsmartsheet.users.addUser(options)\n  .then(function(newUser) {\n    console.log(newUser)\n  }).catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nnew_user = smartsheet_client.Users.add_user(\n  smartsheet.models.User({\n    'first_name': 'John',\n    'last_name': 'Doe',\n    'email': 'john.doe@smartsheet.com',\n    'admin': False,\n    'licensed_sheet_creator': True\n  })\n)\n"
          }
        ]
      }
    },
    "/users/me": {
      "parameters": [
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "operationId": "get-current-user",
        "summary": "Get current user",
        "description": "Gets the current user.\n\nFor **System Admins**, the following UserProfile attributes\nare included in the response:\n  * `customWelcomeScreenViewed` (only included when an Enterprise user has viewed the <a href=\"https://help.smartsheet.com/articles/1392225-customizing-a-welcome-message-upgrade-screen-enterprise-only\" target=\"_blank\" rel=\"noopener noreferrer\">Custom Welcome Screen</a>)\n  * `lastLogin` (only included if the user has logged in)\n  * `sheetCount` (**Sunset**) - The `sheetCount` attribute now holds the value `-1` and is included only if the retrieved user's `status` is `ACTIVE`.\n",
        "tags": [
          "users"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Authorization"
          },
          {
            "$ref": "#/components/parameters/userProfileInclude"
          }
        ],
        "responses": {
          "200": {
            "description": "IndexResultUnknownPages object containing a UserProfile object.\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/UserProfile"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "List of Groups",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Group"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nUserProfile userProfile = smartsheet.UserResources.GetCurrentUser();\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/users/me \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nUserProfile userProfile = smartsheet.userResources().getCurrentUser();\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.users.getCurrentUser()\n  .then(function(userProfile) {\n    console.log(userProfile);\n  })\n  .catch(function(error) {\n      console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Get current user\nuser_profile = smartsheet_client.Users.get_current_user()\n\n# Sample 2: Include groups\nuser_profile = smartsheet_client.Users.get_current_user(include=Groups)\n"
          }
        ]
      }
    },
    "/users/sheets": {
      "parameters": [
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "operationId": "list-org-sheets",
        "summary": "List org sheets",
        "description": "Gets a summarized list of all sheets owned by the members of the\norganization account.\n\n> **Who can use this operation?**\n> \n> **Permissions:** System Admin\n\n* **_You may use the query string parameter numericDates with a value of\ntrue to enable strict parsing of dates in numeric format. See [Dates and\nTimes](/api/smartsheet/guides/basics/dates-and-times) for more information._**\n",
        "tags": [
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Authorization"
          },
          {
            "$ref": "#/components/parameters/modifiedSince"
          }
        ],
        "responses": {
          "200": {
            "description": "IndexResultUnknownPages object containing an array of Sheet objects,\nlimited to the following attributes:\n\n* id\n\n* name\n\n* owner: empty string\n\n* ownerId: (static \"0\")\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResultUnknownPages"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "List of Sheets",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/SheetList"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nPaginatedResult<Sheet> sheets = smartsheet.UserResources.SheetResources.ListOrgSheets(\n  null,               // PaginationParameters\n  null                // Nullable<DateTime> modifiedSince\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/users/sheets \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nPagedResult<Sheet> sheets = smartsheet.userResources().listOrgSheets();\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.sheets.listOrganizationSheets()\n  .then(function(sheetsList) {\n    console.log(sheetsList)\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Sheets.list_org_sheets()\nsheets = response.data\n"
          }
        ]
      }
    },
    "/users/{userId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/userId"
        }
      ],
      "get": {
        "operationId": "get-user",
        "summary": "Get user",
        "description": "Gets the user specified in the URL.\n\nFor **System Admins**, the following UserProfile attributes are\nincluded in the response):\n  * `admin`\n  * `customWelcomeScreenViewed` (only returned when an Enterprise user has viewed the <a href=\"https://help.smartsheet.com/articles/1392225-customizing-a-welcome-message-upgrade-screen-enterprise-only\" target=\"_blank\" rel=\"noopener noreferrer\">Custom Welcome Screen</a>)\n  * `groupAdmin`\n  * `lastLogin` (only returned if the user has logged in)\n  * `licensedSheetCreator`\n  * `resourceViewer`\n  * `sheetCount` (**Sunset**) - The `sheetCount` attribute now holds the value `-1` and is included only if the retrieved user's `status` is `ACTIVE`.\n  * `status`\n",
        "tags": [
          "users"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_USERS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns UserProfile object.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserProfile"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nUserProfile userProfile = smartsheet.UserResources.GetUser(\n  48569348493401200           // long userId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/users/{userId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nUserProfile userProfile = smartsheet.userResources().getUser(\n        48569348493401200L           // long userId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  id: 48569348493401200\t// Id of user\n};\n\n// Get user\nsmartsheet.users.getUser(options)\n  .then(function(userProfile) {\n    console.log(userProfile)\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nuser_profile = smartsheet_client.Users.get_user(\n  48569348493401200)          # user_id\n"
          }
        ]
      },
      "delete": {
        "operationId": "remove-user",
        "summary": "Remove user from organization",
        "description": "Removes the user from your organization.\n\n> **Who can use this operation?**\n>\n> **Permissions:** System Admin\n\n> **Important:** To remove a user from your plan, refer to [Remove user from plan](/api/smartsheet/openapi/users/remove-user-from-plan).\n\n**If you have <a href=\"https://help.smartsheet.com/articles/2482433-Enterprise-plan-manager-overview\" target=\"_blank\" rel=\"noopener noreferrer\">Enterprise Plan Manager</a> enabled**, this endpoint removes the user from organizations that inherit from your organization.\n\n**If you're managing users via an external source**, such as an identity provider (IdP) or directory integration (DI) provider, you must use that source to remove users. Okta and Azure AD are examples of external sources.\n",
        "tags": [
          "users"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "parameters": [
          {
            "name": "removeFromSharing",
            "in": "query",
            "required": false,
            "description": "Set this to `true` to remove the user's access to all assets in your organization and plan.\n",
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "transferSheets",
            "in": "query",
            "required": false,
            "description": "If you want to transfer ownership of all the removed user's assets and groups to a qualified user\\*, set this parameter to `true` and set the `transferTo` parameter to the ID of the qualified user. The transfer depends on setting the `transferTo` parameter.\n\n> **Warning:** If your asset transfer size exceeds 38k, the transfer fails with a `400` error that prompts you to contact Support for guidance.\n\n\\* The receiving user must be a <a href=\"https://help.smartsheet.com/articles/520100-user-types\" target=\"_blank\" rel=\"noopener noreferrer\">Group Admin</a> of the group(s) to be transferred.\n",
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "transferTo",
            "in": "query",
            "required": false,
            "description": "Set this to the ID of a qualified user\\* to receive ownership of all groups the removed user owns.\n\nAlso if you set the `transferSheets` parameter to `true`, the operation additionally transfers ownership of all the removed user's assets to the assigned user.\n\n\\* The receiving user must be a <a href=\"https://help.smartsheet.com/articles/520100-user-types\" target=\"_blank\" rel=\"noopener noreferrer\">Group Admin</a> of the groups.\n",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the result object.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "400": {
            "description": "This can be caused by the following situations:\n\n- You attempted to remove your plan's main contact.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 5687,\n    \"message\": \"This person is the main contact for your plan and can't be removed.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- You cannot remove directory integration-managed users.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 5666,\n    \"message\": \"This person is managed from your directory service. Please delete them through your directory service instead.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- The user owns groups but you didn't set the `transferTo` parameter.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1121,\n    \"message\": \"transferTo must be provided because user being deleted owns one or more groups.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- You cannot transfer to the user to be removed.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1018,\n    \"message\": \"The value '{userId}' was not valid for the parameter 'transferTo'.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- The transfer recipient user cannot be found.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1019,\n    \"message\": \"Cannot transfer to the user specified. User not found.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- You cannot transfer to a user in a different organization.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1021,\n    \"message\": \"Cannot transfer to the user specified. They are not a member of your account.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- The user to be removed owns groups but the transfer recipient is not a <a href=\"https://help.smartsheet.com/articles/520100-user-types\" target=\"_blank\" rel=\"noopener noreferrer\">Group Admin</a>.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1107,\n    \"message\": \"User specified in transferGroupsTo must be a group admin.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- The asset transfer size exceeds the threshold.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 5737,\n    \"message\": \"Sorry we could not complete this transfer ownership request at this time. Contact support@smartsheet.com\",\n    \"refId\": \"abcd1234\"\n  }\n"
          },
          "403": {
            "description": "This can be caused by the following situations:\n\n- You are not a System Admin.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1004,\n    \"message\": \"You are not authorized to perform this action.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- The user is not in your organization and the user is not internal to your User Subscription Model plan.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1004,\n    \"message\": \"You are not authorized to perform this action.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n"
          },
          "404": {
            "description": "This can be caused by the following situations:\n\n- The user is not in your organization and you're on a Legacy Collaborator Model plan.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1020,\n    \"message\": \"User not found.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- No user account found (invalid user ID).\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1020,\n    \"message\": \"User not found.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n"
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Transfer ownership of groups and sheets to another user and remove the user from sharing\nsmartsheet.UserResources.RemoveUser(\n  94094820842,                // long userId\n  transferToUserId,           // Nullable<long> transferTo\n  true,                       // Nullable<bool> transferSheets\n  true                        // Nullable<bool> removeFromSharing\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/users/{userId}?transferTo=USER_Id&removeFromSharing=true' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Transfer ownership of groups and sheets to another user and remove the user from sharing\nDeleteUserParameters parameters = new DeleteUserParameters(\n        62123820842L,       // long transferToUserId\n        true,               // Boolean transferSheets\n        true                // Boolean removeFromSharing\n        );\n\nsmartsheet.userResources().deleteUser(\n        94094820842L,        // long userId\n        parameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  id: 94094820842 // Id of User\n};\n\n// Remove user\nsmartsheet.users.removeUser(options)\n  .then(function(results) {\n    console.log(results)\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Users.remove_user(\n  94094820842,                # user_id\n  transfer_to=62123820842,    # ownership of groups and sheets transfer to user_id\n  remove_from_sharing=True)\n"
          }
        ]
      },
      "put": {
        "operationId": "update-user",
        "summary": "Update user",
        "description": "Updates attributes of the specified user.\n\n> **Who can use this operation?**\n> \n> **Permissions:** System Admin. To modify a user who belongs to a **user model organization**, you must also be a member of that same organization.\n\n**Licensed sheet creator constraints**\n\n- **On the user model**, you can only update `licensedSheetCreator` for a **System Admin** user (`admin: true`). \n- You can't revoke the licensed sheet creator status (that is, set `licensedSheetCreator` to `false`) for a user who is either a **Group Admin** (`groupAdmin: true`) or a **Resource Viewer** (`resourceViewer: true`). \n",
        "tags": [
          "users"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UserUpdate"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing the [User object](/api/smartsheet/openapi/users/user) for the updated user.\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "Updated User Properties",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/UserProfileImageResponse"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "This can be caused by the following situation:\n\nUpdating the license status (that is, updating the `licensedSheetCreator` attribute) of a non-System Admin user. \n\n```json\n{\n  \"errorCode\": 2109,\n  \"message\": \"User subscription updates (upgrade/downgrade) cannot be performed through this method. Please use the bulk upgrade/downgrade API.\"\n}\n```\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "errorCode": {
                      "example": 2109
                    },
                    "message": {
                      "example": "User subscription updates (upgrade/downgrade) cannot be performed through this method. Please use the bulk upgrade/downgrade API."
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "This can be caused by the following situations:\n\n- Setting `licensedSheetCreator` to `false` for a Group Administrator.\n  Example response: \n\n  ```json\n  {\n    \"errorCode\": 1102,\n    \"message\": \"A user must be a licensed sheet creator to be a group administrator.\"\n  }\n  ```\n\n- Setting `licensedSheetCreator` to `false` for a Resource Viewer.\n  Example response: \n\n  ```json\n  {\n    \"errorCode\": 1097\n    \"message\": \"A user must be a licensed sheet creator to be a resource viewer.\"\n  }\n  ```\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "errorCode": {
                      "example": 1102
                    },
                    "message": {
                      "example": "A user must be a licensed sheet creator to be a group administrator."
                    }
                  }
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify updated user properties\nUser userSpecification = new User\n{\n  Id = 82349925918590,    // userId\n  Admin = true\n};\n\n// Update user\nUser updatedUser = smartsheet.UserResources.UpdateUser(\n  userSpecification\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/users/{userId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '{\"admin\": true}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify updated user properties\nUser userSpecification = new User();\nuserSpecification.setLicensedSheetCreator(true)\n        .setAdmin(true)\n        .setId(82349925918590L);        // long userId\n\n// Update user\nUser updatedUser = smartsheet.userResources().updateUser(userSpecification);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify updated user properties\nvar user = {\n  \"admin\": true\n};\n\n// Set options\nvar options = {\n  id: 82349925918590, // Id of User\n  body: user\n  };\n\n// Update user\nsmartsheet.users.updateUser(options)\n  .then(function(updatedUser) {\n    console.log(updatedUser)\n  }).catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nupdated_user = smartsheet_client.Users.update_user(\n  82349925918590,     # user_id\n  smartsheet.models.User({\n    'admin': True\n  })\n)\n"
          }
        ]
      }
    },
    "/users/{userId}/alternateemails": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/userId"
        }
      ],
      "get": {
        "operationId": "list-alternate-emails",
        "summary": "List alternate emails",
        "description": "Gets a list of the alternate emails for the specified user.\n\n> **Who can use this operation?**\n> \n> - **Plans:** Only Enterprise and Advanced Work Management plans with this feature activated by Support can use this method. If you want to activate this feature, please contact Support.\n> - **Permissions:** System Admin\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
        "tags": [
          "alternateEmailAddress"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_USERS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "IndexResult object containing an array of [AlternateEmail objects](/api/smartsheet/openapi/alternateemailaddress/alternateemail).\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of attachments",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/AlternateEmail"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit 'email' parameter and pagination parameters\nPaginatedResult<AlternateEmail> results = smartsheet.UserResources.ListAlternateEmails(\n  123456789012345,        // long userId\n  null                    // PaginationParameters\n);\n"
          },
          {
            "lang": "curl",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/users/{userId}/alternateemails \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit 'email' parameter and pagination parameters\nPagedResult<AlternateEmail> results = smartsheet.userResources().listAlternateEmails(\n        123456789012345L,        // long userId\n        null                    // PaginationParameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  userId: 123456789012345\n};\n\n// List alternate email addresses\nsmartsheet.users.listAlternateEmails(options)\n  .then(function(emailList) {\n    console.log(emailList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Users.list_alternate_emails(\n  123456789012345)        # user_id\nemails = response.data\n"
          }
        ]
      },
      "post": {
        "operationId": "add-alternate-email",
        "summary": "Add alternate emails",
        "description": "Adds one or more alternate email addresses for the specified user.\n\n> **Who can use this operation?**\n> \n> - **Plans:** Only Enterprise plans with this feature activated by Support can use this method. If you want to activate this feature, please contact Support.\n> - **Permissions:** System Admin\n",
        "tags": [
          "alternateEmailAddress"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/AddAlternateEmail"
                  },
                  {
                    "type": "array",
                    "title": "Alternate email array",
                    "items": {
                      "$ref": "#/components/schemas/AddAlternateEmail"
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing an array of the newly created [AlternateEmail\nobjects](/api/smartsheet/openapi/alternateemailaddress/alternateemail).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "Updated User Properties",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/AlternateEmail"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "If a single email address is specified in the request and an error\noccurs, the response contains an Error object.\n\nIf multiple email addresses are specified in the request and an error\noccurs, the Error object returned contains a detail attribute set to an\narray of objects, each object in the array having the following\nattributes:\n  * email: Problematic email address specified in the request\n  * errorCode: Smartsheet error code\n  * message: Message that describes the problem with the specified email address\n\nFor example:\n\n```javascript\n{\n  \"errorCode\": 1160,\n  \"message\": \"Invalid bulk request. See detail for more information.\"\n  \"detail\": [\n      {\n        \"email\": \"altEmail1@smartsheet.com\",\n        \"errorCode\": 1157,\n        \"message\": \"This address is already associated with another Smartsheet account, so it cannot be added as an alternate address for this account.\"\n      }\n  ]\n}\n```\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nList<AlternateEmail> alternateEmails = smartsheet.UserResources.AddAlternateEmail(\n  4495214342629252,                       // userId\n  new AlternateEmail[] {                  // Array of AlternateEmail\n    new AlternateEmail { Email = \"John.Doe@smartsheet.com\" },\n    new AlternateEmail { Email = \"John.Doe.Test@smartsheet.com\" }\n  }\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/users/{userId}/alternateemails \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '[{\"email\": \"John.Doe@smartsheet.com\"}]'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nAlternateEmail alias1 = new AlternateEmail();\nalias1.setEmail(\"John.Doe@smartsheet.com\");\nAlternateEmail alias2 = new AlternateEmail();\nalias2.setEmail(\"John.Doe.Test@smartsheet.com\");\n\nsmartsheet.userResources().addAlternateEmail(\n        4495214342629252L,    // long userId\n        Arrays.asList(alias1, alias2)\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify email addresses to add\nvar body = [\n  {\n    email: \"John.Doe@smartsheet.com\"\n  }\n];\n\n// Set options\nvar options = {\n  userId: 4495214342629252,\n  body: body\n};\n\n// Add alternate email address\nsmartsheet.users.addAlternateEmail(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Users.add_alternate_email(\n  4495214342629252,          # user_id\n  [\n    smartsheet.models.AlternateEmail({\n        'email': 'John.Doe@smartsheet.com'\n    })\n  ]\n)\n"
          }
        ]
      }
    },
    "/users/{userId}/alternateemails/{alternateEmailId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/userId"
        },
        {
          "$ref": "#/components/parameters/alternateEmailId"
        }
      ],
      "get": {
        "operationId": "get-alternate-email",
        "summary": "Get alternate email",
        "description": "Gets the specified alternate email.\n\n> **Who can use this operation?**\n> \n> - **Plans:** Only Enterprise and Advanced Work Management plans with this feature activated by Support can use this method. If you want to activate this feature, please contact Support.\n> - **Permissions:** System Admin\n",
        "tags": [
          "alternateEmailAddress"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_USERS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns [AlternateEmail object](/api/smartsheet/openapi/alternateemailaddress/alternateemail)\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AlternateEmail"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.UserResources.GetAlternateEmail(\n  401090454808452,        // long userId\n  123456789012345         // long altEmailId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/users/{userId}/alternateemails/{alternateEmailId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.userResources().getAlternateEmail(\n        401090454808452L,        // long userId\n        123456789012345L         // long altEmailId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  userId: 401090454808452,\n  alternateEmailId: 123456789012345\n};\n\n// Get alternate email address\nsmartsheet.users.getAlternateEmail(options)\n  .then(function(email) {\n    console.log(email);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nalt_email = smartsheet_client.Users.get_alternate_email(\n  401090454808452,        # user_id\n  123456789012345)        # alternate_email_id\n"
          }
        ]
      },
      "delete": {
        "operationId": "delete-alternate-email",
        "summary": "Delete alternate email",
        "description": "Deletes the specified alternate email address for the specified user.\n\n> **Who can use this operation?**\n> \n> - **Plans:** Only Enterprise and Advanced Work Management plans with this feature activated by Support can use this method. If you want to activate this feature, please contact Support.\n> - **Permissions:** System Admin\n",
        "tags": [
          "alternateEmailAddress"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the result object.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.UserResources.DeleteAlternateEmail(\n  401090454808452,        // long userId\n  123456789012345         // long altEmailId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/users/{userId}/alternateemails/{alternatEmailId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.userResources().deleteAlternateEmail(\n        401090454808452L,        // long userId\n        123456789012345L         // long altEmailId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  userId: 401090454808452,\n  alternateEmailId: 123456789012345\n};\n\n// Delete alternate email address\nsmartsheet.users.deleteAlternateEmail(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Users.delete_alternate_email(\n  401090454808452,        # user_id\n  123456789012345)        # alternate_email_id\n"
          }
        ]
      }
    },
    "/users/{userId}/alternateemails/{alternateEmailId}/makeprimary": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/userId"
        },
        {
          "$ref": "#/components/parameters/alternateEmailId"
        }
      ],
      "post": {
        "operationId": "promote-alternate-email",
        "summary": "Make alternate email primary",
        "description": "Makes the specified alternate email address to become the primary email\naddress for the specified user.\n\n> **Who can use this operation?**\n> \n> - **Plans:** Only Enterprise and Advanced Work Management plans with this feature activated by Support can use this method. If you want to activate this feature, please contact Support.\n> - **Permissions:** System Admin\n\nThe alternate email address can only be made primary if both conditions are\nmet:\n\n- The primary email address domain is validated\n- The alternate email address is confirmed or the alternate email address domain is validated\n",
        "tags": [
          "alternateEmailAddress"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of alternate email results",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/AlternateEmail"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "403": {
            "description": "This can be caused by the following situation:\n\nYou are not on an Enterprise plan and do not have this feature enabled.\n\nExample response:\n\n```json\n{\n    \"errorCode\": 1189,\n    \"message\": \"Only Enterprise or Team accounts with security controls are able to change primary emails.\",\n    \"refId\": \"abcd1234\"\n}\n```\n"
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nAlternateEmail primaryEmail = smartsheet.UserResources.PromoteAlternateEmail(\n  401090454808452,        // userId\n  123456789012345         // altEmailId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/users/{userId}/alternateemails/{alternatEmailId}/makeprimary \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nAlternateEmail primaryEmail = smartsheet.userResources().promoteAlternateEmail(\n        401090454808452L,    // long userId\n        123456789012345L    // long altEmailId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  userId: 401090454808452,\n  alternateEmailId: 123456789012345\n};\n\n// Make alternate email primary\nsmartsheet.users.makeAlternateEmailPrimary(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nresponse = smartsheet_client.Users.promote_alternate_email(\n  401090454808452,        # user_id\n  123456789012345)        # alt_id\n"
          }
        ]
      }
    },
    "/users/{userId}/deactivate": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/userId"
        }
      ],
      "post": {
        "operationId": "deactivate-user",
        "summary": "Deactivate user",
        "description": "Deactivates the user associated with the current Smartsheet plan, blocking the user from using Smartsheet in any way. Deactivating a user does not affect their existing permissions on owned or shared items.\n\nOptionally, with Enterprise Plan Manager (EPM) enabled, you can deactivate a user from child organizations.\n\n> **Who can use this operation?**\n> \n> **Permissions:** System Admin\n>\n> This operation is unavailable for Smartsheet Gov.\n\nAttempting to deactivate a user that matches any of the following criteria results in an error:\n- The user's primary email address belongs to an ISP domain (e.g., `gmail.com`, `yahoo.com`, `outlook.com`). For example, see the common ISP domains listed below.\n- The user's primary email address is unassociated with the current Smartsheet plan domain(s).\n- The user is managed by an external source, such as an identity provider (IdP) or directory integration (DI) provider. External source examples include Okta and Azure AD. Deactivating such a user can only be done via the external source.\n\nUsers with primary email addresses on the following ISP domains cannot be deactivated:\n- `aol.com`\n- `charter.net`\n- `comcast.net`\n- `duck.com`\n- `email.com`\n- `gmail.com`\n- `hotmail.com`\n- `icloud.com`\n- `live.com`\n- `mail.com`\n- `mail.ru`\n- `outlook.com`\n- `rocketmail.com`\n- `usa.com`\n- `verizon.net`\n- `web.de`\n- `yahoo.com`\n",
        "tags": [
          "users"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the result object.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "400": {
            "description": "The user is managed from a directory service.\n\nExample response:\n\n```json\n{\n  \"errorCode\": 5697,\n  \"message\": \"This person is managed from your directory service. Please deactivate them through your directory service instead.\",\n  \"refId\": \"abcd1234\"\n}\n```\n"
          },
          "403": {
            "description": "This can be caused by the following situations:\n\n- User account has a common ISP domain email.\n  ```json\n  {\n    \"errorCode\": 1359,\n    \"message\": \"User account with a common ISP domain email cannot be deactivated. You can only remove them from the Org.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n- User is external: in your org, not in your EPM child org, or has no internal planMembership in your plan.\n  ```json\n  {\n    \"errorCode\": 1004,\n    \"message\": \"You are not authorized to perform this action.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n"
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C#",
            "label": "C# SDK",
            "source": "var userId = 1234567890L;\nsmartsheet.UserResources.DeactivateUser(userId);\n"
          },
          {
            "lang": "Java",
            "label": "Java SDK",
            "source": "long userId = 1234567890L;\nsmartsheet.userResources().deactivateUser(userId);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/users/{userId}/deactivate \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST\n"
          },
          {
            "lang": "JavaScript",
            "label": "JavaScript SDK",
            "source": "var options = {\n  userId: 1234567890\n};\n\nsmartsheet.users.deactivateUser(options)\n  .then(function(result) {\n    console.log(\"User deactivated successfully.\");\n  }).catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "smartsheet_client.Users.deactivate_user(user_id=1234567890)\n"
          }
        ]
      }
    },
    "/users/{userId}/plans/{planId}/downgrade": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/userId"
        },
        {
          "$ref": "#/components/parameters/planId-path"
        }
      ],
      "post": {
        "operationId": "downgrade-user",
        "summary": "Downgrade user",
        "description": "Downgrades the user associated with the specified Smartsheet plan. Downgrading a user does not affect their existing permissions on owned or shared items.\n\nA user can be downgraded to the following seat types:\n* GUEST - only external users can be downgraded to this seat type.\n* CONTRIBUTOR \n* VIEWER (Deprecated, use CONTRIBUTOR instead)\n\n> **Who can use this operation?**\n>\n> **Permissions:** System Admin\n",
        "tags": [
          "users"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "requestBody": {
          "description": "The seat type to be downgraded to.",
          "content": {
            "application/json": {
              "schema": {
                "required": [
                  "seatType"
                ],
                "properties": {
                  "seatType": {
                    "description": "User's seat type.\n\n**DEPRECATED - As early as the sunset date specified in this [changelog entry](/api/smartsheet/changelog#deprecated-viewer-seat-type-in-favor-of-contributor-new), `VIEWER` will be removed and replaced by `CONTRIBUTOR` for all free-tier plans users.** Commenting and attachments are free to the `CONTRIBUTOR` seat type.\n",
                    "type": "string",
                    "enum": [
                      "GUEST",
                      "CONTRIBUTOR",
                      "VIEWER"
                    ],
                    "example": "CONTRIBUTOR"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Returns the result object..\n\nDowngrading a user to its current seat type returns 200 OK.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "400": {
            "description": "This can be caused by the following situations:\n\n- Downgrading a sysadmin.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1364,\n    \"message\": \"Seat type cannot be changed. User 48569348493401200 is a sysadmin.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- Downgrading a user to an invalid seat type.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1365,\n    \"message\": \"Invalid seatType provided. Allowed values are 'VIEWER' or 'GUEST'.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- Downgrading an inactive user.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1366,\n    \"message\": \"Seat type cannot be changed. User 48569348493401200 is inactive. Reactivate the user first.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- Downgrading an internal user to `GUEST`.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1367,\n    \"message\": \"Internal user's seat type cannot be changed to GUEST.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n"
          },
          "403": {
            "description": "This can be caused by the following situations:\n\n- Caller is not a System Admin.\n  ```json\n  {\n    \"errorCode\": 1004,\n    \"message\": \"You are not authorized to perform this action.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n"
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C#",
            "label": "C# SDK",
            "source": "var userId = 1234567890L;\nvar planId = 9876543210L;\nsmartsheet.UserResources.DowngradeUser(userId, planId, DowngradeSeatType.CONTRIBUTOR);\n"
          },
          {
            "lang": "Java",
            "label": "Java SDK",
            "source": "long userId = 1234567890L;\nlong planId = 9876543210L;\nsmartsheet.userResources().downgradeUser(userId, planId, DowngradeSeatType.CONTRIBUTOR);\n"
          },
          {
            "lang": "JavaScript",
            "label": "JavaScript SDK",
            "source": "var options = {\n  userId: 1234567890,\n  planId: 9876543210,\n  body: { seatType: SeatTypes.CONTRIBUTOR },\n};\n\nsmartsheet.users.downgradeUser(options)\n  .then(function() {\n    console.log(\"User downgraded successfully.\");\n  }).catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "smartsheet_client.Users.downgrade_user(user_id=1234567890, plan_id=9876543210, seat_type=DowngradeSeatType.CONTRIBUTOR)\n"
          }
        ]
      }
    },
    "/users/{userId}/profileimage": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/userId"
        }
      ],
      "post": {
        "operationId": "update-user-profile-image",
        "summary": "Update user profile image",
        "description": "Uploads an image to the user profile.\n\nUploading a profile image differs from Adding an Image to a Cell in the\nfollowing ways:\n  * A **Content-Length** header is not required\n  * Allowable file types are limited to: gif, jpg, and png\n  * Maximum file size is determined by the following rules:\n      * If you have not defined a custom size and the image is larger than 1050 x 1050 pixels, Smartsheet scales the image down to 1050 x 1050\n      * If you have defined a custom size, Smartsheet uses that as the file size max\n  * If the image is not square, Smartsheet uses a solid color to pad the image\n",
        "tags": [
          "users"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "WRITE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            },
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "filename": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            },
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/URLAttachmentRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Returns the result object.\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "Updated User Properties",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/UserProfileImageResponse"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nUser myUser = smartsheet.UserResources.AddProfileImage(\n  3173821341106052,                // userId\n  \"../path/to/mrgoodlookin.jpg\",   // string file\n  \"image/jpeg\"                     // string fileType (MIME)\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/users/{userId}/profileimage' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: image/jpeg\" \\\n-H 'Content-Disposition: attachment; filename=janeroe.jpg' \\\n-X POST \\\n--data-binary @janeroe.jpg\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\ntry {\n        User myUser = smartsheet.userResources().addProfileImage(\n        3173821341106052L,               // long userId\n        \"../path/to/mrgoodlookin.jpg\",   // String file\n        \"image/jpeg\"                     // String fileType (MIME)\n        );\n        } catch (FileNotFoundException e) {\n        e.printStackTrace();\n        }\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nvar options = {\n  userId: 3173821341106052,\n  path: '../path/to/mrgoodlookin.jpg',\n  fileName: 'mrgoodlookin.jpg'\n};\n\nsmartsheet.users.addProfileImage(options)\n  .then(function(result) {\n    console.log(result);\n  }).catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\naction = smartsheet_client.Users.add_profile_image(\n  3173821341106052,               # user_id (int)\n  '../path/to/mrgoodlookin.jpg',  # file (string)\n  'image/jpeg'                    # file_type (string)\n)\n"
          }
        ]
      }
    },
    "/users/{userId}/reactivate": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/userId"
        }
      ],
      "post": {
        "operationId": "reactivate-user",
        "summary": "Reactivate user",
        "description": "Reactivates the user associated with the current Smartsheet plan, restoring the user's access to Smartsheet, owned items, and shared items.\n\nOptionally, with Enterprise Plan Manager (EPM) enabled, you can specify the ID of a user within your managed plan hierarchy.\n\n> **Important:** You can reactivate the user only if that user has been deactivated for less than thirty (30) days.\n\n> **Who can use this operation?**\n>\n> **Permissions:** System Admin\n>\n> This operation is unavailable for Smartsheet Gov.\n\nAttempting to reactivate a user that matches any of the following criteria results in an error:\n- The user's primary email address belongs to an ISP domain (e.g., `gmail.com`, `yahoo.com`, `outlook.com`). For example, see the common ISP domains listed below.\n- The user's primary email address is unassociated with the current Smartsheet plan domain(s).\n- The user is not in the plan's organization.\n\nUsers with primary email addresses on the following ISP domains cannot be reactivated:\n- `aol.com`\n- `charter.net`\n- `comcast.net`\n- `duck.com`\n- `email.com`\n- `gmail.com`\n- `hotmail.com`\n- `icloud.com`\n- `live.com`\n- `mail.com`\n- `mail.ru`\n- `outlook.com`\n- `rocketmail.com`\n- `usa.com`\n- `verizon.net`\n- `web.de`\n- `yahoo.com`\n",
        "tags": [
          "users"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the result object.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "400": {
            "description": "The user is managed from a directory service.\n\nExample response:\n\n```json\n{\n  \"errorCode\": 5717,\n  \"message\": \"This person is managed from your directory service. Please reactivate them through your directory service instead.\",\n  \"refId\": \"abcd1234\"\n}\n```\n"
          },
          "403": {
            "description": "The user is external: in your org, not in your EPM child org, or has no internal planMembership in your plan.\n\nExample response:\n\n```json\n{\n  \"errorCode\": 1004,\n  \"message\": \"You are not authorized to perform this action.\",\n  \"refId\": \"abcd1234\"\n}\n```\n"
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C#",
            "label": "C# SDK",
            "source": "var userId = 1234567890L;\nsmartsheet.UserResources.ReactivateUser(userId);\n"
          },
          {
            "lang": "Java",
            "label": "Java SDK",
            "source": "long userId = 1234567890L;\nsmartsheet.userResources().reactivateUser(userId);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\ncurl https://api.smartsheet.com/2.0/users/{userId}/reactivate \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST\n"
          },
          {
            "lang": "JavaScript",
            "label": "JavaScript SDK",
            "source": "var options = {\n  userId: 1234567890\n};\n\nsmartsheet.users.reactivateUser(options)\n  .then(function(result) {\n    console.log(\"User reactivated successfully.\");\n  }).catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "smartsheet_client.Users.reactivate_user(user_id=1234567890)\n"
          }
        ]
      }
    },
    "/users/{userId}/plans/{planId}/upgrade": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/userId"
        },
        {
          "$ref": "#/components/parameters/planId-path"
        }
      ],
      "post": {
        "operationId": "upgrade-user",
        "summary": "Upgrade user",
        "description": "Upgrades the user associated with the specified Smartsheet plan.\n\nA user can be upgraded to the following seat types:\n* GUEST - only external users can be upgraded to this seat type.\n* MEMBER\n\n> **Who can use this operation?**\n>\n> **Permissions:** System Admin\n\n> **Note:** Upgrading a user to its current seat type returns `200` OK.\n",
        "tags": [
          "users"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "requestBody": {
          "description": "The seat type to be upgraded to.",
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "seatType": {
                    "description": "User's seat type.",
                    "type": "string",
                    "enum": [
                      "GUEST",
                      "MEMBER"
                    ],
                    "default": "MEMBER",
                    "example": "MEMBER"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Returns the result object.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "400": {
            "description": "This can be caused by the following situations:\n\n- Upgrading a sysadmin.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1364,\n    \"message\": \"Seat type cannot be changed. User 48569348493401200 is a sysadmin.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- Upgrading a user to an invalid seat type.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1365,\n    \"message\": \"Invalid seatType provided. Allowed values are 'MEMBER' or 'GUEST'.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- Upgrading an inactive user.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1366,\n    \"message\": \"Seat type cannot be changed. User 48569348493401200 is inactive. Reactivate the user first.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- Upgrading an internal user to `GUEST`.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1367,\n    \"message\": \"Internal user's seat type cannot be changed to GUEST.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n"
          },
          "403": {
            "description": "This can be caused by the following situations:\n\n- Caller is not a System Admin.\n  ```json\n  {\n    \"errorCode\": 1004,\n    \"message\": \"You are not authorized to perform this action.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n"
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C#",
            "label": "C# SDK",
            "source": "var userId = 1234567890L;\nvar planId = 9876543210L;\nsmartsheet.UserResources.UpgradeUser(userId, planId, UpgradeSeatType.MEMBER);\n"
          },
          {
            "lang": "Java",
            "label": "Java SDK",
            "source": "long userId = 1234567890L;\nlong planId = 9876543210L;\nsmartsheet.userResources().upgradeUser(userId, planId, UpgradeSeatType.MEMBER);\n"
          },
          {
            "lang": "JavaScript",
            "label": "JavaScript SDK",
            "source": "var options = {\n  userId: 1234567890,\n  planId: 9876543210,\n  body: { seatType: SeatTypes.MEMBER },\n};\n\nsmartsheet.users.upgradeUser(options)\n  .then(function() {\n    console.log(\"User upgraded successfully.\");\n  }).catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "smartsheet_client.Users.upgrade_user(user_id=1234567890, plan_id=9876543210, seat_type=UpgradeSeatType.MEMBER)\n"
          }
        ]
      }
    },
    "/users/{userId}/plans/{planId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/userId"
        },
        {
          "$ref": "#/components/parameters/planId-path"
        }
      ],
      "delete": {
        "operationId": "remove-user-from-plan",
        "summary": "Remove user from plan",
        "description": "Removes a user's access to all items they were previously shared to within the specified plan. This action can't be reversed.",
        "tags": [
          "users"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns result object.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "400": {
            "description": "This can be caused by the following situations:\n\n- Removing a sysadmin.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1364,\n    \"message\": \"Seat type cannot be changed. User 48569348493401200 is a sysadmin.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n\n- Removing an inactive user.\n\n  Example response:\n\n  ```json\n  {\n    \"errorCode\": 1366,\n    \"message\": \"Seat type cannot be changed. User 48569348493401200 is inactive. Reactivate the user first.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n"
          },
          "403": {
            "description": "This can be caused by the following situation:\n\n- Caller is not a system administrator.\n  ```json\n  {\n    \"errorCode\": 1004,\n    \"message\": \"You are not authorized to perform this action.\",\n    \"refId\": \"abcd1234\"\n  }\n  ```\n"
          },
          "default": {
            "description": "Generic error payload.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C#",
            "label": "C# SDK",
            "source": "var userId = 1234567890L;\nvar planId = 9876543210L;\nsmartsheet.UserResources.RemoveUserFromPlan(userId, planId);\n"
          },
          {
            "lang": "Java",
            "label": "Java SDK",
            "source": "long userId = 1234567890L;\nlong planId = 9876543210L;\nsmartsheet.userResources().removeUserFromPlan(userId, planId);\n"
          },
          {
            "lang": "JavaScript",
            "label": "JavaScript SDK",
            "source": "var options = {\n  userId: 1234567890,\n  planId: 9876543210,\n};\n\nsmartsheet.users.removeUserFromPlan(options)\n  .then(function() {\n    console.log(\"User removed from plan successfully.\");\n  }).catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "smartsheet_client.Users.remove_user_from_plan(user_id=1234567890, plan_id=9876543210)\n"
          }
        ]
      }
    },
    "/users/{userId}/plans": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/userId"
        }
      ],
      "get": {
        "operationId": "list-user-plans",
        "summary": "List user plans",
        "description": "List plans to which the user belongs.\n\n> **Note:** For pagination guidance, refer to [Token-based pagination](/api/smartsheet/guides/basics/pagination#token-based-pagination).\n",
        "parameters": [
          {
            "$ref": "#/components/parameters/lastKey"
          },
          {
            "$ref": "#/components/parameters/maxItems"
          },
          {
            "name": "displayContributorSeatType",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "example": true
            },
            "description": "When `true`, displays `seatType` as `CONTRIBUTOR` for all free-tier plans the user belongs to.\n"
          }
        ],
        "tags": [
          "users"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_USERS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns result object.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/TokenBasedIndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "List of user' plan objects.",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/UserPlan"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic error payload.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C#",
            "label": "C# SDK",
            "source": "var userId = 1234567890L;\nresult TokenPaginatedResult<UserPlan> = smartsheet.UserResources.ListUserPlans(userId);\n"
          },
          {
            "lang": "Java",
            "label": "Java SDK",
            "source": "long userId = 1234567890L\nTokenPaginatedResult<UserPlan> result = userResources.listUserPlans(userId, null, null);\n"
          },
          {
            "lang": "JavaScript",
            "label": "JavaScript SDK",
            "source": "var options = {\n  userId: 1234567890,\n};\n\nsmartsheet.users.listUserPlans(options)\n  .then(function(userPlans) {\n    console.log(userPlans);\n  }).catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python",
            "label": "Python SDK",
            "source": "user_plans = smartsheet_client.Users.list_user_plans(user_id=1234567890)\n"
          }
        ]
      }
    },
    "/webhooks": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "operationId": "list-webhooks",
        "summary": "List webhooks",
        "description": "Gets the list of all *webhooks* that the user owns (if a user-generated\ntoken was used to make the request) or the list of all webhooks associated\nwith the third-party app (if a third-party app made the request). Items in\nthe response are ordered by API cient name > webhook name > creation date.\n\n**Note: In the response, each webhook's `events` field defaults to `[\"*.*\"]`, regardless of its actual value.** Alternatively, call [GET /webhook/{webhookId}](/api/smartsheet/openapi/webhooks/getwebhook) on an individual webhook to get its `events` value. \n\n**DEPRECATION - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), webhooks will be sorted by creation date (most recent first) instead of name.** See the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for migration instructions and details.\n",
        "tags": [
          "webhooks"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WEBHOOKS"
            ]
          }
        ],
        "parameters": [
          {
            "name": "includeAll",
            "in": "query",
            "deprecated": true,
            "required": false,
            "description": "If true, include all results, that is, do not paginate. Mutually exclusive\nwith page and pageSize (they are ignored if includeAll=true is specified).\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this parameter will be discontinued (sunset) to reduce latency, mitigate performance issues, and add stability, especially for users with many webhooks.** See the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for migration instructions and details.\n",
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "name": "pageSize",
            "in": "query",
            "deprecated": true,
            "required": false,
            "description": "The maximum number of items to return per page. Unless otherwise stated for a\nspecific endpoint, defaults to 100. If only page is specified, defaults to a\npage size of 100. For reports, the default is 100 rows. If you need larger\nsets of data from your report, returns a maximum of 10,000 rows per request.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), the unlimited value range will be discontinued (sunset) to reduce latency, mitigate performance issues, and add stability, especially for users with many webhooks.** See the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for migration instructions and details.\n",
            "schema": {
              "type": "number",
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The List of Webhooks",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "pageNumber": {
                          "description": "The current page in the full result set that the data array represents.\nNOTE when a page number greater than totalPages is requested, the last\npage is instead returned.\n",
                          "type": "number",
                          "example": 1,
                          "readOnly": true
                        },
                        "pageSize": {
                          "description": "The number of items in a page. Omitted if there is no limit to page size (and hence, all results are included). Unless otherwise specified, this defaults to 100 for most endpoints.",
                          "type": "number",
                          "example": 50,
                          "nullable": true,
                          "readOnly": true
                        },
                        "totalPages": {
                          "description": "The total number of pages in the full result set.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this response property value will be `-1`.** See the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for migration instructions and details.\n",
                          "type": "number",
                          "deprecated": true,
                          "example": 25,
                          "readOnly": true
                        },
                        "totalCount": {
                          "description": "The total number of items in the full result set.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this response property value will be `-1`.** See the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for migration instructions and details.\n",
                          "type": "number",
                          "deprecated": true,
                          "example": 136,
                          "readOnly": true
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "list of Webhooks",
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Webhook"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPaginatedResult<Webhook> webhooks = smartsheet.WebhookResources.ListWebhooks(\n    null            // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/webhooks \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPagedResult<Webhook> webhooks = smartsheet.webhookResources().listWebhooks(\n    null            // PaginationParameters\n);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n};\n\n// List webhooks\nsmartsheet.webhooks.listWebhooks(options)\n    .then(function(webhookList) {\n        console.log(webhookList);\n    })\n    .catch(function(error) {\n        console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# List webhooks\nresponse = smartsheet_client.Webhooks.list_webhooks()\n"
          }
        ]
      },
      "post": {
        "summary": "Create webhook",
        "description": "Creates a new Webhook.\n\n> **Important:** On creation, a webhook is inactive by default. You can activate the webhook by calling the [Update webhook](/api/smartsheet/openapi/webhooks/updatewebhook) operation on it with `enabled` set to `true`.\n\n**Webhook instance limits**\n\nEach scope object, such as a plan or a sheet, can have a maximum number of associated webhooks.\n\n| Object | Maximum webhooks |\n| :----------- | :-------------------------- |\n| Plan         | 100 |\n| Sheet        | 100k | \n\n> **Note:** If you're creating a plan-level webhook (**plan webhook**), you can pass **custom headers** in your webhook requests, which Smartsheet then adds to all requests that the webhook sends to your callback URL. This is useful for including authentication tokens or other information your application needs. To do this, add a `customHeaders` object to the request body, with each key-value pair representing a header and its value.\n> \n> See also:\n> \n> - `customHeaders` body parameter in the Body section below\n> - [Launch a plan-level webhook](/api/smartsheet/guides/users/automate-user-seat-type-management/launch-a-plan-level-webhook)\n> - [Create a plan event-handling endpoint](/api/smartsheet/guides/users/automate-user-seat-type-management/create-an-endpoint-to-handle-user-seat-type-events) article\n",
        "operationId": "createWebhook",
        "tags": [
          "webhooks"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WEBHOOKS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/PlanWebhook"
                      },
                      {
                        "$ref": "#/components/schemas/SheetWebhook"
                      }
                    ]
                  },
                  {
                    "type": "object",
                    "required": [
                      "callbackUrl",
                      "events",
                      "name",
                      "scope",
                      "scopeObjectId",
                      "version"
                    ]
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object, containing a Webhook object for the newly created webhook",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Webhook"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Webhook specification\nWebhook webhook = new Webhook\n{\n    Name = \"Webhook #4\",\n    CallbackUrl = \"https://www.myApp.com/webhooks\",\n    Scope = \"sheet\",\n    ScopeObjectId = 3285357287499652,\n    Events = new string[] { \"*.*\" },\n    Version = 1\n};\n\n// Create Webhook\nWebhook newWebhook = smartsheet.WebhookResources.CreateWebhook(\n    webhook\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/webhooks \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{   \"name\": \"Webhook #4\", \"callbackUrl\": \"https://www.myApp.com/webhooks\", \"scope\": \"sheet\", \"scopeObjectId\": 3285357287499652, \"events\": [\"*.*\"], \"version\": 1, \"subscope\": {\"columnIds\": [7318427511613316, 7318427511613123]}}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Webhook specification\nWebhook webhook = new Webhook();\nwebhook.setCallbackUrl(\"https://www.myApp.com/webhooks\")\n    .setScope(\"sheet\")\n    .setScopeObjectId(3285357287499652L)\n    .setEvents(Arrays.asList(\"*.*\"))\n    .setVersion(1)\n    .setName(\"Webhook #4\");\n\n// Create Webhook\nWebhook newWebhook = smartsheet.webhookResources().createWebhook(\n    webhook\n);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify webhook details\nvar body = {\n  name: \"Webhook #4\",\n  callbackUrl: \"https://www.myApp.com/webhooks\",\n  scope: \"sheet\",\n  scopeObjectId: 3285357287499652,\n  events: [\"*.*\"],\n  version: 1,\n};\n\n// Set options\nvar options = {\n  body: body,\n};\n\n// Create webhook\nsmartsheet.webhooks.createWebhook(options)\n    .then(function(newWebhook) {\n      console.log(newWebhook);\n    })\n    .catch(function(error) {\n      console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nWebhook = smartsheet_client.Webhooks.create_webhook(\n  smartsheet.models.Webhook({\n    'name': 'Webhook #4',\n    'callbackUrl': 'https://www.myApp.com/webhooks',\n    'scope': 'sheet',\n    'scopeObjectId': 3285357287499652,\n    'events': ['*.*'],\n    'version': 1}))\n"
          }
        ]
      }
    },
    "/webhooks/{webhookId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/webhookId"
        }
      ],
      "get": {
        "summary": "Get webhook",
        "description": "Gets a matching webhook based on the specified ID.",
        "operationId": "getWebhook",
        "tags": [
          "webhooks"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WEBHOOKS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Webhook object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Webhook"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nWebhook webhook = smartsheet.WebhookResources.GetWebhook(\n    401090454808452     // long webhookId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/webhooks/{webhookId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nWebhook webhook = smartsheet.webhookResources().getWebhook(\n    401090454808452L     // long webhookId\n);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n    webhookId: 401090454808452\n};\n\n// Get webhook\nsmartsheet.webhooks.getWebhook(options)\n    .then(function(webhook) {\n        console.log(webhook);\n    })\n    .catch(function(error) {\n        console.log(error);\n    });;\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nWebhook = smartsheet_client.Webhooks.get_webhook(\n  401090454808452)       # webhook_id\n"
          }
        ]
      },
      "put": {
        "summary": "Update webhook",
        "description": "Updates the matching Webhook. \n\n> **Important:** If you set `enabled` to `true`, the behavior and result depend on the webhook's `status` and may trigger a webhook verification or, in some cases, cause an error. See [Webhook status](/api/smartsheet/guides/webhooks/webhook-status) for details.\n\n> **Note:** If you're creating a plan-level webhook (**plan webhook**), you can pass **custom headers** in your webhook requests, which Smartsheet then adds to all requests that the webhook sends to your callback URL. This is useful for including authentication tokens or other information your application needs. To do this, add a `customHeaders` object to the request body, with each key-value pair representing a header and its value.\n> \n> See also:\n> \n> - `customHeaders` body parameter in the Body section below\n> - [Launch a plan-level webhook](/api/smartsheet/guides/users/automate-user-seat-type-management/launch-a-plan-level-webhook)\n> - [Create a plan event-handling endpoint](/api/smartsheet/guides/users/automate-user-seat-type-management/create-an-endpoint-to-handle-user-seat-type-events) article\n",
        "operationId": "updateWebhook",
        "tags": [
          "webhooks"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WEBHOOKS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/PlanWebhook"
                      },
                      {
                        "$ref": "#/components/schemas/SheetWebhook"
                      }
                    ]
                  },
                  {
                    "type": "object",
                    "properties": {
                      "enabled": {
                        "type": "boolean",
                        "example": true,
                        "description": "If `true`, the webhook is activated; Otherwise, it's inactive or deactivated."
                      },
                      "scope": {
                        "type": "string",
                        "enum": [
                          "sheet",
                          "plan"
                        ],
                        "example": "sheet",
                        "readOnly": true,
                        "description": "Scope of the subscription. Currently, the only supported values are sheet and plan. Specified when a webhook is created and cannot be changed.\n"
                      },
                      "scopeObjectId": {
                        "type": "integer",
                        "format": "int64",
                        "minimum": 1,
                        "example": 3285357287499652,
                        "readOnly": true,
                        "description": "ID of the object whose events this webhook is subscribed to.\n"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing the Webhook object for the updated webhook",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/Webhook"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Webhook specification\nWebhook webhook = new Webhook\n{\n    Id = 8444254503626628,\n    CallbackUrl = \"https://www.myApp.com/webhooks\",\n    Version = 1,\n    Enabled = true\n}\n\n// Update Webhook\nWebhook updatedWebhook = smartsheet.WebhookResources.UpdateWebhook(\n    webhook\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/webhooks/{webhookId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '{ \"enabled\": true }\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Webhook specification\nWebhook webhook = new Webhook();\n    webhook.setCallbackUrl(\"https://www.myApp.com/webhooks\")\n    .setVersion(1)\n    .setEnabled(true)\n    .setId(8444254503626628L);\n\n// Update Webhook\nWebhook updatedWebhook = smartsheet.webhookResources().updateWebhook(\n    webhook\n);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify changed values\nvar body = {\n    enabled: true\n};\n\n// Set options\nvar options = {\n    webhookId: 8444254503626628,\n    body: body\n};\n\n// Update webhook\nsmartsheet.webhooks.updateWebhook(options)\n    .then(function(updatedWebhook) {\n        console.log(updatedWebhook);\n    })\n    .catch(function(error) {\n        console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nWebhook = smartsheet_client.Webhooks.update_webhook(\n  8444254503626628,       # webhook_id\n  smartsheet_client.models.Webhook({\n    'enabled': True}))\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete webhook",
        "description": "Permanently deletes the specified webhook.\n\n> **Important:** This operation permanently deletes the webhook. Alternatively, to temporarily disable the webhook, use the [Update webhook](/api/smartsheet/openapi/webhooks/updatewebhook) operation with `enabled` set to `false`.\n",
        "operationId": "deleteWebhook",
        "tags": [
          "webhooks"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WEBHOOKS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Result object",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.WebhookResources.DeleteWebhook(\n    401090454808452     // long webhookId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/webhooks/{webhookId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.webhookResources().deleteWebhook(\n    401090454808452L     // long webhookId\n);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n    webhookId: 401090454808452\n};\n\n// Delete webhook\nsmartsheet.webhooks.deleteWebhook(options)\n    .then(function(results) {\n        console.log(results);\n    })\n    .catch(function(error) {\n        console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Webhooks.delete_webhook(\n  401090454808452)       # webhook_id\n"
          }
        ]
      }
    },
    "/webhooks/{webhookId}/resetSharedSecret": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/webhookId"
        }
      ],
      "post": {
        "summary": "Reset shared secret",
        "description": "Resets the shared secret for the specified webhook.\n\nYou can improve security by using this operation to rotate an API client webhooks' shared secrets at periodic intervals.\n\nFor more information about how a shared secret is used, see the **Authenticating callbacks** section in [Webhook callbacks](/api/smartsheet/guides/webhooks/webhook-callbacks#authenticating-callbacks-optional).\n",
        "operationId": "resetSharedSecret",
        "tags": [
          "webhooks"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WEBHOOKS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/SharedSecret"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nWebhookSharedSecret newSecret = smartsheet.WebhookResources.ResetSharedSecret(\n    401090454808452     // long webhookId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/webhooks/{webhookId}/resetsharedsecret \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nWebhookSharedSecret newSecret = smartsheet.webhookResources().ResetSharedSecret(\n    401090454808452L     // long webhookId\n);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Get options\nvar options = {\n    webhookId: 401090454808452\n};\n\n// Reset shared secret\nsmartsheet.webhooks.resetSharedSecret(options)\n    .then(function(newSecret) {\n        console.log(newSecret);\n    })\n    .catch(function(error) {\n        console.log(error);\n    });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nWebhook = smartsheet_client.Webhooks.reset_shared_secret(\n  401090454808452)       # webhook_id\n"
          }
        ]
      }
    },
    "/workspaces": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "List workspaces",
        "description": "Retrieves a list of workspaces that the user has access to. It returns metadata for the workspaces only and doesn't include nested sub-structures.\n\n> **Tip:** Set `paginationType=token` to use [token-based pagination](/api/smartsheet/guides/basics/pagination#token-based-pagination). \n\n> **See also:** [Pagination - SDK examples](/api/smartsheet/guides/basics/pagination-sdk-examples) demonstrates listing workspaces with token-based pagination.\n",
        "tags": [
          "workspaces"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "operationId": "list-workspaces",
        "parameters": [
          {
            "$ref": "#/components/parameters/accessApiLevel"
          },
          {
            "$ref": "#/components/parameters/paginationType"
          },
          {
            "$ref": "#/components/parameters/maxItemsListWorkspaces"
          },
          {
            "$ref": "#/components/parameters/lastKey"
          },
          {
            "name": "includeAll",
            "in": "query",
            "required": false,
            "description": "If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize\n(they are ignored if includeAll=true is specified).\n\n**DEPRECATED - As early as the sunset date specified in this \n[Changelog entry](/api/smartsheet/changelog#2025-08-04), this request parameter will no longer be supported.**\n\nRefer to the following articles for examples of listing workspaces with token-based pagination: \n\n- [Pagination](/api/smartsheet/guides/basics/pagination#token-based-pagination)\n- [Pagination - SDK examples](/api/smartsheet/guides/basics/pagination-sdk-examples)\n",
            "schema": {
              "type": "boolean",
              "default": false,
              "deprecated": true
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "description": "Which page to return. Defaults to 1 if not specified. If you specify a value\ngreater than the total number of pages, the last page of results is returned.\n\n**DEPRECATED - As early as the sunset date specified in this\n[Changelog entry](/api/smartsheet/changelog#2025-08-04), this request parameter will no longer be supported.**\n\nRefer to the following articles for examples of listing workspaces with token-based pagination: \n\n- [Pagination](/api/smartsheet/guides/basics/pagination#token-based-pagination)\n- [Pagination - SDK examples](/api/smartsheet/guides/basics/pagination-sdk-examples)\n",
            "schema": {
              "type": "number",
              "default": 1,
              "deprecated": true
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "required": false,
            "description": "The maximum number of items to return per page. Unless otherwise stated for a\nspecific endpoint, defaults to 100. If only page is specified, defaults to a\npage size of 100. For reports, the default is 100 rows. If you need larger\nsets of data from your report, returns a maximum of 10,000 rows per request.\n\n**DEPRECATED - As early as the sunset date specified in this\n[Changelog entry](/api/smartsheet/changelog#2025-08-04), this request parameter will no longer be supported.**\n\nRefer to the following articles for examples of listing workspaces with token-based pagination: \n\n- [Pagination](/api/smartsheet/guides/basics/pagination#token-based-pagination)\n- [Pagination - SDK examples](/api/smartsheet/guides/basics/pagination-sdk-examples)\n",
            "schema": {
              "type": "number",
              "default": 100,
              "deprecated": true
            }
          }
        ],
        "responses": {
          "200": {
            "description": "IndexResultWorkspaces object containing an array of Workspace objects. The response structure varies based on the paginationType parameter. When using token-based pagination (default), includes lastKey field. When using legacy page-based pagination, includes pageNumber and totalPages.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResultWorkspaces"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "lastKey": {
                          "$ref": "#/components/schemas/LastKey"
                        },
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/WorkspaceListing"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "string? lastKey = null;\ndo\n{\n    TokenPaginatedResult<Workspace> page =\n        client.WorkspaceResources.ListWorkspaces(\n            new ListWorkspacesTokenPaginationParameters(\n                lastKey, 100, \"token\"));\n\n    Console.WriteLine(page); // Do what you want with the page items\n\n    lastKey = page.LastKey;\n} while (!string.IsNullOrEmpty(lastKey));\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/workspaces?paginationType=token \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "String lastKey = null;\ndo {\n    PagedResult<Workspace> page = \n        client.workspaceResources()\n            .listWorkspaces(\n                new PaginationParameters(\n                    \"token\", lastKey, 100));\n\n    for (Workspace workspace : page.getData()) {\n        System.out.println(\n            \"Workspace: \" + workspace.getName()\n            + \" (ID: \" + workspace.getId() + \")\");\n    }\n\n    lastKey = page.getLastKey();\n} while (lastKey != null && !lastKey.isBlank());\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "try {\n  let lastKey = '';\n  do {\n    const page = await client.workspaces.listWorkspaces({\n      queryParameters: { \n        paginationType: \"token\",\n        maxItems: 100,\n        lastKey },\n    });\n\n    console.log(page); // Do what you want with the page items\n\n    lastKey = page?.lastKey;\n  } while (lastKey);\n} catch (err) {\n  console.error(err);\n  process.exit(1);\n}\n"
          }
        ]
      },
      "post": {
        "summary": "Create workspace",
        "description": "Creates a new workspace.\n",
        "operationId": "create-workspace",
        "tags": [
          "workspaces"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type_AppJsonOnly"
          }
        ],
        "requestBody": {
          "description": "Workspace to create.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "description": "Workspace name.",
                    "type": "string",
                    "example": "New workspace",
                    "maxLength": 50
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Basic information about the new Workspace.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/SuccessResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/WorkspaceListing"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify workspace name\nWorkspace workspaceSpecification = new Workspace { Name = \"New workspace\" };\n\n// Create workspace\nWorkspace newWorkspace = smartsheet.WorkspaceResources.CreateWorkspace(workspaceSpecification);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/workspaces \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"name\": \"New workspace\"}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify workspace name\nWorkspace workspaceSpecification = new Workspace();\nworkspaceSpecification.setName(\"New workspace\");\n\n// Create workspace\nWorkspace newWorkspace = smartsheet.workspaceResources().createWorkspace(workspaceSpecification);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify workspace name\nvar workspace = {\"name\": \"New workspace\"};\n\n// Set options\nvar options = {\n  body: workspace\n};\n\n// Create workspace\nsmartsheet.workspaces.createWorkspace(options)\n  .then(function(newWorkspace) {\n    console.log(newWorkspace);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Create workspace\nworkspace = smartsheet_client.Workspaces.create_workspace(\n  smartsheet.models.Workspace({\n    'name': 'New workspace'\n  })\n)\n\n# Sample 2: Include attachments\nworkspace = smartsheet_client.Workspaces.create_workspace(\n  include=attachments,\n  smartsheet.models.Workspace({\n      'name': 'New workspace'\n  })\n)\n"
          }
        ]
      }
    },
    "/workspaces/{workspaceId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/workspaceId"
        }
      ],
      "get": {
        "summary": "Get workspace",
        "deprecated": true,
        "description": "Gets a Workspace object.\n\n> **Important:** We've set a 60 requests per minute per API token limit for this operation.\n\n> **DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be removed.** See the [Get workspace metadata](/api/smartsheet/openapi/workspaces/get-workspace-metadata) and the [Get workspace children](/api/smartsheet/openapi/workspaces/get-workspace-children) endpoints for replacement functionality.\n> \n> Refer to these articles for details on using the above-mentioned endpoints:\n>\n> - [Migrate from GET /workspaces/{id} for workspace and child metadata](/api/smartsheet/guides/updating-code/migrate-from-get-workspace)\n> - [Migrate from GET /workspaces/{id} for workspace hierarchies](/api/smartsheet/guides/updating-code/migrate-from-get-workspaces-loadall)\n",
        "tags": [
          "workspaces"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "operationId": "get-workspace",
        "parameters": [
          {
            "$ref": "#/components/parameters/accessApiLevel"
          },
          {
            "$ref": "#/components/parameters/folderWorkspaceInclude"
          },
          {
            "in": "query",
            "name": "loadAll",
            "description": "If set to `true`, the workspace's entire hierarchy of items and folders is returned.",
            "schema": {
              "type": "boolean",
              "default": false
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "A single Workspace object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Workspace"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Omit 'include' parameter\nWorkspace workspace = smartsheet.WorkspaceResources.GetWorkspace(\n  6621332407379844,           // long workspaceId\n  null                        // IEnumerable<WorkspaceInclusion> include\n);\n\n// Sample 2: Specify 'include' parameter with value of \"source\"\nWorkspace workspace = smartsheet.WorkspaceResources.GetWorkspace(\n  6621332407379844,           // long workspaceId\n  new WorkspaceInclusion[] { WorkspaceInclusion.SOURCE }\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/workspaces/{workspaceid} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Omit 'include' parameter\nWorkspace workspace = smartsheet.workspaceResources().getWorkspace(\n        6621332407379844L,      // long workspaceId\n        null                    // EnumSet<SourceInclusion> includes\n        );\n\n// Sample 2: Specify 'include' parameter with value of \"source\"\nWorkspace workspace = smartsheet.workspaceResources().getWorkspace(\n        6621332407379844L,      // long workspaceId\n        EnumSet.of(SourceInclusion.SOURCE)\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  workspaceId: 7116448184199044\n};\n\n// Get workspace\nsmartsheet.workspaces.getWorkspace(options)\n  .then(function(workspace) {\n    console.log(workspace);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Get workspace\nworkspace = smartsheet_client.Workspaces.get_workspace(\n  6621332407379844)       # workspace_id\n\n# Sample 2: Include owner info and sheet version\nworkspace = smartsheet_client.Workspaces.get_workspace(\n  6621332407379844,       # workspace_id\n  include='ownerInfo,sheetVersion'\n  )\nworkspace = response.data\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete workspace",
        "description": "Deletes a workspace.",
        "tags": [
          "workspaces"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "operationId": "delete-workspace",
        "responses": {
          "200": {
            "description": "Returns Result object\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericResult"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.WorkspaceResources.DeleteWorkspace(\n  6621332407379844                // long workspaceId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/workspaces/7960873114331012 \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.workspaceResources().deleteWorkspace(\n        6621332407379844L        // long workspaceId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  workspaceId: 6621332407379844\n};\n\n// Delete workspace\nsmartsheet.workspaces.deleteWorkspace(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Workspaces.delete_workspace(\n  6621332407379844)       # workspace_id\n"
          }
        ]
      },
      "put": {
        "summary": "Update workspace",
        "description": "Updates a workspace.",
        "operationId": "update-workspace",
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type_AppJsonOnly"
          }
        ],
        "tags": [
          "workspaces"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "description": "The new Workspace name.",
                    "type": "string",
                    "maxLength": 50
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Basic information about the updated Workspace",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/SuccessResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/WorkspaceListing"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify updated workspace name\nWorkspace workspaceSpecification = new Workspace\n{\n  Id = 7960873114331012,      // workspaceId\n  Name = \"Updated Workspace\"\n};\n\n// Update workspace\nWorkspace updatedWorkspace = smartsheet.WorkspaceResources.UpdateWorkspace(\n  workspaceSpecification\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/workspaces/7960873114331012 \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '{\"name\": \"Updated workspace\"}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify updated workspace properties\nWorkspace workspaceSpecification = new Workspace();\nworkspaceSpecification.setName(\"Updated workspace\")\n        .setId(7960873114331012L);    // long workspaceId\n\n// Update workspace\nWorkspace updatedWorkspace = smartsheet.workspaceResources().updateWorkspace(workspaceSpecification);\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify updated workspace properties\nvar workspace = {\"name\": \"Updated workspace\"};\n\n// Set options\nvar options = {\n  workspaceId: 7960873114331012,\n  body: workspace\n  };\n\n// Update workspace\nsmartsheet.workspaces.updateWorkspace(options)\n  .then(function(updatedWorkspace) {\n    console.log(updatedWorkspace);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Update workspace\nupdated_workspace = smartsheet_client.Workspaces.update_workspace(\n  7960873114331012,       # workspace_id\n  smartsheet.models.Workspace({\n    'name': 'Updated workspace'\n  })\n)\n\n# Sample 2: Allow Commenter access\nupdated_workspace = smartsheet_client.Workspaces.update_workspace(\n  7960873114331012,       # workspace_id\n  accessApiLevel=1,\n  smartsheet.models.Workspace({\n    'name': 'Updated workspace'\n  })\n)\n"
          }
        ]
      }
    },
    "/workspaces/{workspaceId}/metadata": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "name": "workspaceId",
          "in": "path",
          "required": true,
          "description": "The ID of the workspace",
          "schema": {
            "type": "integer",
            "format": "int64"
          }
        }
      ],
      "get": {
        "summary": "Get workspace metadata",
        "description": "Gets the metadata of a workspace.",
        "tags": [
          "workspaces"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "operationId": "get-workspace-metadata",
        "parameters": [
          {
            "$ref": "#/components/parameters/includeSource"
          },
          {
            "$ref": "#/components/parameters/numericDates"
          },
          {
            "$ref": "#/components/parameters/accessApiLevel"
          }
        ],
        "responses": {
          "200": {
            "description": "The metadata of a workspace.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceMetadata"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "500": {
            "$ref": "#/components/responses/500"
          },
          "503": {
            "$ref": "#/components/responses/503"
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "Workspace workspace =\n    client.WorkspaceResources.GetWorkspaceMetadata(workspaceId);\n\nConsole.WriteLine($\"Workspace\\n \" + \n    $\"name: {workspace.Name}\\n \" +\n    $\"id: {workspace.Id}\\n \" +\n    $\"access level: {workspace.AccessLevel}\\n \" +\n    $\"permalink: {workspace.Permalink}\\n \" +\n    $\"created at: {workspace.CreatedAt}\\n \" +\n    $\"modified at: {workspace.ModifiedAt}\\n \");\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "Workspace workspaceMetadata =\n    client.workspaceResources().getWorkspaceMetadata(workspaceId, null);\n\nSystem.out.println(\"Workspace \" +\n    \"\\nname: \" + workspaceMetadata.getName() +\n    \"\\nid: \" + workspaceMetadata.getId() +\n    \"\\naccess level: \" + workspaceMetadata.getAccessLevel() +\n    \"\\npermalink: \" + workspaceMetadata.getPermalink() +\n    \"\\ncreated at: \" + workspaceMetadata.getCreatedAt() +\n    \"\\nmodified at: \" + workspaceMetadata.getModifiedAt());\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "const workspace =\n  await client.workspaces.getWorkspaceMetadata({ workspaceId });\n\nconsole.log(\n  `Workspace: ${workspace.name},`,\n  `ID: ${workspace.id},`,\n  `Access Level: ${workspace.accessLevel},`,\n  `Permalink: ${workspace.permalink},`,\n  `Created At: ${workspace.createdAt},`,\n  `Modified At: ${workspace.modifiedAt}`\n);\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "response = smart.Workspaces.get_workspace_metadata(workspace_id)\nassert isinstance(response, smartsheet.models.workspace.Workspace)\n\nworkspace = response.name, response.id, response.permalink, response.access_level, response.created_at, response.modified_at\n"
          }
        ]
      }
    },
    "/workspaces/{workspaceId}/children": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "name": "workspaceId",
          "in": "path",
          "required": true,
          "description": "The ID of the workspace",
          "schema": {
            "type": "integer",
            "format": "int64"
          }
        }
      ],
      "get": {
        "summary": "List workspace children",
        "description": "Retrieves a paginated list of immediate child resources within a specified workspace.\n\n**Key Characteristics**\n\n- **Shallow representation:** It returns metadata for the direct children only, rather than the full content or nested sub-structures.\n- **Filtered by type:** The results are restricted to the resource types defined in the `childrenResourceTypes` query parameter.\n- **Paginated:** The response provides a page of results, implying that for large workspaces, multiple requests may be necessary to view all children.\n\n> **Note:** For pagination guidance, refer to [Token-based pagination](/api/smartsheet/guides/basics/pagination#token-based-pagination).\n",
        "tags": [
          "workspaces"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "operationId": "get-workspace-children",
        "parameters": [
          {
            "$ref": "#/components/parameters/childrenResourceTypes"
          },
          {
            "$ref": "#/components/parameters/includeForChildren"
          },
          {
            "$ref": "#/components/parameters/numericDates"
          },
          {
            "$ref": "#/components/parameters/accessApiLevel"
          },
          {
            "$ref": "#/components/parameters/lastKey"
          },
          {
            "name": "maxItems",
            "in": "query",
            "required": false,
            "description": "The maximum number of items to return in the response.",
            "schema": {
              "type": "integer",
              "default": 100,
              "minimum": 100,
              "multipleOf": 100,
              "maximum": 1000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "An array of asset references with a pagination token if there are more results.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaginatedChildrenResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "500": {
            "$ref": "#/components/responses/500"
          },
          "503": {
            "$ref": "#/components/responses/503"
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Sample 1: Get a page of data\nstring? lastKey = null; // Use null key for first page\nTokenPaginatedResult<object> page =\n    client.WorkspaceResources.GetWorkspaceChildren(\n        workspaceId,\n        childrenResourceTypes: null,\n        include: null,\n        numericDates: null,\n        accessApiLevel: null,\n        lastKey: lastKey,\n        maxItems: 100);\n\nforeach (var item in page.Data)\n{\n    switch (item)\n    {\n        case Sheet sheet:\n            sheets.Add(sheet);\n            break;\n        case Folder folder:\n            folders.Add(folder);\n            break;\n        case Report report:\n            reports.Add(report);\n            break;\n        case Sight sight:\n            sights.Add(sight);\n            break;\n        case Template template:\n            templates.Add(template);\n            break;\n    }\n\n}\nlastKey = page.LastKey; // Non-null means more items\n\n// Sample 2: Page through the data\nstring? lastKey = null;\ndo\n{\n    TokenPaginatedResult<object> page =\n        client.WorkspaceResources.GetWorkspaceChildren(\n            workspaceId,\n            childrenResourceTypes: null,\n            include: null,\n            numericDates: null,\n            accessApiLevel: null,\n            lastKey: lastKey,\n            maxItems: null);\n\n    foreach (var item in page.Data)\n    {\n        switch (item)\n        {\n            case Sheet sheet:\n                sheets.Add(sheet);\n                break;\n            // Check for other types\n        }\n\n    }\n    lastKey = page.LastKey;\n} while (!string.IsNullOrEmpty(lastKey));\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Sample 1: Get a page of data\nString lastKey = null; // Use null key for first page\nTokenPaginatedResult<Object> response = client.workspaceResources()\n        .getWorkspaceChildren(\n                workspaceId, null, null, lastKey, null);\n\nfor (Object child : response.getData()) {\n    if (child instanceof Folder folder) {\n        folders.add(folder);\n    } else if (child instanceof Report report) {\n        reports.add(report);\n    } else if (child instanceof Sheet sheet) {\n        sheets.add(sheet);\n    } else if (child instanceof Sight sight) {\n        sights.add(sight);\n    } else if (child instanceof Template template) {\n        templates.add(template);\n    }\n}\nlastKey = response.getLastKey(); // Non-null means more items\n\n// Sample 2: Page through the data\nString lastKey = null;\ndo {\n    TokenPaginatedResult<Object> response = client.workspaceResources()\n            .getWorkspaceChildren(\n                    workspaceId, null, null, lastKey, null);\n\n    for (Object child : response.getData()) {\n        if (child instanceof Sheet sheet) {\n            sheets.add(sheet);\n        }\n        // Check for other types\n    }\n\n    lastKey = response.getLastKey();\n} while (lastKey != null && !lastKey.isBlank());\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Sample 1: Get a page of data\nlet lastKey = ''; // Use empty string for first page\nconst page = await client.workspaces.getWorkspaceChildren({\n  workspaceId, queryParameters: { lastKey },\n});\nconst children = page?.data ?? [];\nfor (const child of children) {\n  switch (child?.resourceType) {\n    case 'sheet':\n      sheets.push(child);\n      break;\n    case 'report':\n      reports.push(child);\n      break;\n    case 'sight':\n      sights.push(child);\n      break;\n    case 'folder':\n      folders.push(child);\n      break;\n    case 'template':\n      templates.push(child);\n      break;\n    default:\n      break;\n  }\n}\nlastKey = page?.lastKey; // Non-null means more items\n\n// Sample 2: Page through the data\nlet lastKey = '';\ndo {\n  const page = await client.workspaces.getWorkspaceChildren({\n    workspaceId,\n    queryParameters: { lastKey },\n  });\n  const children = page?.data ?? [];\n  for (const child of children) {\n    switch (child?.resourceType) {\n      case 'sheet':\n        sheets.push(child);\n        break;\n      // Check for other types\n    }\n  }\n  lastKey = page?.lastKey;\n} while (lastKey);\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Sample 1: Get a page of data\nlast_key = None # Use None for first page\nresponse = smart.Workspaces.get_workspace_children(\n    workspace_id, last_key=last_key\n)\nassert isinstance(\n    response,\n    smartsheet.models.paginated_children_result.PaginatedChildrenResult\n)\n\nfor child in response.data:\n    if type(child) is Folder:\n        folders.append(child)\n    elif type(child) is Sheet:\n        sheets.append(child)\n    elif type(child) is Report:\n        reports.append(child)\n    elif type(child) is Sight:\n        sights.append(child)\n    elif type(child) is Template:\n        templates.append(child)\nlast_key = getattr(response, \"last_key\", None) # Non-null means more items\n\n# Sample 2: Page through the data\nlast_key = None\nwhile True:\n    response = smart.Workspaces.get_workspace_children(\n        workspace_id, last_key=last_key\n    )\n    assert isinstance(\n        response,\n        smartsheet.models.paginated_children_result.PaginatedChildrenResult\n    )\n\n    for child in response.data:\n        if type(child) is Sheet:\n            sheets.append(child)\n        // Check for other types\n\n    last_key = getattr(response, \"last_key\", None)\n    if not last_key:\n        break\n"
          }
        ]
      }
    },
    "/workspaces/{workspaceId}/copy": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/workspaceId"
        }
      ],
      "post": {
        "summary": "Copy workspace",
        "description": "Copies a workspace.\n\n> **Important:** This operation doesn't copy cell history.\n",
        "tags": [
          "workspaces"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "operationId": "copy-workspace",
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type_AppJsonOnly"
          },
          {
            "$ref": "#/components/parameters/workspaceCopyInclude"
          },
          {
            "$ref": "#/components/parameters/skipRemap"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "newName": {
                    "description": "Name of the newly created workspace.",
                    "type": "string",
                    "maxLength": 50
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Basic information about the new Workspace.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/SuccessResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/WorkspaceListing"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify name for the new workspace\nContainerDestination destination = new ContainerDestination {\n  NewName = \"newWorkspaceName\"\n};\n\n// Sample 1: Omit 'include' and 'skipRemap' parameters\nWorkspace workspace = smartsheet.WorkspaceResources.CopyWorkspace(\n  7116448184199044,          // long workspaceId\n  destination,\n  null,                      // IEnumerable<WorkspaceCopyInclusion> include\n  null                       // IEnumerable<WorkspaceRemapExclusion> skipRemap\n);\n\n// Sample 2: Specify 'include' parameter with value of \"DATA\", and 'skipRemap' parameter with value of \"CELL_LINKS\"\nWorkspace workspace = smartsheet.WorkspaceResources.CopyWorkspace(\n  7116448184199044,           // long workspaceId\n  destination,\n  new WorkspaceCopyInclusion[] { WorkspaceCopyInclusion.DATA },\n  new WorkspaceRemapExclusion[] { WorkspaceRemapExclusion.CELL_LINKS }\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/workspaces/{workspaceId}/copy?include=data' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"newName\": \"newWorkspaceName\"}' \\\n-X POST\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify name for the new workspace\nContainerDestination destination = new ContainerDestination();\ndestination.setNewName(\"newWorkspaceName\");\n\n// Sample 1: Omit 'include' and 'skipRemap' parameters\nWorkspace workspace = smartsheet.workspaceResources().copyWorkspace(\n        7116448184199044L,          // long workspaceId\n        destination,\n        null,                       // EnumSet<WorkspaceCopyInclusion> includes\n        null                        // EnumSet<WorkspaceRemapExclusion> skipRemap\n        );\n\n// Sample 2: Specify 'include' parameter with value of \"DATA\", and 'skipRemap' parameter with value of \"CELLLINKS\"\nWorkspace workspace = smartsheet.workspaceResources().copyWorkspace(\n        7116448184199044L,          // long workspaceId\n        destination,\n        EnumSet.of(WorkspaceCopyInclusion.DATA),\n        EnumSet.of(WorkspaceRemapExclusion.CELLLINKS)\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify new workspace name\nvar body = {\n  newName: \"newWorkspaceName\"\n};\n\n// Set elements to copy\nvar params = {\n  include: \"data,discussions\",\n  skipRemap: \"cellLinks\"\n};\n\n// Set options\nvar options = {\n  workspaceId: 7116448184199044,\n  body: body,\n  queryParameters: params\n};\n\n// Copy workspace\nsmartsheet.workspaces.copyWorkspace(options)\n  .then(function(copiedWorkspace) {\n    console.log(copiedWorkspace);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Copy workspace\nnew_workspace = smartsheet_client.Workspaces.copy_workspace(\n  7116448184199044,           # workspace_id\n  smartsheet.models.ContainerDestination({\n    'new_name': 'newWorkspaceName'\n  })\n)\n\n# Sample 2: Include attachments and discussions\nnew_workspace = smartsheet_client.Workspaces.copy_workspace(\n  7116448184199044,           # workspace_id\n  include='attachments,discussions',\n  smartsheet.models.ContainerDestination({\n    'new_name': 'newWorkspaceName'\n  })\n)\n"
          }
        ]
      }
    },
    "/workspaces/{workspaceId}/folders": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/workspaceId"
        }
      ],
      "get": {
        "summary": "List workspace folders",
        "deprecated": true,
        "description": "Lists a workspace's folders.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n\n> **DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be removed.** See the [Get workspace children](/api/smartsheet/openapi/workspaces/get-workspace-children) endpoint for replacement functionality. You can use the [`GET /workspaces/{workspaceId}/children`](/api/smartsheet/openapi/workspaces/get-workspace-children) endpoint with the `childrenResourceTypes=folders` parameter, to list folders specific to a workspace.\n> \n> Refer to the following article for details on using the above-mentioned endpoint: [Migrate from GET /workspaces/{id} for workspace and child metadata](/api/smartsheet/guides/updating-code/migrate-from-get-workspace)\n",
        "tags": [
          "workspaces"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "operationId": "get-workspace-folders",
        "parameters": [
          {
            "$ref": "#/components/parameters/includeAll"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "An array of Folder references.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "description": "Array of all the workspace folders, referenced by their ID, name, and URL.",
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number",
                                "description": "The folder's unique identifier.",
                                "example": 987654321
                              },
                              "name": {
                                "type": "string",
                                "description": "The folder's name.",
                                "example": "Upcoming Campaigns"
                              },
                              "permalink": {
                                "type": "string",
                                "description": "URL to the folder in Smartsheet.",
                                "example": "https://app.smartsheet.com/folders/c8gJxw87cXpRCvCC5PPw6jFhFRrf5r8PxCrxvW21"
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPaginatedResult<Folder> folders = smartsheet.WorkspaceResources.FolderResources.ListFolders(\n  1656220827314052,               // long workspaceId\n  null                            // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/workspaces/{workspaceId}/folders \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPagedResult<Folder> folders = smartsheet.workspaceResources().folderResources().listFolders(\n        1656220827314052L,                   // long workspaceId\n        null                                 // PaginationParameters\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  workspaceId: 1656220827314052\n};\n\n// List folders in workspace\nsmartsheet.workspaces.listWorkspaceFolders(options)\n  .then(function(folderList) {\n    console.log(folderList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List all\nresponse = smartsheet_client.Workspaces.list_folders(\n  1656220827314052,       # workspace_id\n  include_all=True)\nfolders = response.data\n\n# Sample 2: Paginate the list\nresponse = smartsheet_client.Workspaces.list_folders(\n  1656220827314052,       # workspace_id\n  page_size=5,\n  page=1)\npages = response.total_pages\nfolders = response.data\n"
          }
        ]
      },
      "post": {
        "summary": "Create folder in workspace",
        "description": "Creates a new folder in the workspace.\n",
        "operationId": "create-workspace-folder",
        "tags": [
          "workspaces"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Type_AppJsonOnly"
          }
        ],
        "requestBody": {
          "description": "Folder to create.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FolderCreateRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Basic information about the created Folder.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/SuccessResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/FolderListing"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set folder name\nFolder folderSpecification = new Folder { Name = \"New folder\" };\n\n// Create folder in a workspace\nFolder newFolder = smartsheet.WorkspaceResources.FolderResources.CreateFolder(\n  1656220827314052,               // long workspaceId\n  folderSpecification\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/workspaces/{workspaceid}/folders \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"name\": \"New folder\"}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set folder name\nFolder folderSpecification = new Folder();\nfolderSpecification.setName(\"New Folder\");\n\n// Create folder in a workspace\nFolder newFolder = smartsheet.workspaceResources().folderResources().createFolder(\n        1656220827314052L,       // long workspaceId\n        folderSpecification\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set folder name\nvar folder = {\n  \"name\": \"New folder\"\n};\n\n// Set options\nvar options = {\n  workspaceId: 1656220827314052,\n  body: folder\n  };\n\n// Create folder in a workspace\nsmartsheet.workspaces.createFolder(options)\n  .then(function(newFolder) {\n    console.log(newFolder);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nnew_workspace = smartsheet_client.Workspaces.create_folder_in_workspace(\n  1656220827314052,       # workspace_id\n  'New folder')\n"
          }
        ]
      }
    },
    "/workspaces/{workspaceId}/shares": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/accessApiLevel"
        },
        {
          "$ref": "#/components/parameters/workspaceId"
        }
      ],
      "post": {
        "summary": "Share workspace",
        "description": "Shares a Workspace with the specified users and groups. This operation\nsupports both single-object and bulk semantics.\n\n**_This operation is only available to system administrators._**\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "share-workspace",
        "tags": [
          "sharing",
          "workspaces"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/sendEmail"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/Share"
                  },
                  {
                    "type": "array",
                    "title": "Array of shares",
                    "items": {
                      "$ref": "#/components/schemas/Share"
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "This operation supports both single-object and bulk semantics. For more information, see Optional Bulk Operations.\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "oneOf": [
                            {
                              "$ref": "#/components/schemas/Share"
                            },
                            {
                              "type": "array",
                              "title": "Array of shares",
                              "items": {
                                "$ref": "#/components/schemas/Share"
                              }
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "If called with a single Share object, and that user or group share already exists, error code 1025 is returned.\nIf called with an array of Share objects, and one or more user or group shares in the array already exist,\nthey are ignored and omitted from the response.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify share (to one user as Editor)\nShare[] shareSpecification = new Share[] { new Share\n  {\n    Email = \"jane.doe@smartsheet.com\",\n    AccessLevel = AccessLevel.EDITOR\n  }\n};\n\n// Share workspace\nIList<Share> addressList = smartsheet.WorkspaceResources.ShareResources.ShareTo(\n  7960873114331012,               // long workspaceId\n  shareSpecification,\n  true                            // Nullable<bool> sendEmail\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl 'https://api.smartsheet.com/2.0/workspaces/{workspaceId}/shares?sendEmail=true' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '[{\"email\": \"jane.doe@smartsheet.com\", \"accessLevel\": \"EDITOR\"}]'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify share (to one user as Editor)\nShare shareSpecification = new Share()\n        .setEmail(\"jane.doe@smartsheet.com\")\n        .setAccessLevel(AccessLevel.EDITOR);\n\n// Share workspace\nList<Share> addressList = smartsheet.workspaceResources().shareResources().shareTo(\n        7960873114331012L,                    // long workspaceId\n        (Arrays.asList(shareSpecification)),\n        true                                  // Boolean sendEmail\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Specify share (to one user as Editor)\nvar shares = [\n  {\n    \"email\": \"john.doe@smartsheet.com\",\n    \"accessLevel\": \"EDITOR\"\n  }\n];\n\n// Set options\nvar options = {\n  workspaceId: 7960873114331012,\n  body: shares\n};\n\n// Share workspace\nsmartsheet.workspaces.share(options)\n  .then(function(addressList) {\n    console.log(addressList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Share workspace\nresponse = smartsheet_client.Workspaces.share_workspace(\n  1656220827314052,       # workspace_id\n  smartsheet.models.Share({\n    'access_level': 'EDITOR',\n    'email': 'jane.doe@smartsheet.com'\n  })\n)\n\n# Sample 2: Allow Commenter access\nresponse = smartsheet_client.Workspaces.share_workspace(\n  1656220827314052,       # workspace_id\n  accessApiLevel=1,       # enables functionality\n  smartsheet.models.Share({\n    'access_level': 'COMMENTER',     # declares access level\n    'email': 'jane.doe@smartsheet.com'\n  })\n)\n"
          }
        ]
      },
      "get": {
        "summary": "List workspace shares",
        "description": "Gets a list of all users and groups to whom the specified Workspace is shared, and their access level.\n\n> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "list-workspace-shares",
        "tags": [
          "sharing",
          "workspaces"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/includeAll"
          }
        ],
        "responses": {
          "200": {
            "description": "IndexResult object containing an array of Share objects.\n\n**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).\n",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/IndexResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Share"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPaginatedResult<Share> shares = smartsheet.WorkspaceResources.ShareResources.ListShares(\n  1656220827314052,               // long workspaceId\n  null                            // PaginationParameters\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/workspaces/{workspaceId}/shares \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Omit pagination parameters\nPagedResult<Share> shares = smartsheet.workspaceResources().shareResources().listShares(\n        1656220827314052L,       // long workspaceId\n        null,                    // PaginationParameters\n        true                     // Boolean includeWorkspaceShares\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  workspaceId: 1656220827314052\n};\n\n// List workspace shares\nsmartsheet.workspaces.listShares(options)\n  .then(function(shareList) {\n    console.log(shareList);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: List all\nresponse = smartsheet_client.Workspaces.list_shares(\n  1656220827314052,       # workspace_id\n  include_all=True)\nshares = response.data\n\n# Sample 2: Paginate the list\nresponse = smartsheet_client.Workspaces.list_shares(\n  1656220827314052,       # workspace_id\n  page_size=10,\n  page=1)\npages = response.total_pages\nshares = response.data\n"
          }
        ]
      }
    },
    "/workspaces/{workspaceId}/shares/{shareId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/workspaceId"
        },
        {
          "$ref": "#/components/parameters/shareId"
        },
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        }
      ],
      "get": {
        "summary": "Get workspace share",
        "description": "Gets the share specified in the URL.\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "share-workspace-get",
        "parameters": [
          {
            "$ref": "#/components/parameters/accessApiLevel"
          }
        ],
        "tags": [
          "sharing",
          "workspaces"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "READ_SHEETS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns Share object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Share"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nShare share = smartsheet.WorkspaceResources.ShareResources.GetShare(\n  1656220827314052,           // long workspaceId\n  \"AQAISF82FOeE\"              // string shareId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/workspaces/{workspaceId}/shares/{shareId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\"\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nShare share = smartsheet.workspaceResources().shareResources().getShare(\n        1656220827314052L,       // long workspaceId\n        \"AQAISF82FOeE\"           // string shareId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  workspaceId: 1656220827314052,\n  shareId: \"AQAISF82FOeE\"\n};\n\n// Get workspace share\nsmartsheet.workspaces.getShare(options)\n  .then(function(share) {\n    console.log(share);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Get workspace share\nshare = smartsheet_client.Sheets.get_share(\n  1656220827314052,           # workspace_id\n  'AAAEQesWFOeE')             # share_id\n\n# Sample 2: Enable Commenter access\nshare = smartsheet_client.Sheets.get_share(\n  1656220827314052,           # workspace_id\n  accessApiLevel=1,\n  'AAAEQesWFOeE')             # share_id\n"
          }
        ]
      },
      "delete": {
        "summary": "Delete workspace share",
        "description": "Deletes the share specified in the URL.\n\n**_This operation is only available to system administrators._**\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "delete-workspace-share",
        "tags": [
          "sharing",
          "workspaces"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Returns Result object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Result"
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.WorkspaceResources.ShareResources.DeleteShare(\n  1656220827314052,               // long workspaceId\n  \"AAAEQesWFOeE\"                  // string shareId\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/workspaces/{workspaceId}/shares/{shareId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-X DELETE\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nsmartsheet.workspaceResources().shareResources().deleteShare(\n        1656220827314052L,       // long workspaceId\n        \"AAAEQesWFOeE\"           // string shareId\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set options\nvar options = {\n  workspaceId: 1656220827314052,\n  shareId: \"AAAEQesWFOeE\"\n};\n\n// Delete workspace share\nsmartsheet.workspaces.deleteShare(options)\n  .then(function(results) {\n    console.log(results);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nsmartsheet_client.Workspaces.delete_share(\n  1656220827314052,           # workspace_id\n  'AAAEQesWFOeE')             # share_id\n"
          }
        ]
      },
      "put": {
        "summary": "Update workspace share",
        "description": "Updates the access level of a user or group for the specified workspace.\n\n**_This operation is only available to system administrators._**\n\n**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [Changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n",
        "deprecated": true,
        "operationId": "update-workspace-share",
        "parameters": [
          {
            "$ref": "#/components/parameters/accessApiLevel"
          }
        ],
        "tags": [
          "sharing",
          "workspaces"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "ADMIN_WORKSPACES"
            ]
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "accessLevel": {
                    "$ref": "#/components/schemas/AccessLevel"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing the modified Share object.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Result"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "object",
                          "items": {
                            "$ref": "#/components/schemas/Share"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set the access level to Viewer\nShare shareSpecification = new Share\n{\n  Id = \"AAAFeF82FOeE\",\n  AccessLevel = AccessLevel.VIEWER\n};\n\n// Update workspace share\nShare updatedShare = smartsheet.WorkspaceResources.ShareResources.UpdateShare(\n  1656220827314052,             // long workspaceId\n  shareSpecification\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl https://api.smartsheet.com/2.0/workspaces/{workspaceId}/shares/{shareId} \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X PUT \\\n-d '{\"accessLevel\": \"VIEWER\"}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set the access level to Viewer\nShare shareSpecification = new Share();\n        shareSpecification.setAccessLevel(AccessLevel.VIEWER)\n        .setId(\"AAAFeF82FOeE\");   // string shareId\n\n// Update workspace share\nShare updatedShare = smartsheet.workspaceResources().shareResources().updateShare(\n        1656220827314052L,   // long workspaceId\n        shareSpecification\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Set access level to Viewer\nvar share = {\"accessLevel\": \"VIEWER\"};\n\n// Set options\nvar options = {\n  workspaceId: 1656220827314052,\n  shareId: \"AAAFeF82FOeE\",\n  body: share\n  };\n\n// Update workspace share\nsmartsheet.workspaces.updateShare(options)\n  .then(function(updatedShare) {\n    console.log(updatedShare);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Update workspace share\nupdated_share = smartsheet_client.Workspaces.update_share(\n  1656220827314052,       # workspace_id\n  'AAAFeF82FOeE',         # share_id\n  smartsheet.models.Share({\n    'access_level': 'VIEWER'\n  })\n)\n\n# Sample 2: Enable Commenter access\nupdated_share = smartsheet_client.Workspaces.update_share(\n  1656220827314052,       # workspace_id\n  'AAAFeF82FOeE',         # share_id\n  accessApiLevel=1,       # enables functionality\n  smartsheet.models.Share({\n    'access_level': 'COMMENTER'   # declares access level\n  })\n)\n"
          }
        ]
      }
    },
    "/workspaces/{workspaceId}/sheets": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/workspaceId"
        }
      ],
      "post": {
        "summary": "Create sheet in workspace",
        "description": "Creates a sheet from scratch or from the specified template at the top-level of the specified workspace.\nFor subfolders, use Create Sheet in Folder.\n",
        "operationId": "create-sheet-in-workspace",
        "tags": [
          "sheets"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "CREATE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/accessApiLevel"
          },
          {
            "$ref": "#/components/parameters/Content-Type"
          },
          {
            "$ref": "#/components/parameters/include"
          }
        ],
        "requestBody": {
          "description": "An object which defines the sheet to create.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/SheetToCreate"
                  },
                  {
                    "$ref": "#/components/schemas/SheetToCreateFromTemplate"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing a Sheet object for newly created sheet, corresponding to what was specified in the request.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "oneOf": [
                            {
                              "$ref": "#/components/schemas/SheetCreated"
                            },
                            {
                              "$ref": "#/components/schemas/SheetCreatedFromTemplate"
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Create sheet in workspace\n// Specify properties of the first column\nColumn columnA = new Column\n{\n  Title = \"Favorite\",\n  Primary = false,\n  Type = ColumnType.CHECKBOX,\n  Symbol = Symbol.STAR\n};\n\n// Specify properties of the second column\nColumn columnB = new Column\n{\n  Title = \"Primary Column\",\n  Primary = true,\n  Type = ColumnType.TEXT_NUMBER\n};\n\n// Create sheet in workspace (specifying the 2 columns to include in the sheet)\nSheet newSheet = smartsheet.WorkspaceResources.SheetResources.CreateSheet(\n  3734419270854532,                   // long workspaceId\n  new Sheet\n    {\n      Name = \"new sheet title\",\n      Columns = new Column[] { columnA, columnB }\n    }\n);\n\n// Sample 2: Create sheet in workspace from template\n// Specify name for the sheet and Id of the template\nSheet sheetSpecification = new Sheet\n{\n  Name = \"new sheet title\",\n  FromId = 7679398137620356     // template Id\n};\n\n// Option 1: Omit 'include' parameter\nSheet newSheet = smartsheet.WorkspaceResources.SheetResources.CreateSheetFromTemplate(\n  1656220827314052,               // long workspaceId\n  sheetSpecification,\n  null                            // IEnumerable<TemplateInclusion> include\n);\n\n// Option 2: Include ATTACHMENTS, DATA, and DISCUSSIONS\nSheet newSheet = smartsheet.WorkspaceResources.SheetResources.CreateSheetFromTemplate(\n  1656220827314052,               // long workspaceId\n  sheetSpecification,\n  new TemplateInclusion[] {\n    TemplateInclusion.ATTACHMENTS,\n    TemplateInclusion.DATA,\n    TemplateInclusion.DISCUSSIONS }\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "// Sample 1: Create sheet in workspace\ncurl https://api.smartsheet.com/2.0/workspaces/{workspaceId}/sheets \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"name\":\"newsheet\",\"columns\":[{\"title\":\"Favorite\",\"type\":\"CHECKBOX\",\"symbol\":\"STAR\"}, {\"title\":\"Primary Column\", \"primary\":true,\"type\":\"TEXT_NUMBER\"}]}'\n\n// Sample 2: Create sheet in workspace from template\ncurl 'https://api.smartsheet.com/2.0/workspaces/{workspaceId}/sheets?include=data,attachments,discussions' \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Type: application/json\" \\\n-X POST \\\n-d '{\"name\":\"newsheet\", \"fromId\": 7679398137620356}'\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Create sheet in workspace\n// Specify properties of the first column\nColumn columnA = new Column()\n        .setTitle(\"Favorite\")\n        .setType(ColumnType.CHECKBOX)\n        .setSymbol(Symbol.STAR);\n\n// Specify properties of the second column\nColumn columnB = new Column()\n        .setTitle(\"Primary Column\")\n        .setType(ColumnType.TEXT_NUMBER)\n        .setPrimary(true);\n\n// Create sheet in workspace (specifying the 2 columns to include in the sheet)\nSheet newSheet = new Sheet();\n        newSheet.setName(\"new sheet title\");\n        newSheet.setColumns(Arrays.asList(columnA, columnB));\n\nsmartsheet.sheetResources().createSheetInWorkspace(\n        3734419270854532L,    // long workspaceId\n        newSheet\n        );\n\n// Sample 2: Create sheet in workspace from template\n// Specify name for the sheet and Id of the template\nSheet sheet = new Sheet();\nsheet.setFromId(7679398137620356L);     // long templateId\nsheet.setName(\"newsheet\");\n\n// Option 1: Omit 'include' parameter\nSheet newSheet = smartsheet.sheetResources().createSheetInWorkspaceFromTemplate(\n        1656220827314052L,                  // long workspaceId\n        sheetSpecification,\n        null                                // EnumSet<SheetTemplateInclusion> includes\n        );\n\n// Option 2: Include ATTACHMENTS, DATA, and DISCUSSIONS\nSheet newSheet = smartsheet.sheetResources().createSheetInWorkspaceFromTemplate(\n        1656220827314052L,                 // long workspaceId\n        sheetSpecification,\n        EnumSet.of(\n            SheetTemplateInclusion.ATTACHMENTS,\n            SheetTemplateInclusion.DATA,\n            SheetTemplateInclusion.DISCUSSIONS)\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Create sheet in workspace\n// Specify sheet properties\nvar sheet = {\n  \"name\": \"newsheet\",\n  \"columns\": [\n    {\n      \"title\": \"Favorite\",\n      \"type\": \"CHECKBOX\",\n      \"symbol\": \"STAR\"\n    },\n    {\n      \"title\": \"Primary Column\",\n      \"primary\": true,\n      \"type\": \"TEXT_NUMBER\"\n    }\n  ]\n};\n\n// Set options\nvar options = {\n  workspaceId: 1656220827314052,\n  body: sheet\n};\n\n// Create sheet in workspace\nsmartsheet.sheets.createSheetInWorkspace(options)\n  .then(function(newSheet) {\n    console.log(newSheet);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n\n// Sample 2: Create sheet in workspace from template\n// Specify the directive\nvar sheet = {\n  \"fromId\": 7679398137620356,\n  \"name\": \"newsheet\"\n  };\n\n// Set options\nvar options = {\n  workspaceId: 1656220827314052,\n  body: sheet\n  };\n\n// Create sheet from template in the specified workspace\nsmartsheet.sheets.createSheetFromExisting(options)\n  .then(function(newSheet) {\n    console.log(newSheet);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\n# Sample 1: Create sheet in workspace\nsheet_spec = smartsheet.models.Sheet({\n  'name': 'newsheet',\n  'columns': [{\n      'title': 'Favorite',\n      'type': 'CHECKBOX',\n      'symbol': 'STAR'\n    }, {\n      'title': 'Primary Column',\n      'primary': True,\n      'type': 'TEXT_NUMBER'\n    }\n  ]\n})\n\nresponse = smartsheet_client.Workspaces.create_sheet_in_workspace(\n  3734419270854532,           # workspace_id\n  sheet_spec)\nnew_sheet = response.result\n\n# Sample 2: Create sheet in workspace from template\nresponse = smartsheet_client.Workspaces.create_sheet_in_workspace_from_template(\n  1656220827314052,                   # workspace_id\n  smartsheet.models.Sheet({\n    'name': 'newsheet',\n    'from_id': 7679398137620356     # template_id\n  })\n)\n"
          }
        ]
      }
    },
    "/workspaces/{workspaceId}/sheets/import": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Authorization"
        },
        {
          "$ref": "#/components/parameters/smartsheetIntegrationSourceHeader"
        },
        {
          "$ref": "#/components/parameters/workspaceId"
        }
      ],
      "post": {
        "summary": "Import sheet into workspace",
        "description": "Imports CSV or XLSX data into a new sheet in the specified workspace.\n\nNote the following:\n* Both sheetName and the file name must use ASCII characters.\n* The source data must be basic text. To include rich formula data, import and create a sheet first, and then use Update Rows. To work with images, see Cell Images.\n* XLS is not supported. You must use XLSX.\n* Hierarchical relationships between rows in an external file won't import.\n",
        "operationId": "import-sheet-into-workspace",
        "tags": [
          "imports"
        ],
        "security": [
          {
            "APIToken": []
          },
          {
            "OAuth2": [
              "CREATE_SHEETS"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Content-Disposition"
          },
          {
            "$ref": "#/components/parameters/parameters-Content-Type"
          },
          {
            "$ref": "#/components/parameters/sheetName"
          },
          {
            "$ref": "#/components/parameters/headerRowIndex"
          },
          {
            "$ref": "#/components/parameters/primaryColumnIndex"
          }
        ],
        "requestBody": {
          "description": "Binary content for the CSV / XLSX file.",
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Result object containing a Sheet object for imported sheet.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/GenericResult"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "$ref": "#/components/schemas/SheetImported"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Generic Error Payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "C# SDK",
            "label": "C# SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSheet sheet = smartsheet.WorkspaceResources.SheetResources.ImportXlsSheet(\n  4124946017347460,       // workspaceId\n  \"D:/ProgressReport.xlsx\",\n  null,                   // sheetName defaults to file name unless specified\n  0,                      // headerRowIndex\n  null                    // primaryColumnIndex\n);\n"
          },
          {
            "lang": "cURL",
            "label": "cURL",
            "source": "curl  https://api.smartsheet.com/2.0/workspaces/{workspaceId}/sheets/import?sheetName=MarketingProgressReport&headerRowIndex=0&primaryColumnIndex=0 \\\n-H \"Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789\" \\\n-H \"Content-Disposition: attachment\" \\\n-H \"Content-Type: text/csv\" \\\n-X POST \\\n--data-binary @ProgressReport.csv\n"
          },
          {
            "lang": "Java SDK",
            "label": "Java SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\nSheet sheet = smartsheet.sheetResources().importXlsxInWorkspace(\n        4124946017347460L,           // long workspaceId\n        \"D:/ProgressReport.xlsx\",\n        \"MarketingProgressReport\",\n        0,                          // headerRowIndex\n        0                           // primaryColumnIndex\n        );\n"
          },
          {
            "lang": "JavaScript SDK",
            "label": "JavaScript SDK",
            "source": "// Note: SDK object attribute names may differ from the REST API's.\n// Sample 1: Import CSV into workspace\n// Set options\nvar options = {\n  workspaceId: 4124946017347460,\n  queryParameters: {\n    sheetName: 'MarketingProgressReport'\n  },\n  path: \"D:/ProgressReport.csv\"\n};\n\n// Import CSV as sheet into workspace\nsmartsheet.sheets.importCsvSheetIntoWorkspace(options)\n  .then(function(attachment) {\n    console.log(attachment);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n\n// Sample 2: Import XLSX into workspace\n// Set options\nvar options = {\n  workspaceId: 4124946017347460,\n  queryParameters: {\n    sheetName: 'MarketingProgressReport'\n  },\n  path: \"D:/ProgressReport.xlsx\"\n};\n\n// Import XLSX as sheet into workspace\nsmartsheet.sheets.importXlsxSheetIntoWorkspace(options)\n  .then(function(attachment) {\n    console.log(attachment);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n"
          },
          {
            "lang": "Python SDK",
            "label": "Python SDK",
            "source": "# Note: SDK object attribute names may differ from the REST API's.\nimported_sheet = smartsheet_client.Workspaces.import_xlsx_sheet(\n  4124946017347460,           # workspace_id\n  'D:/ProgressReport.xlsx',\n  'MarketingProgressReport',  # sheet_name\n  header_row_index=0\n)\n"
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "AccessLevel": {
        "title": "Access level",
        "type": "string",
        "enum": [
          "ADMIN",
          "COMMENTER",
          "EDITOR",
          "EDITOR_SHARE",
          "OWNER",
          "VIEWER"
        ]
      },
      "Account": {
        "title": "Account",
        "type": "object",
        "x-tags": [
          "users"
        ],
        "properties": {
          "id": {
            "description": "Account ID.",
            "type": "number",
            "example": 122454719915908
          },
          "name": {
            "description": "Account name.",
            "type": "string",
            "example": "Smartsheet Org"
          }
        }
      },
      "AlternateEmail": {
        "title": "Alternate email",
        "type": "object",
        "x-tags": [
          "alternateEmailAddress"
        ],
        "properties": {
          "id": {
            "description": "AlternateEmail ID.",
            "type": "number",
            "example": 8150532427671428
          },
          "confirmed": {
            "description": "Indicates whether the alternate email address has been confirmed.",
            "type": "boolean",
            "example": true
          },
          "email": {
            "description": "User's alternate email address.",
            "type": "string",
            "example": "johnathan.doe@smartsheet.com"
          }
        }
      },
      "Attachment": {
        "title": "Attachment",
        "description": "Attachment Object",
        "type": "object",
        "x-tags": [
          "attachments"
        ],
        "properties": {
          "id": {
            "description": "Attachment ID.",
            "type": "number"
          },
          "parentId": {
            "description": "The ID of the parent.",
            "type": "number"
          },
          "attachmentType": {
            "description": "Attachment type. Note--Dropbox, Egnyte, and Evernote are not supported for Smartsheet.gov accounts.",
            "type": "string",
            "enum": [
              "BOX_COM",
              "DROPBOX",
              "EGNYTE",
              "EVERNOTE",
              "FILE",
              "GOOGLE_DRIVE",
              "LINK",
              "ONEDRIVE",
              "TRELLO"
            ]
          },
          "attachmentSubType": {
            "description": "Attachment sub type. Note--Folder type is for EGNYTE values and the rest are GOOGLE_DRIVE values.",
            "type": "string",
            "enum": [
              "DOCUMENT",
              "DRAWING",
              "FOLDER",
              "PDF",
              "PRESENTATION",
              "SPREADSHEET"
            ]
          },
          "mimeType": {
            "description": "Attachment MIME type.",
            "type": "string",
            "example": "PNG"
          },
          "parentType": {
            "description": "The type of object the attachment belongs to.",
            "type": "string",
            "enum": [
              "COMMENT",
              "PROOF",
              "ROW",
              "SHEET"
            ]
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "createdBy": {
            "description": "`User` object containing `name` and `email` of the user who created this attachment.\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/MiniUser"
              }
            ]
          },
          "name": {
            "description": "Attachment name.",
            "type": "string"
          },
          "sizeInKb": {
            "description": "The size of the file, if the attachmentType is FILE.",
            "type": "number"
          },
          "url": {
            "description": "Attachment temporary URL (files only).",
            "type": "string"
          },
          "urlExpiresInMillis": {
            "description": "Attachment temporary URL time to live (files only).",
            "type": "number"
          }
        }
      },
      "AutomationAction": {
        "title": "Automation action",
        "type": "object",
        "x-tags": [
          "automationRules"
        ],
        "properties": {
          "includedColumnIds": {
            "description": "Specifies which columns to include in message.",
            "type": "array",
            "items": {
              "type": "number"
            }
          },
          "type": {
            "type": "string",
            "enum": [
              "APPROVAL_REQUEST_ACTION",
              "NOTIFICATION_ACTION",
              "UPDATE_REQUEST_ACTION"
            ]
          },
          "frequency": {
            "type": "string",
            "enum": [
              "DAILY",
              "HOURLY",
              "IMMEDIATELY",
              "WEEKLY"
            ]
          },
          "includeAllColumns": {
            "description": "If true, all columns are included in email contents.",
            "type": "boolean",
            "default": true
          },
          "includeAttachments": {
            "description": "If true, all attachments are included in email contents.",
            "type": "string"
          },
          "includeDiscussions": {
            "description": "If true, all discussions are included in email contents.",
            "type": "boolean"
          },
          "message": {
            "description": "Email body.",
            "type": "string"
          },
          "subject": {
            "description": "Email subject line.",
            "type": "string"
          }
        },
        "oneOf": [
          {
            "title": "Notify all shared users",
            "properties": {
              "notifyAllSharedUsers": {
                "description": "If true, notifications are sent to all users shared to the sheet.",
                "type": "boolean"
              }
            }
          },
          {
            "title": "Recipient array",
            "properties": {
              "recipients": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Recipient"
                }
              }
            }
          },
          {
            "title": "Recipient column IDs",
            "properties": {
              "recipientColumnIds": {
                "description": "Array of column Ids from which to collect email recipients.",
                "type": "array",
                "items": {
                  "type": "number"
                }
              }
            }
          }
        ]
      },
      "AutomationRule": {
        "title": "Automation rule",
        "type": "object",
        "x-tags": [
          "automationRules"
        ],
        "properties": {
          "id": {
            "description": "AutomationRule ID.",
            "type": "number"
          },
          "action": {
            "description": "An [AutomationAction object](/api/smartsheet/openapi/automationrules/automationaction) containing information for this rule, such as type, recipients, and frequency."
          },
          "createdAt": {
            "description": "A timestamp of when the rule was originally added.",
            "allOf": [
              {
                "$ref": "#/components/schemas/Timestamp"
              }
            ]
          },
          "createdBy": {
            "description": "`User` object containing `name` and `email` of the creator of this rule.\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/MiniUser"
              }
            ]
          },
          "disabledReason": {
            "description": "Machine-readable reason a rule is disabled:\n* `APPROVAL_COLUMN_MISSING` This rule's approval status column has been deleted.\n\n* `APPROVAL_COLUMN_WRONG_TYPE` The approval column must be a dropdown column.\n\n* `AUTOMATION_NOT_ENABLED_FOR_ORG` To create or edit automated actions,\nyou need to upgrade your organization account to a Business or Enterprise plan.\n\n* `COLUMN_MISSING` A column referenced by this rule has been deleted.\n\n* `COLUMN_TYPE_INCOMPATIBLE` A column referenced by this rule has been changed to an incompatible column type.\n\n* `NO_POTENTIAL_RECIPIENTS` This rule has no recipients that will be able to receive\nnotifications based on this sheet's permission settings or this account's approved domain sharing list.\n\n* `NO_VALID_SELECTED_COLUMNS` All selected columns for this rule have been deleted.\n",
            "type": "string",
            "enum": [
              "APPROVAL_COLUMN_MISSING",
              "APPROVAL_COLUMN_WRONG_TYPE",
              "AUTOMATION_NOT_ENABLED_FOR_ORG",
              "COLUMN_MISSING",
              "COLUMN_TYPE_INCOMPATIBLE",
              "NO_POTENTIAL_RECIPIENTS",
              "NO_VALID_SELECTED_COLUMNS"
            ]
          },
          "disabledReasonText": {
            "description": "Descriptive reason a rule is disabled.",
            "type": "string"
          },
          "enabled": {
            "description": "If true, indicates that the rule is active.",
            "type": "boolean"
          },
          "modifiedAt": {
            "description": "The datetime for when the change was made to the rule.",
            "allOf": [
              {
                "$ref": "#/components/schemas/Timestamp"
              }
            ]
          },
          "modifiedBy": {
            "description": "`User` object containing the `name` and `email` of the user that made the change.\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/MiniUser"
              }
            ]
          },
          "name": {
            "description": "Rule name as shown in the UI.",
            "type": "string"
          },
          "userCanModify": {
            "description": "If true, indicates that the current user can modify the rule.",
            "type": "boolean"
          }
        }
      },
      "AutoNumberFormat": {
        "title": "Auto-number format",
        "type": "object",
        "description": "Specifies how to format values for an auto-generated numbers column.\n",
        "properties": {
          "fill": {
            "description": "Indicates zero-padding. It must be between 0 and 10 \"0\" (zero) characters.",
            "type": "string"
          },
          "prefix": {
            "description": "The prefix. Can include these date tokens:\n  * {DD}\n  * {MM}\n  * {YY}\n  * {YYYY}\n",
            "type": "string"
          },
          "startingNumber": {
            "description": "The starting number for the auto-ID.",
            "type": "number"
          },
          "suffix": {
            "description": "The suffix. Can include these date tokens:\n  * {DD}\n  * {MM}\n  * {YY}\n  * {YYYY}\n",
            "type": "string"
          }
        },
        "example": {
          "fill": "",
          "prefix": "",
          "startingNumber": 1,
          "suffix": ""
        }
      },
      "BulkItemFailure": {
        "title": "Bulk item failure",
        "type": "object",
        "properties": {
          "rowId": {
            "description": "The ID of the row that failed. Applicable only to bulk row operations.",
            "type": "number",
            "nullable": true
          },
          "error": {
            "$ref": "#/components/schemas/Error"
          },
          "index": {
            "description": "The index of the failed item in the bulk request array.",
            "type": "number"
          }
        }
      },
      "Callback": {
        "title": "Callback",
        "description": "The webhook callback object.\n\n> **Note:** Plan callbacks may be accompanied by **custom headers** that you define in the [plan webhook's `customHeaders`](/api/smartsheet/openapi/schemas/planwebhook) attribute. For details, see the [Create webhook](/api/smartsheet/openapi/webhooks/createwebhook) or [Update webhook](/api/smartsheet/openapi/webhooks/updatewebhook) operations.\n",
        "type": "object",
        "x-tags": [
          "webhooks"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/CallbackPlanScoped"
          },
          {
            "$ref": "#/components/schemas/CallbackSheetScoped"
          }
        ]
      },
      "Cell": {
        "title": "Cell",
        "type": "object",
        "x-tags": [
          "cells"
        ],
        "properties": {
          "columnId": {
            "type": "number",
            "description": "The ID of the column that the cell is located in."
          },
          "columnType": {
            "type": "string",
            "description": "Only returned if the include query string parameter contains **columnType**."
          },
          "conditionalFormat": {
            "type": "string",
            "description": "The format descriptor describing this cell's conditional format. Only returned if the include query string parameter contains **format** and this cell has a conditional format applied."
          },
          "displayValue": {
            "type": "string",
            "description": "Visual representation of cell contents, as presented to the user in the UI."
          },
          "format": {
            "type": "string",
            "description": "The format descriptor. Only returned if the include query string parameter contains **format** and this cell has a non-default format applied."
          },
          "formula": {
            "type": "string",
            "description": "The formula for a cell, if set, for instance **=COUNTM([Assigned To]3)**. Note that calculation errors or problems with a formula do not cause the API call to return an error code. Instead, the response contains the same value as in the UI, such as **cell.value = \"#CIRCULAR REFERENCE\"**."
          },
          "hyperlink": {
            "$ref": "#/components/schemas/Hyperlink"
          },
          "image": {
            "$ref": "#/components/schemas/Image"
          },
          "linkInFromCell": {
            "$ref": "#/components/schemas/CellLink"
          },
          "linksOutToCells": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CellLink"
            }
          },
          "objectValue": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "$ref": "#/components/schemas/AbstractDatetimeObjectValue"
              },
              {
                "$ref": "#/components/schemas/ContactObjectValue"
              },
              {
                "$ref": "#/components/schemas/DateObjectValue"
              },
              {
                "$ref": "#/components/schemas/DatetimeObjectValue"
              },
              {
                "$ref": "#/components/schemas/DurationObjectValue"
              },
              {
                "$ref": "#/components/schemas/MultiContactObjectValue"
              },
              {
                "$ref": "#/components/schemas/MultiPicklistObjectValue"
              },
              {
                "$ref": "#/components/schemas/PredecessorList"
              }
            ]
          },
          "overrideValidation": {
            "type": "boolean",
            "description": "(Admin only) Indicates whether the cell value can contain a value outside of the validation limits (value = **true**). When using this parameter, you must also set **strict** to **false** to bypass value type checking. This property is honored for POST or PUT actions that update rows."
          },
          "strict": {
            "type": "boolean",
            "description": "Set to **false** to enable lenient parsing. Defaults to **true**. You can specify this attribute in a request, but it is never present in a response."
          },
          "value": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              }
            ],
            "description": "A string, number, or a Boolean value -- depending on the cell type and the data in the cell. Cell values larger than 4000 characters are silently truncated. An empty cell returns no value."
          }
        }
      },
      "CellDataItem": {
        "title": "Cell data item",
        "type": "object",
        "properties": {
          "columnId": {
            "description": "Column ID for each item.",
            "type": "number"
          },
          "rowId": {
            "description": "Row ID for each item.",
            "type": "number"
          },
          "sheetId": {
            "description": "Sheet ID for each item.",
            "type": "number"
          },
          "objectValue": {
            "description": "The type of data returned depends on the cell type and the data in the cell.",
            "oneOf": [
              {
                "type": "boolean"
              },
              {
                "type": "number"
              },
              {
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/AbstractDatetimeObjectValue"
              },
              {
                "$ref": "#/components/schemas/ContactObjectValue"
              },
              {
                "$ref": "#/components/schemas/DateObjectValue"
              },
              {
                "$ref": "#/components/schemas/DatetimeObjectValue"
              },
              {
                "$ref": "#/components/schemas/DurationObjectValue"
              },
              {
                "$ref": "#/components/schemas/MultiContactObjectValue"
              },
              {
                "$ref": "#/components/schemas/MultiPicklistObjectValue"
              },
              {
                "$ref": "#/components/schemas/PredecessorList"
              }
            ]
          },
          "cell": {
            "$ref": "#/components/schemas/Cell"
          },
          "dataSource": {
            "type": "string",
            "enum": [
              "CELL",
              "SUMMARY_FIELD"
            ]
          },
          "inheritCellValue": {
            "description": "Specifies if valueFormat is inherited from the underlying cell value",
            "type": "boolean"
          },
          "label": {
            "description": "Label for the data point. This is either the column name or a user-provided string.",
            "type": "string"
          },
          "labelFormat": {
            "description": "Format description for label.",
            "type": "string",
            "example": ",,1,1,,,,,,,,,,,,,"
          },
          "labelFont": {
            "$ref": "#/components/schemas/DashboardFont"
          },
          "order": {
            "description": "The display order for the CellDataItem.",
            "type": "number"
          },
          "profileField": {
            "$ref": "#/components/schemas/SummaryField"
          },
          "valueFormat": {
            "description": "Format description for value.",
            "type": "string",
            "example": ",,1,1,,,,,,,,,,,,,"
          },
          "valueFont": {
            "$ref": "#/components/schemas/DashboardFont"
          }
        }
      },
      "CellHistory": {
        "title": "Cell history",
        "type": "object",
        "x-tags": [
          "cells"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/Cell"
          }
        ],
        "properties": {
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "modifiedBy": {
            "description": "User object containing the name and email of the user that made the change.",
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/MiniUser"
              }
            ]
          }
        }
      },
      "CellLink": {
        "title": "Cell link object",
        "type": "object",
        "properties": {
          "columnId": {
            "type": "number",
            "description": "Column ID of the linked cell."
          },
          "rowId": {
            "type": "number",
            "description": "Row ID of the linked cell."
          },
          "sheetId": {
            "type": "number",
            "description": "Sheet ID of the sheet that the linked cell belongs to."
          },
          "sheetName": {
            "type": "string",
            "description": "Sheet name of the linked cell."
          },
          "status": {
            "type": "string",
            "enum": [
              "BLOCKED",
              "BROKEN",
              "CIRCULAR",
              "DISABLED",
              "INACCESSIBLE",
              "INVALID",
              "NOT_SHARED",
              "OK"
            ],
            "description": "* `BLOCKED` One of several other values indicating unusual error conditions.\n* `BROKEN` The row or sheet linked to was deleted.\n* `CIRCULAR` One of several other values indicating unusual error conditions.\n* `DISABLED` One of several other values indicating unusual error conditions.\n* `INACCESSIBLE` The sheet linked to cannot be viewed by this user.\n* `INVALID` One of several other values indicating unusual error conditions.\n* `NOT_SHARED` One of several other values indicating unusual error conditions.\n* `OK` The link is in a good state.\n"
          }
        }
      },
      "CellLinkWidgetContent": {
        "title": "Metric widget content",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "METRIC",
              "SHEETSUMMARY"
            ]
          },
          "sheetId": {
            "description": "Sheet ID from which the cell data originates.",
            "type": "number"
          },
          "cellData": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CellDataItem"
            }
          },
          "columns": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Column"
            }
          },
          "hyperlink": {
            "$ref": "#/components/schemas/WidgetHyperlink"
          }
        }
      },
      "ChartWidgetContent": {
        "title": "Chart widget content",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "CHART"
            ]
          },
          "reportId": {
            "description": "Report ID denoting container source, if applicable.",
            "type": "number"
          },
          "sheetId": {
            "description": "Sheet ID denoting container source, if applicable.",
            "type": "number"
          },
          "axes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Axes"
            }
          },
          "hyperlink": {
            "$ref": "#/components/schemas/WidgetHyperlink"
          },
          "includedColumnIds": {
            "description": "Array of column Ids if the range was selected through the UI.",
            "type": "array",
            "items": {
              "type": "number"
            }
          },
          "legend": {
            "$ref": "#/components/schemas/Legend"
          },
          "selectionRanges": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SelectionRange"
            }
          },
          "series": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Series"
            }
          },
          "verticalGridLines": {
            "$ref": "#/components/schemas/WidgetChartGridLine"
          },
          "horizontalGridLines": {
            "$ref": "#/components/schemas/WidgetChartGridLine"
          }
        }
      },
      "Column": {
        "title": "Column",
        "type": "object",
        "x-tags": [
          "columns"
        ],
        "description": "A column can be one of the following types.\n",
        "allOf": [
          {
            "type": "object",
            "required": [
              "autoNumberFormat",
              "id",
              "index",
              "options",
              "systemColumnType",
              "title",
              "type",
              "version",
              "validation",
              "width"
            ]
          },
          {
            "oneOf": [
              {
                "$ref": "#/components/schemas/TextNumberColumn"
              },
              {
                "$ref": "#/components/schemas/AutoNumberColumn"
              },
              {
                "$ref": "#/components/schemas/CheckboxColumn"
              },
              {
                "$ref": "#/components/schemas/ContactListColumn"
              },
              {
                "$ref": "#/components/schemas/CreatedByColumn"
              },
              {
                "$ref": "#/components/schemas/CreatedDateColumn"
              },
              {
                "$ref": "#/components/schemas/DateColumn"
              },
              {
                "$ref": "#/components/schemas/AbstractDatetimeColumn"
              },
              {
                "$ref": "#/components/schemas/DropdownListColumn"
              },
              {
                "$ref": "#/components/schemas/DurationColumn"
              },
              {
                "$ref": "#/components/schemas/ModifiedByColumn"
              },
              {
                "$ref": "#/components/schemas/ModifiedDateColumn"
              },
              {
                "$ref": "#/components/schemas/MultiContactListColumn"
              },
              {
                "$ref": "#/components/schemas/MultiDropdownListColumn"
              },
              {
                "$ref": "#/components/schemas/PercentCompleteColumn"
              },
              {
                "$ref": "#/components/schemas/PredecessorColumn"
              },
              {
                "$ref": "#/components/schemas/RMAssignedResourceContactColumn"
              },
              {
                "$ref": "#/components/schemas/RMAssignedResourceTextColumn"
              },
              {
                "$ref": "#/components/schemas/RMPercentAllocationColumn"
              },
              {
                "$ref": "#/components/schemas/SymbolColumn"
              }
            ]
          }
        ]
      },
      "Comment": {
        "title": "Comment",
        "type": "object",
        "x-tags": [
          "comments"
        ],
        "properties": {
          "attachments": {
            "description": "Array of attachments on comments.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Attachment"
            }
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "createdBy": {
            "description": "User object containing name and email of the creator of this comment.",
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/MiniUser"
              }
            ]
          },
          "discussionId": {
            "description": "Discussion ID of discussion that contains comment.",
            "type": "number"
          },
          "id": {
            "description": "Comment ID.",
            "type": "number"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "text": {
            "description": "Comment body.",
            "type": "string"
          }
        }
      },
      "Contact": {
        "title": "Contact",
        "type": "object",
        "x-tags": [
          "contacts"
        ],
        "properties": {
          "id": {
            "description": "Contact ID.",
            "type": "string",
            "example": "AAAAATYU54QAD7_fNhTnhA"
          },
          "name": {
            "description": "Contact's full name.",
            "type": "string",
            "example": "Jane Doe"
          },
          "email": {
            "description": "Contact's email address.",
            "type": "string",
            "format": "email",
            "example": "jane.doe@smartsheet.com"
          }
        }
      },
      "ContactOption": {
        "title": "Contact option",
        "type": "object",
        "properties": {
          "email": {
            "description": "A parsable email address.",
            "type": "string"
          },
          "name": {
            "description": "Can be a user's name, display name, or free text.",
            "type": "string"
          }
        }
      },
      "CopyOrMoveRowDestination": {
        "title": "Row destination",
        "type": "object",
        "x-tags": [
          "rows"
        ],
        "properties": {
          "sheetId": {
            "description": "The ID of the destination sheet.",
            "type": "number"
          }
        }
      },
      "CopyOrMoveRowDirective": {
        "title": "Row directive",
        "type": "object",
        "x-tags": [
          "rows"
        ],
        "properties": {
          "rowIds": {
            "description": "The Ids of the rows to move or copy from the source sheet.",
            "type": "array",
            "items": {
              "type": "number"
            }
          },
          "to": {
            "$ref": "#/components/schemas/CopyOrMoveRowDestination"
          }
        }
      },
      "CopyOrMoveRowResult": {
        "title": "Row copy or move response",
        "type": "object",
        "x-tags": [
          "rows"
        ],
        "properties": {
          "destinationSheetId": {
            "description": "The ID of the destination sheet.",
            "type": "number"
          },
          "rowMappings": {
            "description": "Array of rowMapping objects.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RowMapping"
            }
          }
        }
      },
      "ColumnFilterCriteria": {
        "title": "Column filter criteria",
        "description": "Column-focused rules for returning rows.",
        "type": "object",
        "required": [
          "columnId",
          "operator"
        ],
        "properties": {
          "columnId": {
            "description": "Unique identifier for the column.",
            "type": "number",
            "example": 293452983475
          },
          "operator": {
            "$ref": "#/components/schemas/ColumnFilterCriteriaOperator"
          },
          "values": {
            "description": "Present if a custom filter criteria's operator has one or more arguments.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "Complete",
              "In progress"
            ]
          }
        }
      },
      "CrossSheetReference": {
        "title": "Cross-sheet reference",
        "type": "object",
        "x-tags": [
          "crossSheetReferences"
        ],
        "properties": {
          "endColumnId": {
            "description": "Defines ending edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.",
            "type": "number"
          },
          "endRowId": {
            "description": "Defines ending edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.",
            "type": "number"
          },
          "id": {
            "description": "Cross-sheet reference ID, guaranteed unique within referencing sheet.",
            "type": "number"
          },
          "name": {
            "description": "Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References.",
            "type": "string"
          },
          "startColumnId": {
            "description": "Defines beginning edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.",
            "type": "number"
          },
          "startRowId": {
            "description": "Defines beginning edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.",
            "type": "number"
          },
          "status": {
            "description": "Status of request:\n * 'BLOCKED' - A reference is downstream of a circular issue.\n * 'BROKEN' - The data source location (column, row or sheet) was deleted.\n * 'CIRCULAR' - The formula reference is self referencing and cannot be resolved.\n * 'DISABLED' - Updating the reference is temporarily disabled due to maintenance.\n * 'INVALID/UNKNOWN' - The reference is new and had not been validated.\n * 'NOT_SHARED' - No common shared users.\n * 'OK' - The reference is in a good state.\n",
            "type": "string",
            "enum": [
              "BLOCKED",
              "BROKEN",
              "CIRCULAR",
              "DISABLED",
              "INVALID/UNKNOWN",
              "NOT-SHARED",
              "OK"
            ]
          },
          "sourceSheetId": {
            "description": "Sheet ID of source sheet.",
            "type": "number"
          }
        }
      },
      "Currency": {
        "title": "Currency",
        "type": "object",
        "properties": {
          "code": {
            "description": "The ISO 4217 currency code.",
            "example": "EUR",
            "type": "string"
          },
          "symbol": {
            "description": "The currency symbol.",
            "type": "string",
            "example": "€"
          }
        }
      },
      "Discussion": {
        "title": "Discussion",
        "type": "object",
        "x-tags": [
          "discussions"
        ],
        "properties": {
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "id": {
            "description": "Discussion ID.",
            "type": "number"
          },
          "comments": {
            "description": "Array of comments in discussion. Only returned if the include query string parameter contains comments.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Comment"
            }
          },
          "commentAttachments": {
            "description": "Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Attachment"
            }
          },
          "commentCount": {
            "description": "Number of comments in the discussion.",
            "type": "number"
          },
          "createdBy": {
            "description": "`User` object containing `name` and `email` of the user who created the discussion.\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/MiniUser"
              }
            ]
          },
          "lastCommentedAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "lastCommentedUser": {
            "description": "`User` object containing `name` and `email` of the user who last commented on the discussion.\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/MiniUser"
              }
            ]
          },
          "parentId": {
            "description": "The ID of the associated row or sheet.",
            "type": "number"
          },
          "parentType": {
            "description": "Type of parent object.",
            "type": "string",
            "enum": [
              "ROW",
              "SHEET"
            ]
          },
          "readOnly": {
            "description": "Indicates whether the user can modify the discussion.",
            "type": "boolean"
          },
          "title": {
            "description": "Title automatically created by duplicating the first 100 characters of top-level comment.",
            "type": "string",
            "readOnly": true
          }
        }
      },
      "Duration": {
        "title": "Duration",
        "description": "In a project sheet, represents a value in a duration cell, or a lag value of a predecessor.",
        "type": "object",
        "properties": {
          "days": {
            "description": "The number of days for this duration.",
            "type": "number"
          },
          "elapsed": {
            "description": "If true, indicates this duration represents elapsed time, which ignores non-working time.",
            "type": "boolean"
          },
          "hours": {
            "description": "The number of hours for this duration.",
            "type": "number"
          },
          "milliseconds": {
            "description": "The number of milliseconds for this duration.",
            "type": "number"
          },
          "minutes": {
            "description": "The number of minutes for this duration.",
            "type": "number"
          },
          "negative": {
            "description": "When used as a predecessor's lag value, indicates whether the lag is negative (if true), or positive (false). The individual duration values themselves (for example, days, hours, or minutes) is always positive.",
            "type": "boolean"
          },
          "objectType": {
            "type": "string",
            "enum": [
              "DURATION"
            ]
          },
          "seconds": {
            "description": "The number of seconds for this duration.",
            "type": "number"
          },
          "weeks": {
            "description": "The number of weeks for this duration.",
            "type": "number"
          }
        }
      },
      "Email": {
        "title": "Email object",
        "type": "object",
        "properties": {
          "ccMe": {
            "description": "Indicates whether to send a copy of the email to the sender.",
            "type": "boolean"
          },
          "message": {
            "description": "The message of the email.",
            "type": "string"
          },
          "sendTo": {
            "description": "Array of recipients.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Recipient"
            }
          },
          "subject": {
            "description": "The subject of the email.",
            "type": "string"
          }
        }
      },
      "Error": {
        "title": "Error",
        "description": "The error caused by the failed item.",
        "type": "object",
        "properties": {
          "refId": {
            "description": "The ID of the specific error occurrence. Please include this information when contacting Smartsheet support.",
            "type": "string"
          },
          "errorCode": {
            "description": "Custom error code from Smartsheet. See the complete [Error Code List](/api/smartsheet/error-codes).",
            "type": "number"
          },
          "message": {
            "description": "Descriptive error message.",
            "type": "string"
          }
        }
      },
      "Event": {
        "title": "Event",
        "description": "The base object for Event Reporting events. \n\n> **Note:** Event Reporting is a premium add-on available for Enterprise and Advanced Work Management plans. For details on the Event Reporting add-on, please contact our <a href=\"https://www.smartsheet.com/contact/sales\" target=\"_blank\" rel=\"noopener noreferrer\">Sales Team</a>.\n\nAll [event types](/api/smartsheet/event-types) include the Event properties and override the following properties:\n\n- `objectType` (string)\n- `action` (string)\n- `additionalDetails` (object)\n\nSee [Event types](/api/smartsheet/event-types) for event descriptions and example event response objects.\n",
        "type": "object",
        "x-tags": [
          "events"
        ],
        "properties": {
          "eventId": {
            "description": "Unique event identifier.",
            "type": "string",
            "example": "2.1.iI9WIpaEAhjz-0hV0eGw2lOEoKDqoRUP00NJv2RvAyKoOvyws63zsfpTBqda5tb33ylcz2JdGVC9Rfa2FRJKQg"
          },
          "objectType": {
            "description": "The type of Smartsheet resource object impacted by the event.\n\nSee [Event types](/api/smartsheet/event-types) for all the event object types.\n",
            "type": "string",
            "example": "SHEET"
          },
          "action": {
            "description": "The action applied to the specified object, such as CREATE, UPDATE, or DELETE.\n\nSee [Event types](/api/smartsheet/event-types) for actions associated with each event object type.\n",
            "type": "string",
            "example": "UPDATE"
          },
          "objectId": {
            "description": "The identifier of the object impacted by the event. \n\nThis property's value depends on the type of the ID in the event object:\n\n- If the object ID is a number, this property's value is a numeric ID.\n- If the object ID is a string, this property's value is `-1`; the `objectIdStr` property's value is the object ID.\n\n**DEPRECATED - Use the `objectIdStr` property instead of this property.**\n",
            "deprecated": true,
            "type": "integer",
            "format": "int64",
            "minimum": -1,
            "example": 345678901234
          },
          "objectIdStr": {
            "description": "The identifier of the object impacted by the event.\n\nFor objects with numeric IDs, this field contains the string representation of the numeric ID.\nFor objects with string IDs, this field contains the string ID.\n",
            "type": "string",
            "example": "345678901234"
          },
          "eventTimestamp": {
            "description": "Date and time of the event. Defaults to ISO-8601 format. See dates and\ntimes for more information.\n",
            "type": "string",
            "format": "date-time",
            "example": "2025-05-24T14:15:22Z"
          },
          "userId": {
            "description": "User assumed as the one who initiated the event. Usually the userId\nproperty and the requestUserId property (below) have the same value.\nHowever, if the request is an API call with Assume-User header then the\nuserId property identifies the user whose email matches the value in the\nAssume-User header.\n",
            "type": "number",
            "example": 123457654321
          },
          "requestUserId": {
            "description": "User whose authentication credential is embedded in the request that\ninitiated the event. For example, if the request is an API call with an\naccess token then requestUserId identifies the user whose data can be\naccessed via the access token (i.e., the user who authorized the creation\nof the access token). On the other hand, if the request comes from a UI\nsession, then requestUserId identifies the user logged-in to the UI.\n",
            "type": "number",
            "example": 133445566778
          },
          "accessTokenName": {
            "description": "Name of the access token embedded in the request. This property is omitted\nif there's no access token in the request (i.e., it isn't an API call) or\nif the access token wasn't given a name when created (only access tokens\ngenerated via the Smartsheet desktop UI can be given a name at creation\ntime).\n",
            "type": "string",
            "nullable": false,
            "example": "Test token"
          },
          "source": {
            "description": "Identifies the client or user agent used to initiate the action.\n",
            "type": "string",
            "enum": [
              "WEB_APP",
              "MOBILE_IOS",
              "MOBILE_ANDROID",
              "API_UNDEFINED_APP",
              "API_INTEGRATED_APP",
              "API_ODBC_DRIVER",
              "UNKNOWN"
            ],
            "example": "WEB_APP"
          },
          "additionalDetails": {
            "type": "object",
            "description": "Container object for additional event-specific properties. Properties depend upon the event type, but all events include an `emailAddress` property, representing the user responsible for the event\nas well as a `sourceIpAddress` property, representing the responsible's user IP address, if the source of the event is \"WEB_APP\". \n\nSee [Event types](/api/smartsheet/event-types) for event details, including event-specific `additionalDetails` properties and example event response objects.\n",
            "properties": {
              "emailAddress": {
                "description": "Email address of the user responsible for the event.",
                "type": "string",
                "example": "jane.doe@smartsheet.com"
              },
              "sourceIpAddress": {
                "description": "IP address of the user responsible for the event.",
                "type": "string",
                "example": "248.253.157.32"
              }
            },
            "required": [
              "emailAddress"
            ]
          }
        }
      },
      "Favorite": {
        "title": "Favorite",
        "type": "object",
        "x-tags": [
          "favorites"
        ],
        "properties": {
          "objectId": {
            "description": "The ID of the favorited item. If type is template, only private sheet-type template ID is allowed.",
            "type": "number"
          },
          "type": {
            "type": "string",
            "enum": [
              "folder",
              "report",
              "sheet",
              "sight",
              "template",
              "workspace"
            ]
          }
        }
      },
      "FilteredEventsRequest": {
        "title": "Filtered events request",
        "type": "object",
        "properties": {
          "sheetIds": {
            "description": "Array of sheet Ids used to filter events. Only events related to the specified sheet Ids are returned.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "workspaceIds": {
            "description": "Array of workspace Ids used to filter events. Only events related to the specified workspace Ids are returned.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "since": {
            "description": "The earliest time from which events are included in the response. Events before this time are excluded. This field is intended for use when backfilling data at client startup or recovery--don't use it for fine-grained date-based queries. Therefore, resolution is limited to the nearest hour. The value is interpreted as ISO-8601 format, unless `numericDates` is specified (see details about `numericDates` below).\n\nYou must pass in a value for either `since` or `streamPosition` and never both.",
            "type": "string",
            "format": "date-time"
          },
          "to": {
            "description": "The latest time up to which events are included in the response. Events after this time are excluded. The `to` field requires using the `since` body field (above). This field is intended for use when backfilling data at client startup or recovery--don't use it for fine-grained date-based queries. Therefore, resolution is limited to the nearest hour. The value is interpreted as ISO-8601 format, unless `numericDates` is specified (see details about `numericDates` below).\n\nIf `to` is a future time, the current time is used. If `to` equals the `since` time, an empty data value is returned. If `to` is before the `since` time, an error is returned.",
            "type": "string",
            "format": "date-time"
          },
          "streamPosition": {
            "description": "Indicates next set of events to return. Use value of `nextStreamPosition` returned from the previous call.\nYou must pass in a value for either `since` or `streamPosition` and never both.",
            "type": "string",
            "example": "XyzAb1234cdefghijklmnofpq"
          },
          "maxCount": {
            "description": "Maximum number of events to return as response to this call.\nMust be between 1 through 10,000 (inclusive).\nDefaults to 1,000 if not specified.",
            "type": "integer",
            "minimum": 1,
            "maximum": 10000,
            "default": 1000
          },
          "numericDates": {
            "description": "If true, dates are accepted and returned in Unix epoch time (milliseconds since midnight on January 1, 1970 in UTC time).\nDefault is false, which means ISO-8601 format.",
            "type": "boolean",
            "default": false
          },
          "managedPlanId": {
            "description": "The target managed plan for which to list events. Authorized if the caller is a licensed user on either the target managed plan or the main plan in EPM hierarchy.",
            "type": "number"
          }
        }
      },
      "Filters": {
        "title": "Filter",
        "description": "Smartsheet users can define and save personal filters on sheets they can view.\n",
        "type": "object",
        "required": [
          "filterType",
          "query"
        ],
        "properties": {
          "id": {
            "description": "Filters ID.",
            "type": "number",
            "readOnly": true,
            "example": 52739485234
          },
          "excludeSelected": {
            "description": "If `true`, rows containing cells matching the values or criteria items are excluded.\n",
            "type": "boolean",
            "example": false
          },
          "filterType": {
            "type": "string",
            "enum": [
              "PERSONAL",
              "SHARED"
            ],
            "example": "PERSONAL"
          },
          "query": {
            "$ref": "#/components/schemas/Query"
          }
        }
      },
      "Folder": {
        "title": "Folder",
        "description": "Can contain dashboards, folders, reports, sheets, or templates.",
        "type": "object",
        "x-tags": [
          "folders"
        ],
        "properties": {
          "id": {
            "description": "Folder ID.",
            "type": "number"
          },
          "favorite": {
            "deprecated": true,
            "description": "**Deprecated** Returned only if the user has marked the folder as a favorite in their \"Home\" tab (value = true).",
            "type": "boolean"
          },
          "folders": {
            "description": "Folders contained in folder.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Folder"
            }
          },
          "name": {
            "description": "Folder name.",
            "type": "string"
          },
          "permalink": {
            "description": "URL that represents a direct link to the folder in Smartsheet.",
            "type": "string"
          },
          "reports": {
            "description": "Reports contained in folder.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GridListing"
            }
          },
          "sheets": {
            "description": "Sheets contained in folder.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GridListing"
            }
          },
          "sights": {
            "description": "Dashboards contained in folder.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DashboardListing"
            }
          },
          "templates": {
            "description": "Templates contained in folder.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GridListing"
            }
          }
        }
      },
      "FontFamily": {
        "title": "Font family",
        "type": "object",
        "properties": {
          "name": {
            "description": "Name of the font family.",
            "example": "Arial",
            "type": "string"
          },
          "traits": {
            "description": "Platform-independent traits of the font family. Contains one of the listed enum values.",
            "example": [
              "sans-serif"
            ],
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "sans-serif",
                "serif"
              ]
            }
          }
        }
      },
      "FormatDetails": {
        "title": "Email format details",
        "type": "object",
        "properties": {
          "paperSize": {
            "description": "Specifies paper size.",
            "type": "string",
            "example": "LETTER",
            "enum": [
              "A0",
              "A1",
              "A2",
              "A3",
              "A4",
              "ARCHID",
              "LEGAL",
              "LETTER",
              "WIDE"
            ]
          }
        }
      },
      "FormatTables": {
        "title": "Server info format tables",
        "description": "Contains all of the lookup tables that the format descriptor indexes refer to. Here the examples show the formatting options, the default value is used to denote each option. NOTE -- Indexes and their values are guaranteed never to change or be removed for a given major API version.  However, new values could potentially be added to the ends of lookup tables. Because of this possibility, your code should handle the case where a cell might contain a format index value greater than the size of a lookup table your app has loaded. Your application should check for that case and reload the format tables if necessary.",
        "type": "object",
        "properties": {
          "defaults": {
            "description": "A format descriptor where each element describes the formats the Smartsheet Web app displays for format values that have not been set. Each value refers to an index of the following options.",
            "type": "string",
            "example": ",,1,1,,,,,,,,,,,,,"
          },
          "bold": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "none",
              "on"
            ]
          },
          "color": {
            "description": "The default setting is \"none\". Typically this is black text and a white background.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "none",
              "transparent",
              "#000000",
              "#0B347D",
              "#1061C3",
              "#237F2E",
              "#40B14B",
              "#592C00",
              "#5FB3F9",
              "#61058B",
              "#757575",
              "#7ED085",
              "#9210AD",
              "#974C00",
              "#991310",
              "#B9DDFC",
              "#BDBDBD",
              "#C6E7C8",
              "#D0AF8F",
              "#D190DA",
              "#E2F2FE",
              "#E5E5E5",
              "#E7F5E9",
              "#EA352E",
              "#EA5000",
              "#EBC700",
              "#EBC7EF",
              "#EEDCCA",
              "#F2E8DE",
              "#F4E4F5",
              "#F87E7D",
              "#FEFF00",
              "#FEFF85",
              "#FF8D00",
              "#FFCCD2",
              "#FFCD7A",
              "#FFE1AF",
              "#FFEBEE",
              "#FFED00",
              "#FFF3DF",
              "#FFFEE6",
              "#FFFFFF"
            ]
          },
          "currency": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Currency"
            },
            "example": [
              {
                "code": "none",
                "symbol": "none"
              },
              {
                "code": "ARS",
                "symbol": "$"
              },
              {
                "code": "AUD",
                "symbol": "$"
              },
              {
                "code": "BRL",
                "symbol": "R$"
              },
              {
                "code": "CAD",
                "symbol": "$"
              },
              {
                "code": "CHF",
                "symbol": "CHF"
              },
              {
                "code": "CLP",
                "symbol": "$"
              },
              {
                "code": "CNY",
                "symbol": "¥"
              },
              {
                "code": "DKK",
                "symbol": "kr."
              },
              {
                "code": "EUR",
                "symbol": "€"
              },
              {
                "code": "GBP",
                "symbol": "£"
              },
              {
                "code": "HKD",
                "symbol": "$"
              },
              {
                "code": "ILS",
                "symbol": "₪"
              },
              {
                "code": "INR",
                "symbol": "₹"
              },
              {
                "code": "JPY",
                "symbol": "¥"
              },
              {
                "code": "KRW",
                "symbol": "₩"
              },
              {
                "code": "MXN",
                "symbol": "$"
              },
              {
                "code": "NOK",
                "symbol": "kr"
              },
              {
                "code": "NZD",
                "symbol": "$"
              },
              {
                "code": "RUB",
                "symbol": "₽"
              },
              {
                "code": "SEK",
                "symbol": "kr"
              },
              {
                "code": "SGD",
                "symbol": "$"
              },
              {
                "code": "USD",
                "symbol": "$"
              },
              {
                "code": "ZAR",
                "symbol": "R"
              }
            ]
          },
          "dateFormat": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "LOCALE_BASED",
              "MMMM_D_YYYY",
              "MMM_D_YYYY",
              "D_MMM_YYYY",
              "YYYY_MM_DD_HYPHEN",
              "YYYY_MM_DD_DOT",
              "DWWWW_MMMM_D_YYYY",
              "DWWW_DD_MMM_YYYY",
              "DWWW_MM_DD_YYYY",
              "MMMM_D",
              "D_MMMM"
            ]
          },
          "decimalCount": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "0",
              "1",
              "2",
              "3",
              "4",
              "5"
            ]
          },
          "fontFamily": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FontFamily"
            },
            "example": [
              {
                "name": "Arial",
                "traits": [
                  "sans-serif"
                ]
              },
              {
                "name": "Roboto",
                "traits": [
                  "sans-serif"
                ]
              },
              {
                "name": "Tahoma",
                "traits": [
                  "sans-serif"
                ]
              },
              {
                "name": "Times New Roman",
                "traits": [
                  "serif"
                ]
              },
              {
                "name": "Verdana",
                "traits": [
                  "sans-serif"
                ]
              }
            ]
          },
          "fontSize": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "8",
              "9",
              "10",
              "12",
              "14",
              "16",
              "18",
              "20",
              "24",
              "28",
              "32",
              "36"
            ]
          },
          "horizontalAlign": {
            "description": "The default setting is \"default\" which is equivalent to \"left\".",
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "default",
              "left",
              "center",
              "right"
            ]
          },
          "italic": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "none",
              "on"
            ]
          },
          "numberFormat": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "none",
              "NUMBER",
              "CURRENCY",
              "PERCENT"
            ]
          },
          "strikethrough": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "none",
              "on"
            ]
          },
          "textWrap": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "none",
              "on"
            ]
          },
          "thousandsSeparator": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "none",
              "on"
            ]
          },
          "underline": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "none",
              "on"
            ]
          },
          "verticalAlign": {
            "description": "The default setting is \"default\" which is equivalent to \"top\".",
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "default",
              "top",
              "middle",
              "bottom"
            ]
          }
        }
      },
      "GridFilterCriteria": {
        "title": "Grid filter criteria",
        "description": "Rules focused on grids (sheets).",
        "type": "object",
        "required": [
          "operator"
        ],
        "properties": {
          "operator": {
            "description": "Operator for filtering on grids.",
            "type": "string",
            "enum": [
              "HAS_ATTACHMENTS",
              "HAS_COMMENTS",
              "NO_ATTACHMENTS",
              "NO_COMMENTS",
              "BETWEEN",
              "CONTAINS",
              "DOES_NOT_CONTAIN",
              "EQUAL",
              "FUTURE",
              "GREATER_THAN",
              "GREATER_THAN_OR_EQUAL",
              "IS_NOT_NUMBER",
              "IS_NOT_ONE_OF",
              "IS_NUMBER",
              "IS_ONE_OF",
              "LAST_N_DAYS",
              "LESS_THAN",
              "LESS_THAN_OR_EQUAL",
              "NEXT_N_DAYS",
              "NOT_BETWEEN",
              "NOT_EQUAL",
              "NOT_FUTURE",
              "NOT_LAST_N_DAYS",
              "NOT_NEXT_N_DAYS",
              "NOT_PAST",
              "NOT_TODAY",
              "PAST",
              "TODAY"
            ],
            "example": "IS_ONE_OF"
          },
          "values": {
            "description": "Present if a custom filter criteria's operator has one or more arguments.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "Complete",
              "In progress"
            ]
          }
        }
      },
      "Group": {
        "title": "Group",
        "type": "object",
        "x-tags": [
          "groups"
        ],
        "properties": {
          "id": {
            "description": "Group ID.",
            "type": "number",
            "example": 4583173393803140
          },
          "name": {
            "description": "Group name.",
            "type": "string",
            "example": "Group 1"
          },
          "description": {
            "description": "Group description.",
            "type": "string",
            "example": "My group"
          },
          "owner": {
            "description": "Group owner’s email address.",
            "type": "string",
            "format": "email",
            "example": "john.doe@smartsheet.com"
          },
          "ownerId": {
            "description": "Group owner's user ID.",
            "type": "number",
            "example": 2331373580117892
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp"
          }
        }
      },
      "GroupMember": {
        "title": "Group member",
        "type": "object",
        "x-tags": [
          "groupMembers"
        ],
        "properties": {
          "id": {
            "description": "Group member's user ID.",
            "type": "number",
            "example": 2331373580117892
          },
          "email": {
            "description": "Group member's email address.",
            "type": "string",
            "format": "email",
            "example": "john.doe@smartsheet.com"
          },
          "firstName": {
            "description": "Group member's first name.",
            "type": "string",
            "example": "John"
          },
          "lastName": {
            "description": "Group member's last name.",
            "type": "string",
            "example": "Doe"
          },
          "name": {
            "description": "Group member's full name.",
            "type": "string",
            "example": "John Doe"
          }
        }
      },
      "Home": {
        "title": "Home",
        "description": "All objects a user has access to, including dashboards, folders, reports, sheets, and templates.",
        "type": "object",
        "properties": {
          "folders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Folder"
            }
          },
          "reports": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Report"
            }
          },
          "sheets": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Sheet"
            }
          },
          "sights": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Sight"
            }
          },
          "templates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Template"
            }
          }
        }
      },
      "Hyperlink": {
        "title": "Hyperlink object",
        "type": "object",
        "properties": {
          "reportId": {
            "type": "number",
            "description": "If non-null, this hyperlink is a link to the report with this ID."
          },
          "sheetId": {
            "type": "number",
            "description": "If non-null, this hyperlink is a link to the sheet with this ID."
          },
          "sightId": {
            "type": "number",
            "description": "If non-null, this hyperlink is a link to the dashboard with this ID."
          },
          "url": {
            "type": "string",
            "description": "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a dashboard/report/sheet link (that is, dashboardId, reportId, or sheetId is non-null), this property contains the permalink to the dashboard, report, or sheet."
          }
        }
      },
      "Image": {
        "title": "Image",
        "type": "object",
        "x-tags": [
          "cellImages"
        ],
        "properties": {
          "altText": {
            "type": "string",
            "description": "Alternate text for the image."
          },
          "height": {
            "type": "number",
            "description": "Original height (in pixels) of the uploaded image."
          },
          "id": {
            "type": "string",
            "description": "Image ID."
          },
          "width": {
            "type": "number",
            "description": "Original width (in pixels) of the uploaded image."
          }
        }
      },
      "ImageUrl": {
        "title": "Image URL",
        "type": "object",
        "x-tags": [
          "cellImages"
        ],
        "properties": {
          "imageId": {
            "description": "Image ID.",
            "type": "string"
          },
          "error": {
            "$ref": "#/components/schemas/Error"
          },
          "height": {
            "description": "Image height in pixels.",
            "type": "number"
          },
          "url": {
            "description": "Temporary URL that can be used to retrieve the image. This attribute can be present in a response but is never specified in a request.",
            "type": "string"
          },
          "width": {
            "description": "Image width in pixels.",
            "type": "number"
          }
        }
      },
      "ImageUrlMap": {
        "title": "Image URL map",
        "type": "object",
        "x-tags": [
          "cellImages"
        ],
        "properties": {
          "imageUrls": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImageUrl"
            }
          },
          "urlExpiresInMillis": {
            "description": "Milliseconds before the URLs within imageUrls expire.",
            "type": "number"
          }
        }
      },
      "ImageWidgetContent": {
        "type": "object",
        "title": "Image Widget Content",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "IMAGE"
            ]
          },
          "privateId": {
            "description": "The image private ID.",
            "type": "string"
          },
          "fileName": {
            "description": "Name of the image file.",
            "type": "string"
          },
          "fit": {
            "description": "Describes how the image occupies the available space of its widget.\n * ACTUAL_SIZE - Uses the original image width and height dimensions.\n * FILL - Scales the image to maintain its aspect ratio while filling its entire widget. If the image aspect \nratio does not match the aspect ratio of its widget, then the image will be clipped to fit.\n * FIT - Scales the image to maintain its aspect ratio while fitting within its widget. The image will be \n\"letterboxed\" if its aspect ratio does not match the aspect ratio of its widget. Default value for new  image widgets and for existing image widgets where this property has not been explicitly set.\n",
            "enum": [
              "ACTUAL_SIZE",
              "FILL",
              "FIT"
            ],
            "type": "string"
          },
          "format": {
            "description": "Format descriptor. Follows the pattern in FormatTables.",
            "type": "string",
            "example": ",7,1,,,,2,2,1,3,,,,,,1,"
          },
          "height": {
            "type": "number"
          },
          "hyperlink": {
            "$ref": "#/components/schemas/WidgetHyperlink"
          },
          "margin": {
            "description": "Indicates whether there is margin between the image and its widget borders.\n * MARGIN - Default value for existing image widgets where this property has not been explicitly set.\n * NO_MARGIN - Default value for new image widgets.\n",
            "enum": [
              "MARGIN",
              "NO_MARGIN"
            ],
            "type": "string"
          },
          "width": {
            "description": "Original width of the image in pixels.",
            "type": "number"
          }
        }
      },
      "IndexResult": {
        "title": "Index result",
        "type": "object",
        "properties": {
          "pageNumber": {
            "description": "The current page in the full result set that the data array represents. NOTE when a page number greater than totalPages is requested, the last page is instead returned.",
            "type": "number",
            "example": 1,
            "readOnly": true
          },
          "pageSize": {
            "description": "The number of items in a page. Omitted if there is no limit to page size (and hence, all results are included). Unless otherwise specified, this defaults to 100 for most endpoints.",
            "type": "number",
            "example": 50,
            "nullable": true,
            "readOnly": true
          },
          "totalPages": {
            "description": "The total number of pages in the full result set.",
            "type": "number",
            "example": 25,
            "readOnly": true
          },
          "totalCount": {
            "description": "The total number of items in the full result set.",
            "type": "number",
            "example": 136,
            "readOnly": true
          }
        }
      },
      "IndexResultUnknownPages": {
        "title": "Index result unknown pages",
        "type": "object",
        "properties": {
          "pageNumber": {
            "description": "The current page in the full result set that the data array represents. NOTE when a page number greater than totalPages is requested, the last page is instead returned.",
            "type": "number",
            "example": 1,
            "readOnly": true
          },
          "pageSize": {
            "description": "The number of items in a page. Omitted if there is no limit to page size (and hence, all results are included). Unless otherwise specified, this defaults to 100 for most endpoints.",
            "type": "number",
            "example": 50,
            "nullable": true,
            "readOnly": true
          },
          "totalPages": {
            "description": "If the data field value is not empty, returns a static value of -1. When you reach the first empty page after the end of the result set, then all four fields are set with a static value of “0”.",
            "type": "number",
            "example": -1,
            "readOnly": true
          },
          "totalCount": {
            "description": "If the data field value is not empty, returns a static value of -1. When you reach the first empty page after the end of the result set, then all four fields are set with a static value of “0”.",
            "type": "number",
            "example": -1,
            "readOnly": true
          }
        }
      },
      "MiniUser": {
        "title": "Mini user",
        "description": "MiniUser Object",
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "example": "jane.doe@smartsheet.com"
          },
          "name": {
            "type": "string",
            "readOnly": true,
            "example": "Jane Doe"
          }
        }
      },
      "MultiRowEmail": {
        "title": "Multi-row email",
        "x-tags": [
          "sendViaEmail"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/RowEmail"
          }
        ],
        "type": "object",
        "properties": {
          "rowIds": {
            "description": "The Ids of rows to be included.",
            "type": "array",
            "items": {
              "type": "number"
            }
          }
        }
      },
      "Predecessor": {
        "title": "Predecessor",
        "type": "object",
        "properties": {
          "rowId": {
            "description": "The ID of the predecessor row.",
            "type": "number"
          },
          "type": {
            "description": "Type of the predecessor:\n * FF (Finish-to-Finish) - finish at the same time the predecessor finishes.\n * FS (Finish-to-Start) - start after the predecessor finishes.\n * SF (Start-to-Finish) - finish before the predecessor starts.\n * SS (Start-to-Start) - start at the same time the predecessor starts.\n",
            "type": "string",
            "enum": [
              "FF",
              "FS",
              "SF",
              "SS"
            ]
          },
          "inCriticalPath": {
            "description": "True if this predecessor is in the critical path.",
            "type": "boolean",
            "readOnly": true
          },
          "invalid": {
            "description": "True if the row referenced by rowId is not a valid row in this sheet, or there is a circular reference (displayed in the Smartsheet app as \"#REF\") Omitted if false.",
            "type": "boolean",
            "readOnly": true
          },
          "lag": {
            "$ref": "#/components/schemas/Duration"
          },
          "rowNumber": {
            "description": "The row number of the predecessor row. Omitted if invalid is true.",
            "type": "number",
            "readOnly": true
          }
        },
        "example": {
          "rowId": 1234567890123456,
          "rowNumber": 2,
          "type": "FS",
          "inCriticalPath": true
        }
      },
      "PredecessorList": {
        "title": "Predecessor list object value",
        "description": "Object containing a list of references to rows on which the current row depends\n",
        "type": "object",
        "properties": {
          "objectType": {
            "type": "string",
            "enum": [
              "PREDECESSOR_LIST"
            ]
          },
          "predecessors": {
            "description": "List of references to rows on which the current row depends",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Predecessor"
            }
          }
        }
      },
      "ProjectSettings": {
        "title": "Project settings",
        "description": "Represents the project settings dependencies for a specific sheet. Project settings may be updated on sheets that the user has editor access.\n",
        "type": "object",
        "properties": {
          "lengthOfDay": {
            "description": "Length of a workday for a project sheet.",
            "type": "number",
            "minimum": 1,
            "maximum": 24
          },
          "nonWorkingDays": {
            "description": "Non-working days for a project sheet.",
            "type": "array",
            "items": {
              "type": "string",
              "format": "date"
            }
          },
          "workingDays": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY",
                "SATURDAY",
                "SUNDAY"
              ]
            }
          }
        }
      },
      "Proof": {
        "title": "Proof",
        "description": "Object containing zero or more media items, including images, videos, and documents, for review, editing, or approval.",
        "x-tags": [
          "proofs"
        ],
        "type": "object",
        "properties": {
          "id": {
            "description": "Proof ID of the proof version.",
            "type": "number"
          },
          "originalId": {
            "description": "Proof ID of the original proof version.",
            "type": "number"
          },
          "name": {
            "description": "Proof name. This is the same as primary column value. If the primary column value is empty, name is empty.",
            "type": "string"
          },
          "type": {
            "description": "File type for the proof version.",
            "type": "string",
            "enum": [
              "DOCUMENT",
              "IMAGE",
              "MIXED",
              "NONE",
              "VIDEO"
            ]
          },
          "documentType": {
            "description": "If `type=DOCUMENT`, then this indicates the type of file, such as PDF.",
            "type": "string"
          },
          "proofRequestUrl": {
            "description": "URL to review a proofing request.",
            "type": "string"
          },
          "version": {
            "description": "The version number of the proof.",
            "type": "number"
          },
          "lastUpdatedAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "lastUpdatedBy": {
            "description": "`User` object containing `name` and `email` of the user who last updated the proof.\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/MiniUser"
              }
            ]
          },
          "isCompleted": {
            "description": "Indicates whether the proof is completed.",
            "type": "boolean"
          },
          "attachments": {
            "description": "Array of Attachment objects. Only returned if the include query string parameter contains attachments.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Attachment"
            }
          },
          "discussions": {
            "description": "Array of Discussion objects. Only returned if the include query string parameter contains discussions.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Discussion"
            }
          }
        }
      },
      "ProofRequest": {
        "title": "Proof request",
        "x-tags": [
          "proofs"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/ProofRequestBody"
          }
        ],
        "type": "object",
        "properties": {
          "id": {
            "description": "Proof request ID.",
            "type": "number"
          },
          "proofId": {
            "description": "Proof ID of the original proof.",
            "type": "number"
          },
          "sentBy": {
            "description": "`User` object containing `name` and `email` of the sender.\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/MiniUser"
              }
            ]
          },
          "sentAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "isDownloadable": {
            "description": "Indicates whether the description is downloadable.",
            "type": "boolean"
          },
          "status": {
            "description": "Proof request status.",
            "type": "string",
            "enum": [
              "ACTIVE",
              "EXPIRED",
              "PROOF_DELETED"
            ]
          }
        }
      },
      "ProofRequestAction": {
        "title": "Proof request action",
        "x-tags": [
          "proofs"
        ],
        "type": "object",
        "properties": {
          "user": {
            "description": "`User` object containing `name` and `email` of the user performing the action.\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/MiniUser"
              }
            ]
          },
          "actionStatus": {
            "description": "Proof request action status.",
            "type": "string",
            "enum": [
              "APPROVED",
              "PENDING",
              "REJECTED"
            ]
          }
        }
      },
      "ProofRequestBody": {
        "title": "Proof request body",
        "allOf": [
          {
            "$ref": "#/components/schemas/Email"
          }
        ],
        "type": "object",
        "properties": {
          "isDownloadable": {
            "description": "Whether the description is downloadable.",
            "type": "boolean"
          }
        }
      },
      "Query": {
        "title": "Filter query",
        "description": "Applies one or more rules to a filter.",
        "type": "object",
        "required": [
          "criteria"
        ],
        "properties": {
          "operator": {
            "description": "Relationship between multiple rules, if there are multiple.",
            "type": "string",
            "enum": [
              "AND",
              "OR"
            ]
          },
          "criteria": {
            "description": "Criteria objects specifying custom criteria against which to match cell, row, or grid values.\n",
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/ColumnFilterCriteria"
                },
                {
                  "$ref": "#/components/schemas/RowFilterCriteria"
                },
                {
                  "$ref": "#/components/schemas/GridFilterCriteria"
                }
              ]
            }
          },
          "includeParent": {
            "description": "If `true`, include parent rows matching the criteria.",
            "type": "boolean"
          }
        }
      },
      "Recipient": {
        "title": "Recipient",
        "description": "Specifies the recipient of an email. The recipient may be either an individual or a group. To specify an individual, set the email attribute; to specify a group, set the groupId attribute. Either email and groupId may be set, but not both.\n",
        "oneOf": [
          {
            "$ref": "#/components/schemas/Recipient_Individual"
          },
          {
            "$ref": "#/components/schemas/Recipient_Group"
          }
        ]
      },
      "Report": {
        "title": "Report",
        "x-tags": [
          "reports"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "minimum": 1,
            "readOnly": true,
            "description": "The report's unique identifier."
          },
          "name": {
            "type": "string",
            "description": "The report's name."
          },
          "totalRowCount": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "readOnly": true,
            "description": "The number of rows in the report."
          },
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "effectiveAttachmentOptions": {
            "description": "Array of enum strings (see [Attachment.attachmentType](/api/smartsheet/openapi/attachments) indicating the allowable attachment options for the current user and report.\n",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "ganttEnabled": {
            "description": "Indicates whether \"Gantt View\" is enabled.",
            "type": "boolean"
          },
          "cellImageUploadEnabled": {
            "description": "If true,images can be uploaded to the report's cells.",
            "type": "boolean"
          },
          "workspace": {
            "description": "The workspace in which the report resides.",
            "type": "object",
            "properties": {
              "id": {
                "description": "Workspace ID.",
                "type": "number",
                "minimum": 1
              },
              "name": {
                "description": "Workspace name.",
                "type": "string"
              }
            }
          },
          "permalink": {
            "description": "URL that represents a direct link to this item in Smartsheet.",
            "type": "string",
            "readOnly": true
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "columns": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReportColumn"
            }
          },
          "rows": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReportRow"
            }
          },
          "isSummaryReport": {
            "type": "boolean",
            "description": "If true, this is a sheet summary report; otherwise, it's a row report."
          }
        }
      },
      "ReportCell": {
        "title": "Report cell",
        "type": "object",
        "properties": {
          "columnId": {
            "type": "number",
            "description": "The ID of the column that the cell is located in.",
            "minimum": 1
          },
          "virtualColumnId": {
            "type": "number",
            "description": "This property refers to the cell's parent column in the report, while the `columnId` property refers to the cell's parent column in its originating source sheet.\n"
          },
          "value": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              }
            ],
            "description": "A string, number, or a Boolean value -- depending on the cell type and the data in the cell. Cell values larger than 4000 characters are silently truncated. An empty cell returns no value.\n"
          },
          "displayValue": {
            "type": "string",
            "description": "Visual representation of cell contents, as presented to the user in the UI.\n"
          }
        }
      },
      "ReportColumn": {
        "type": "object",
        "title": "Report column",
        "anyOf": [
          {
            "type": "object",
            "title": "Regular report column",
            "required": [
              "index",
              "title",
              "type"
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/ReportColumnIdentifier"
              },
              {
                "$ref": "#/components/schemas/ReportColumnAttributes"
              }
            ]
          },
          {
            "type": "object",
            "title": "System report column",
            "required": [
              "index",
              "type",
              "systemColumnType"
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/ReportColumnIdentifier"
              },
              {
                "$ref": "#/components/schemas/ReportColumnAttributes"
              }
            ]
          },
          {
            "type": "object",
            "title": "Primary report column",
            "required": [
              "index",
              "type",
              "primary"
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/ReportColumnIdentifier"
              },
              {
                "$ref": "#/components/schemas/ReportColumnAttributes"
              }
            ]
          },
          {
            "type": "object",
            "title": "Sheet name report column",
            "required": [
              "index",
              "type",
              "sheetNameColumn"
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/ReportColumnIdentifier"
              },
              {
                "$ref": "#/components/schemas/ReportColumnAttributes"
              }
            ]
          }
        ]
      },
      "ReportColumnIdentifier": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AbstractReportColumnIdentifier"
          },
          {
            "type": "object",
            "properties": {
              "primary": {
                "type": "boolean",
                "description": "Set this to `true` to match the primary column.",
                "default": false
              }
            }
          }
        ]
      },
      "ReportPublish": {
        "title": "Report publish",
        "type": "object",
        "properties": {
          "readOnlyFullAccessibleBy": {
            "description": "Indicates who can access the 'Read-Only Full' view of the published report:\n* If **ALL**, it is available to anyone who has the link.\n* If **ORG**, it is available only to members of the report owner's Smartsheet organization account.\n* If **SHARED**, it is available only to users shared to the item.\n\nOnly returned in a response if **readOnlyFullEnabled** = **true**.\n",
            "type": "string"
          },
          "readOnlyFullDefaultView": {
            "description": "Indicates which view the user has set for a read-only, default view of the published report. Must be one of\nthe following values: **CALENDAR**, **CARD**, or **GRID**.\n",
            "type": "string"
          },
          "readOnlyFullEnabled": {
            "description": "(Required) If **true**, a rich version of the report is published with the ability to download row\nattachments and discussions.\n",
            "type": "boolean"
          },
          "readOnlyFullShowToolbar": {
            "deprecated": true,
            "description": "**Deprecated** Indicates whether the left nav toolbar is displayed. The default, or **true**, is to display the toolbar.\nIf **false**, hides the toolbar.\n",
            "type": "boolean"
          },
          "readOnlyFullUrl": {
            "description": "URL for 'Read-Only Full' view of the published report.\n\nOnly returned in a response if **readOnlyFullEnabled** = **true**.\n",
            "type": "string"
          }
        }
      },
      "ReportRow": {
        "title": "Report row",
        "type": "object",
        "properties": {
          "id": {
            "description": "Row ID.",
            "type": "number",
            "minimum": 1
          },
          "sheetId": {
            "type": "number",
            "description": "The ID of the sheet from which the row originates.",
            "minimum": 1
          },
          "rowNumber": {
            "description": "Row number within the report.",
            "type": "integer",
            "format": "int64",
            "minimum": 1
          },
          "siblingId": {
            "description": "Sibling ID.",
            "type": "number",
            "minimum": 1
          },
          "locked": {
            "description": "Indicates whether the row is locked.",
            "type": "boolean"
          },
          "lockedForUser": {
            "description": "Indicates whether the row is locked for the requesting user.",
            "type": "boolean"
          },
          "expanded": {
            "description": "Indicates whether the row is expanded or collapsed.",
            "type": "boolean"
          },
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "dataModifiedAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "cells": {
            "description": "Cells belonging to the row.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReportCell"
            }
          }
        }
      },
      "ReportWidgetContent": {
        "title": "Report",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "GRIDGANTT"
            ]
          },
          "reportId": {
            "description": "Report ID denoting container source.",
            "type": "number"
          },
          "htmlContent": {
            "description": "HTMl snippet to render report.",
            "type": "string"
          },
          "backgroundColor": {
            "description": "The hex color.",
            "example": "#E6F5FE",
            "type": "string"
          },
          "hyperlink": {
            "$ref": "#/components/schemas/WidgetHyperlink"
          }
        }
      },
      "Result": {
        "title": "Result",
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/ItemResult"
          }
        ],
        "properties": {
          "version": {
            "description": "New version of the sheet. Applicable only for operations which update sheet data.",
            "type": "number",
            "nullable": true
          }
        }
      },
      "RichTextWidgetContent": {
        "title": "Rich Text",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "RICHTEXT"
            ]
          },
          "htmlContent": {
            "description": "The widget contents as HTML. The Rich Text widget supports the following subset of HTML tags and CSS Styles:\n\nHTML\n  * a - hyperlink\n  * br - line break\n  * li - list item\n  * ol - ordered list\n  * p - paragraph\n  * span - section of the document\n  * ul - unordered list\n\nCSS\n  * color\n  * font-family\n  * font-size\n  * font-style\n  * font-weight\n  * text-align\n  * text-decoration\n",
            "type": "string"
          }
        }
      },
      "Row": {
        "title": "Row",
        "x-tags": [
          "rows"
        ],
        "type": "object",
        "properties": {
          "id": {
            "description": "Row ID.",
            "type": "number"
          },
          "siblingId": {
            "description": "Sibling ID.",
            "type": "number"
          },
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "attachments": {
            "description": "Attachments on row. Only returned if the include query string parameter contains attachments.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Attachment"
            }
          },
          "cells": {
            "description": "Cells belonging to the row.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Cell"
            }
          },
          "columns": {
            "description": "Columns of row. Only returned if the include query string parameter contains columns.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Column"
            }
          },
          "conditionalFormat": {
            "description": "Describes this row's conditional format. Only returned if the include query string parameter contains format and this row has a conditional format applied.",
            "type": "string",
            "example": ",,1,1,,,,,,,,,,,,,"
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "createdBy": {
            "description": "User object containing name and email of the creator of this row.",
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/MiniUser"
              }
            ]
          },
          "discussions": {
            "description": "Discussions on the row. Only returned if the include query string parameter contains discussions.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Discussion"
            }
          },
          "proof": {
            "$ref": "#/components/schemas/Proof"
          },
          "expanded": {
            "description": "Indicates whether the row is expanded or collapsed.",
            "type": "boolean"
          },
          "filteredOut": {
            "description": "Indicates if the row is filtered out by a column filter. Only returned if the include query string parameter contains filters.",
            "type": "boolean"
          },
          "format": {
            "description": "Format descriptor. Only returned if the include query string parameter contains format and this row has a non-default format applied.",
            "type": "string",
            "example": ",,1,1,,,,,,,,,,,,,"
          },
          "inCriticalPath": {
            "description": "Only returned, with a value of true, if the sheet is a project sheet with dependencies enabled and this row is in the critical path.",
            "type": "boolean"
          },
          "locked": {
            "description": "Indicates whether the row is locked.",
            "type": "boolean"
          },
          "lockedForUser": {
            "description": "Indicates whether the row is locked for the requesting user.",
            "type": "boolean"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "modifiedBy": {
            "description": "User object containing name and email of the last person to modify this row.",
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/MiniUser"
              }
            ]
          },
          "permaLink": {
            "description": "URL that represents a direct link to the row in Smartsheet. Only returned if the include query string parameter contains rowPermalink.",
            "type": "string"
          },
          "rowNumber": {
            "description": "Row number within the sheet.",
            "type": "number",
            "minimum": 1
          },
          "version": {
            "description": "Sheet version number that is incremented every time a sheet is modified.",
            "type": "number"
          }
        }
      },
      "RowEmail": {
        "title": "Row email",
        "x-tags": [
          "sendViaEmail"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/Email"
          }
        ],
        "type": "object",
        "properties": {
          "columnIds": {
            "description": "The ID of the columns to be included.",
            "type": "array",
            "items": {
              "type": "number"
            }
          },
          "includeAttachments": {
            "description": "Indicates whether to include attachments in the email.",
            "type": "boolean"
          },
          "includeDiscussions": {
            "description": "Indicates whether to include discussions in the email.",
            "type": "boolean"
          },
          "layout": {
            "description": "One of the following values: **HORIZONTAL** or **VERTICAL**. Optional, defaults to **HORIZONTAL** when multiple rows are being sent and to **VERTICAL** when a single row is being sent. **HORIZONTAL** formats the rows being sent as a grid, whereas **VERTICAL** formats the rows being sent as separate cards.\n",
            "type": "boolean"
          }
        }
      },
      "RowFilterCriteria": {
        "title": "Row filter criteria",
        "description": "Row-focused rules.",
        "type": "object",
        "required": [
          "operator"
        ],
        "properties": {
          "operator": {
            "description": "Operator for filtering on row values.",
            "type": "string",
            "enum": [
              "HAS_ATTACHMENTS",
              "HAS_COMMENTS",
              "IS_LOCKED",
              "NOT_LOCKED",
              "NOT_ON_CRITICAL_PATH",
              "NO_ATTACHMENTS",
              "NO_COMMENTS",
              "ON_CRITICAL_PATH",
              "BETWEEN",
              "CONTAINS",
              "DOES_NOT_CONTAIN",
              "EQUAL",
              "FUTURE",
              "GREATER_THAN",
              "NOT_GREATER_THAN",
              "GREATER_THAN_OR_EQUAL",
              "IS_NOT_ONE_OF",
              "IS_ONE_OF",
              "LAST_N_DAYS",
              "LESS_THAN",
              "NOT_LESS_THAN",
              "LESS_THAN_OR_EQUAL",
              "NEXT_N_DAYS",
              "NOT_BETWEEN",
              "NOT_EQUAL",
              "NOT_FUTURE",
              "NOT_LAST_N_DAYS",
              "NOT_NEXT_N_DAYS",
              "NOT_PAST",
              "NOT_TODAY",
              "PAST",
              "TODAY"
            ],
            "example": "IS_ONE_OF"
          },
          "values": {
            "description": "Present if a custom filter criteria's operator has one or more arguments.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "Complete",
              "In progress"
            ]
          }
        }
      },
      "RowMapping": {
        "title": "Row mapping",
        "x-tags": [
          "rows"
        ],
        "type": "object",
        "properties": {
          "from": {
            "description": "Row ID in the source sheet.",
            "type": "number"
          },
          "to": {
            "description": "Row ID in the destination sheet.",
            "type": "number"
          }
        }
      },
      "Schedule": {
        "title": "Schedule",
        "type": "object",
        "properties": {
          "type": {
            "description": "Type of schedule.",
            "type": "string",
            "enum": [
              "ONCE",
              "DAILY",
              "WEEKLY",
              "MONTHLY",
              "YEARLY"
            ]
          },
          "dayDescriptors": {
            "description": "A string array consists of one or more of the following values:\n* **DAY**, **WEEKDAY**, **WEEKEND**\n* **SUNDAY**, **MONDAY**, **TUESDAY**, **WEDNESDAY**, **THURSDAY**, **FRIDAY**, **SATURDAY**\n\nThe subset of values applicable to the schedule type are as followed:\n\n| Value         | Daily schedule | Weekly schedule | Monthly schedule |\n|---------------|----------------|-----------------|------------------|\n| **DAY**       |                |                 |       **✓**      |\n| **WEEKDAY**   |      **✓**     |                 |       **✓**      |\n| **WEEKEND**   |                |                 |       **✓**      |\n| **SUNDAY**    |                |      **✓**      |       **✓**      |\n| **MONDAY**    |                |      **✓**      |       **✓**      |\n| **TUESDAY**   |                |      **✓**      |       **✓**      |\n| **WEDNESDAY** |                |      **✓**      |       **✓**      |\n| **THURSDAY**  |                |      **✓**      |       **✓**      |\n| **FRIDAY**    |                |      **✓**      |       **✓**      |\n| **SATURDAY**  |                |      **✓**      |       **✓**      |\n\nFor more details, refer to the Table of Schedule Object’s Attributes below.\n",
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "DAY",
                "WEEKDAY",
                "WEEKEND",
                "SUNDAY",
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY",
                "SATURDAY"
              ]
            }
          },
          "dayOfMonth": {
            "description": "The day within the month.\n\nValid range is 1 to 28.\n\nThis attribute is applicable to the following schedule type:\n * **MONTHLY**\n\nFor more details, refer to the Table of Schedule Object’s Attributes below.\n",
            "type": "number",
            "minimum": 1,
            "maximum": 31
          },
          "dayOrdinal": {
            "description": "Must be one of the following values:\n  * **FIRST** or **LAST**\n  * **SECOND**, **THIRD**, or **FOURTH**\n\nThis attribute is applicable to the following schedule type:\n  * **MONTHLY**\n\n  For more details, refer to the Table of Schedule Object’s Attributes below.\n",
            "type": "string",
            "enum": [
              "FIRST",
              "LAST",
              "SECOND",
              "THIRD",
              "FOURTH"
            ]
          },
          "repeatEvery": {
            "description": "Frequency on which the request is delivered. The unit is a function of the **type** attribute. For example,\nfor **MONTHLY** schedule, **repeatEvery=1** means every month.\n\nValid range is 1 to 99.\n\nThis attribute is applicable to the following schedule types: **DAILY**, **WEEKLY**, **MONTHLY**, or **YEARLY**.\nFor more details, refer to the Table of Schedule Object’s Attributes below.\n",
            "type": "number",
            "minimum": 1,
            "maximum": 99
          },
          "endAt": {
            "allOf": [
              {
                "description": "The date, time, and time zone at which the delivery schedule ends.\n\nThe value is either in a string format or a numeric format:\n\n* When the value is a string, it must be a valid ISO-8601 date and time with an offset (YYYY-MM-DDThh:mm:ssTZD).\n* When the value is a number, it represents a date and time with no offset (UTC time zone). See Dates and Times for more information.\n\nThe value must be later than startAt and the current date and time.\n\nThe value must contain zero hours, zero minutes, and zero seconds.\n\nThe offset (time zone) value must be the same as the offset (time zone) value in startAt.\n\nThis attribute is applicable to the following schedule types: DAILY, WEEKLY, MONTHLY, YEARLY. For more details, refer to the Table of Schedule Object’s Attributes below.\n"
              },
              {
                "$ref": "#/components/schemas/Timestamp_Writeable"
              }
            ]
          },
          "lastSentAt": {
            "allOf": [
              {
                "description": "The date and time for when the last request was sent."
              },
              {
                "$ref": "#/components/schemas/Timestamp"
              }
            ]
          },
          "nextSendAt": {
            "allOf": [
              {
                "description": "The date and time for when the next request is scheduled to send."
              },
              {
                "$ref": "#/components/schemas/Timestamp"
              }
            ]
          },
          "startAt": {
            "allOf": [
              {
                "description": "The date, time, and time zone at which the first delivery starts.\n\nThe value is either in a string format or a numeric format:\n\n *   When the value is a string, it must be a valid ISO-8601 date and time with an offset (YYYY-MM-DDThh:mm:ssTZD).\n *   When the value is a number, it represents a date and time with no offset (UTC time zone). See [Dates and times](/api/smartsheet/guides/basics/dates-and-times) for more information.\n\nFor ONCE schedule type, it must be later than the current date time.\n\nFor all other schedule types, it must be later than “2000-01-01T00:00:00Z” in string format or 946684800000 in numeric format.\n\nThe value must contain zero minutes and zero seconds.\n\nThis attribute is applicable to all schedule types.\n\nFor more details, refer to the Table of Schedule Object’s Attributes below.\n"
              },
              {
                "$ref": "#/components/schemas/Timestamp_Writeable"
              }
            ]
          }
        }
      },
      "Scope": {
        "title": "Scope",
        "type": "object",
        "properties": {
          "sheets": {
            "description": "Array of Sheet objects (containing just the sheet ID) of any sheets that the requester has access to that make up the report.\n",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Sheet"
            }
          },
          "workspaces": {
            "description": "Array of Workspace objects (containing just the workspace ID) that the requester has access to that make up the report.\n",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WorkspaceListing"
            }
          }
        }
      },
      "SearchResult": {
        "title": "Search result",
        "type": "object",
        "properties": {
          "results": {
            "description": "Array of matching items.",
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/SearchResultItem"
                },
                {
                  "$ref": "#/components/schemas/SearchResultSubItem"
                }
              ]
            }
          },
          "totalCount": {
            "description": "Total number of search results in the `results` array.",
            "type": "number",
            "example": 1
          }
        }
      },
      "SearchResultItem": {
        "title": "Search result item",
        "x-tags": [
          "search"
        ],
        "description": "Represents an item that matches the search query.",
        "allOf": [
          {
            "$ref": "#/components/schemas/SearchResultItemCoreAttributes"
          },
          {
            "type": "object",
            "properties": {
              "favorite": {
                "type": "boolean",
                "description": "`true` if the item is one of the user's favorites.",
                "example": true
              }
            }
          }
        ]
      },
      "SelectionRange": {
        "title": "Selection range",
        "description": "Defines a block of cells in a sheet.",
        "type": "object",
        "properties": {
          "sourceColumnId1": {
            "description": "Defines beginning edge of range when specifying one or more columns.",
            "type": "number"
          },
          "sourceColumnId2": {
            "description": "Defines ending edge of range when specifying one or more columns.",
            "type": "number"
          },
          "sourceRowId1": {
            "description": "Defines beginning edge of range when specifying one or more rows.",
            "type": "number"
          },
          "sourceRowId2": {
            "description": "Defines ending edge of range when specifying one or more rows.",
            "type": "number"
          }
        }
      },
      "SentUpdateRequest": {
        "title": "Sent update request",
        "x-tags": [
          "updateRequests"
        ],
        "type": "object",
        "description": "A sent update request.",
        "allOf": [
          {
            "$ref": "#/components/schemas/SentUpdateRequestListItem"
          },
          {
            "type": "object",
            "properties": {
              "columnIds": {
                "description": "The IDs of columns included in the request.",
                "type": "array",
                "items": {
                  "type": "number"
                }
              },
              "rowIds": {
                "description": "The IDs of rows where an update is requested.",
                "type": "array",
                "items": {
                  "type": "number"
                }
              },
              "includeAttachments": {
                "description": "Indicates whether the attachments were included in the email.",
                "type": "boolean"
              },
              "includeDiscussions": {
                "description": "Indicates whether the discussions were included in the email.",
                "type": "boolean"
              }
            }
          }
        ]
      },
      "ServerInfo": {
        "title": "Server info",
        "x-tags": [
          "serverInfo"
        ],
        "type": "object",
        "properties": {
          "formats": {
            "$ref": "#/components/schemas/FormatTables"
          },
          "supportedLocales": {
            "description": "Array of strings representing all Smartsheet-supported locales.",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "Share": {
        "title": "Share",
        "x-tags": [
          "sharing"
        ],
        "description": "**DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#2025-08-04), this endpoint will be discontinued.** Please refer to the [changelog entry](/api/smartsheet/changelog#2025-08-04) for more details.\n\nShare object used for various sharing relation operations.\n",
        "type": "object",
        "properties": {
          "id": {
            "description": "Share ID.\n\n**NOTE**: unlike other Smartsheet object Ids, this ID is an alphanumeric string.\n",
            "type": "string"
          },
          "groupId": {
            "description": "Group ID if the share is a group share, else null.",
            "type": "number"
          },
          "userId": {
            "description": "User ID if the share is a user share, else null.",
            "type": "number"
          },
          "type": {
            "description": "The type of this share. One of the following values: GROUP or USER.\n",
            "type": "string"
          },
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "ccMe": {
            "description": "Indicates whether to send a copy of the email to the sharer of the sheet. You can specify this attribute\nin a request, but it is never present in a response.\n",
            "type": "boolean"
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "email": {
            "description": "User's primary email address for user shares.",
            "type": "string"
          },
          "message": {
            "description": "The message included in the body of the email that is optionally sent to the recipient. You can specify\nthis attribute in a request, but it is never present in a response.\n",
            "type": "string"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "name": {
            "description": "If a user share and user is also a contact, the user's full name. If a group share, the group's name.",
            "type": "string"
          },
          "scope": {
            "description": "The scope of this share. One of the following values:\n  * **ITEM**: an item-level share (that is, the specific object to which the share applies is shared with\n    the user or group).\n  * **WORKSPACE**: a workspace-level share (that is, the workspace that contains the object to which the\n    share applies is shared with the user or group).\n",
            "type": "string"
          },
          "subject": {
            "description": "The subject of the email that is optionally sent to notify the recipient. You can specify this attribute\nin a request, but it is never present in a response.\n",
            "type": "string"
          }
        }
      },
      "SharedSecret": {
        "title": "Shared secret",
        "type": "object",
        "properties": {
          "sharedSecret": {
            "description": "Value for the shared secret.",
            "type": "string"
          }
        }
      },
      "Sheet": {
        "title": "Sheet",
        "x-tags": [
          "sheets"
        ],
        "type": "object",
        "properties": {
          "id": {
            "description": "Sheet ID.",
            "type": "number"
          },
          "fromId": {
            "description": "The ID of the template from which to create the sheet. This attribute can be specified in a request, but is never present in a response.",
            "type": "number"
          },
          "ownerId": {
            "description": "User ID of the sheet owner.",
            "type": "number"
          },
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "attachments": {
            "description": "Array of Attachment objects.\nOnly returned if the [include](/api/smartsheet/openapi/sheets/getsheet) query string parameter contains **attachments**.\n",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Attachment"
            }
          },
          "cellImageUploadEnabled": {
            "description": "The sheet is enabled for cell images to be uploaded.\n",
            "type": "boolean"
          },
          "columns": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Column"
            }
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "crossSheetReferences": {
            "description": "Array of CrossSheetReference objects.\nOnly returned if the [include](/api/smartsheet/openapi/sheets/getsheet) query string parameter contains **crossSheetReferences**.\n",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CrossSheetReference"
            }
          },
          "dependenciesEnabled": {
            "description": "Indicates whether dependencies are enabled.",
            "type": "boolean"
          },
          "discussions": {
            "description": "Array of Discussion objects\nOnly returned if the [include](/api/smartsheet/openapi/sheets/getsheet) query string parameter contains **discussions**.\n",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Discussion"
            }
          },
          "effectiveAttachmentOptions": {
            "description": "Array of enum strings (see [Attachment.attachmentType](/api/smartsheet/openapi/attachments) indicating the allowable attachment options for the current user and sheet.\n",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "favorite": {
            "deprecated": true,
            "description": "**Deprecated** Returned only if the user has marked this sheet as a favorite in their Home tab (value = **true**).",
            "type": "boolean"
          },
          "ganttEnabled": {
            "description": "Indicates whether \"Gantt View\" is enabled.",
            "type": "boolean"
          },
          "hasSummaryFields": {
            "description": "Indicates whether a sheet summary is present.",
            "type": "boolean"
          },
          "isMultiPicklistEnabled": {
            "description": "Indicates whether multi-select is enabled.",
            "type": "boolean"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "name": {
            "description": "Sheet name.",
            "type": "string"
          },
          "owner": {
            "description": "Email address of the sheet owner.",
            "type": "string"
          },
          "permalink": {
            "description": "URL that represents a direct link to the sheet in Smartsheet.",
            "type": "string"
          },
          "projectSettings": {
            "$ref": "#/components/schemas/ProjectSettings"
          },
          "readOnly": {
            "description": "Returned only if the sheet belongs to an expired trial (value = **true**).",
            "type": "boolean"
          },
          "resourceManagementEnabled": {
            "description": "Indicates that resource management is enabled.",
            "type": "boolean"
          },
          "resourceManagementType": {
            "description": "Resource Management type. Indicates the type of RM that is enabled.",
            "type": "string",
            "enum": [
              "NONE",
              "LEGACY_RESOURCE_MANAGEMENT",
              "RESOURCE_MANAGEMENT_BY_SMARTSHEET"
            ]
          },
          "rows": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Row"
            }
          },
          "showParentRowsForFilters": {
            "description": "Returned only if there are column filters on the sheet. Value = **true** if \"show parent rows\" is enabled for the filters.",
            "type": "boolean"
          },
          "source": {
            "$ref": "#/components/schemas/Source"
          },
          "summary": {
            "$ref": "#/components/schemas/SheetSummary"
          },
          "totalRowCount": {
            "description": "The total number of rows in the sheet.",
            "type": "number"
          },
          "userPermissions": {
            "$ref": "#/components/schemas/SheetUserPermissions"
          },
          "userSettings": {
            "$ref": "#/components/schemas/SheetUserSettings"
          },
          "version": {
            "description": "A number that is incremented every time a sheet is modified.",
            "type": "number"
          },
          "workspace": {
            "$ref": "#/components/schemas/WorkspaceListing"
          }
        }
      },
      "SheetEmail": {
        "title": "Sheet email",
        "x-tags": [
          "sendViaEmail"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/Email"
          }
        ],
        "type": "object",
        "properties": {
          "format": {
            "description": "One of the following values: **EXCEL**, **PDF**, or **PDF_GANTT**.\n",
            "type": "string"
          },
          "formatDetails": {
            "$ref": "#/components/schemas/FormatDetails"
          }
        }
      },
      "SheetPublish": {
        "title": "Sheet publish settings",
        "description": "Describes the sheet's publish settings.",
        "allOf": [
          {
            "$ref": "#/components/schemas/SheetPublishRequest"
          }
        ],
        "type": "object",
        "properties": {
          "icalUrl": {
            "description": "URL for `iCal` view of the published sheet. Only returned in a response if `icalEnabled = true`.\n"
          },
          "readOnlyFullUrl": {
            "description": "URL for 'Read-Only Full' view of the published sheet. Only returned in a response if `readOnlyFullEnabled = true`.\n",
            "type": "string"
          },
          "readOnlyLiteSslUrl": {
            "description": "URL for 'Read-Only' view of the published sheet when SSL is enabled.",
            "type": "string"
          },
          "readOnlyLiteUrl": {
            "description": "URL for 'Read-Only HTML' view of the published sheet. Only returned in a response if `readOnlyLiteEnabled = true`.\n",
            "type": "string"
          },
          "readWriteUrl": {
            "description": "URL for 'Edit by Anyone' view of the published sheet. Only returned in a response if `readWriteEnabled = true`.\n",
            "type": "string"
          },
          "icalEnabled": {
            "description": "If `true`, a webcal is available for the calendar in the sheet.",
            "type": "boolean"
          }
        }
      },
      "SheetSummary": {
        "title": "Sheet summary",
        "x-tags": [
          "sheetSummary"
        ],
        "description": "Represents the entire summary, or a list of defined fields and values, for a specific sheet.\n",
        "type": "object",
        "properties": {
          "fields": {
            "description": "Array of summary (or metadata) fields defined on the sheet.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SummaryField"
            }
          }
        }
      },
      "SheetUserPermissions": {
        "title": "Sheet user permissions",
        "type": "object",
        "description": "Describes the current user's editing permissions for a specific sheet.",
        "properties": {
          "summaryPermissions": {
            "description": "One of:\n  * ADMIN: full control over fields.\n  * READ_DELETE: sheet is owned by an individual account that doesn't have summary capabilities. If a summary exists, the only possible operations are GET and DELETE fields.\n  * READ_ONLY.\n  * READ_WRITE: can edit values of existing fields, but not create or delete fields, nor modify field type.\n",
            "type": "string",
            "enum": [
              "ADMIN",
              "READ_DELETE",
              "READ_ONLY",
              "READ_WRITE"
            ]
          }
        }
      },
      "SheetUserSettings": {
        "title": "Sheet user settings",
        "type": "object",
        "description": "Represents individual user settings for a specific sheet. User settings may be updated even on sheets where the current user only has read access (for example, viewer permissions or a read-only sheet).",
        "properties": {
          "criticalPathEnabled": {
            "description": "Does this user have \"Show Critical Path\" turned on for this sheet? **NOTE**: This setting only has an effect on project sheets with dependencies enabled.\n",
            "type": "boolean"
          },
          "displaySummaryTasks": {
            "description": "Does this user have \"Display Summary Tasks\" turned on for this sheet? Applies only to sheets where \"Calendar View\" has been configured.",
            "type": "boolean"
          }
        }
      },
      "ShortcutDataItem": {
        "title": "Shortcut data item",
        "type": "object",
        "properties": {
          "attachmentType": {
            "type": "string",
            "enum": [
              "BOX_COM",
              "DROPBOX",
              "EGNYTE",
              "EVERNOTE",
              "FILE",
              "GOOGLE_DRIVE",
              "LINK",
              "ONEDRIVE",
              "SMARTSHEET"
            ]
          },
          "hyperlink": {
            "$ref": "#/components/schemas/Hyperlink"
          },
          "label": {
            "description": "Label for the data point.",
            "type": "string"
          },
          "labelFormat": {
            "description": "Format description of label.",
            "type": "string",
            "example": ",,1,1,,,,,,,,,,,,,"
          },
          "labelFont": {
            "$ref": "#/components/schemas/DashboardFont"
          },
          "mimeType": {
            "type": "string"
          },
          "order": {
            "description": "The display order for the ShortcutWidgetItem object.",
            "type": "number"
          }
        }
      },
      "ShortcutWidgetContent": {
        "title": "Shortcut",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "SHORTCUT",
              "SHORTCUTICON",
              "SHORTCUTLIST"
            ]
          },
          "shortcutData": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShortcutDataItem"
            }
          }
        }
      },
      "Sight": {
        "title": "Sight",
        "type": "object",
        "x-tags": [
          "dashboards"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/SightListItem"
          }
        ],
        "properties": {
          "backgroundColor": {
            "description": "The hex color, for instance `#E6F5FE`.",
            "type": "string",
            "readOnly": true
          },
          "defaultWidgetBackgroundColor": {
            "description": "The hex color of the background color for all widgets except for title widgets on the dashboard, for instance `#E6F5FEF4` or `#E6F5FE`.",
            "type": "string",
            "readOnly": true
          },
          "columnCount": {
            "description": "Number of columns that the dashboard contains.",
            "type": "number",
            "readOnly": true
          },
          "source": {
            "$ref": "#/components/schemas/Source"
          },
          "widgets": {
            "readOnly": true,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Widget"
            }
          },
          "workspace": {
            "description": "A reference to the dashboard's workspace, if the dashboard is in a workspace; otherwise an empty value.",
            "type": "object",
            "properties": {
              "id": {
                "description": "Workspace ID.",
                "type": "number"
              },
              "name": {
                "description": "Workspace name.",
                "type": "string"
              }
            },
            "example": {
              "id": 1234567890,
              "name": "Some Workspace"
            }
          }
        }
      },
      "SightPublish": {
        "title": "Sight publish settings",
        "description": "Describes the dashboard's publish settings.",
        "type": "object",
        "x-tags": [
          "dashboards"
        ],
        "properties": {
          "readOnlyFullAccessibleBy": {
            "description": "Indicates who can access the 'Read-Only Full' view of the published dashboard. Only returned in the response if **readOnlyFullEnabled = true**.\n  * **ALL** - available to anyone who has the link.\n  * **ORG** - available only to members of the dashboard owner's Smartsheet organization account.\n  * **SHARED** - available only to users shared to the item.\n\n---\nIf **readOnlyFullEnabled** is set to true in the request, but **readOnlyFullAccessibleBy** is not specified, the value of **readOnlyFullAccessibleBy** defaults to the organization-level 'Dashboard Publishing' setting (if the dashboard owner belongs to an organization account) or to **ALL** (if the dashboard owner does not belong to an organization account).\n",
            "type": "string",
            "enum": [
              "ALL",
              "ORG"
            ]
          },
          "readOnlyFullEnabled": {
            "description": "If true, a rich version of the dashboard is published with the ability to use shortcuts and widget interactions.",
            "type": "boolean"
          },
          "readOnlyFullUrl": {
            "description": "URL for 'Read-Only Full' view of the published dashboard. Only returned in a response if readOnlyFullEnabled = true.",
            "type": "string",
            "readOnly": true
          }
        },
        "required": [
          "readOnlyFullEnabled"
        ]
      },
      "SortCriterion": {
        "title": "Sort criterion",
        "type": "object",
        "properties": {
          "columnId": {
            "type": "number"
          },
          "direction": {
            "description": "Direction of the sort.",
            "type": "string",
            "enum": [
              "ASCENDING",
              "DESCENDING"
            ],
            "default": "ASCENDING"
          }
        }
      },
      "SortSpecifier": {
        "title": "Sort specifier",
        "type": "object",
        "properties": {
          "sortCriteria": {
            "description": "Specifies sort order. Array is in priority order.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SortCriterion"
            }
          }
        }
      },
      "Source": {
        "title": "Source",
        "type": "object",
        "properties": {
          "id": {
            "description": "The ID of the dashboard, report, sheet, or template from which the enclosing dashboard, report, sheet, or template was created.\n",
            "type": "number"
          },
          "type": {
            "description": "**report**, **sheet**, **sight** (aka dashboard), or **template**.\n",
            "type": "string"
          }
        }
      },
      "StreamResult": {
        "title": "Stream result",
        "description": "Stream result properties",
        "type": "object",
        "properties": {
          "nextStreamPosition": {
            "description": "This string should be passed back to the next GET events call to obtain\nsubsequent events.\n",
            "type": "string",
            "example": "XyzAb1234cdefghijklmnofpq"
          },
          "moreAvailable": {
            "description": "True if more results are available. This is typically due to event counts\nexceeding the maxCount parameter passed in.\n",
            "type": "boolean",
            "example": true
          }
        }
      },
      "SummaryField": {
        "title": "Summary field",
        "x-tags": [
          "sheetSummary"
        ],
        "type": "object",
        "properties": {
          "id": {
            "description": "SummaryField ID.",
            "type": "number"
          },
          "contactOptions": {
            "description": "Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ContactOption"
            }
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "createdBy": {
            "description": "User object containing name and email of the creator of this summary field.",
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/MiniUser"
              }
            ]
          },
          "displayValue": {
            "description": "Visual representation of cell contents, as presented to the user in the UI.",
            "type": "string"
          },
          "format": {
            "description": "The format descriptor. Only returned if the include query string parameter contains format and this column has a non-default format applied to it.",
            "type": "string"
          },
          "formula": {
            "description": "The formula for a cell, if set.",
            "type": "string"
          },
          "hyperlink": {
            "$ref": "#/components/schemas/Hyperlink"
          },
          "image": {
            "$ref": "#/components/schemas/Image"
          },
          "index": {
            "description": "Field index or position. This number is zero-based.",
            "type": "number"
          },
          "locked": {
            "description": "Indicates whether the field is locked.",
            "type": "boolean"
          },
          "lockedForUser": {
            "description": "Indicates whether the field is locked for the requesting user.",
            "type": "boolean"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "modifiedBy": {
            "description": "User object containing name and email of the user who most recently modified this summary field.",
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/MiniUser"
              }
            ]
          },
          "objectValue": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "$ref": "#/components/schemas/ContactObjectValue"
              },
              {
                "$ref": "#/components/schemas/DateObjectValue"
              }
            ]
          },
          "options": {
            "description": "When applicable for PICKLIST column type. Array of the options available for the field.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "symbol": {
            "description": "When applicable for PICKLIST column type.",
            "type": "string"
          },
          "title": {
            "description": "Arbitrary name, must be unique within summary.",
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "ABSTRACT_DATETIME",
              "CHECKBOX",
              "CONTACT_LIST",
              "DATE",
              "DATETIME",
              "DURATION",
              "MULTI_CONTACT_LIST",
              "MULTI_PICKLIST",
              "PICKLIST",
              "PREDECESSOR",
              "TEXT_NUMBER"
            ]
          },
          "validation": {
            "description": "Indicates whether summary field values are restricted to the type.",
            "type": "boolean"
          }
        }
      },
      "Template": {
        "title": "Template",
        "description": "A template can be used to create a sheet.",
        "type": "object",
        "x-tags": [
          "templates"
        ],
        "properties": {
          "id": {
            "description": "Template ID.",
            "type": "number"
          },
          "type": {
            "description": "Type of template. Only applicable to public templates.",
            "type": "string",
            "enum": [
              "report",
              "sheet"
            ]
          },
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "blank": {
            "description": "Indicates whether the template is blank. Only applicable to public templates.",
            "type": "boolean"
          },
          "categories": {
            "description": "Indicates whether the template is blank. Only applicable to public templates.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "description": {
            "description": "Template description.",
            "type": "string"
          },
          "globalTemplate": {
            "description": "Type of global template. Only applicable to blank public templates.",
            "type": "string",
            "enum": [
              "BLANK_SHEET",
              "PROJECT_SHEET",
              "TASK_LIST"
            ]
          },
          "image": {
            "description": "URL to the small preview image for this template. Only applicable to non-blank public templates.",
            "type": "string"
          },
          "largeImage": {
            "description": "URL to the large preview image for this template. Only applicable to non-blank public templates.",
            "type": "string"
          },
          "locale": {
            "description": "Locale of the template. Only applicable to public templates.",
            "type": "string",
            "enum": [
              "ar_AE",
              "ar_BH",
              "ar_DZ",
              "ar_EG",
              "ar_IQ",
              "ar_JO",
              "ar_KW",
              "ar_LB",
              "ar_LY",
              "ar_MA",
              "ar_OM",
              "ar_QA",
              "ar_SA",
              "ar_SD",
              "ar_SY",
              "ar_TN",
              "ar_YE",
              "be_BY",
              "bg_BG",
              "ca_ES",
              "cs_CZ",
              "da_DK",
              "de_AT",
              "de_CH",
              "de_DE",
              "de_LU",
              "el_CY",
              "el_GR",
              "en_AU",
              "en_CA",
              "en_GB",
              "en_IE",
              "en_IN",
              "en_MT",
              "en_NZ",
              "en_PH",
              "en_SG",
              "en_US",
              "en_ZA",
              "es_AR",
              "es_BO",
              "es_CL",
              "es_CO",
              "es_CR",
              "es_DO",
              "es_EC",
              "es_ES",
              "es_GT",
              "es_HN",
              "es_MX",
              "es_NI",
              "es_PA",
              "es_PE",
              "es_PR",
              "es_PY",
              "es_SV",
              "es_US",
              "es_UY",
              "es_VE",
              "et_EE",
              "fi_FI",
              "fr_BE",
              "fr_CA",
              "fr_CH",
              "fr_FR",
              "fr_LU",
              "ga_IE",
              "hi_US",
              "hr_HR",
              "hu_HU",
              "in_ID",
              "is_IS",
              "it_CH",
              "it_IT",
              "iw_IL",
              "ja_JP",
              "ko_KR",
              "lt_LT",
              "lv_LV",
              "mk_MK",
              "ms_MY",
              "mt_MT",
              "nl_BE",
              "nl_NL",
              "no_NO",
              "pl_PL",
              "pt_BR",
              "pt_PT",
              "ro_RO",
              "ru_RU",
              "sk_SK",
              "sl_SI",
              "sq_AL",
              "sr_BA",
              "sr_CS",
              "sv_SE",
              "th_US",
              "tr_TR",
              "uk_UA",
              "vi_VN",
              "zh_CN",
              "zh_HK",
              "zh_SG",
              "zh_TW"
            ]
          },
          "name": {
            "type": "string",
            "description": "Type of global template.",
            "example": "Awesome Project Template"
          },
          "tags": {
            "description": "List of search tags for this template. Only applicable to non-blank public templates.",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "Timestamp": {
        "title": "Timestamp",
        "oneOf": [
          {
            "$ref": "#/components/schemas/Timestamp_date-time"
          },
          {
            "$ref": "#/components/schemas/Timestamp_number"
          }
        ],
        "readOnly": true
      },
      "TitleWidgetContent": {
        "title": "Title",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "RICHTEXT"
            ]
          },
          "backgroundColor": {
            "type": "string"
          },
          "htmlContent": {
            "type": "string",
            "description": "The widget contents as HTML. The Title widget supports the following subset of HTML tags and CSS Styles:\n\nHTML\n  * br - line break\n  * p - paragraph\n  * span - section of the document\n\nCSS\n  * color\n  * font-family\n  * font-size\n  * font-style\n  * font-weight\n  * text-align\n  * text-decoration\n",
            "example": "<p style=\"text-align:center\"><span class=\"clsDbFt\">HI!</span></p>"
          }
        }
      },
      "Token": {
        "title": "Token",
        "type": "object",
        "x-tags": [
          "tokens"
        ],
        "properties": {
          "access_token": {
            "description": "A credential that can be used by a client to access the Smartsheet API.",
            "type": "string",
            "readOnly": true
          },
          "token_type": {
            "description": "How an access token will be generated and presented. Smartsheet uses the bearer parameter, which means essentially give access to the bearer of this token.",
            "type": "string",
            "readOnly": true
          },
          "expires_in": {
            "description": "Number of seconds token is valid once issued.",
            "type": "number",
            "default": 604799,
            "readOnly": true
          },
          "refresh_token": {
            "description": "A credential tied to the access token that can be used to obtain a fresh access token with the same permissions, without further involvement from a user.",
            "type": "string",
            "readOnly": true
          }
        }
      },
      "UpdateProofStatusRequest": {
        "title": "Update proof status request",
        "type": "object",
        "properties": {
          "isCompleted": {
            "type": "boolean"
          }
        }
      },
      "UpdateRequest": {
        "title": "Update request object",
        "type": "object",
        "x-tags": [
          "updateRequests"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/MultiRowEmail"
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "description": "ID of the update request.",
                "type": "number"
              },
              "createdAt": {
                "description": "The date and time for when this request was originally created.\n\nRead-only.\n",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Timestamp"
                  }
                ]
              },
              "modifiedAt": {
                "description": "The date and time for when the last change was made to this request.\n\nRead-only.\n",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Timestamp"
                  }
                ]
              },
              "schedule": {
                "description": "The schedule for which update requests are sent out.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Schedule"
                  }
                ]
              },
              "sentBy": {
                "description": "`User` object containing `name` and `email` of the sender.\n",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MiniUser"
                  }
                ]
              }
            }
          }
        ]
      },
      "URLAttachmentRequest": {
        "title": "URL attachment request",
        "type": "object",
        "x-tags": [
          "attachments"
        ],
        "properties": {
          "attachmentSubType": {
            "description": "Attachment sub type.\n\n**Note:** `\"FOLDER\"` type is for EGNYTE values--the rest are GOOGLE_DRIVE values.\n",
            "type": "string",
            "enum": [
              "DOCUMENT",
              "DRAWING",
              "FOLDER",
              "PDF",
              "PRESENTATION",
              "SPREADSHEET"
            ]
          },
          "attachmentType": {
            "description": "Attachment type. \n\n**Note:** `\"DROPBOX\"`, `\"EGNYTE\"`, and `\"EVERNOTE\"` aren't supported for Smartsheet.gov accounts.\n",
            "type": "string",
            "enum": [
              "BOX_COM",
              "DROPBOX",
              "EGNYTE",
              "EVERNOTE",
              "FILE",
              "GOOGLE_DRIVE",
              "LINK",
              "ONEDRIVE",
              "TRELLO"
            ]
          },
          "description": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        }
      },
      "User": {
        "title": "User",
        "x-tags": [
          "users"
        ],
        "description": "User object.",
        "type": "object",
        "properties": {
          "id": {
            "description": "User ID.",
            "type": "number",
            "readOnly": true,
            "example": 48569348493401200
          },
          "admin": {
            "description": "Indicates whether the user is a system admin (can manage user accounts and organization account).",
            "type": "boolean",
            "default": false,
            "example": true
          },
          "customWelcomeScreenViewed": {
            "description": "Timestamp of viewing an Enterprise Custom Welcome Screen by the current user.\n",
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "example": "2020-08-25T12:15:47Z"
          },
          "email": {
            "description": "User's primary email address.",
            "type": "string",
            "format": "email",
            "example": "jane.doe@smartsheet.com"
          },
          "firstName": {
            "description": "User's first name.",
            "type": "string",
            "example": "Jane"
          },
          "groupAdmin": {
            "description": "Indicates whether the user is a group admin (can create and edit groups).",
            "type": "boolean",
            "default": false,
            "example": true
          },
          "isInternal": {
            "description": "Indicates whether the user is internal to the plan's domain. \n\n**Note:** It's present only when a `planId` query parameter is supplied.\n",
            "type": "boolean",
            "readOnly": true,
            "example": true
          },
          "lastLogin": {
            "description": "The timestamp of the user's last login to Smartsheet.\n\nThis property is only included in the response when **all** of the following conditions are met:\n\n- The `include=lastLogin` query parameter is present\n- The user has logged in to Smartsheet at least once\n- The caller has System Admin permissions\n- The total number of users in the response is 100 or fewer\n\nThis property is **excluded from the response** if **any** of the following conditions apply:\n\n- The `includeAll=true` query parameter is present\n- The `planId` query parameter is present\n- The `seatType` query parameter is present\n- The `pageSize` query parameter is set to a value greater than 100\n",
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "example": "2020-10-04T18:32:47Z"
          },
          "lastName": {
            "description": "User's last name.",
            "type": "string",
            "example": "Doe"
          },
          "licensedSheetCreator": {
            "description": "Indicates whether the user is a licensed user (can create and own sheets).\n\n**Note:** On user model plans, the [`POST /users`](/api/smartsheet/openapi/users/add-user) operation sets `licensedSheetCreator` to `true`, regardless of the value provided in the request body.\n",
            "type": "boolean",
            "example": true
          },
          "name": {
            "description": "User's full name (read-only).",
            "type": "string",
            "readOnly": true,
            "example": "Jane Doe"
          },
          "profileImage": {
            "$ref": "#/components/schemas/ProfileImage"
          },
          "provisionalExpirationDate": {
            "description": "The expiration timestamp of the user's provisional seat type. It's null if the user doesn't have a `PROVISIONAL_MEMBER` seat type.\n\n**Note:** It's present only when a `planId` query parameter is supplied.\n",
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "nullable": true,
            "example": "2025-06-14T09:55:30Z"
          },
          "resourceViewer": {
            "description": "Indicates whether the user is a resource viewer (can access resource views).",
            "type": "boolean",
            "default": false,
            "example": true
          },
          "seatType": {
            "description": "User's seat type. \n\n**Note:** It's only present when **either or both** the `planId` and `seatType` query parameters are supplied (available to system admins only).\n\n**DEPRECATED - As early as the sunset date specified in this [changelog entry](/api/smartsheet/changelog#deprecated-viewer-seat-type-in-favor-of-contributor-new), `VIEWER` will be removed and replaced by `CONTRIBUTOR` for all free-tier plans users.** Commenting and attachments are free to the `CONTRIBUTOR` seat type. \n",
            "type": "string",
            "readOnly": true,
            "enum": [
              "MEMBER",
              "PROVISIONAL_MEMBER",
              "CONTRIBUTOR",
              "GUEST",
              "VIEWER"
            ],
            "example": "PROVISIONAL_MEMBER"
          },
          "seatTypeLastChangedAt": {
            "description": "Timestamp of the user's last seat type change. \n\n**Note:** It's only present when **either or both** the `planId` and `seatType` query parameters are supplied (available to system admins only).\n",
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "example": "2025-06-14T09:55:30Z"
          },
          "sheetCount": {
            "description": "**SUNSET** - The `sheetCount` attribute now holds the value `-1` and is included only if the retrieved user's `status` is `ACTIVE`.\n",
            "type": "number",
            "readOnly": true,
            "example": -1,
            "default": -1,
            "minimum": -1,
            "maximum": -1,
            "deprecated": true
          },
          "status": {
            "description": "User status, set to one of the listed enum values.",
            "type": "string",
            "enum": [
              "ACTIVE",
              "DECLINED",
              "PENDING",
              "DEACTIVATED"
            ],
            "example": "ACTIVE"
          }
        }
      },
      "UserProfile": {
        "title": "User profile",
        "type": "object",
        "x-tags": [
          "users"
        ],
        "properties": {
          "id": {
            "description": "Current user's ID.",
            "type": "number",
            "example": 48569348493401200
          },
          "account": {
            "$ref": "#/components/schemas/Account"
          },
          "admin": {
            "description": "Indicates whether the user is a system admin (can manage user accounts and organization account).\n",
            "type": "boolean",
            "example": true
          },
          "alternateEmails": {
            "description": "The user's additional email addresses.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AlternateEmail"
            }
          },
          "company": {
            "description": "User's company.",
            "type": "string",
            "example": "Smartsheet"
          },
          "customWelcomeScreenViewed": {
            "description": "Timestamp of viewing an Enterprise Custom Welcome Screen by the current user.\n",
            "type": "string",
            "format": "date-time",
            "example": "2020-08-25T12:15:47Z"
          },
          "department": {
            "description": "User's department.",
            "type": "string",
            "example": "Engineering"
          },
          "email": {
            "description": "Current user's primary email address.",
            "type": "string",
            "example": "john.doe@smartsheet.com"
          },
          "firstName": {
            "description": "Current user's first name.",
            "type": "string",
            "example": "John"
          },
          "groupAdmin": {
            "description": "Indicates whether the user is a group admin (can create and edit groups).",
            "type": "boolean",
            "example": true
          },
          "jiraAdmin": {
            "description": "Indicates whether the user is a JIRA admin.",
            "type": "boolean",
            "example": true
          },
          "lastLogin": {
            "description": "Last login time of the current user.",
            "type": "string",
            "format": "date-time",
            "example": "2020-10-31T12:15:47Z"
          },
          "lastName": {
            "description": "Current user's last name.",
            "type": "string",
            "example": "Doe"
          },
          "licensedSheetCreator": {
            "description": "Indicates whether the user is a licensed user (can create and own sheets).",
            "type": "boolean",
            "example": true
          },
          "locale": {
            "description": "Current user's locale (see [ServerInfo](/api/smartsheet/openapi/serverinfo/serverinfo)).\n",
            "type": "string",
            "example": "en_US"
          },
          "mobilePhone": {
            "description": "User's mobile phone number.",
            "type": "string",
            "example": "555-867-5309"
          },
          "profileImage": {
            "$ref": "#/components/schemas/ProfileImage"
          },
          "resourceViewer": {
            "description": "Indicates whether the user is a resource viewer (can access resource views).\n",
            "type": "boolean",
            "example": true
          },
          "role": {
            "description": "User's role.",
            "type": "string",
            "example": "Software Developer"
          },
          "salesforceAdmin": {
            "description": "Indicates whether the user is a Salesforce admin.",
            "type": "boolean",
            "example": false
          },
          "salesforceUser": {
            "description": "Indicates whether the user is a registered Salesforce user.",
            "type": "boolean",
            "example": false
          },
          "sheetCount": {
            "description": "**SUNSET** - The `sheetCount` attribute now holds the value `-1` and is included only if the retrieved user's `status` is `ACTIVE`.\n",
            "type": "number",
            "example": -1,
            "default": -1,
            "minimum": -1,
            "maximum": -1,
            "deprecated": true
          },
          "timeZone": {
            "description": "Current user's time zone ID.",
            "type": "string",
            "example": "US/Pacific"
          },
          "title": {
            "description": "User's title.",
            "type": "string",
            "example": "Senior Software Engineer"
          },
          "workPhone": {
            "description": "User's work phone number.",
            "type": "string",
            "example": "844-324-2360"
          }
        }
      },
      "WebContentWidgetContent": {
        "title": "Web Content",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "WidgetWebContent"
            ]
          },
          "url": {
            "description": "The URL for the web content.",
            "type": "string",
            "example": "https://www.youtube.com/embed/quGpnXiCUms"
          }
        }
      },
      "Webhook": {
        "title": "Webhook",
        "x-tags": [
          "webhooks"
        ],
        "description": "The webhook object.",
        "oneOf": [
          {
            "allOf": [
              {
                "$ref": "#/components/schemas/PlanWebhook"
              },
              {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean",
                    "example": false,
                    "description": "If `true`, the webhook is activated; Otherwise, it's inactive or deactivated."
                  },
                  "scope": {
                    "type": "string",
                    "enum": [
                      "plan"
                    ],
                    "example": "plan",
                    "readOnly": true,
                    "description": "Scope of the subscription. \n"
                  },
                  "scopeObjectId": {
                    "type": "integer",
                    "format": "int64",
                    "minimum": 1,
                    "example": 3285357287499652,
                    "readOnly": true,
                    "description": "ID of the object whose events this webhook is subscribed to.\n"
                  }
                }
              }
            ]
          },
          {
            "allOf": [
              {
                "$ref": "#/components/schemas/SheetWebhook"
              },
              {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean",
                    "example": false,
                    "description": "If `true`, the webhook is activated; Otherwise, it's inactive or deactivated."
                  },
                  "scope": {
                    "type": "string",
                    "enum": [
                      "sheet"
                    ],
                    "example": "sheet",
                    "readOnly": true,
                    "description": "Scope of the subscription. \n"
                  },
                  "scopeObjectId": {
                    "type": "integer",
                    "format": "int64",
                    "minimum": 1,
                    "example": 3285357287499652,
                    "readOnly": true,
                    "description": "ID of the object whose events this webhook is subscribed to.\n"
                  }
                }
              }
            ]
          }
        ]
      },
      "Widget": {
        "title": "Widget",
        "x-tags": [
          "dashboards"
        ],
        "type": "object",
        "readOnly": true,
        "properties": {
          "id": {
            "description": "Widget ID.",
            "type": "number"
          },
          "type": {
            "description": "Type of widget.",
            "type": "string",
            "enum": [
              "CHART",
              "GRIDGANTT",
              "IMAGE",
              "METRIC",
              "RICHTEXT",
              "SHEETSUMMARY",
              "SHORTCUT",
              "SHORTCUTICON",
              "SHORTCUTLIST",
              "TITLE",
              "WEBCONTENT"
            ]
          },
          "contents": {
            "description": "The type of widget content depends on the value of widget.type.",
            "oneOf": [
              {
                "$ref": "#/components/schemas/ChartWidgetContent"
              },
              {
                "$ref": "#/components/schemas/CellLinkWidgetContent"
              },
              {
                "$ref": "#/components/schemas/ImageWidgetContent"
              },
              {
                "$ref": "#/components/schemas/ReportWidgetContent"
              },
              {
                "$ref": "#/components/schemas/RichTextWidgetContent"
              },
              {
                "$ref": "#/components/schemas/ShortcutWidgetContent"
              },
              {
                "$ref": "#/components/schemas/TitleWidgetContent"
              },
              {
                "$ref": "#/components/schemas/WebContentWidgetContent"
              }
            ]
          },
          "height": {
            "description": "Number of rows that the widget occupies on the dashboard.",
            "type": "number"
          },
          "showTitle": {
            "description": "True indicates that the client should display the widget title. This is independent of the title string which may be null or empty.\n",
            "type": "boolean"
          },
          "showTitleIcon": {
            "description": "True indicates that the client should display the sheet icon in the widget title.\n",
            "type": "boolean"
          },
          "title": {
            "description": "Title of the widget.",
            "type": "string"
          },
          "titleFormat": {
            "description": "Title format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)).\n",
            "type": "string",
            "example": ",,1,,,,,,,3,,,,,,1,"
          },
          "titleFont": {
            "$ref": "#/components/schemas/DashboardFont"
          },
          "version": {
            "description": "Widget version number.",
            "type": "number"
          },
          "viewMode": {
            "description": "Indicates the content layout. Must use a query parameter of level=2 to see this information.\n\n  * 1 - centered\n  * 2 - left aligned\n",
            "type": "number",
            "enum": [
              1,
              2
            ]
          },
          "width": {
            "description": "Number of columns that the widget occupies on the dashboard.",
            "type": "number"
          },
          "xPosition": {
            "description": "X-coordinate of widget's position on the dashboard.",
            "type": "number"
          },
          "yPosition": {
            "description": "Y-coordinate of widget's position on the dashboard.",
            "type": "number"
          }
        }
      },
      "WidgetHyperlink": {
        "title": "Widget hyperlink",
        "type": "object",
        "description": "Specifies what happens (the widget behavior) when a user clicks on the widget.",
        "oneOf": [
          {
            "title": "No widget hyperlink",
            "type": "object",
            "description": "Do nothing.",
            "properties": {
              "interactionType": {
                "description": "Do nothing.",
                "type": "string",
                "enum": [
                  "NONE"
                ]
              }
            }
          },
          {
            "title": "Distribution widget hyperlink",
            "type": "object",
            "properties": {
              "interactionType": {
                "description": "Opens the current org's distribution link; it's only available if the org has distribution links enabled.",
                "type": "string",
                "enum": [
                  "DISTI_COPY"
                ]
              },
              "url": {
                "type": "string"
              }
            }
          },
          {
            "title": "Folder widget hyperlink",
            "type": "object",
            "properties": {
              "interactionType": {
                "description": "Opens the specified folder.",
                "type": "string",
                "enum": [
                  "SMARTSHEET_ITEM"
                ]
              },
              "url": {
                "type": "string"
              },
              "folderId": {
                "type": "number"
              }
            }
          },
          {
            "title": "Report widget hyperlink",
            "type": "object",
            "properties": {
              "interactionType": {
                "description": "Opens the specified report.",
                "type": "string",
                "enum": [
                  "SMARTSHEET_ITEM"
                ]
              },
              "url": {
                "type": "string"
              },
              "reportId": {
                "type": "number"
              }
            }
          },
          {
            "title": "Sheet widget hyperlink",
            "type": "object",
            "properties": {
              "interactionType": {
                "description": "Opens the specified sheet.",
                "type": "string",
                "enum": [
                  "SMARTSHEET_ITEM"
                ]
              },
              "url": {
                "type": "string"
              },
              "sheetId": {
                "type": "number"
              }
            }
          },
          {
            "title": "Dashboard widget hyperlink",
            "type": "object",
            "properties": {
              "interactionType": {
                "description": "Opens the specified dashboard.",
                "type": "string",
                "enum": [
                  "SMARTSHEET_ITEM"
                ]
              },
              "url": {
                "type": "string"
              },
              "sightId": {
                "type": "number"
              }
            }
          },
          {
            "title": "Workspace widget hyperlink",
            "type": "object",
            "properties": {
              "interactionType": {
                "description": "Opens the specified workspace.",
                "type": "string",
                "enum": [
                  "SMARTSHEET_ITEM"
                ]
              },
              "url": {
                "type": "string"
              },
              "workspaceId": {
                "type": "number"
              }
            }
          },
          {
            "title": "Source sheet widget hyperlink",
            "type": "object",
            "properties": {
              "interactionType": {
                "description": "Opens the widget's source sheet.",
                "type": "string",
                "enum": [
                  "SOURCE_SHEET"
                ]
              },
              "url": {
                "type": "string"
              },
              "sheetId": {
                "type": "number"
              }
            }
          },
          {
            "title": "Source report widget hyperlink",
            "type": "object",
            "properties": {
              "interactionType": {
                "description": "Opens the widget's source report.",
                "type": "string",
                "enum": [
                  "SOURCE_SHEET"
                ]
              },
              "url": {
                "type": "string"
              },
              "reportId": {
                "type": "number"
              }
            }
          },
          {
            "title": "Web widget hyperlink",
            "type": "object",
            "properties": {
              "interactionType": {
                "description": "Opens the website specified by the URL.",
                "type": "string",
                "enum": [
                  "WEB"
                ]
              },
              "url": {
                "type": "string"
              }
            }
          }
        ]
      },
      "Workspace": {
        "title": "Workspace",
        "x-tags": [
          "workspaces"
        ],
        "description": "Can contain dashboards, folders, reports, sheets, and templates.",
        "type": "object",
        "properties": {
          "id": {
            "description": "Workspace ID.",
            "type": "number"
          },
          "name": {
            "description": "Workspace name.",
            "type": "string"
          },
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "permalink": {
            "description": "URL that represents a direct link to the workspace in Smartsheet.",
            "type": "string"
          },
          "folders": {
            "description": "Folders contained in the workspace.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Folder"
            }
          },
          "reports": {
            "description": "Reports contained in the workspace.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GridListing"
            }
          },
          "sheets": {
            "description": "Sheets contained in the workspace.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GridListing"
            }
          },
          "sights": {
            "description": "Dashboards contained in the workspace.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DashboardListing"
            }
          }
        }
      },
      "Timestamp_date-time": {
        "title": "Timestamp datetime",
        "type": "string",
        "format": "date-time"
      },
      "Timestamp_number": {
        "title": "Timestamp number",
        "type": "number"
      },
      "Accesstoken_Authorize": {
        "title": "ACCESS_TOKEN - AUTHORIZE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an access token creation is authorized by a user.",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ACCESS_TOKEN"
                ],
                "example": "ACCESS_TOKEN"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "AUTHORIZE"
                ],
                "example": "AUTHORIZE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "tokenName": {
                    "type": "string",
                    "description": "Name of the newly created access token. (Only included in cases when a name was given to the token)\n",
                    "example": "my_token"
                  },
                  "tokenDisplayValue": {
                    "type": "string",
                    "description": "Four or more characters used as a mnemonic to represent this access token. Even though this value serves as a visual token differentiator, this value isn't an ID because it isn't guaranteed to be unique across all tokens. This value is the same displayed by Smartsheet UI for each access token listed under Apps & Integrations > API Access.\n",
                    "example": "AB12..."
                  },
                  "tokenExpirationTimestamp": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Date and time when this access token expires.\n",
                    "example": "2026-05-24T14:15:22Z"
                  },
                  "accessScopes": {
                    "type": "string",
                    "description": "Comma-delimited list of access scopes granted to this access token. See these [access scopes](/api/smartsheet/guides/advanced-topics/oauth#access-scopes) for details.\n",
                    "example": "READ_SHEETS,WRITE_SHEETS"
                  },
                  "appClientId": {
                    "type": "string",
                    "description": "The client ID of the app to which this access token was granted. (Only included in cases when the access token was generated for an app)\n",
                    "example": "dheu3dmkd32fhxme"
                  },
                  "appName": {
                    "type": "string",
                    "description": "The name of the app to which this access token was granted. (Only included in cases when the access token was generated for an app)\n",
                    "example": "my_app"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Accesstoken_Refresh": {
        "title": "ACCESS_TOKEN - REFRESH",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an access token is refreshed. See the [`POST /token`](/api/smartsheet/openapi/tokens/tokens-getorrefresh) operation for more information about access token refresh.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ACCESS_TOKEN"
                ],
                "example": "ACCESS_TOKEN"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REFRESH"
                ],
                "example": "REFRESH"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "tokenDisplayValue": {
                    "type": "string",
                    "description": "Four or more characters used as a mnemonic to represent this access token. Even though this value serves as a visual token differentiator, this value isn't an ID because it isn't guaranteed to be unique across all tokens. This value is the same displayed by Smartsheet UI for each access token listed under Apps & Integrations > API Access.\n",
                    "example": "AB12..."
                  },
                  "tokenExpirationTimestamp": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Date and time when this access token expires.\n",
                    "example": "2026-05-24T14:15:22Z"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Accesstoken_Revoke": {
        "title": "ACCESS_TOKEN - REVOKE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an access token is revoked.",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ACCESS_TOKEN"
                ],
                "example": "ACCESS_TOKEN"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REVOKE"
                ],
                "example": "REVOKE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "tokenDisplayValue": {
                    "type": "string",
                    "description": "Four or more characters used as a mnemonic to represent this access token. Even though this value serves as a visual token differentiator, this value isn't an ID because it isn't guaranteed to be unique across all tokens. This value is the same displayed by Smartsheet UI for each access token listed under Apps & Integrations > API Access.\n",
                    "example": "AB12..."
                  },
                  "tokenUserId": {
                    "type": "string",
                    "description": "The ID of the user who owns this token.\n",
                    "example": "122454719915908"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Account_BulkUpdate": {
        "title": "ACCOUNT - BULK UPDATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin bulk updates users. This can be done through User Managementconsole on UI.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ACCOUNT"
                ],
                "example": "ACCOUNT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "BULK_UPDATE"
                ],
                "example": "BULK_UPDATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "description": "Email address of the user responsible for the event.\n",
                    "type": "string",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Account_DownloadLoginHistory": {
        "title": "ACCOUNT - DOWNLOAD LOGIN HISTORY",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin downloads login history report for the users. This can be done through Login History console on UI.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ACCOUNT"
                ],
                "example": "ACCOUNT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DOWNLOAD_LOGIN_HISTORY"
                ],
                "example": "DOWNLOAD_LOGIN_HISTORY"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "description": "Email address of the user responsible for the event.\n",
                    "type": "string",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Account_DownloadPublishedItemsReport": {
        "title": "ACCOUNT - DOWNLOAD PUBLISHED ITEMS REPORT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin downloads published items report. This can be done through `User Management` console on UI.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ACCOUNT"
                ],
                "example": "ACCOUNT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DOWNLOAD_PUBLISHED_ITEMS_REPORT"
                ],
                "example": "DOWNLOAD_PUBLISHED_ITEMS_REPORT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "description": "Email address of the user responsible for the event.\n",
                    "type": "string",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Account_DownloadSheetAccessReport": {
        "title": "ACCOUNT - DOWNLOAD SHEET ACCESS REPORT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin downloads sheet access report for an organization account. This can be done through `User Management` console on UI.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ACCOUNT"
                ],
                "example": "ACCOUNT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DOWNLOAD_SHEET_ACCESS_REPORT"
                ],
                "example": "DOWNLOAD_SHEET_ACCESS_REPORT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "description": "Email address of the user responsible for the event.\n",
                    "type": "string",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Account_DownloadUserList": {
        "title": "ACCOUNT - DOWNLOAD USER LIST",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin downloads user list report for an organization account. This can be done through User Management console on UI.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ACCOUNT"
                ],
                "example": "ACCOUNT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DOWNLOAD_USER_LIST"
                ],
                "example": "DOWNLOAD_USER_LIST"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "description": "Email address of the user responsible for the event.\n",
                    "type": "string",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Account_ImportUsers": {
        "title": "ACCOUNT - IMPORT USERS",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin imports users through a CSV file. This can be done through User Administration console on UI.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ACCOUNT"
                ],
                "example": "ACCOUNT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "IMPORT_USERS"
                ],
                "example": "IMPORT_USERS"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "description": "Email address of the user responsible for the event.\n",
                    "type": "string",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Account_ListSheets": {
        "title": "ACCOUNT - LIST SHEETS",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a summarized list of all sheets owned by the members of the organization account is generated. This can be done through API.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ACCOUNT"
                ],
                "example": "ACCOUNT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "LIST_SHEETS"
                ],
                "example": "LIST_SHEETS"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "description": "Email address of the user responsible for the event.\n",
                    "type": "string",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Account_Rename": {
        "title": "ACCOUNT - RENAME",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when the organization account is renamed. This can be done through Account Administration console on UI.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ACCOUNT"
                ],
                "example": "ACCOUNT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "RENAME"
                ],
                "example": "RENAME"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "newName": {
                    "type": "string",
                    "description": "New name of the organization account\n",
                    "example": "New Company Name"
                  },
                  "oldName": {
                    "type": "string",
                    "description": "Previous name of the organization account\n",
                    "example": "Old Company Name"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Account_UpdateMainContact": {
        "title": "ACCOUNT - UPDATE MAIN CONTACT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when the main contact of the organization account is updated. This can be done through `Account Administration` console on UI.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ACCOUNT"
                ],
                "example": "ACCOUNT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE_MAIN_CONTACT"
                ],
                "example": "UPDATE_MAIN_CONTACT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "newContactUserId": {
                    "type": "string",
                    "description": "ID of the new main contact\n",
                    "example": "12345678901234567"
                  },
                  "oldContactUserId": {
                    "type": "string",
                    "description": "ID of the former main contact\n",
                    "example": "48569348493401200"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Attachment_Create": {
        "title": "ATTACHMENT - CREATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an attachment is created (i.e. uploaded) in a sheet, in a sheet row, or in a workspace.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ATTACHMENT"
                ],
                "example": "ATTACHMENT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "CREATE"
                ],
                "example": "CREATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "sheetId": {
                    "type": "string",
                    "description": "ID of the sheet that contains the attachment. (This property is included only if the `workspaceId` property below isn't included)\n",
                    "example": "6141831453927300"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace that directly contains the attachment. (This property is included only if the `sheetId` property above isn't included)\n",
                    "example": "9876543210987654"
                  },
                  "attachmentName": {
                    "type": "string",
                    "description": "Name of the attachment.\n",
                    "example": "my file"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Attachment_Delete": {
        "title": "ATTACHMENT - DELETE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an attachment is deleted.",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ATTACHMENT"
                ],
                "example": "ATTACHMENT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DELETE"
                ],
                "example": "DELETE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "sheetId": {
                    "type": "string",
                    "description": "ID of the sheet that contains the attachment. (This property is included only if the `workspaceId` property below isn't included)\n",
                    "example": "6141831453927300"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace that directly contains the attachment. (This property is included only if the `sheetId` property above isn't included)\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Attachment_Load": {
        "title": "ATTACHMENT - LOAD",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an attachment is loaded (i.e. viewed or downloaded).",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ATTACHMENT"
                ],
                "example": "ATTACHMENT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "LOAD"
                ],
                "example": "LOAD"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "sheetId": {
                    "type": "string",
                    "description": "ID of the sheet that contains the attachment. (This property is included only if the `workspaceId` property below isn't included)\n",
                    "example": "6141831453927300"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace that directly contains the attachment. (This property is included only if the `sheetId` property above isn't included)\n",
                    "example": "9876543210987654"
                  },
                  "multiFileDownloadName": {
                    "type": "string",
                    "description": "Name of the compressed file containing the multiple attachments downloaded at once. (Only included if more than one attachment was selected to be downloaded in the same user action. Please notice that multi-attachment download action allows the user to specify the name of the zip file that should include all attachments, which is what is being provided here. The download of a single attachment uses the attachment name as the download file name and it cannot be changed, and it isn't provided in this event because it is provided in the ATTACHMENT-CREATE event or by querying Smartsheet API with the attachment ID)\n",
                    "example": "name_of_first_file.zip"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Attachment_Send": {
        "title": "ATTACHMENT - SEND",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an attachment is **directly** (i.e. instead of indirectly as part of another operation) sent by email to user(s) or user group(s). \n\nAn individual `ATTACHMENT - SEND` event is issued for each user or user group listed as recipient.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ATTACHMENT"
                ],
                "example": "ATTACHMENT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "SEND"
                ],
                "example": "SEND"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "recipientEmail": {
                    "type": "string",
                    "description": "Single email address either of a user explicitly included in the recipient list or of the sender (when *CC sender* is requested). (This property is included only if the recipientGroupId property below isn't included)\n",
                    "example": "john.doe@smartsheet.com"
                  },
                  "recipientGroupId": {
                    "type": "string",
                    "description": "Single ID of a user group explicitly included in the recipient list. (This property is included only if the `recipientEmail` property above isn't included)\n",
                    "example": "4583173393803140"
                  },
                  "sheetId": {
                    "type": "string",
                    "description": "ID of the sheet that contains the attachment. (This property is included only if the `workspaceId` property below isn't included)\n",
                    "example": "6141831453927300"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace that directly contains the attachment. (This property is included only if the `sheetId` property above isn't included)\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Attachment_Update": {
        "title": "ATTACHMENT - UPDATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an existing attachment is updated (e.g. its description changed).",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "ATTACHMENT"
                ],
                "example": "ATTACHMENT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE"
                ],
                "example": "UPDATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "sheetId": {
                    "type": "string",
                    "description": "ID of the sheet that contains the attachment. (This property is included only if the `workspaceId` property below isn't included)\n",
                    "example": "6141831453927300"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace that directly contains the attachment. (This property is included only if the `sheetId` property above isn't included)\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Authentication_Activate_Domain_Strict": {
        "title": "AUTHENTICATION - ACTIVATE_DOMAIN_STRICT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates the domain strict policy for one or more domains in the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_DOMAIN_STRICT"
                ],
                "example": "ACTIVATE_DOMAIN_STRICT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "domains": {
                    "type": "string",
                    "description": "Comma-separated list of FQDNs where domain strict is activated\n"
                  },
                  "mfaEnabled": {
                    "type": "string",
                    "description": "\"true\" or \"false\" indicating whether MFA is enabled for this policy\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Authentication_Activate_Email_Based_Totp": {
        "title": "AUTHENTICATION - ACTIVATE_EMAIL_BASED_TOTP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates email-based TOTP authentication for one or more domains.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_EMAIL_BASED_TOTP"
                ],
                "example": "ACTIVATE_EMAIL_BASED_TOTP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "domains": {
                    "type": "string",
                    "description": "Comma-separated list of FQDNs where email TOTP is activated\n"
                  },
                  "mfaEnabled": {
                    "type": "string",
                    "description": "\"true\" or \"false\" indicating whether MFA is enabled\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Authentication_Activate_Mfa_Email_Based_Totp": {
        "title": "AUTHENTICATION - ACTIVATE_MFA_EMAIL_BASED_TOTP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates MFA requirement for email-based TOTP for one or more domains.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_MFA_EMAIL_BASED_TOTP"
                ],
                "example": "ACTIVATE_MFA_EMAIL_BASED_TOTP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "domains": {
                    "type": "string",
                    "description": "Comma-separated list of FQDNs affected\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Authentication_Activate_Mfa_Sysadmin_Totp_Fallback": {
        "title": "AUTHENTICATION - ACTIVATE_MFA_SYSADMIN_TOTP_FALLBACK",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates the MFA requirement for system administrator TOTP fallback policy for one or more domains.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_MFA_SYSADMIN_TOTP_FALLBACK"
                ],
                "example": "ACTIVATE_MFA_SYSADMIN_TOTP_FALLBACK"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "domains": {
                    "type": "string",
                    "description": "Comma-separated list of FQDNs affected\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Authentication_Activate_Saml_Idp_Config": {
        "title": "AUTHENTICATION - ACTIVATE_SAML_IDP_CONFIG",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates a SAML identity provider configuration from the UI.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_SAML_IDP_CONFIG"
                ],
                "example": "ACTIVATE_SAML_IDP_CONFIG"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "domains": {
                    "type": "string",
                    "description": "The domains for which this policy is activated\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Authentication_Activate_Sysadmin_Totp_Fallback": {
        "title": "AUTHENTICATION - ACTIVATE_SYSADMIN_TOTP_FALLBACK",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates the system administrator TOTP fallback policy for one or more domains.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_SYSADMIN_TOTP_FALLBACK"
                ],
                "example": "ACTIVATE_SYSADMIN_TOTP_FALLBACK"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "domains": {
                    "type": "string",
                    "description": "Comma-separated list of FQDNs where system admin TOTP fallback is activated\n"
                  },
                  "mfaEnabled": {
                    "type": "string",
                    "description": "\"true\" or \"false\" indicating whether MFA is enabled\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Authentication_Add_Saml_Idp": {
        "title": "AUTHENTICATION - ADD_SAML_IDP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin adds a new SAML identity provider to the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ADD_SAML_IDP"
                ],
                "example": "ADD_SAML_IDP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "isOkta": {
                    "type": "string",
                    "description": "\"true\" or \"false\" indicating whether this is an Okta IdP\n"
                  },
                  "displayName": {
                    "type": "string",
                    "description": "Human-readable name of the IdP\n"
                  },
                  "urlBased": {
                    "type": "string",
                    "description": "\"true\" or \"false\" indicating whether metadata is URL-based vs file-based\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Authentication_Deactivate_Domain_Strict": {
        "title": "AUTHENTICATION - DEACTIVATE_DOMAIN_STRICT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates the domain strict policy for one or more domains in the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_DOMAIN_STRICT"
                ],
                "example": "DEACTIVATE_DOMAIN_STRICT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "domains": {
                    "type": "string",
                    "description": "Comma-separated list of FQDNs where domain strict is deactivated\n"
                  },
                  "mfaEnabled": {
                    "type": "string",
                    "description": "\"true\" or \"false\" indicating whether MFA was enabled for this policy\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Authentication_Deactivate_Email_Based_Totp": {
        "title": "AUTHENTICATION - DEACTIVATE_EMAIL_BASED_TOTP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates email-based TOTP authentication for one or more domains.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_EMAIL_BASED_TOTP"
                ],
                "example": "DEACTIVATE_EMAIL_BASED_TOTP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "domains": {
                    "type": "string",
                    "description": "Comma-separated list of FQDNs where email TOTP is deactivated\n"
                  },
                  "mfaEnabled": {
                    "type": "string",
                    "description": "\"true\" or \"false\" indicating whether MFA was enabled\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Authentication_Deactivate_Mfa_Email_Based_Totp": {
        "title": "AUTHENTICATION - DEACTIVATE_MFA_EMAIL_BASED_TOTP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates MFA requirement for email-based TOTP for one or more domains.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_MFA_EMAIL_BASED_TOTP"
                ],
                "example": "DEACTIVATE_MFA_EMAIL_BASED_TOTP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "domains": {
                    "type": "string",
                    "description": "Comma-separated list of FQDNs affected\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Authentication_Deactivate_Mfa_Sysadmin_Totp_Fallback": {
        "title": "AUTHENTICATION - DEACTIVATE_MFA_SYSADMIN_TOTP_FALLBACK",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates the MFA requirement for system administrator TOTP fallback policy for one or more domains.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_MFA_SYSADMIN_TOTP_FALLBACK"
                ],
                "example": "DEACTIVATE_MFA_SYSADMIN_TOTP_FALLBACK"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "domains": {
                    "type": "string",
                    "description": "Comma-separated list of FQDNs affected\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Authentication_Deactivate_Saml_Idp_Config": {
        "title": "AUTHENTICATION - DEACTIVATE_SAML_IDP_CONFIG",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates a SAML identity provider configuration from the UI\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_SAML_IDP_CONFIG"
                ],
                "example": "DEACTIVATE_SAML_IDP_CONFIG"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "domains": {
                    "type": "string",
                    "description": "The domains for which this policy is deactivated\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Authentication_Deactivate_Sysadmin_Totp_Fallback": {
        "title": "AUTHENTICATION - DEACTIVATE_SYSADMIN_TOTP_FALLBACK",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates the system administrator TOTP fallback policy for one or more domains.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_SYSADMIN_TOTP_FALLBACK"
                ],
                "example": "DEACTIVATE_SYSADMIN_TOTP_FALLBACK"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "domains": {
                    "type": "string",
                    "description": "Comma-separated list of FQDNs where system admin TOTP fallback is deactivated\n"
                  },
                  "mfaEnabled": {
                    "type": "string",
                    "description": "\"true\" or \"false\" indicating whether MFA was enabled\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Authentication_Delete_Saml_Idp": {
        "title": "AUTHENTICATION - DELETE_SAML_IDP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deletes a SAML identity provider from the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DELETE_SAML_IDP"
                ],
                "example": "DELETE_SAML_IDP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "displayName": {
                    "type": "string",
                    "description": "Name of the deleted IdP\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Authentication_Login": {
        "title": "AUTHENTICATION - LOGIN",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user logs into Smartsheet. The details contain information about login method and also if the login attempt was a failure or a success\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "LOGIN"
                ],
                "example": "LOGIN"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "loginResult": {
                    "type": "string",
                    "description": "Result of the login attempt: \"success\" or \"failure\"\n"
                  },
                  "loginMethod": {
                    "type": "string",
                    "description": "Authentication method used (e.g., \"EMAIL_PASSWORD\")\n"
                  },
                  "reason": {
                    "type": "string",
                    "description": "Failure reason (only included when loginResult is \"failure\"), e.g., \"AUTH_NO_MATCHING_USER\"\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Authentication_Logout": {
        "title": "AUTHENTICATION - LOGOUT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user logs out of Smartsheet. Contains details of the reason for logout.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "LOGOUT"
                ],
                "example": "LOGOUT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "logoutMethod": {
                    "type": "string",
                    "description": "How the logout was initiated (e.g., \"user_signout\")\n"
                  },
                  "logoutResult": {
                    "type": "string",
                    "description": "Result of the logout (e.g., \"success\")\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Authentication_Update_Saml_Idp": {
        "title": "AUTHENTICATION - UPDATE_SAML_IDP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin updates a SAML identity provider's configuration (e.g. display name, metadata, or verification state).\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "AUTHENTICATION"
                ],
                "example": "AUTHENTICATION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE_SAML_IDP"
                ],
                "example": "UPDATE_SAML_IDP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "isOkta": {
                    "type": "string",
                    "description": "\"true\" or \"false\" (only if the Okta flag changed)\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Dashboard_AddPublish": {
        "title": "DASHBOARD - ADD_PUBLISH",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user publishes a dashboard or republishes a dashboard with new settings.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ADD_PUBLISH"
                ],
                "example": "ADD_PUBLISH"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "accessibleBy": {
                    "type": "string",
                    "enum": [
                      "ALL",
                      "ORG"
                    ],
                    "description": "Indicates who can use the link to view the dashboard: `\"ALL\"` (accessible to any person with the link), `\"ORG\"` (accessible only by those belonging to the org).\n",
                    "example": "ORG"
                  },
                  "publishType": {
                    "type": "string",
                    "enum": [
                      "read_only"
                    ],
                    "description": "Indicates permissions granted to users with a valid link. All dashboard publishes are read only: `\"read_only\"`.\n",
                    "example": "read_only"
                  },
                  "publishFormat": {
                    "type": "string",
                    "enum": [
                      "FULL"
                    ],
                    "description": "Indicates format of the published dashboard. Dashboards are published in a rich media format: `\"FULL\"`,\n",
                    "example": "FULL"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_AddShare": {
        "title": "DASHBOARD - ADD_SHARE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group or user is added to the dashboard's sharing list, or when a group or user's share permissions are changed.",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ADD_SHARE"
                ],
                "example": "ADD_SHARE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "accessLevel": {
                    "type": "string",
                    "enum": [
                      "VIEWER",
                      "EDITOR",
                      "EDITOR_SHARE",
                      "ADMIN"
                    ],
                    "description": "Indicates the access level granted to the user. \n\nNote that this access level represents the access level that has been granted to the user via group membership; it is not the user's effective access level for the dashboard.\n",
                    "example": "VIEWER"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that was added to the group.\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group the user was added to.\n",
                    "example": "5432109876543210"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace that the group is shared to. (Specific to cases where the dashboard is shared to the group via a workspace's sharing list)\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_AddShareMember": {
        "title": "DASHBOARD - ADD_SHARE_MEMBER",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user is added to a group that a dashboard has been shared to via the dashboard's sharing list, or via a workspace's sharing list. If a dashboard has been shared to a group directly via the dashboard's sharing list, and via a workspace's sharing list, then an event will be generated for each of these shares.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ADD_SHARE_MEMBER"
                ],
                "example": "ADD_SHARE_MEMBER"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "accessLevel": {
                    "type": "string",
                    "enum": [
                      "VIEWER",
                      "EDITOR",
                      "EDITOR_SHARE",
                      "ADMIN"
                    ],
                    "description": "Indicates the access level granted to the group or user. \n\nNote that this access level represents the access level granted by this specific sharing action; it is not the group or user's effective access level for the dashboard.\n",
                    "example": "VIEWER"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that was added to the dashboard's sharing list. (Specific to share to user actions)\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that was added to the dashboard's sharing list. (Specific to share to group actions)\n",
                    "example": "5432109876543210"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_AddWorkspaceShare": {
        "title": "DASHBOARD - ADD_WORKSPACE_SHARE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group or user is added to a workspace's sharing list. Note that this event will appear for each dashboard that is in the workspace. If a group or user is added to a workspace's sharing list and the workspace is empty, then no events will be recorded. \n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ADD_WORKSPACE_SHARE"
                ],
                "example": "ADD_WORKSPACE_SHARE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "accessLevel": {
                    "type": "string",
                    "enum": [
                      "VIEWER",
                      "EDITOR",
                      "EDITOR_SHARE",
                      "ADMIN"
                    ],
                    "description": "Indicates the access level granted to the group or user.\n\nNote that this access level represents the access level granted by this specific sharing action; it is not the group or user's effective access level for the dashboard.\n",
                    "example": "VIEWER"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that the workspace was shared to. (Specific to share to user actions)\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that the workspace was shared to. (Specific to share to group actions)\n",
                    "example": "5432109876543210"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace that was shared to the group or user.\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_Create": {
        "title": "DASBHOARD - CREATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a dashboard is created. Dashboards can be created in the UI with the `Create New` button, by selecting the `Save As New` option on an existing dashboard, or through the API.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "type": "string",
                "enum": [
                  "CREATE"
                ],
                "example": "CREATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "dashboardName": {
                    "type": "string",
                    "description": "Name of the newly created dashboard.",
                    "example": "2345678abc"
                  },
                  "sourceGlobalTemplateId": {
                    "type": "string",
                    "description": "ID of the global template that was used to create the dashboard. (Specific to `Create New` actions).\n",
                    "example": "48569348493401200"
                  },
                  "sourceObjectId": {
                    "type": "string",
                    "description": "ID of the source dashboard. (Specific to `Save As New` actions). \n",
                    "example": "48569348493401200"
                  },
                  "sourceType": {
                    "type": "string",
                    "description": "The source object used to create the dashboard, currently only 'global_template' is valid.\n",
                    "example": "global_template"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_Delete": {
        "title": "DASHBOARD - DELETE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a dashboard is deleted.",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DELETE"
                ],
                "example": "DELETE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_Load": {
        "title": "DASHBOARD - LOAD",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a dashboard is viewed in the UI or loaded through the API.",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "LOAD"
                ],
                "example": "LOAD"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_Move": {
        "title": "DASHBOARD - MOVE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a dashboard is moved between workspaces and/or folders.",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "MOVE"
                ],
                "example": "MOVE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "newParentContainerId": {
                    "type": "string",
                    "description": "ID of the destination folder for the move event. (Specific to actions where the dashboard was moved to a different folder).\n",
                    "example": "4365870921436587"
                  },
                  "parentContainerId": {
                    "type": "string",
                    "description": "ID of the parent container of the dashboard. (Specific to move events where a folder containing the dashboard is moved to a folder in a different workspace, indicates that the dashboard has moved to a new workspace but is still within the same folder)\n",
                    "example": "3456789012345678"
                  },
                  "folderName": {
                    "type": "string",
                    "description": "Name of the destination folder for the move event. (Specific to actions where the dashboard was moved to a different folder).\n",
                    "example": "Folder B"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace the dashboard is currently in. If the move was between two workspaces the `workspaceId` will be the ID of the destination workspace.\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_Purge": {
        "title": "DASHBOARD - PURGE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a dashboard is deleted from the deleted items bin.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "PURGE"
                ],
                "example": "PURGE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_RemovePublish": {
        "title": "DASHBOARD - REMOVE_PUBLISH",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user disables publish option for a dashboard.",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REMOVE_PUBLISH"
                ],
                "example": "REMOVE_PUBLISH"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_RemoveShare": {
        "title": "DASHBOARD - REMOVE_SHARE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group or user is removed from a dashboard's sharing list.",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REMOVE_SHARE"
                ],
                "example": "REMOVE_SHARE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that was removed from the dashboard's sharing list. (Specific to remove share from user actions)\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that was removed from the dashboard's sharing list. (Specific to remove share from group actions)\n",
                    "example": "5432109876543210"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_RemoveShareMember": {
        "title": "DASHBOARD - REMOVE_SHARE_MEMBER",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user is removed from a group that a dashboard has been shared to via the dashboard's sharing list, or via a workspace's sharing list. If a dashboard has been shared to a group directly via the dashboard's sharing list, and via a workspace's sharing list, then an event will be generated for each of these shares.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REMOVE_SHARE_MEMBER"
                ],
                "example": "REMOVE_SHARE_MEMBER"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of user that was removed from the group.\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that the user was removed from.\n",
                    "example": "5432109876543210"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace that the group is shared to. (Specific to cases where the dashboard is shared to the group via a workspace's sharing list)\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_RemoveWorkspaceShare": {
        "title": "DASHBOARD - REMOVE_WORKSPACE_SHARE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group or user is removed from a workspace's sharing list. Note that this event will appear for each dashboard that is in the workspace. If a group or user is removed from a workspace's sharing list and the workspace is empty, then no events will be recorded.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REMOVE_WORKSPACE_SHARE"
                ],
                "example": "REMOVE_WORKSPACE_SHARE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that was removed from the workspace. (Specific to remove share from user actions)\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that was removed from the workspace. (Specific to remove share from group actions)\n",
                    "example": "5432109876543210"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace the group or user was removed from.\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_Rename": {
        "title": "DASHBOARD - RENAME",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a dashboard is renamed in the UI or via the API (update).\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "RENAME"
                ],
                "example": "RENAME"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "newName": {
                    "type": "string",
                    "description": "New name of the dashboard.\n",
                    "example": "New Dashboard"
                  },
                  "oldName": {
                    "type": "string",
                    "description": "Previous name of the dashboard.\n",
                    "example": "Old Dashboard"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_Restore": {
        "title": "DASHBOARD - RESTORE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a dashboard is in the deleted items bin and is restored (`Undelete`).\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "RESTORE"
                ],
                "example": "RESTORE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_SaveAsNew": {
        "title": "DASHBOARD - SAVE_AS_NEW",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user saves a copy of a dashboard by using the `Save As New` option.\n\nThis event is recorded for the original  dashboard. If the original dashboard belongs to a different organization, then `Save As New` event will be generated for the organization with original dashboard and for the organization with copied dashboard.\n\nFor copied dashboard, `Save As New` event is paired with a [DASHBOARD - CREATE](/api/smartsheet/openapi/schemas/dashboard_create) event.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "SAVE_AS_NEW"
                ],
                "example": "SAVE_AS_NEW"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_TransferOwnership": {
        "title": "DASHBOARD - TRANSFER_OWNERSHIP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when the ownership of a dashboard is transferred.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "TRANSFER_OWNERSHIP"
                ],
                "example": "TRANSFER_OWNERSHIP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "oldUserId": {
                    "type": "string",
                    "description": "ID of the former dashboard owner.\n",
                    "example": "12345678901234567"
                  },
                  "oldAccessLevel": {
                    "type": "string",
                    "enum": [
                      "ADMIN"
                    ],
                    "default": "ADMIN",
                    "description": "New access level of the former owner: `\"ADMIN\"`.\n",
                    "example": "ADMIN"
                  },
                  "newUserId": {
                    "type": "string",
                    "description": "ID of the new dashboard owner.\n",
                    "example": "21436587092143658"
                  },
                  "newAccessLevel": {
                    "type": "string",
                    "enum": [
                      "OWNER"
                    ],
                    "default": "OWNER",
                    "description": "New access level of the new owner: `\"OWNER\"`.\n",
                    "example": "OWNER"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Dashboard_Update": {
        "title": "DASHBOARD - UPDATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a change is made to a dashboard and the dashboard is saved.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DASHBOARD"
                ],
                "example": "DASHBOARD"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE"
                ],
                "example": "UPDATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Discussion_Create": {
        "title": "DISCUSSION - CREATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a row-level, grid-level, or workspace-level comment is added.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DISCUSSION"
                ],
                "example": "DISCUSSION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "CREATE"
                ],
                "example": "CREATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "sheetRowId": {
                    "type": "string",
                    "description": "ID of the sheet row containing the discussion. (this property is included only if the discussion is on a sheet row)\n",
                    "example": "7654321098765432"
                  },
                  "sheetId": {
                    "type": "string",
                    "description": "ID of the sheet the discussion is on. (This property is included only if the `workspaceId` property below isn't included)\n",
                    "example": "6141831453927300"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace the discussion is directly on. (This property is included only if the `sheetId` property above isn't included)\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Discussion_Delete": {
        "title": "DISCUSSION - DELETE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a comment that has no replies is deleted.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DISCUSSION"
                ],
                "example": "DISCUSSION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DELETE"
                ],
                "example": "DELETE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "sheetRowId": {
                    "type": "string",
                    "description": "ID of the sheet row containing the discussion. (this property is included only if the discussion is on a sheet row)\n",
                    "example": "7654321098765432"
                  },
                  "sheetId": {
                    "type": "string",
                    "description": "ID of the sheet the discussion is on. (This property is included only if the `workspaceId` property below isn't included)\n",
                    "example": "6141831453927300"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace the discussion is directly on. (This property is included only if the `sheetId` property above isn't included)\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Discussion_Send": {
        "title": "DISCUSSION - SEND",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a discussion (i.e. whole thread of top comment and replies) is **directly** (i.e. instead of indirectly as part of another operation) sent by email to user(s) or user group(s). An individual `DISCUSSION - SEND` event is issued for each user or user group listed as recipient.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DISCUSSION"
                ],
                "example": "DISCUSSION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "SEND"
                ],
                "example": "SEND"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "recipientEmail": {
                    "type": "string",
                    "description": "Single email address either of a user explicitly included in the recipient list or of the sender (when *CC sender* is requested). (This property is included only if the `recipientGroupId` property below isn't included)\n",
                    "example": "john.doe@smartsheet.com"
                  },
                  "recipientGroupId": {
                    "type": "string",
                    "description": "Single ID of a user group explicitly included in the recipient list. (This property is included only if the `recipientEmail` property above isn't included)\n",
                    "example": "345987624123"
                  },
                  "sheetRowId": {
                    "type": "string",
                    "description": "ID of the sheet row containing the discussion. (this property is included only if the discussion is on a sheet row)\n",
                    "example": "7654321098765432"
                  },
                  "sheetId": {
                    "type": "string",
                    "description": "ID of the sheet the discussion is on. (This property is included only if the `workspaceId` property below isn't included)\n",
                    "example": "6141831453927300"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace the discussion is directly on. (This property is included only if the `sheetId` property above isn't included)\n",
                    "example": "9876543210987654"
                  },
                  "includeAttachments": {
                    "type": "string",
                    "description": "Indicates whether the discussion was sent with its respective attachments.\nThe value is a string formatted boolean (\"true\" or \"false\").\n",
                    "example": "true"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Discussion_Sendcomment": {
        "title": "DISCUSSION - SEND_COMMENT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a discussion comment (or discussion comment reply) is **directly** (i.e. instead of indirectly as part of another operation) sent by email to user(s) or user group(s). An individual `DISCUSSION - SEND_COMMENT` event is issued for each user or user group listed as recipient.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DISCUSSION"
                ],
                "example": "DISCUSSION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "SEND_COMMENT"
                ],
                "example": "SEND_COMMENT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "recipientEmail": {
                    "type": "string",
                    "description": "Single email address either of a user explicitly included in the recipient list or of the sender (when *CC sender* is requested). (This property is included only if the `recipientGroupId` property below isn't included)\n",
                    "example": "john.doe@smartsheet.com"
                  },
                  "recipientGroupId": {
                    "type": "string",
                    "description": "Single ID of a user group explicitly included in the recipient list. (This property is included only if the `recipientEmail` property above isn't included)\n",
                    "example": "345987624123"
                  },
                  "sheetRowId": {
                    "type": "string",
                    "description": "ID of the sheet row containing the discussion. (this property is included only if the discussion is on a sheet row)\n",
                    "example": "7654321098765432"
                  },
                  "commentId": {
                    "type": "string",
                    "description": "ID of the comment.\n",
                    "example": "5678901234567890"
                  },
                  "sheetId": {
                    "type": "string",
                    "description": "ID of the sheet the discussion is on. (This property is included only if the `workspaceId` property below isn't included)\n",
                    "example": "6141831453927300"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace the discussion is directly on. (This property is included only if the `sheetId` property above isn't included)\n",
                    "example": "9876543210987654"
                  },
                  "includeAttachments": {
                    "type": "string",
                    "description": "Indicates whether the discussion comment (or discussion comment reply) was sent with its respective attachments.\nThe value is a string formatted boolean (\"true\" or \"false\").\n",
                    "example": true
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Discussion_Update": {
        "title": "DISCUSSION - UPDATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a reply is made to a comment, or a reply is deleted from a comment.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "DISCUSSION"
                ],
                "example": "DISCUSSION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE"
                ],
                "example": "UPDATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "sheetRowId": {
                    "type": "string",
                    "description": "ID of the sheet row containing the discussion. (this property is included only if the discussion is on a sheet row)\n",
                    "example": "7654321098765432"
                  },
                  "sheetId": {
                    "type": "string",
                    "description": "ID of the sheet the discussion is on. (This property is included only if the `workspaceId` property below isn't included)\n",
                    "example": "6141831453927300"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace the discussion is directly on. (This property is included only if the `sheetId` property above isn't included)\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Folder_Create": {
        "title": "FOLDER - CREATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a folder is created. \n\nFolders can be created in the UI with the `Create New` button, by selecting the `Save As New` option on an existing folder, or through the API.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "FOLDER"
                ],
                "example": "FOLDER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "CREATE"
                ],
                "example": "CREATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "folderName": {
                    "type": "string",
                    "description": "Name of the destination folder for the move event. (Specific to actions where the folder was moved to a different folder).\n",
                    "example": "Folder A"
                  },
                  "sourceFolderId": {
                    "type": "string",
                    "description": "ID of folder that was copied to create the new folder. (Only included if the folder was created as a result of a *save as new* or *copy*)\n",
                    "example": "4567890123456789"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Folder_Delete": {
        "title": "FOLDER - DELETE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a folder is deleted.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "FOLDER"
                ],
                "example": "FOLDER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DELETE"
                ],
                "example": "DELETE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Folder_Export": {
        "title": "FOLDER - EXPORT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user exports the folder.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "FOLDER"
                ],
                "example": "FOLDER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "EXPORT"
                ],
                "example": "EXPORT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "formatType": {
                    "type": "string",
                    "enum": [
                      "excel",
                      "pdf"
                    ],
                    "description": "The format that the folder was exported. Notice that the same value \"excel\" is displayed either when exporting to Microsoft Excel or when exporting to Google Sheets.\n",
                    "example": "excel"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Folder_Rename": {
        "title": "FOLDER - RENAME",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a folder is renamed in the UI or via the API (update).\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "FOLDER"
                ],
                "example": "FOLDER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "RENAME"
                ],
                "example": "RENAME"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "oldName": {
                    "type": "string",
                    "description": "Old name of the folder.\n",
                    "example": "Folder A"
                  },
                  "newName": {
                    "type": "string",
                    "description": "New name of the folder.\n",
                    "example": "Folder B"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Folder_RequestBackup": {
        "title": "FOLDER - REQUEST_BACKUP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user requests a backup for a folder.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "FOLDER"
                ],
                "example": "FOLDER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REQUEST_BACKUP"
                ],
                "example": "REQUEST_BACKUP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "includeAttachments": {
                    "type": "string",
                    "description": "Indicates whether attachments should be included in the recurring backup.\nThe value is a string formatted boolean (\"true\" or \"false\").\n",
                    "example": "true"
                  },
                  "sendCompletionEmail": {
                    "type": "string",
                    "description": "Indicates whether an email should be sent to the workspace's owner every time a recurring backup completes.\nThe value is a string formatted boolean (\"true\" or \"false\").\n",
                    "example": "true"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Folder_SaveAsNew": {
        "title": "FOLDER - SAVE_AS_NEW",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user saves a copy of a folder by using the `Save As New` option via UI or `Copy Folder` via API.\n\nThis event is recorded for the original folder. Each `Save As New` event is paired with a [FOLDER - CREATE](/api/smartsheet/openapi/schemas/folder_create) event that is recorded for the copy of the folder.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "FOLDER"
                ],
                "example": "FOLDER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "SAVE_AS_NEW"
                ],
                "example": "SAVE_AS_NEW"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Form_Activate": {
        "title": "FORM - ACTIVATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a sheet form is activated.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "FORM"
                ],
                "example": "FORM"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE"
                ],
                "example": "ACTIVATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "sheetId": {
                    "type": "string",
                    "description": "ID of the form's sheet.\n",
                    "example": "6141831453927300"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Form_Create": {
        "title": "FORM - CREATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a sheet form is created.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "FORM"
                ],
                "example": "FORM"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "CREATE"
                ],
                "example": "CREATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "formName": {
                    "type": "string",
                    "description": "Name of the form.\n",
                    "example": "Form A"
                  },
                  "sheetId": {
                    "type": "string",
                    "description": "ID of the form's sheet.\n",
                    "example": "6141831453927300"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Form_Deactivate": {
        "title": "FORM - DEACTIVATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a sheet form is deactivated.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "FORM"
                ],
                "example": "FORM"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE"
                ],
                "example": "DEACTIVATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "sheetId": {
                    "type": "string",
                    "description": "ID of the form's sheet.\n",
                    "example": "6141831453927300"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Form_Delete": {
        "title": "FORM - DELETE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a sheet form is deleted.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "FORM"
                ],
                "example": "FORM"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DELETE"
                ],
                "example": "DELETE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "sheetId": {
                    "type": "string",
                    "description": "ID of the form's sheet.\n",
                    "example": "6141831453927300"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Form_Update": {
        "title": "FORM - UPDATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an existing sheet form is updated.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "FORM"
                ],
                "example": "FORM"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE"
                ],
                "example": "UPDATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "sheetId": {
                    "type": "string",
                    "description": "ID of the form's sheet.\n",
                    "example": "6141831453927300"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Group_AddMember": {
        "title": "GROUP - ADD_MEMBER",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a member is added to a group.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "GROUP"
                ],
                "example": "GROUP"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ADD_MEMBER"
                ],
                "example": "ADD_MEMBER"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "memberUserId": {
                    "type": "string",
                    "description": "ID of the user that was added to the group.\n",
                    "example": "12345678901234567"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Group_Create": {
        "title": "GROUP - CREATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group is created.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "GROUP"
                ],
                "example": "GROUP"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "CREATE"
                ],
                "example": "CREATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "groupName": {
                    "type": "string",
                    "description": "Name of the group.\n",
                    "example": "Group A"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Group_Delete": {
        "title": "GROUP - DELETE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group is deleted.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "GROUP"
                ],
                "example": "GROUP"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DELETE"
                ],
                "example": "DELETE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Group_DownloadSheetAccessReport": {
        "title": "GROUP - DOWNLOAD_SHEET_ACCESS_REPORT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin downloads sheet access report for a group. This can be done through Group Management console on UI.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "GROUP"
                ],
                "example": "GROUP"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DOWNLOAD_SHEET_ACCESS_REPORT"
                ],
                "example": "DOWNLOAD_SHEET_ACCESS_REPORT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Group_RemoveMember": {
        "title": "GROUP - REMOVE_MEMBER",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a member is removed from a group.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "GROUP"
                ],
                "example": "GROUP"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REMOVE_MEMBER"
                ],
                "example": "REMOVE_MEMBER"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "memberUserId": {
                    "type": "string",
                    "description": "ID of the user that was removed from the group.\n",
                    "example": "12345678901234567"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Group_Rename": {
        "title": "GROUP - RENAME",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group name is updated. \n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "GROUP"
                ],
                "example": "GROUP"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "RENAME"
                ],
                "example": "RENAME"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "oldName": {
                    "type": "string",
                    "description": "Old name of the group.\n",
                    "example": "Group A"
                  },
                  "newName": {
                    "type": "string",
                    "description": "New name of the group.\n",
                    "example": "Group B"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Group_TransferOwnership": {
        "title": "GROUP - TRANSFER_OWNERSHIP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group's ownership is transferred.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "GROUP"
                ],
                "example": "GROUP"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "TRANSFER_OWNERSHIP"
                ],
                "example": "TRANSFER_OWNERSHIP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "oldOwnerUserId": {
                    "type": "string",
                    "description": "ID of the former group owner.\n",
                    "example": "12345678901234567"
                  },
                  "newOwnerUserId": {
                    "type": "string",
                    "description": "ID of the new group owner.\n",
                    "example": "21436587092143658"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Group_Update": {
        "title": "GROUP - UPDATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group description is updated. \n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "GROUP"
                ],
                "example": "GROUP"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE"
                ],
                "example": "UPDATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "License_Requests_Decline_License": {
        "title": "LICENSE_REQUESTS - DECLINE_LICENSE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin declines a user's license request.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "LICENSE_REQUESTS"
                ],
                "example": "LICENSE_REQUESTS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DECLINE_LICENSE"
                ],
                "example": "DECLINE_LICENSE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "userEmail": {
                    "type": "string",
                    "description": "Email address of the user who requested the license. If the email cannot be retrieved from the database, the event is published without this field (empty map)\n"
                  }
                }
              }
            }
          }
        ]
      },
      "License_Requests_Grant_License": {
        "title": "LICENSE_REQUESTS - GRANT_LICENSE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin grants a license to a user in response to a license request.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "LICENSE_REQUESTS"
                ],
                "example": "LICENSE_REQUESTS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "GRANT_LICENSE"
                ],
                "example": "GRANT_LICENSE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "userEmail": {
                    "type": "string",
                    "description": "Email address of the user who requested the license. If the email cannot be retrieved from the database, the event is published without this field (empty map)\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Policy_Data_Egress_Activate": {
        "title": "POLICY_DATA_EGRESS - ACTIVATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates a data egress policy.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "POLICY_DATA_EGRESS"
                ],
                "example": "POLICY_DATA_EGRESS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE"
                ],
                "example": "ACTIVATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "name": {
                    "type": "string",
                    "description": "Policy name\n"
                  },
                  "restrictedActions": {
                    "type": "string",
                    "description": "Array notation string of restricted actions\n"
                  },
                  "scope": {
                    "type": "string",
                    "description": "Array notation string of asset types\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Policy_Data_Egress_Create": {
        "title": "POLICY_DATA_EGRESS - CREATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin creates a data egress policy restricting actions on specified asset types.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "POLICY_DATA_EGRESS"
                ],
                "example": "POLICY_DATA_EGRESS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "CREATE"
                ],
                "example": "CREATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "name": {
                    "type": "string",
                    "description": "Human-readable policy name\n"
                  },
                  "restrictedActions": {
                    "type": "string",
                    "description": "Comma-separated list in array notation, e.g., \"[EXPORT, SAVE_AS_NEW]\". Valid actions: EXPORT, PUBLISH, SAVE_AS_NEW, SAVE_AS_TEMPLATE\n"
                  },
                  "scope": {
                    "type": "string",
                    "description": "Comma-separated list of asset types in array notation, e.g., \"[sheets, reports]\". Valid types: sheets, reports, dashboards, dynamicviews\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Policy_Data_Egress_Deactivate": {
        "title": "POLICY_DATA_EGRESS - DEACTIVATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates a data egress policy.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "POLICY_DATA_EGRESS"
                ],
                "example": "POLICY_DATA_EGRESS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE"
                ],
                "example": "DEACTIVATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "name": {
                    "type": "string",
                    "description": "Policy name\n"
                  },
                  "restrictedActions": {
                    "type": "string",
                    "description": "Array notation string of restricted actions\n"
                  },
                  "scope": {
                    "type": "string",
                    "description": "Array notation string of asset types\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Policy_Data_Egress_Delete": {
        "title": "POLICY_DATA_EGRESS - DELETE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deletes a data egress policy.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "POLICY_DATA_EGRESS"
                ],
                "example": "POLICY_DATA_EGRESS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DELETE"
                ],
                "example": "DELETE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "name": {
                    "type": "string",
                    "description": "Name of deleted policy\n"
                  },
                  "restrictedActions": {
                    "type": "string",
                    "description": "Array notation string of restricted actions that were in effect\n"
                  },
                  "scope": {
                    "type": "string",
                    "description": "Array notation string of asset types that were covered\n"
                  },
                  "isDisabled": {
                    "type": "boolean",
                    "description": "Whether the policy was disabled at time of deletion\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Policy_Data_Egress_Update": {
        "title": "POLICY_DATA_EGRESS - UPDATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin updates a data egress policy.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "POLICY_DATA_EGRESS"
                ],
                "example": "POLICY_DATA_EGRESS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE"
                ],
                "example": "UPDATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "name": {
                    "type": "string",
                    "description": "Policy name\n"
                  },
                  "restrictedActions": {
                    "type": "string",
                    "description": "Array notation string of restricted actions\n"
                  },
                  "scope": {
                    "type": "string",
                    "description": "Array notation string of asset types\n"
                  },
                  "isDisabled": {
                    "type": "boolean",
                    "description": "Whether the policy is disabled\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Policy_Data_Retention_Activate": {
        "title": "POLICY_DATA_RETENTION - ACTIVATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates the data retention policy for one or more asset types.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "POLICY_DATA_RETENTION"
                ],
                "example": "POLICY_DATA_RETENTION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE"
                ],
                "example": "ACTIVATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "scope": {
                    "type": "string",
                    "description": "Array notation string of asset types subject to retention policy\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Policy_Data_Retention_Create": {
        "title": "POLICY_DATA_RETENTION - CREATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a data retention policy is configured for the first time\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "POLICY_DATA_RETENTION"
                ],
                "example": "POLICY_DATA_RETENTION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "CREATE"
                ],
                "example": "CREATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "scope": {
                    "type": "string",
                    "description": "Comma-separated list in array notation, e.g., \"[sheets, reports]\". Valid types: sheets, reports, dashboards\n"
                  },
                  "isDisabled": {
                    "type": "boolean",
                    "description": "Whether the policy is created in disabled state\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Policy_Data_Retention_Deactivate": {
        "title": "POLICY_DATA_RETENTION - DEACTIVATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates the data retention policy.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "POLICY_DATA_RETENTION"
                ],
                "example": "POLICY_DATA_RETENTION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE"
                ],
                "example": "DEACTIVATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "scope": {
                    "type": "string",
                    "description": "Array notation string of asset types\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Policy_Data_Retention_Update": {
        "title": "POLICY_DATA_RETENTION - UPDATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin updates the data retention policy's scope or configuration.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "POLICY_DATA_RETENTION"
                ],
                "example": "POLICY_DATA_RETENTION"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE"
                ],
                "example": "UPDATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "scope": {
                    "type": "string",
                    "description": "Array notation string of asset types\n"
                  },
                  "isDisabled": {
                    "type": "boolean",
                    "description": "Current disabled state\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Policy_Safe_Sharing_Activate": {
        "title": "POLICY_SAFE_SHARING - ACTIVATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates the safe sharing policy for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "POLICY_SAFE_SHARING"
                ],
                "example": "POLICY_SAFE_SHARING"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE"
                ],
                "example": "ACTIVATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Policy_Safe_Sharing_Add_Request_Form": {
        "title": "POLICY_SAFE_SHARING - ADD_REQUEST_FORM",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin adds (or updates) the request form used to grant exceptions to the safe sharing policy.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "POLICY_SAFE_SHARING"
                ],
                "example": "POLICY_SAFE_SHARING"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ADD_REQUEST_FORM"
                ],
                "example": "ADD_REQUEST_FORM"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "isDisabled": {
                    "type": "boolean",
                    "description": "Current policy activation state\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Policy_Safe_Sharing_Deactivate": {
        "title": "POLICY_SAFE_SHARING - DEACTIVATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates the safe sharing policy.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "POLICY_SAFE_SHARING"
                ],
                "example": "POLICY_SAFE_SHARING"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE"
                ],
                "example": "DEACTIVATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Report_AddShare": {
        "title": "REPORT - ADD_SHARE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group or user is added to the report's sharing list, or when a group or user's share permissions are changed.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ADD_SHARE"
                ],
                "example": "ADD_SHARE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "accessLevel": {
                    "type": "string",
                    "enum": [
                      "VIEWER",
                      "EDITOR",
                      "EDITOR_SHARE",
                      "ADMIN"
                    ],
                    "description": "Indicates the access level granted to the group or user. \n\nNote that this access level represents the access level granted by this specific sharing action; it is not the group or user's effective access level for the report.\n",
                    "example": "VIEWER"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that was added to the report's sharing list. (Specific to share to user actions)\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that was added to the report's sharing list. (Specific to share to group actions)\n",
                    "example": "5432109876543210"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_AddShareMember": {
        "title": "REPORT - ADD_SHARE_MEMBER",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user is added to a group that a report has been shared to via the report's sharing list, or via a workspace's sharing list. \n\nIf a report has been shared to a group directly via the report's sharing list, and via a workspace's sharing list, then an event will be generated for each of these shares.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ADD_SHARE_MEMBER"
                ],
                "example": "ADD_SHARE_MEMBER"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "accessLevel": {
                    "type": "string",
                    "enum": [
                      "VIEWER",
                      "EDITOR",
                      "EDITOR_SHARE",
                      "ADMIN"
                    ],
                    "description": "Indicates the access level granted to the user. \n\nNote that this access level represents the access level that has been granted to the user via group membership; it is not the user's effective access level for the report.\n",
                    "example": "VIEWER"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that was added to the group.\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group the user was added to.\n",
                    "example": "5432109876543210"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace that the group is shared to. (Specific to cases where the report is shared to the group via a workspace's sharing list)\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_AddWorkspaceShare": {
        "title": "REPORT - ADD_WORKSPACE_SHARE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group or user is added to a workspace's sharing list. \n\nNote that this event will appear for each report that is in the workspace. If a group or user is added to a workspace's sharing list and the workspace is empty, then no events will be recorded.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ADD_WORKSPACE_SHARE"
                ],
                "example": "ADD_WORKSPACE_SHARE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "accessLevel": {
                    "type": "string",
                    "enum": [
                      "VIEWER",
                      "EDITOR",
                      "EDITOR_SHARE",
                      "ADMIN"
                    ],
                    "description": "Indicates the access level granted to the group or user. \n\nNote that this access level represents the access level granted by this specific sharing action; it is not the group or user's effective access level for the report.\n",
                    "example": "VIEWER"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that the workspace was shared to. (Specific to share to user actions)\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that the workspace was shared to. (Specific to share to group actions)\n",
                    "example": "5432109876543210"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace that was shared to the group or user.\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_Create": {
        "title": "REPORT - CREATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a report is created (inserted).\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "CREATE"
                ],
                "example": "CREATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "reportName": {
                    "type": "string",
                    "description": "Name of the new report.\n",
                    "example": "Report A"
                  },
                  "sourceObjectId": {
                    "type": "string",
                    "description": "ID of report that was copied to create the new report. (Only included if the report was created as a result of a *copy* or *save as new*)\n",
                    "example": "12345678901234567"
                  },
                  "sourceGlobalTemplateId": {
                    "type": "string",
                    "description": "ID of the global template that was used to create the new report (Only included if the report was created using a global template. \"New Blank Report\" is a global template)\n",
                    "example": "48569348493401200"
                  },
                  "sourceType": {
                    "type": "string",
                    "enum": [
                      "report",
                      "globale_template"
                    ],
                    "description": "Type of object used to create the new report.\n",
                    "example": "globale_template"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_Delete": {
        "title": "REPORT - DELETE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a report is deleted.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DELETE"
                ],
                "example": "DELETE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_Export": {
        "title": "REPORT - EXPORT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user exports or prints the report. \n\nPrinting a report is a PDF export, then browser print, thus is reported as PDF export\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "EXPORT"
                ],
                "example": "EXPORT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "formatType": {
                    "type": "string",
                    "enum": [
                      "png_gantt",
                      "mspdi",
                      "excel",
                      "pdf"
                    ],
                    "description": "The format that the report was exported in \"png_gantt\" (gantt image), \"mspdi\" (Microsoft Project), \"excel\", or \"pdf\".\n",
                    "example": "excel"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_Load": {
        "title": "REPORT - LOAD",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a report is viewed in the UI or loaded through the API.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "LOAD"
                ],
                "example": "LOAD"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_Move": {
        "title": "REPORT - MOVE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a report is moved between workspaces and/or folders.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "MOVE"
                ],
                "example": "MOVE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "newParentContainerId": {
                    "type": "string",
                    "description": "ID of the destination folder for the move event. (Specific to actions where the report was moved to a different folder).\n",
                    "example": "4365870921436587"
                  },
                  "parentContainerId": {
                    "type": "string",
                    "description": "ID of the parent container of the report. (Specific to move events where a folder containing the report is moved to a folder in a different workspace, indicates that the report has moved to a new workspace but is still within the same folder)\n",
                    "example": "3456789012345678"
                  },
                  "folderName": {
                    "type": "string",
                    "description": "Name of the destination folder for the move event. (Specific to actions where the report was moved to a different folder).\n",
                    "example": "Folder B"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace the report is currently in. If the move was between two workspaces the `workspaceId` will be the ID of the destination workspace.\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_Purge": {
        "title": "REPORT - PURGE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a report is deleted (\"Delete Forever\") from the deleted items bin.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "PURGE"
                ],
                "example": "PURGE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_RemoveShare": {
        "title": "REPORT - REMOVE_SHARE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group or user is removed from a report's sharing list.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REMOVE_SHARE"
                ],
                "example": "REMOVE_SHARE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that was added to the report's sharing list. (Specific to share to user actions)\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that was added to the report's sharing list. (Specific to share to group actions)\n",
                    "example": "5432109876543210"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_RemoveShareMember": {
        "title": "REPORT - REMOVE_SHARE_MEMBER",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user is removed from a group that a report has been shared to via the report's sharing list, or via a workspace's sharing list. \n\nIf a report has been shared to a group directly via the report's sharing list, and via a workspace's sharing list, then an event will be generated for each of these shares.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REMOVE_SHARE_MEMBER"
                ],
                "example": "REMOVE_SHARE_MEMBER"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of user that was removed from the group.\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that the user was removed from.\n",
                    "example": "5432109876543210"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace that the group is shared to. (Specific to cases where the report is shared to the group via a workspace's sharing list)\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_RemoveWorkspaceShare": {
        "title": "REPORT - REMOVE_WORKSPACE_SHARE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group or user is removed from a workspace's sharing list. \n\nNote that this event will appear for each report that is in the workspace. If a group or user is removed from a workspace's sharing list and the workspace is empty, then no events will be recorded.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REMOVE_WORKSPACE_SHARE"
                ],
                "example": "REMOVE_WORKSPACE_SHARE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that was removed from the workspace. (Specific to remove share from user actions)\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that was removed from the workspace. (Specific to remove share from group actions)\n",
                    "example": "5432109876543210"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace the group or user was removed from.\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_Rename": {
        "title": "REPORT - RENAME",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an existing report is renamed.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "RENAME"
                ],
                "example": "RENAME"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "newName": {
                    "type": "string",
                    "description": "New name of the report.\n",
                    "example": "Report B"
                  },
                  "oldName": {
                    "type": "string",
                    "description": "Previous name of the report.\n",
                    "example": "Report A"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_Restore": {
        "title": "REPORT - RESTORE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a report is in the deleted items bin and is restored (`Undelete`).\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "RESTORE"
                ],
                "example": "RESTORE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_SaveAsNew": {
        "title": "REPORT - SAVE_AS_NEW",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user saves a copy of a report by using the `Save As New` option. \n\nThis event is recorded for the original report. If the original reports belongs to a different organization, then an event will be generated for organization with original report and for the organization with copied report.\n\nFor copied report, `Save As New` event is paired with a [REPORT - CREATE](/api/smartsheet/openapi/schemas/report_create) event.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "SAVE_AS_NEW"
                ],
                "example": "SAVE_AS_NEW"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_SendAsAttachment": {
        "title": "REPORT - SEND_AS_ATTACHMENT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user sends a report as email attachment to user(s) or user group(s). \n\nAn individual `REPORT - SEND_AS_ATTACHMENT` event is issued for each user or user group listed as recipient.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "SEND_AS_ATTACHMENT"
                ],
                "example": "SEND_AS_ATTACHMENT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "recipientEmail": {
                    "type": "string",
                    "description": "Single email address either of a user explicitly included in the recipient list or of the sender (when *CC sender* is requested). (This property is included only if the `recipientGroupId` property below isn't included)\n",
                    "example": "john.doe@smartsheet.com"
                  },
                  "recipientGroupId": {
                    "type": "string",
                    "description": "Single ID of a user group explicitly included in the recipient list. (This property is included only if the `recipientEmail` property above isn't included)\n",
                    "example": "4583173393803140"
                  },
                  "formatType": {
                    "type": "string",
                    "enum": [
                      "excel",
                      "pdf",
                      "pdf_gantt",
                      "pdf_calendar"
                    ],
                    "description": "The format in which the report was sent.\n",
                    "example": "pdf"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_TransferOwnership": {
        "title": "REPORT - TRANSFER_OWNERSHIP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when the ownership of a report is transferred.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "TRANSFER_OWNERSHIP"
                ],
                "example": "TRANSFER_OWNERSHIP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "oldUserId": {
                    "type": "string",
                    "description": "ID of the former owner.\n",
                    "example": "12345678901234567"
                  },
                  "oldAccessLevel": {
                    "type": "string",
                    "enum": [
                      "ADMIN"
                    ],
                    "default": "ADMIN",
                    "description": "New access level of the former owner: `\"ADMIN\"`.\n",
                    "example": "ADMIN"
                  },
                  "newUserId": {
                    "type": "string",
                    "description": "ID of the new owner.\n",
                    "example": "21436587092143658"
                  },
                  "newAccessLevel": {
                    "type": "string",
                    "enum": [
                      "OWNER"
                    ],
                    "default": "OWNER",
                    "description": "New access level of the new owner: `\"OWNER\"`.\n",
                    "example": "OWNER"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Report_Update": {
        "title": "REPORT - UPDATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an existing report is updated.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "REPORT"
                ],
                "example": "REPORT"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE"
                ],
                "example": "UPDATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Secure_External_Access_Activate_Mfa": {
        "title": "SECURE_EXTERNAL_ACCESS - ACTIVATE_MFA",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates the multi-factor authentication (MFA) policy for external collaborators.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURE_EXTERNAL_ACCESS"
                ],
                "example": "SECURE_EXTERNAL_ACCESS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_MFA"
                ],
                "example": "ACTIVATE_MFA"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "enforcementLevel": {
                    "type": "string",
                    "description": "MFA enforcement scope. Valid values: \"PLAN\" (enforce at plan level) or \"WORKSPACE\" (allow workspace admins to opt-in)\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Secure_External_Access_Activate_Sso_For_External_Collaborators": {
        "title": "SECURE_EXTERNAL_ACCESS - ACTIVATE_SSO_FOR_EXTERNAL_COLLABORATORS",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates Single Sign-On (SSO) enforcement for external collaborators.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURE_EXTERNAL_ACCESS"
                ],
                "example": "SECURE_EXTERNAL_ACCESS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_SSO_FOR_EXTERNAL_COLLABORATORS"
                ],
                "example": "ACTIVATE_SSO_FOR_EXTERNAL_COLLABORATORS"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Secure_External_Access_Deactivate_Mfa": {
        "title": "SECURE_EXTERNAL_ACCESS - DEACTIVATE_MFA",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates the multi-factor authentication (MFA) policy for external collaborators.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURE_EXTERNAL_ACCESS"
                ],
                "example": "SECURE_EXTERNAL_ACCESS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_MFA"
                ],
                "example": "DEACTIVATE_MFA"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "enforcementLevel": {
                    "type": "string",
                    "description": "MFA enforcement scope. Valid values: \"PLAN\" (enforce at plan level) or \"WORKSPACE\" (allow workspace admins to opt-in)\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Secure_External_Access_Deactivate_Sso_For_External_Collaborators": {
        "title": "SECURE_EXTERNAL_ACCESS - DEACTIVATE_SSO_FOR_EXTERNAL_COLLABORATORS",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates Single Sign-On (SSO) enforcement for external collaborators.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURE_EXTERNAL_ACCESS"
                ],
                "example": "SECURE_EXTERNAL_ACCESS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_SSO_FOR_EXTERNAL_COLLABORATORS"
                ],
                "example": "DEACTIVATE_SSO_FOR_EXTERNAL_COLLABORATORS"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Secure_External_Access_Mfa_Option_Enforce_All_Plan": {
        "title": "SECURE_EXTERNAL_ACCESS - MFA_OPTION_ENFORCE_ALL_PLAN",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin sets the MFA enforcement option to enforce across the entire plan for external collaborators.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURE_EXTERNAL_ACCESS"
                ],
                "example": "SECURE_EXTERNAL_ACCESS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "MFA_OPTION_ENFORCE_ALL_PLAN"
                ],
                "example": "MFA_OPTION_ENFORCE_ALL_PLAN"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Secure_External_Access_Mfa_Option_Workspace_Opt_In": {
        "title": "SECURE_EXTERNAL_ACCESS - MFA_OPTION_WORKSPACE_OPT_IN",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin sets the MFA enforcement option to workspace opt-in for external collaborators.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURE_EXTERNAL_ACCESS"
                ],
                "example": "SECURE_EXTERNAL_ACCESS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "MFA_OPTION_WORKSPACE_OPT_IN"
                ],
                "example": "MFA_OPTION_WORKSPACE_OPT_IN"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Activate_Account_Discovery": {
        "title": "SECURITY_CONTROLS - ACTIVATE_ACCOUNT_DISCOVERY",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates account discovery for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_ACCOUNT_DISCOVERY"
                ],
                "example": "ACTIVATE_ACCOUNT_DISCOVERY"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Activate_Api_Token_Expiration_Period": {
        "title": "SECURITY_CONTROLS - ACTIVATE_API_TOKEN_EXPIRATION_PERIOD",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates the API token expiration period policy for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_API_TOKEN_EXPIRATION_PERIOD"
                ],
                "example": "ACTIVATE_API_TOKEN_EXPIRATION_PERIOD"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Activate_Attachment": {
        "title": "SECURITY_CONTROLS - ACTIVATE_ATTACHMENT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates a specific attachment source for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_ATTACHMENT"
                ],
                "example": "ACTIVATE_ATTACHMENT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "type": {
                    "type": "string",
                    "description": "Attachment provider type; one of: \"upload\" | \"google_drive\" | \"onedrive\" | \"box\" | \"dropbox\" | \"evernote\" | \"egnyte\" | \"link_url\"\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Activate_Calendar_Publishing": {
        "title": "SECURITY_CONTROLS - ACTIVATE_CALENDAR_PUBLISHING",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates calendar publishing for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_CALENDAR_PUBLISHING"
                ],
                "example": "ACTIVATE_CALENDAR_PUBLISHING"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "publicationType": {
                    "type": "string",
                    "description": "Type of calendar publishing: \"iCal\" or \"calendarApp\"\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Activate_Dashboard_Publishing": {
        "title": "SECURITY_CONTROLS - ACTIVATE_DASHBOARD_PUBLISHING",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates the ability to publish dashboards for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_DASHBOARD_PUBLISHING"
                ],
                "example": "ACTIVATE_DASHBOARD_PUBLISHING"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Activate_Directory_Integration": {
        "title": "SECURITY_CONTROLS - ACTIVATE_DIRECTORY_INTEGRATION",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates the directory integration for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_DIRECTORY_INTEGRATION"
                ],
                "example": "ACTIVATE_DIRECTORY_INTEGRATION"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Activate_Images_In_Sheet_Cells": {
        "title": "SECURITY_CONTROLS - ACTIVATE_IMAGES_IN_SHEET_CELLS",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates the ability to add images to sheet cells for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_IMAGES_IN_SHEET_CELLS"
                ],
                "example": "ACTIVATE_IMAGES_IN_SHEET_CELLS"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Activate_Offline_Form_Submission": {
        "title": "SECURITY_CONTROLS - ACTIVATE_OFFLINE_FORM_SUBMISSION",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates offline form submission for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_OFFLINE_FORM_SUBMISSION"
                ],
                "example": "ACTIVATE_OFFLINE_FORM_SUBMISSION"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Activate_Report_Publishing": {
        "title": "SECURITY_CONTROLS - ACTIVATE_REPORT_PUBLISHING",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates the ability to publish reports for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_REPORT_PUBLISHING"
                ],
                "example": "ACTIVATE_REPORT_PUBLISHING"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Activate_Sheet_Publishing": {
        "title": "SECURITY_CONTROLS - ACTIVATE_SHEET_PUBLISHING",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates the ability to publish sheets for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_SHEET_PUBLISHING"
                ],
                "example": "ACTIVATE_SHEET_PUBLISHING"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Activate_Smartsheet_Tenant_Id": {
        "title": "SECURITY_CONTROLS - ACTIVATE_SMARTSHEET_TENANT_ID",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates the Smartsheet tenant ID security control for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_SMARTSHEET_TENANT_ID"
                ],
                "example": "ACTIVATE_SMARTSHEET_TENANT_ID"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Activate_Web_Content_Widget": {
        "title": "SECURITY_CONTROLS - ACTIVATE_WEB_CONTENT_WIDGET",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin activates the web content widget for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACTIVATE_WEB_CONTENT_WIDGET"
                ],
                "example": "ACTIVATE_WEB_CONTENT_WIDGET"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "includeValidatedDomains": {
                    "type": "string",
                    "description": "Whether validated domains are included: \"true\" | \"false\"\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Deactivate_Account_Discovery": {
        "title": "SECURITY_CONTROLS - DEACTIVATE_ACCOUNT_DISCOVERY",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates account discovery for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_ACCOUNT_DISCOVERY"
                ],
                "example": "DEACTIVATE_ACCOUNT_DISCOVERY"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Deactivate_Api_Token_Expiration_Period": {
        "title": "SECURITY_CONTROLS - DEACTIVATE_API_TOKEN_EXPIRATION_PERIOD",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates the API token expiration period policy for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_API_TOKEN_EXPIRATION_PERIOD"
                ],
                "example": "DEACTIVATE_API_TOKEN_EXPIRATION_PERIOD"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Deactivate_Attachment": {
        "title": "SECURITY_CONTROLS - DEACTIVATE_ATTACHMENT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates a specific attachment source for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_ATTACHMENT"
                ],
                "example": "DEACTIVATE_ATTACHMENT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "type": {
                    "type": "string",
                    "description": "Attachment provider type; one of: \"upload\" | \"google_drive\" | \"onedrive\" | \"box\" | \"dropbox\" | \"evernote\" | \"egnyte\" | \"link_url\"\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Deactivate_Calendar_Publishing": {
        "title": "SECURITY_CONTROLS - DEACTIVATE_CALENDAR_PUBLISHING",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates calendar publishing for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_CALENDAR_PUBLISHING"
                ],
                "example": "DEACTIVATE_CALENDAR_PUBLISHING"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "publicationType": {
                    "type": "string",
                    "description": "Type of calendar publishing: \"iCal\" or \"calendarApp\"\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Deactivate_Dashboard_Publishing": {
        "title": "SECURITY_CONTROLS - DEACTIVATE_DASHBOARD_PUBLISHING",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates the ability to publish dashboards for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_DASHBOARD_PUBLISHING"
                ],
                "example": "DEACTIVATE_DASHBOARD_PUBLISHING"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Deactivate_Directory_Integration": {
        "title": "SECURITY_CONTROLS - DEACTIVATE_DIRECTORY_INTEGRATION",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates the directory integration for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_DIRECTORY_INTEGRATION"
                ],
                "example": "DEACTIVATE_DIRECTORY_INTEGRATION"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Deactivate_Images_In_Sheet_Cells": {
        "title": "SECURITY_CONTROLS - DEACTIVATE_IMAGES_IN_SHEET_CELLS",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates the ability to add images to sheet cells for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_IMAGES_IN_SHEET_CELLS"
                ],
                "example": "DEACTIVATE_IMAGES_IN_SHEET_CELLS"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Deactivate_Offline_Form_Submission": {
        "title": "SECURITY_CONTROLS - DEACTIVATE_OFFLINE_FORM_SUBMISSION",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates offline form submission for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_OFFLINE_FORM_SUBMISSION"
                ],
                "example": "DEACTIVATE_OFFLINE_FORM_SUBMISSION"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Deactivate_Report_Publishing": {
        "title": "SECURITY_CONTROLS - DEACTIVATE_REPORT_PUBLISHING",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates the ability to publish reports for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_REPORT_PUBLISHING"
                ],
                "example": "DEACTIVATE_REPORT_PUBLISHING"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Deactivate_Sheet_Publishing": {
        "title": "SECURITY_CONTROLS - DEACTIVATE_SHEET_PUBLISHING",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates the ability to publish sheets for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_SHEET_PUBLISHING"
                ],
                "example": "DEACTIVATE_SHEET_PUBLISHING"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Deactivate_Smartsheet_Tenant_Id": {
        "title": "SECURITY_CONTROLS - DEACTIVATE_SMARTSHEET_TENANT_ID",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates the Smartsheet tenant ID security control for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_SMARTSHEET_TENANT_ID"
                ],
                "example": "DEACTIVATE_SMARTSHEET_TENANT_ID"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Deactivate_Web_Content_Widget": {
        "title": "SECURITY_CONTROLS - DEACTIVATE_WEB_CONTENT_WIDGET",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates the web content widget for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE_WEB_CONTENT_WIDGET"
                ],
                "example": "DEACTIVATE_WEB_CONTENT_WIDGET"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "includeValidatedDomains": {
                    "type": "string",
                    "description": "Whether validated domains are included: \"true\" | \"false\"\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Update_Api_Token_Expiration_Period": {
        "title": "SECURITY_CONTROLS - UPDATE_API_TOKEN_EXPIRATION_PERIOD",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin updates the API token expiration period value or interval.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE_API_TOKEN_EXPIRATION_PERIOD"
                ],
                "example": "UPDATE_API_TOKEN_EXPIRATION_PERIOD"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "oldValue": {
                    "type": "string",
                    "description": "Previous expiration period in days as numeric string (e.g., \"90\")\n"
                  },
                  "newValue": {
                    "type": "string",
                    "description": "New expiration period in days as numeric string (e.g., \"180\")\n"
                  },
                  "oldInterval": {
                    "type": "string",
                    "description": "Previous interval string representation (e.g., \"P90D\")\n"
                  },
                  "newInterval": {
                    "type": "string",
                    "description": "New interval string representation (e.g., \"P180D\")\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Update_Dashboard_Publishing_Options": {
        "title": "SECURITY_CONTROLS - UPDATE_DASHBOARD_PUBLISHING_OPTIONS",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin updates dashboard publishing options for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE_DASHBOARD_PUBLISHING_OPTIONS"
                ],
                "example": "UPDATE_DASHBOARD_PUBLISHING_OPTIONS"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "oldValue": {
                    "type": "string",
                    "description": "Previous permission: \"anyone_with_link\" | \"same_plan_users_only\"\n"
                  },
                  "newValue": {
                    "type": "string",
                    "description": "New permission: \"anyone_with_link\" | \"same_plan_users_only\"\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Update_Directory_Integration": {
        "title": "SECURITY_CONTROLS - UPDATE_DIRECTORY_INTEGRATION",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin updates the directory integration configuration.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE_DIRECTORY_INTEGRATION"
                ],
                "example": "UPDATE_DIRECTORY_INTEGRATION"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "oldRemoveFromSharing": {
                    "type": "string",
                    "description": "Previous \"remove from sharing\" flag: \"true\" | \"false\"\n"
                  },
                  "newRemoveFromSharing": {
                    "type": "string",
                    "description": "New \"remove from sharing\" flag: \"true\" | \"false\"\n"
                  },
                  "oldTransferSheets": {
                    "type": "string",
                    "description": "Previous \"transfer sheets\" flag: \"true\" | \"false\"\n"
                  },
                  "newTransferSheets": {
                    "type": "string",
                    "description": "New \"transfer sheets\" flag: \"true\" | \"false\"\n"
                  },
                  "oldEscrowEmail": {
                    "type": "string",
                    "description": "(optional) Email of previous escrow user (only present if user ID changed)\n"
                  },
                  "newEscrowEmail": {
                    "type": "string",
                    "description": "(optional) Email of new escrow user (only present if user ID changed)\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Update_Form_Access_Permissions": {
        "title": "SECURITY_CONTROLS - UPDATE_FORM_ACCESS_PERMISSIONS",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin updates form access permissions (e.g. anyone with link, Smartsheet login required, or safe sharing).\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE_FORM_ACCESS_PERMISSIONS"
                ],
                "example": "UPDATE_FORM_ACCESS_PERMISSIONS"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "oldValue": {
                    "type": "string",
                    "description": "Previous permission: \"anyone_with_link\" | \"smartsheet_login\" | \"safe_sharing\"\n"
                  },
                  "newValue": {
                    "type": "string",
                    "description": "New permission: \"anyone_with_link\" | \"smartsheet_login\" | \"safe_sharing\"\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Update_Group_Membership_Scope": {
        "title": "SECURITY_CONTROLS - UPDATE_GROUP_MEMBERSHIP_SCOPE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin updates the group membership scope (e.g. restricting membership to account users only).\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE_GROUP_MEMBERSHIP_SCOPE"
                ],
                "example": "UPDATE_GROUP_MEMBERSHIP_SCOPE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "oldValue": {
                    "type": "string",
                    "description": "Previous scope: \"people_in_account_and_external_contacts\" | \"only_people_in_account\"\n"
                  },
                  "newValue": {
                    "type": "string",
                    "description": "New scope: \"people_in_account_and_external_contacts\" | \"only_people_in_account\"\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Update_Notifications_And_Requests": {
        "title": "SECURITY_CONTROLS - UPDATE_NOTIFICATIONS_AND_REQUESTS",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin updates a notifications and requests configuration property (e.g. external sheet access for automations).\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE_NOTIFICATIONS_AND_REQUESTS"
                ],
                "example": "UPDATE_NOTIFICATIONS_AND_REQUESTS"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "oldValue": {
                    "type": "string",
                    "description": "Previous permission level; one of:\n"
                  },
                  "newValue": {
                    "type": "string",
                    "description": "New permission level (same options as oldValue)\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Update_Report_Publishing_Options": {
        "title": "SECURITY_CONTROLS - UPDATE_REPORT_PUBLISHING_OPTIONS",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin updates report publishing options (e.g. restricting publishing to same-plan users).\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE_REPORT_PUBLISHING_OPTIONS"
                ],
                "example": "UPDATE_REPORT_PUBLISHING_OPTIONS"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "oldValue": {
                    "type": "string",
                    "description": "Previous permission: \"anyone_with_link\" | \"same_plan_users_only\"\n"
                  },
                  "newValue": {
                    "type": "string",
                    "description": "New permission: \"anyone_with_link\" | \"same_plan_users_only\"\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Update_Sheet_Publishing_Options": {
        "title": "SECURITY_CONTROLS - UPDATE_SHEET_PUBLISHING_OPTIONS",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin updates sheet publishing options for the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE_SHEET_PUBLISHING_OPTIONS"
                ],
                "example": "UPDATE_SHEET_PUBLISHING_OPTIONS"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "oldValue": {
                    "type": "string",
                    "description": "Previous permission: \"anyone_with_link\" | \"same_plan_users_only\"\n"
                  },
                  "newValue": {
                    "type": "string",
                    "description": "New permission: \"anyone_with_link\" | \"same_plan_users_only\"\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Security_Controls_Update_Web_Content_Widget": {
        "title": "SECURITY_CONTROLS - UPDATE_WEB_CONTENT_WIDGET",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin updates the web content widget configuration (e.g. validated domains setting).\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SECURITY_CONTROLS"
                ],
                "example": "SECURITY_CONTROLS"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE_WEB_CONTENT_WIDGET"
                ],
                "example": "UPDATE_WEB_CONTENT_WIDGET"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "includeValidatedDomains": {
                    "type": "string",
                    "description": "Whether validated domains are included: \"true\" | \"false\"\n"
                  }
                }
              }
            }
          }
        ]
      },
      "Sheet_AddShare": {
        "title": "SHEET - ADD_SHARE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group or user is added to the sheet's sharing list, or when a group or user's share permissions are changed.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ADD_SHARE"
                ],
                "example": "ADD_SHARE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "accessLevel": {
                    "type": "string",
                    "enum": [
                      "VIEWER",
                      "EDITOR",
                      "EDITOR_SHARE",
                      "ADMIN"
                    ],
                    "description": "Indicates the access level granted to the group or user. \n\nNote that this access level represents the access level granted by this specific sharing action; it is not the group or user's effective access level for the sheet.\n",
                    "example": "VIEWER"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that was added to the sheet's sharing list. (Specific to share to user actions)\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that was added to the sheet's sharing list. (Specific to share to group actions)\n",
                    "example": "5432109876543210"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_AddShareMember": {
        "title": "SHEET - ADD_SHARE_MEMBER",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user is added to a group that a sheet has been shared to via the sheet's sharing list, or via a workspace's sharing list.\n\nIf a sheet has been shared to a group directly via the sheet's sharing list, and via a workspace's sharing list, then an event will be generated for each of these shares.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ADD_SHARE_MEMBER"
                ],
                "example": "ADD_SHARE_MEMBER"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "accessLevel": {
                    "type": "string",
                    "enum": [
                      "VIEWER",
                      "EDITOR",
                      "EDITOR_SHARE",
                      "ADMIN"
                    ],
                    "description": "Indicates the access level granted to the user. \n\nNote that this access level represents the access level that has been granted to the user via group membership; it is not the user's effective access level for the sheet.\n",
                    "example": "VIEWER"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that was added to the group.\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group the user was added to.\n",
                    "example": "5432109876543210"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace that the group is shared to. (Specific to cases where the sheet is shared to the group via a workspace's sharing list)\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_AddWorkspaceShare": {
        "title": "SHEET - ADD_WORKSPACE_SHARE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group or user is added to a workspace's sharing list. \n\nNote that this event will appear for each sheet that is in the workspace. If a group or user is added to a workspace's sharing list and the workspace is empty, then no events will be recorded.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ADD_WORKSPACE_SHARE"
                ],
                "example": "ADD_WORKSPACE_SHARE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "accessLevel": {
                    "type": "string",
                    "enum": [
                      "VIEWER",
                      "EDITOR",
                      "EDITOR_SHARE",
                      "ADMIN"
                    ],
                    "description": "Indicates the access level granted to the group or user. \n\nNote that this access level represents the access level granted by this specific sharing action; it is not the group or user's effective access level for the sheet.\n",
                    "example": "VIEWER"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that the workspace was shared to. (Specific to share to user actions)\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that the workspace was shared to. (Specific to share to group actions)\n",
                    "example": "5432109876543210"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace that was shared to the group or user.\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_CopyRow": {
        "title": "SHEET - COPY_ROW",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when row(s) are copied from one sheet to another.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "COPY_ROW"
                ],
                "example": "COPY_ROW"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "includeAttachments": {
                    "type": "string",
                    "description": "Indicates whether the row(s) were copied with their respective attachments.\nThe value is a string encoded boolean - \"true\" or \"false\".\n",
                    "example": "true"
                  },
                  "includeDiscussions": {
                    "type": "string",
                    "description": "Indicates whether the row(s) were copied with their respective discussion comments.\nThe value is a string encoded boolean - \"true\" or \"false\".\n",
                    "example": "true"
                  },
                  "sourceSheetId": {
                    "type": "string",
                    "description": "ID of sheet from where the rows copied. (Only included when the `objectId` property contains the ID of the destination sheet)\n",
                    "example": "6141831453927300"
                  },
                  "destinationSheetId": {
                    "type": "string",
                    "description": "ID of sheet to where the rows copied. (Only included when the `objectId` property contains the ID of the source sheet)\n",
                    "example": "3006141831453927"
                  },
                  "rowsCopied": {
                    "type": "string",
                    "description": "Number of rows copied encoded as a string.\n",
                    "example": "2"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_Create": {
        "title": "SHEET - CREATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a sheet is created (inserted).\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "CREATE"
                ],
                "example": "CREATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "sourceObjectId": {
                    "type": "string",
                    "description": "ID of sheet that was copied to create the new sheet. (Only included if the sheet was created as a result of a *copy* or *save as new*)\n",
                    "example": "12345678901234567"
                  },
                  "sourceGlobalTemplateId": {
                    "type": "string",
                    "description": "ID of the global template that was used to create the new sheet (Only included if the sheet was created using a global template)\n",
                    "example": "48569348493401200"
                  },
                  "sourceTemplateId": {
                    "type": "string",
                    "description": "ID of the template used to create the sheet. (Only included if the sheet was created using a template, that is not a global template)\n",
                    "example": "8901234567890123"
                  },
                  "sourceType": {
                    "type": "string",
                    "enum": [
                      "sheet",
                      "template",
                      "globale_template",
                      "import"
                    ],
                    "example": "sheet"
                  },
                  "sheetName": {
                    "type": "string",
                    "description": "Name of the newly created Sheets.\n",
                    "example": "Sheet A"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_CreateCellLink": {
        "title": "SHEET - CREATE_CELL_LINK",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a link to another sheet cell is created in a sheet cell.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "CREATE_CELL_LINK"
                ],
                "example": "CREATE_CELL_LINK"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "cellLinkSourceSheetId": {
                    "type": "string",
                    "description": "ID of sheet referenced by the cell link.\n",
                    "example": "6141831453927300"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_Delete": {
        "title": "SHEET - DELETE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a sheet is deleted.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DELETE"
                ],
                "example": "DELETE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_Export": {
        "title": "SHEET - EXPORT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user exports or prints the sheet.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "EXPORT"
                ],
                "example": "EXPORT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "formatType": {
                    "type": "string",
                    "enum": [
                      "png_gantt",
                      "mspdi",
                      "excel",
                      "pdf"
                    ],
                    "description": "The format that the sheet was exported in \"png_gantt\" (gantt image), \"mspdi\" (Microsoft Project), \"excel\", or \"pdf\".\n",
                    "example": "excel"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_Load": {
        "title": "SHEET - LOAD",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a sheet is viewed in the UI or loaded through the API.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "LOAD"
                ],
                "example": "LOAD"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_Move": {
        "title": "SHEET - MOVE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a sheet is moved between workspaces and/or folders.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "MOVE"
                ],
                "example": "MOVE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "newParentContainerId": {
                    "type": "string",
                    "description": "ID of the destination folder for the move event. (Specific to actions where the sheet was moved to a different folder).\n",
                    "example": "4365870921436587"
                  },
                  "parentContainerId": {
                    "type": "string",
                    "description": "ID of the parent container of the sheet. (Specific to move events where a folder containing the sheet is moved to a folder in a different workspace, indicates that the sheet has moved to a new workspace but is still within the same folder)\n",
                    "example": "3456789012345678"
                  },
                  "folderName": {
                    "type": "string",
                    "description": "Name of the destination folder for the move event. (Specific to actions where the sheet was moved to a different folder).\n",
                    "example": "Folder B"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace the sheet is currently in. If the move was between two workspaces the `workspaceId` will be the ID of the destination workspace.\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_MoveRow": {
        "title": "SHEET - MOVE_ROW",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when row(s) are moved from one sheet to another.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "MOVE_ROW"
                ],
                "example": "MOVE_ROW"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "includeAttachments": {
                    "type": "string",
                    "description": "Indicates whether the row(s) were moved with their respective attachments.\nThe value us a string encoded boolean - \"true\" or \"false\".\n",
                    "example": "true"
                  },
                  "includeDiscussions": {
                    "type": "string",
                    "description": "Indicates whether the row(s) were moved with their respective discussion comments.\nThe value us a string encoded boolean - \"true\" or \"false\".\n",
                    "example": "true"
                  },
                  "sourceSheetId": {
                    "type": "string",
                    "description": "ID of sheet from where the rows moved. (Only included when the `objectId` property contains the ID of the destination sheet)\n",
                    "example": "6141831453927300"
                  },
                  "destinationSheetId": {
                    "type": "string",
                    "description": "ID of sheet to where the rows moved. (Only included when the `objectId` property contains the ID of the source sheet)\n",
                    "example": "3006141831453927"
                  },
                  "rowsMoved": {
                    "type": "string",
                    "description": "Number of rows moved formatted as a string.\n",
                    "example": "2"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_Purge": {
        "title": "SHEET - PURGE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a sheet is deleted (\"Delete Forever\") from the deleted items bin.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "PURGE"
                ],
                "example": "PURGE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_RemoveShare": {
        "title": "SHEET - REMOVE_SHARE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group or user is removed from a sheet's sharing list.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REMOVE_SHARE"
                ],
                "example": "REMOVE_SHARE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that was removed from the sheet's sharing list. (Specific to remove share from user actions)\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that was removed from the sheet's sharing list. (Specific to remove share from group actions)\n",
                    "example": "5432109876543210"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_RemoveShareMember": {
        "title": "SHEET - REMOVE_SHARE_MEMBER",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user is removed from a group that a sheet has been shared to via the sheet's sharing list, or via a workspace's sharing list. \n\nIf a sheet has been shared to a group directly via the sheet's sharing list, and via a workspace's sharing list, then an event will be generated for each of these shares.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REMOVE_SHARE_MEMBER"
                ],
                "example": "REMOVE_SHARE_MEMBER"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of user that was removed from the group.\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that the user was removed from.\n",
                    "example": "5432109876543210"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace that the group is shared to. (Specific to cases where the sheet is shared to the group via a workspace's sharing list)\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_RemoveWorkspaceShare": {
        "title": "SHEET - REMOVE_WORKSPACE_SHARE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group or user is removed from a workspace's sharing list. \n\nNote that this event will appear for each sheet that is in the workspace. If a group or user is removed from a workspace's sharing list and the workspace is empty, then no events will be recorded.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REMOVE_WORKSPACE_SHARE"
                ],
                "example": "REMOVE_WORKSPACE_SHARE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that was removed from the workspace. (Specific to remove share from user actions)\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that was removed from the workspace. (Specific to remove share from group actions)\n",
                    "example": "5432109876543210"
                  },
                  "workspaceId": {
                    "type": "string",
                    "description": "ID of the workspace the group or user was removed from.\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_Rename": {
        "title": "SHEET - RENAME",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an existing sheet is renamed.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "RENAME"
                ],
                "example": "RENAME"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "newName": {
                    "type": "string",
                    "description": "New name of the sheet.\n",
                    "example": "Sheet B"
                  },
                  "oldName": {
                    "type": "string",
                    "description": "Previous name of the sheet.\n",
                    "example": "Sheet A"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_RequestBackup": {
        "title": "SHEET - REQUEST_BACKUP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user requests a backup for a sheet.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REQUEST_BACKUP"
                ],
                "example": "REQUEST_BACKUP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "includeAttachments": {
                    "type": "string",
                    "description": "Indicates whether attachments should be included in the recurring backup.\nThe value is a string formatted boolean (i.e. \"true\" or \"false\").\n",
                    "example": "true"
                  },
                  "sendCompletionEmail": {
                    "type": "string",
                    "description": "Indicates whether an email should be sent to the workspace's owner every time a recurring backup completes.\nThe value is a string formatted boolean (i.e. \"true\" or \"false\").\n",
                    "example": "true"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_Restore": {
        "title": "SHEET - RESTORE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a sheet is in the deleted items bin and is restored (`Undelete`).\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "RESTORE"
                ],
                "example": "RESTORE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_SaveAsNew": {
        "title": "SHEET - SAVE_AS_NEW",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user saves a copy of a sheet by using the `Save As New` option. \n\nThis event is recorded for the original sheet. \n\nIf the original sheet belongs to a different organization, then an event will be generated for organization with original sheet and for the organization with copied sheet.\n\nFor copied sheet, `Save As New` event is paired with a [SHEET - CREATE](/api/smartsheet/openapi/schemas/sheet_create) event.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "SAVE_AS_NEW"
                ],
                "example": "SAVE_AS_NEW"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_SaveAsTemplate": {
        "title": "SHEET - SAVE_AS_TEMPLATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user saves a copy of a sheet as a template by using the `Save As Template` option. \n\nThis event is recorded for the original sheet. \n\nIf the original sheet belongs to a different organization, then an event will be generated for organization with original sheet and for the organization with copied sheet.\n\nFor copied sheet, `Save As Template` event is paired with a [SHEET - CREATE](/api/smartsheet/openapi/schemas/sheet_create) event.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "SAVE_AS_TEMPLATE"
                ],
                "example": "SAVE_AS_TEMPLATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_SendAsAttachment": {
        "title": "SHEET - SEND_AS_ATTACHMENT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user sends a sheet as email attachment to user(s) or user group(s). \n\nAn individual `SHEET - SEND_AS_ATTACHMENT` event is issued for each user or user group listed as recipient.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "SEND_AS_ATTACHMENT"
                ],
                "example": "SEND_AS_ATTACHMENT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "recipientEmail": {
                    "type": "string",
                    "description": "Single email address either of a user explicitly included in the recipient list or of the sender (when *CC sender* is requested). (This property is included only if the `recipientGroupId` property below isn't included)\n",
                    "example": "john.doe@smartsheet.com"
                  },
                  "recipientGroupId": {
                    "type": "string",
                    "description": "Single ID of a user group explicitly included in the recipient list. (This property is included only if the `recipientEmail` property above isn't included)\n",
                    "example": "4583173393803140"
                  },
                  "formatType": {
                    "type": "string",
                    "enum": [
                      "excel",
                      "pdf",
                      "pdf_gantt",
                      "pdf_calendar"
                    ],
                    "description": "The format in which the sheet was sent.\n",
                    "example": "pdf"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_SendRow": {
        "title": "SHEET - SEND_ROW",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user sends selected sheet row(s) by email to user(s) or user group(s). \n\nAn individual `SHEET - SEND_ROW` event is issued for each user or user group listed as recipient.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "SEND_ROW"
                ],
                "example": "SEND_ROW"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "recipientEmail": {
                    "type": "string",
                    "description": "Single email address either of a user explicitly included in the recipient list or of the sender (when *CC sender* is requested). (This property is included only if the `recipientGroupId` property below isn't included)\n",
                    "example": "john.doe@smartsheet.com"
                  },
                  "recipientGroupId": {
                    "type": "string",
                    "description": "Single ID of a user group explicitly included in the recipient list. (This property is included only if the `recipientEmail` property above isn't included)\n",
                    "example": "4583173393803140"
                  },
                  "rowCount": {
                    "type": "string",
                    "description": "Number of rows sent formatted as a string value.\n",
                    "example": "2"
                  },
                  "includeAttachments": {
                    "type": "string",
                    "description": "Indicates whether the row(s) were sent with their respective attachments.\nThe value is a string formatted boolean (i.e. \"true\" or \"false\").\n",
                    "example": "true"
                  },
                  "includeDiscussions": {
                    "type": "string",
                    "description": "Indicates whether the row(s) were sent with their respective discussion comments.\nThe value is a string formatted boolean (i.e. \"true\" or \"false\").\n",
                    "example": "true"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_TransferOwnership": {
        "title": "SHEET - TRANSFER_OWNERSHIP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when the ownership of a sheet is transferred.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "TRANSFER_OWNERSHIP"
                ],
                "example": "TRANSFER_OWNERSHIP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "oldUserId": {
                    "type": "string",
                    "description": "ID of the former owner.\n",
                    "example": "12345678901234567"
                  },
                  "oldAccessLevel": {
                    "type": "string",
                    "enum": [
                      "ADMIN"
                    ],
                    "default": "ADMIN",
                    "description": "New access level of the former owner: `\"ADMIN\"`.\n",
                    "example": "ADMIN"
                  },
                  "newUserId": {
                    "type": "string",
                    "description": "ID of the new owner.\n",
                    "example": "21436587092143658"
                  },
                  "newAccessLevel": {
                    "type": "string",
                    "enum": [
                      "OWNER"
                    ],
                    "default": "OWNER",
                    "description": "New access level of the new owner: `\"OWNER\"`.\n",
                    "example": "OWNER"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Sheet_Update": {
        "title": "SHEET - UPDATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an existing sheet is updated.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "SHEET"
                ],
                "example": "SHEET"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE"
                ],
                "example": "UPDATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "UpdateRequest_Create": {
        "title": "UPDATE_REQUEST - CREATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user creates a sheet update request. \n\nNotice that an update request is created whenever the user sends a new update request via the UI. Also, notice that even though update requests can be sent from a report, it is in fact an update request on the sheet that owns the rows sent in the update request.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "UPDATE_REQUEST"
                ],
                "example": "UPDATE_REQUEST"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "CREATE"
                ],
                "example": "CREATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "sheetId": {
                    "type": "string",
                    "description": "ID of the sheet that owns the rows sent in the update request.\n",
                    "example": "6141831453927300"
                  },
                  "rowCount": {
                    "type": "string",
                    "description": "Number of rows sent in the update request formatted as a string\n",
                    "example": "2"
                  },
                  "includeAttachments": {
                    "type": "string",
                    "description": "Indicates whether the row(s) were sent with their respective attachments.\nThe value is a string formatted boolean (i.e. \"true\" or \"false\").\n",
                    "example": "true"
                  },
                  "includeDiscussions": {
                    "type": "string",
                    "description": "Indicates whether the row(s) were sent with their respective discussion comments.\nThe value is a string formatted boolean (i.e. \"true\" or \"false\").\n",
                    "example": "true"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "User_AcceptInvite": {
        "title": "USER - ACCEPT_INVITE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user accepts an invitation to join an organization account through email.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "USER"
                ],
                "example": "USER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ACCEPT_INVITE"
                ],
                "example": "ACCEPT_INVITE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "User_AddToAccount": {
        "title": "USER - ADD_TO_ACCOUNT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user is added to an auto-provisioned organization account by an admin or when the user logs in with email associated with an auto-provisioned domain.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "USER"
                ],
                "example": "USER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ADD_TO_ACCOUNT"
                ],
                "example": "ADD_TO_ACCOUNT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "userTypes": {
                    "type": "string",
                    "description": "Comma-delimited list of user types, e.g. `SYSTEM_ADMIN`, `LICENSED_USER`, `GROUP_ADMIN`, `RESOURCE_VIEWER`, `JIRA_ADMIN`, `JIRA_USER`, `SALESFORCE_ADMIN`, `SALESFORCE_USER`. \n\nThe full list of available user types can be seen <a href=\"https://help.smartsheet.com/learning-track/shared-users/user-types-and-permissions\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. Please notice that user types Unlicensed User and Free Collaborator are not applicable for this event.\n"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "User_Deactivate": {
        "title": "USER - DEACTIVATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin deactivates a user from the organization account.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "USER"
                ],
                "example": "USER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DEACTIVATE"
                ],
                "example": "DEACTIVATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "userEmail": {
                    "type": "string",
                    "description": "Email address of the user being deactivated\n"
                  }
                }
              }
            }
          }
        ]
      },
      "User_DeclineInvite": {
        "title": "USER - DECLINE_INVITE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user declines an invitation to join an organization account through email.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "USER"
                ],
                "example": "USER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DECLINE_INVITE"
                ],
                "example": "DECLINE_INVITE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "declineReason": {
                    "type": "string",
                    "enum": [
                      "ACCEPT_FAILED_REMOVED_FROM_ORG",
                      "ACCEPT_FAILED_IN_OTHER_ORG",
                      "ACCEPT_FAILED_IS_PAID_USER",
                      "ACCEPT_FAILED_NEEDS_LICENSE",
                      "ACCEPT_FAILED_INSUFFICIENT_LICENSES",
                      "ACCEPT_FAILED_NOT_ELIGIBLE_FOR_TRIAL",
                      "ACCEPT_FAILED",
                      "ACCEPT_FAILED_NEEDS_GROUP_ADMIN_ROLE",
                      "ACCEPT_FAILED_UAP_VIOLATION",
                      "DECLINE_SUCCESS"
                    ],
                    "example": "DECLINE_SUCCESS"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "User_DownloadSheetAccessReport": {
        "title": "USER - DOWNLOAD_SHEET_ACCESS_REPORT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin downloads sheet access report for a user. This can be done through User Management console on UI.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "USER"
                ],
                "example": "USER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DOWNLOAD_SHEET_ACCESS_REPORT"
                ],
                "example": "DOWNLOAD_SHEET_ACCESS_REPORT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "User_Merge_Users": {
        "title": "USER - MERGE_USERS",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin merges one user account into another, transferring source ownership to the destination user.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "USER"
                ],
                "example": "USER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "MERGE_USERS"
                ],
                "example": "MERGE_USERS"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "sourceEmail": {
                    "type": "string",
                    "description": "Email address of the source user being merged (account that will be removed)\n"
                  },
                  "destinationEmail": {
                    "type": "string",
                    "description": "Email address of the destination user (account that receives merged data)\n"
                  }
                }
              }
            }
          }
        ]
      },
      "User_RemoveFromAccount": {
        "title": "USER - REMOVE_FROM_ACCOUNT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user is removed from the organization account. This can be done through User Management on UI or via the API (Remove User).\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "USER"
                ],
                "example": "USER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REMOVE_FROM_ACCOUNT"
                ],
                "example": "REMOVE_FROM_ACCOUNT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "User_RemoveFromGroups": {
        "title": "USER - REMOVE_FROM_GROUPS",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin removes an user from all groups owned by users on the organization account. This can be done through User Management on UI.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "USER"
                ],
                "example": "USER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REMOVE_FROM_GROUPS"
                ],
                "example": "REMOVE_FROM_GROUPS"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "User_RemoveShares": {
        "title": "USER - REMOVE_SHARES",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin removes the user from all groups and from sharing for all sheets, workspaces, and dashboards owned by users on the organization account. This can be done through User Management on UI.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "USER"
                ],
                "example": "USER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REMOVE_SHARES"
                ],
                "example": "REMOVE_SHARES"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "User_SendInvite": {
        "title": "USER - SEND_INVITE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin sends/resends an invitation link to the user. This can be done through User Management console on UI or via the API (Add User). \n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "USER"
                ],
                "example": "USER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "SEND_INVITE"
                ],
                "example": "SEND_INVITE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "userTypes": {
                    "type": "string",
                    "description": "Comma-delimited list of user types, e.g. `SYSTEM_ADMIN`, `LICENSED_USER`, `GROUP_ADMIN`, `RESOURCE_VIEWER`, `JIRA_ADMIN`, `JIRA_USER`, `SALESFORCE_ADMIN`, `SALESFORCE_USER`. \n\nThe full list of available user types can be seen <a href=\"https://help.smartsheet.com/learning-track/shared-users/user-types-and-permissions\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. Please notice that user types Unlicensed User and Free Collaborator are not applicable for this event.\n"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "User_SendPasswordReset": {
        "title": "USER - SEND_PASSWORD_RESET",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin sends a password reset email. This can be done through User Management on UI.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "USER"
                ],
                "example": "USER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "SEND_PASSWORD_RESET"
                ],
                "example": "SEND_PASSWORD_RESET"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "User_TransferOwnedGroups": {
        "title": "USER - TRANSFER_OWNED_GROUPS",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin transfers ownership of all groups owned by a user to another user. This can be done through User Management on UI.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "USER"
                ],
                "example": "USER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "TRANSFER_OWNED_GROUPS"
                ],
                "example": "TRANSFER_OWNED_GROUPS"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "oldOwnerUserId": {
                    "type": "string",
                    "description": "ID of the former group owner.\n",
                    "example": "12345678901234567"
                  },
                  "newOwnerUserId": {
                    "type": "string",
                    "description": "ID of the new group owner.\n",
                    "example": "21436587092143658"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "User_TransferOwnedItems": {
        "title": "USER - TRANSFER_OWNED_ITEMS",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin transfers ownership of all items (sheets/reports/dashboards/workspaces) owned by a user to another user. This can be done through User Management on UI.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "USER"
                ],
                "example": "USER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "TRANSFER_OWNED_ITEMS"
                ],
                "example": "TRANSFER_OWNED_ITEMS"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "oldOwnerUserId": {
                    "type": "string",
                    "description": "ID of the former group owner.\n",
                    "example": "12345678901234567"
                  },
                  "newOwnerUserId": {
                    "type": "string",
                    "description": "ID of the new group owner.\n",
                    "example": "21436587092143658"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "User_UpdateUser": {
        "title": "USER - UPDATE_USER",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when the user account is updated. This can be done through User Management on UI or via the API.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "USER"
                ],
                "example": "USER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE_USER"
                ],
                "example": "UPDATE_USER"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "User_View_User_Roles_And_Reports": {
        "title": "USER - VIEW_USER_ROLES_AND_REPORTS",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when an admin views the user roles and reports section in the User Management console.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "USER"
                ],
                "example": "USER"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "VIEW_USER_ROLES_AND_REPORTS"
                ],
                "example": "VIEW_USER_ROLES_AND_REPORTS"
              }
            }
          }
        ]
      },
      "Workspace_AddShare": {
        "title": "WORKSPACE - ADD_SHARE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group or user is added to the workspace's sharing list, or when a group or user's share permissions are changed.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "WORKSPACE"
                ],
                "example": "WORKSPACE"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ADD_SHARE"
                ],
                "example": "ADD_SHARE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "accessLevel": {
                    "type": "string",
                    "enum": [
                      "VIEWER",
                      "EDITOR",
                      "EDITOR_SHARE",
                      "ADMIN"
                    ],
                    "description": "Indicates the access level granted to the group or user. \n\nNote that this access level represents the access level granted by this specific sharing action; it is not the group or user's effective access level for the workspace.\n",
                    "example": "VIEWER"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that was added to the workspace's sharing list. (Specific to share to user actions)\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that was added to the workspace's sharing list. (Specific to share to group actions)\n",
                    "example": "5432109876543210"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Workspace_AddShareMember": {
        "title": "WORKSPACE - ADD_SHARE_MEMBER",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user is added to a group that a workspace has been shared to via the workspace's sharing list, or via a workspace's sharing list. \n\nIf a workspace has been shared to a group directly via the workspace's sharing list, and via a workspace's sharing list, then an event will be generated for each of these shares.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "WORKSPACE"
                ],
                "example": "WORKSPACE"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "ADD_SHARE_MEMBER"
                ],
                "example": "ADD_SHARE_MEMBER"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "accessLevel": {
                    "type": "string",
                    "enum": [
                      "VIEWER",
                      "EDITOR",
                      "EDITOR_SHARE",
                      "ADMIN"
                    ],
                    "description": "Indicates the access level granted to the user. \n\nNote that this access level represents the access level that has been granted to the user via group membership; it is not the user's effective access level for the workspace.\n",
                    "example": "VIEWER"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that was added to the group.\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group the user was added to.\n",
                    "example": "5432109876543210"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Workspace_Create": {
        "title": "WORKSPACE - CREATE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a workspace is created.\n\nWorkspaces can be created in the UI with the `Create New` button, by selecting the `Save As New` option on an existing workspace, or through the API.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "WORKSPACE"
                ],
                "example": "WORKSPACE"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "CREATE"
                ],
                "example": "CREATE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "workspaceName": {
                    "type": "string",
                    "description": "Name of the workspace.\n",
                    "example": "Workspace A"
                  },
                  "sourceWorkspaceId": {
                    "type": "string",
                    "description": "ID of workspace that was copied to create the new workspace. (Only included if the workspace was created as a result of a *save as new* or *copy*)\n",
                    "example": "9876543210987654"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Workspace_CreateRecurringBackup": {
        "title": "WORKSPACE - CREATE_RECURRING_BACKUP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user schedules a recurring backup for a workspace.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "WORKSPACE"
                ],
                "example": "WORKSPACE"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "CREATE_RECURRING_BACKUP"
                ],
                "example": "CREATE_RECURRING_BACKUP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "includeAttachments": {
                    "type": "string",
                    "description": "Indicates whether attachments should be included in the recurring backup.\nThe value is a string formatted boolean (\"true\" or \"false\").\n",
                    "example": "true"
                  },
                  "sendCompletionEmail": {
                    "type": "string",
                    "description": "Indicates whether an email should be sent to the workspace's owner every time a recurring backup completes.\nThe value is a string formatted boolean (\"true\" or \"false\").\n",
                    "example": "true"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Workspace_Delete": {
        "title": "WORKSPACE - DELETE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a workspace is deleted.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "WORKSPACE"
                ],
                "example": "WORKSPACE"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DELETE"
                ],
                "example": "DELETE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Workspace_DeleteRecurringBackup": {
        "title": "WORKSPACE - DELETE_RECURRING_BACKUP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user deletes a recurring backup schedule for a workspace.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "WORKSPACE"
                ],
                "example": "WORKSPACE"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "DELETE_RECURRING_BACKUP"
                ],
                "example": "DELETE_RECURRING_BACKUP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Workspace_Export": {
        "title": "WORKSPACE - EXPORT",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user exports the workspace.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "WORKSPACE"
                ],
                "example": "WORKSPACE"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "EXPORT"
                ],
                "example": "EXPORT"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "formatType": {
                    "type": "string",
                    "enum": [
                      "excel",
                      "pdf"
                    ],
                    "description": "The format that the workspace was exported (\"excel\" or \"pdf\"). Notice that the same value \"excel\" is displayed either when exporting to Microsoft Excel or when exporting to Google Sheets.\n",
                    "example": "excel"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Workspace_RemoveShare": {
        "title": "WORKSPACE - REMOVE_SHARE",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a group or user is removed from a workspace's sharing list.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "WORKSPACE"
                ],
                "example": "WORKSPACE"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REMOVE_SHARE"
                ],
                "example": "REMOVE_SHARE"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "userId": {
                    "type": "string",
                    "description": "ID of the user that was removed from the workspace's sharing list. (Specific to remove share from user actions)\n",
                    "example": "12345678901234567"
                  },
                  "groupId": {
                    "type": "string",
                    "description": "ID of the group that was removed from the workspace's sharing list. (Specific to remove share from group actions)\n",
                    "example": "5432109876543210"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Workspace_RemoveShareMember": {
        "title": "WORKSPACE - REMOVE_SHARE_MEMBER",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user is removed from a group that a workspace has been shared to via the workspace's sharing list, or via a workspace's sharing list. \n\nIf a workspace has been shared to a group directly via the workspace's sharing list, and via a workspace's sharing list, then an event will be generated for each of these shares.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "WORKSPACE"
                ],
                "example": "WORKSPACE"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REMOVE_SHARE_MEMBER"
                ],
                "example": "REMOVE_SHARE_MEMBER"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Workspace_Rename": {
        "title": "WORKSPACE - RENAME",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a workspace is renamed in the UI or via the API (update).\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "WORKSPACE"
                ],
                "example": "WORKSPACE"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "RENAME"
                ],
                "example": "RENAME"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "newName": {
                    "type": "string",
                    "description": "New name of the workspace.\n",
                    "example": "Workspace B"
                  },
                  "oldName": {
                    "type": "string",
                    "description": "Previous name of the workspace.\n",
                    "example": "Workspace A"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Workspace_RequestBackup": {
        "title": "WORKSPACE - REQUEST_BACKUP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user requests a backup for a workspace.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "WORKSPACE"
                ],
                "example": "WORKSPACE"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "REQUEST_BACKUP"
                ],
                "example": "REQUEST_BACKUP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "includeAttachments": {
                    "type": "string",
                    "description": "Indicates whether attachments should be included in the recurring backup.\nThe value is a string formatted boolean (\"true\" or \"false\").\n",
                    "example": "true"
                  },
                  "sendCompletionEmail": {
                    "type": "string",
                    "description": "Indicates whether an email should be sent to the workspace's owner every time a recurring backup completes.\nThe value is a string formatted boolean (\"true\" or \"false\").\n",
                    "example": "true"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Workspace_SaveAsNew": {
        "title": "WORKSPACE - SAVE_AS_NEW",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user saves a copy of a workspace by using the `Save As New` option via UI or `Copy Workspace` via API. \n\nThis event is recorded for the original workspace. Each `Save As New` event is paired with a [WORKSPACE - CREATE](/api/smartsheet/openapi/schemas/workspace_create) event that is recorded for the copy of the workspace.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "WORKSPACE"
                ],
                "example": "WORKSPACE"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "SAVE_AS_NEW"
                ],
                "example": "SAVE_AS_NEW"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Workspace_TransferOwnership": {
        "title": "WORKSPACE - TRANSFER_OWNERSHIP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a workspace ownership is transferred.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "WORKSPACE"
                ],
                "example": "WORKSPACE"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "TRANSFER_OWNERSHIP"
                ],
                "example": "TRANSFER_OWNERSHIP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "Workspace_UpdateRecurringBackup": {
        "title": "WORKSPACE - UPDATE_RECURRING_BACKUP",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event"
          },
          {
            "type": "object",
            "description": "Triggered when a user updates the options (listed below in **`additionalDetails`**) in a recurring backup schedule for a workspace.\n",
            "properties": {
              "objectType": {
                "description": "The Smartsheet resource impacted by the event.",
                "type": "string",
                "enum": [
                  "WORKSPACE"
                ],
                "example": "WORKSPACE"
              },
              "action": {
                "description": "The action applied to the specified object",
                "type": "string",
                "enum": [
                  "UPDATE_RECURRING_BACKUP"
                ],
                "example": "UPDATE_RECURRING_BACKUP"
              },
              "additionalDetails": {
                "type": "object",
                "properties": {
                  "sourceIpAddress": {
                    "type": "string",
                    "description": "IP address of the user responsible for the event. This field is only present if the source of the event is \"WEB_APP\".\n",
                    "example": "248.253.157.32"
                  },
                  "emailAddress": {
                    "type": "string",
                    "description": "Email address of the user responsible for the event.\n",
                    "example": "jane.doe@smartsheet.com"
                  },
                  "includeAttachments": {
                    "type": "string",
                    "description": "Indicates whether attachments should be included in the recurring backup.\nThe value is a string formatted boolean (\"true\" or \"false\").\n",
                    "example": "true"
                  },
                  "sendCompletionEmail": {
                    "type": "string",
                    "description": "Indicates whether an email should be sent to the workspace's owner every time a recurring backup completes.\nThe value is a string formatted boolean (\"true\" or \"false\").\n",
                    "example": "true"
                  }
                },
                "required": [
                  "emailAddress"
                ]
              }
            }
          }
        ]
      },
      "GenericResult": {
        "title": "Generic result",
        "type": "object",
        "properties": {
          "message": {
            "description": "Message that indicates the outcome of the request. (One of `SUCCESS` or `PARTIAL_SUCCESS`.)\n",
            "type": "string",
            "enum": [
              "PARTIAL_SUCCESS",
              "SUCCESS"
            ],
            "example": "SUCCESS"
          },
          "resultCode": {
            "description": "* '0' Success\n* '3' Partial Success of Bulk Operation\n",
            "type": "number",
            "enum": [
              0,
              3
            ]
          }
        }
      },
      "GridListing": {
        "title": "Grid index item",
        "type": "object",
        "properties": {
          "id": {
            "description": "Asset ID.",
            "type": "number"
          },
          "name": {
            "description": "Asset name.",
            "type": "string"
          },
          "permalink": {
            "description": "URL that represents a direct link to the asset in Smartsheet.",
            "type": "string"
          }
        }
      },
      "DashboardListing": {
        "title": "Dashboard index item",
        "type": "object",
        "properties": {
          "id": {
            "description": "Asset ID.",
            "type": "number"
          },
          "name": {
            "description": "Asset name.",
            "type": "string"
          },
          "permalink": {
            "description": "URL that represents a direct link to the asset in Smartsheet.",
            "type": "string"
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp"
          }
        }
      },
      "FolderCreateRequest": {
        "title": "Folder creation request",
        "description": "A request body for creating or updating a folder.",
        "type": "object",
        "properties": {
          "name": {
            "description": "Folder name.",
            "type": "string",
            "maxLength": 50
          }
        }
      },
      "SuccessResult": {
        "title": "Success result",
        "type": "object",
        "properties": {
          "message": {
            "description": "Message that indicates the request was successful.",
            "type": "string",
            "enum": [
              "SUCCESS"
            ],
            "example": "SUCCESS"
          },
          "resultCode": {
            "description": "* '0' Success",
            "type": "number",
            "enum": [
              0
            ]
          }
        }
      },
      "FolderListing": {
        "title": "Folder listing",
        "type": "object",
        "properties": {
          "id": {
            "description": "Folder ID.",
            "type": "number"
          },
          "name": {
            "description": "Folder name.",
            "type": "string"
          },
          "permalink": {
            "description": "URL that represents a direct link to the folder in Smartsheet.",
            "type": "string"
          }
        }
      },
      "Timestamp_long": {
        "title": "Timestamp long",
        "type": "integer",
        "format": "int64"
      },
      "Timestamp2": {
        "title": "Timestamp2",
        "readOnly": true,
        "oneOf": [
          {
            "$ref": "#/components/schemas/Timestamp_date-time"
          },
          {
            "$ref": "#/components/schemas/Timestamp_long"
          }
        ]
      },
      "FolderMetadata": {
        "title": "Folder metadata",
        "description": "The metadata of a Folder",
        "type": "object",
        "x-tags": [
          "folders"
        ],
        "required": [
          "id",
          "name",
          "permalink",
          "createdAt",
          "modifiedAt"
        ],
        "properties": {
          "id": {
            "description": "Folder ID.",
            "type": "integer",
            "format": "int64"
          },
          "name": {
            "description": "Folder name.",
            "type": "string"
          },
          "permalink": {
            "description": "URL to the folder in Smartsheet.",
            "type": "string",
            "format": "uri"
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp2"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp2"
          }
        }
      },
      "PaginatedChildrenListItem": {
        "title": "Paginated children list item",
        "type": "object",
        "required": [
          "id",
          "name",
          "permalink",
          "createdAt",
          "modifiedAt",
          "resourceType",
          "accessLevel"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "description": "Resource ID."
          },
          "name": {
            "type": "string",
            "description": "Resource name."
          },
          "permalink": {
            "type": "string",
            "format": "uri",
            "description": "URL to the resource in Smartsheet."
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp2"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp2"
          },
          "accessLevel": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AccessLevel"
              }
            ]
          },
          "resourceType": {
            "type": "string",
            "description": "The type of the child resource",
            "enum": [
              "sheet",
              "report",
              "sight",
              "template"
            ]
          }
        }
      },
      "PaginatedFolderListItem": {
        "title": "Paginated folder list item",
        "type": "object",
        "required": [
          "id",
          "name",
          "permalink",
          "createdAt",
          "modifiedAt",
          "resourceType"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "description": "Resource ID."
          },
          "name": {
            "type": "string",
            "description": "Resource name."
          },
          "permalink": {
            "type": "string",
            "format": "uri",
            "description": "URL to the resource in Smartsheet."
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp2"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp2"
          },
          "resourceType": {
            "type": "string",
            "description": "The type of the resource",
            "enum": [
              "folder"
            ]
          }
        }
      },
      "LastKey": {
        "title": "Last key",
        "type": "string",
        "example": "abcDefGhIjKlMnOpQrStUvWxYz",
        "description": "A token that is used to retrieve the next page of results when passed as the\n`lastKey` query parameter. This value will be absent when there are no \nfurther pages.\n"
      },
      "PaginatedChildrenResponse": {
        "title": "Paginated children response",
        "type": "object",
        "description": "Paginated response object containing an array of asset references. Call again\nwith the `lastKey` query parameter to retrieve the next page of results.\n",
        "required": [
          "data"
        ],
        "properties": {
          "data": {
            "description": "Array of assets of the requested type in this folder.",
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PaginatedChildrenListItem"
                },
                {
                  "$ref": "#/components/schemas/PaginatedFolderListItem"
                }
              ]
            }
          },
          "lastKey": {
            "$ref": "#/components/schemas/LastKey"
          }
        }
      },
      "ContainerDestinationForMove": {
        "title": "Container destination for move",
        "type": "object",
        "properties": {
          "destinationId": {
            "description": "The ID of the destination container.\n",
            "type": "number"
          },
          "destinationType": {
            "description": "Type of destination container.\n\nThe `\"home\"` enum is **Deprecated** since March 25, 2025, and will be removed.\n",
            "type": "string",
            "nullable": true,
            "enum": [
              "folder",
              "home",
              "workspace"
            ]
          }
        },
        "required": [
          "destinationId",
          "destinationType"
        ]
      },
      "PathWorkspace": {
        "type": "object",
        "required": [
          "id",
          "name",
          "permalink",
          "accessLevel"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "description": "Workspace ID.",
            "example": 4509918431602564
          },
          "name": {
            "type": "string",
            "description": "Workspace name.",
            "example": "Sample Workspace"
          },
          "permalink": {
            "type": "string",
            "format": "uri",
            "description": "URL that represents a direct link to the workspace in Smartsheet.",
            "example": "https://api.smartsheet.com/workspaces/cpG82pf5v8FPrgFfJrFcrM56xCHVGhmV4P4xcQ71"
          },
          "accessLevel": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AccessLevel"
              },
              {
                "description": "The access level of the user to the workspace."
              }
            ]
          }
        }
      },
      "PathFoldersOnly": {
        "type": "object",
        "oneOf": [
          {
            "title": "Folders",
            "type": "object",
            "required": [
              "folders"
            ],
            "properties": {
              "folders": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "name",
                    "permalink"
                  ],
                  "properties": {
                    "id": {
                      "type": "integer",
                      "format": "int64",
                      "description": "Folder ID.",
                      "example": 1234567890123456
                    },
                    "name": {
                      "type": "string",
                      "description": "Folder name.",
                      "example": "Project Plans"
                    },
                    "permalink": {
                      "type": "string",
                      "format": "uri",
                      "description": "URL that represents a direct link to the folder in Smartsheet.",
                      "example": "https://app.smartsheet.com/folders/abcd1234efgh5678ijkl9012mnop3456"
                    }
                  }
                }
              }
            }
          },
          {
            "title": "Folders",
            "type": "object",
            "required": [
              "folders"
            ],
            "properties": {
              "folders": {
                "type": "array",
                "description": "Array of a single folder on the path from the asset to its workspace.",
                "items": {
                  "allOf": [
                    {
                      "type": "object",
                      "required": [
                        "id",
                        "name"
                      ],
                      "properties": {
                        "id": {
                          "type": "integer",
                          "format": "int64",
                          "description": "Folder ID.",
                          "example": 1234567890123456
                        },
                        "name": {
                          "type": "string",
                          "description": "Folder name.",
                          "example": "Project Plans"
                        },
                        "permalink": {
                          "type": "string",
                          "format": "uri",
                          "description": "URL that represents a direct link to the folder in Smartsheet.",
                          "example": "https://api.smartsheet.com/folders/abcd1234efgh5678ijkl9012mnop3456"
                        }
                      }
                    },
                    {
                      "$ref": "#/components/schemas/PathFoldersOnly"
                    }
                  ]
                }
              }
            }
          }
        ]
      },
      "PathFolderResponse": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/PathWorkspace"
          },
          {
            "$ref": "#/components/schemas/PathFoldersOnly"
          }
        ]
      },
      "ColumnBase": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "description": "Column description."
          },
          "format": {
            "type": "string",
            "description": "The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)).\n\n**Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it.\n",
            "example": ""
          },
          "hidden": {
            "type": "boolean",
            "description": "If set to `true`, the column is hidden.",
            "example": false
          },
          "id": {
            "type": "number",
            "minimum": 0,
            "description": "The column's unique identifier.",
            "readOnly": true,
            "example": 4567890123
          },
          "index": {
            "type": "number",
            "description": "The column's position in the sheet. Indexes start at `0`.",
            "minimum": 0,
            "example": 0
          },
          "locked": {
            "type": "boolean",
            "description": "If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet.\n",
            "example": false
          },
          "lockedForUser": {
            "type": "boolean",
            "readOnly": true,
            "description": "Indicates whether the column is locked for the requesting user. \n",
            "example": false
          },
          "title": {
            "type": "string",
            "description": "Column title."
          },
          "width": {
            "type": "number",
            "minimum": 1,
            "description": "The column's display width in pixels.",
            "example": 150
          }
        }
      },
      "AutoNumberColumn": {
        "title": "Auto number column",
        "type": "object",
        "description": "A column of auto-generated numbers.\n\n> **Note:** A sheet can have at most one auto number column.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "autoNumberFormat": {
                "$ref": "#/components/schemas/AutoNumberFormat"
              },
              "systemColumnType": {
                "type": "string",
                "enum": [
                  "AUTO_NUMBER"
                ],
                "description": "If this property is set, the column contains auto-generated numbers. Its [Auto-number format object](/api/smartsheet/openapi/schemas/autonumberformat) describes the mask used to generate column values.\n"
              },
              "type": {
                "type": "string",
                "enum": [
                  "TEXT_NUMBER"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns)."
              },
              "validation": {
                "type": "boolean",
                "readOnly": true,
                "example": false
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "ColumnPropsInvalidForCreateSheet": {
        "type": "object",
        "properties": {
          "index": {
            "type": "number",
            "readOnly": true
          },
          "locked": {
            "type": "boolean",
            "readOnly": true
          },
          "lockedForUser": {
            "type": "boolean",
            "readOnly": true
          },
          "tags": {
            "type": "array",
            "readOnly": true,
            "items": {
              "type": "string"
            }
          },
          "validation": {
            "type": "boolean",
            "readOnly": true
          },
          "version": {
            "type": "number",
            "readOnly": true
          }
        }
      },
      "AutoNumberColumnForCreateSheet": {
        "title": "Auto number column for sheet creation",
        "type": "object",
        "description": "A column of auto-generated numbers.\n\n> **Note:** A sheet can have at most one auto number column.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/AutoNumberColumn"
          },
          {
            "$ref": "#/components/schemas/ColumnPropsInvalidForCreateSheet"
          }
        ]
      },
      "CheckboxColumn": {
        "title": "Checkbox column",
        "type": "object",
        "description": "A column of checkboxes that you can select or clear. You can display the column checkboxes as one of the following symbols:\n\n- box\n- flag\n- star\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "formula": {
                "description": "The formula for the column, if set.\n\nFor example: \"=ISODD([ID]@row)\"\n",
                "type": "string",
                "example": ""
              },
              "symbol": {
                "type": "string",
                "enum": [
                  "FLAG",
                  "STAR"
                ],
                "description": "A checkbox column can use box (default), flag, or star symbols. See [Symbol Columns](/api/smartsheet/openapi/columns).\n\nIf the box symbol is used, the `symbol` property is absent.\n"
              },
              "tags": {
                "type": "array",
                "readOnly": true,
                "description": "If present, `true` cell values indicate completed tasks. This property is only present for dependency-enabled project sheets.\n\nFor details on Gantt view, refer to <a href=\"https://help.smartsheet.com/articles/765675-work-with-gantt-chart\" target=\"_blank\" rel=\"noopener noreferrer\">Create and work with a Gantt view</a>.\n\nFor details on workload tracking and Resource Management, see <a href=\"https://help.smartsheet.com/articles/2483101-workload-tracking-in-smartsheet\" target=\"_blank\" rel=\"noopener noreferrer\">Workload tracking in Smartsheet</a>.\n",
                "items": {
                  "type": "string",
                  "enum": [
                    "CARD_DONE"
                  ]
                },
                "example": []
              },
              "type": {
                "type": "string",
                "enum": [
                  "CHECKBOX"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns)."
              },
              "validation": {
                "type": "boolean",
                "readOnly": true,
                "description": "If `true`, validation is enabled for the column values.",
                "example": false
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "CheckboxColumnForCreateSheet": {
        "title": "Checkbox column for sheet creation",
        "type": "object",
        "description": "The column represents a checkbox you can select or clear. You can display the checkbox as a box, a flag, or a single star, each of which you can select or unselect.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/CheckboxColumn"
          },
          {
            "$ref": "#/components/schemas/ColumnPropsInvalidForCreateSheet"
          }
        ]
      },
      "contactOptions": {
        "title": "Contact options",
        "description": "Array of ContactOption objects to specify a pre-defined list of values for the column. \n",
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/ContactOption"
        },
        "example": [
          {
            "email": "jane.doe@smartsheet.com",
            "name": "Jane Doe"
          },
          {
            "email": "john.doe@company.com",
            "name": "John Doe"
          }
        ]
      },
      "ContactListColumn": {
        "title": "Contact list column",
        "type": "object",
        "description": "A column of predefined contacts from which you can choose up to one for each cell.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "contactOptions": {
                "$ref": "#/components/schemas/contactOptions"
              },
              "formula": {
                "description": "The formula for the column, if set.\n\nFor example: =IF(Department@row = \"Engineering\", \"jane.doe@company.com\", IF(Department@row = \"Marketing\", \"john.smith@company.com\", \"admin@company.com\"))\n",
                "type": "string",
                "example": ""
              },
              "type": {
                "type": "string",
                "enum": [
                  "CONTACT_LIST"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns)."
              },
              "validation": {
                "type": "boolean",
                "description": "If `true`, validation is enabled for the column values.",
                "example": false
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "ContactListColumnForCreateSheet": {
        "title": "Contact list column for sheet creation",
        "type": "object",
        "description": "This column provides a predefined list of contacts from which you can choose up to one for a cell's value.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ContactListColumn"
          },
          {
            "$ref": "#/components/schemas/ColumnPropsInvalidForCreateSheet"
          }
        ]
      },
      "CreatedByColumn": {
        "title": "Created by column",
        "type": "object",
        "description": "A system-populated column that identifies the user who created each row.\n\n> **Note:** A sheet has at most, one of these columns.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "systemColumnType": {
                "type": "string",
                "enum": [
                  "CREATED_BY"
                ],
                "description": "The contact represents the user who created the row.\n",
                "example": "CREATED_BY"
              },
              "type": {
                "type": "string",
                "enum": [
                  "CONTACT_LIST"
                ]
              },
              "validation": {
                "type": "boolean",
                "readOnly": true,
                "description": "If `true`, validation is enabled for the column values.",
                "example": false
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "CreatedByColumnForCreateSheet": {
        "title": "Created by column for sheet creation",
        "type": "object",
        "description": "A system-populated column that represents the user who created each row.\n\n> **Note:** A sheet has at most, one of these columns.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/CreatedByColumn"
          },
          {
            "$ref": "#/components/schemas/ColumnPropsInvalidForCreateSheet"
          }
        ]
      },
      "CreatedDateColumn": {
        "title": "Created date column",
        "type": "object",
        "description": "A system-populated column of datetime values representing each row's creation datetime.\n\n> **Note:** This type of column can only be added via the web application, and a sheet can only have one column of this type.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "systemColumnType": {
                "type": "string",
                "enum": [
                  "CREATED_DATE"
                ],
                "description": "The system row creation datetime type.\n",
                "example": "CREATED_DATE"
              },
              "type": {
                "type": "string",
                "enum": [
                  "DATETIME"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns).",
                "example": "DATETIME"
              },
              "validation": {
                "type": "boolean",
                "readOnly": true,
                "description": "If `true`, validation is enabled for the column values.",
                "example": false
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "CreatedDateColumnForCreateSheet": {
        "title": "Created date column for sheet creation",
        "type": "object",
        "description": "A system-populated column of datetime values representing each row's creation datetime.\n\n> **Note:** This type of column can only be added via the web application, and a sheet can only have one column of this type.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/CreatedDateColumn"
          },
          {
            "$ref": "#/components/schemas/ColumnPropsInvalidForCreateSheet"
          }
        ]
      },
      "DateColumn": {
        "title": "Date column",
        "type": "object",
        "description": "A column of datetime values.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "formula": {
                "description": "The formula for the column, if set.\n\nFor example: =TODAY(-1)\n",
                "type": "string",
                "example": ""
              },
              "type": {
                "type": "string",
                "enum": [
                  "DATE"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns).",
                "example": "DATE"
              },
              "validation": {
                "type": "boolean",
                "readOnly": true,
                "description": "If `true`, validation is enabled for the column values.",
                "example": false
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "DateColumnForCreateSheet": {
        "title": "Date column for sheet creation",
        "type": "object",
        "description": "Column for datetime values.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/DateColumn"
          },
          {
            "$ref": "#/components/schemas/ColumnPropsInvalidForCreateSheet"
          }
        ]
      },
      "DropdownListColumn": {
        "title": "Dropdown list column",
        "type": "object",
        "description": "A column of predefined values from which you can choose for each cell.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "formula": {
                "type": "string",
                "description": "A formula that returns a string value that matches one of the symbol options exactly (for example, \"Red\", \"Yellow\", \"Green\").\n\nFor example: =[Literal Rating]@row\n",
                "example": ""
              },
              "options": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "An array of the options available to use in the column.",
                "example": [
                  "Option 1",
                  "Option 2",
                  "Option n"
                ]
              },
              "type": {
                "type": "string",
                "enum": [
                  "PICKLIST"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns)."
              },
              "validation": {
                "type": "boolean",
                "readOnly": true,
                "description": "If `true`, validation is enabled for the column values.",
                "example": false
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "DropdownListColumnForCreateSheet": {
        "title": "Dropdown list column for sheet creation",
        "type": "object",
        "description": "This column provides a predefined list of values from which to choose for each cell.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/DropdownListColumn"
          },
          {
            "$ref": "#/components/schemas/ColumnPropsInvalidForCreateSheet"
          }
        ]
      },
      "ModifiedByColumn": {
        "title": "Modified by column",
        "type": "object",
        "description": "A system-populated column that identifies the user who last modified each row.\n\n> **Note:** A sheet has at most, one of these columns.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "systemColumnType": {
                "type": "string",
                "enum": [
                  "MODIFIED_BY"
                ],
                "description": "If specified, the contact represents the user who created the row or last modified it.\n",
                "example": "MODIFIED_BY"
              },
              "type": {
                "type": "string",
                "enum": [
                  "CONTACT_LIST"
                ]
              },
              "validation": {
                "type": "boolean",
                "readOnly": true,
                "description": "If `true`, validation is enabled for the column values.",
                "example": false
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "ModifiedByColumnForCreateSheet": {
        "title": "Modified by column for sheet creation",
        "type": "object",
        "description": "A system-populated column that represents the user who last modified each row.\n\n> **Note:** A sheet has at most, one of these columns.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ModifiedByColumn"
          },
          {
            "$ref": "#/components/schemas/ColumnPropsInvalidForCreateSheet"
          }
        ]
      },
      "ModifiedDateColumn": {
        "title": "Modified date column",
        "type": "object",
        "description": "A system-populated column of datetime values representing each row's last modification datetime.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "systemColumnType": {
                "type": "string",
                "enum": [
                  "MODIFIED_DATE"
                ],
                "description": "The system row modification datetime type.\n",
                "example": "MODIFIED_DATE"
              },
              "type": {
                "type": "string",
                "enum": [
                  "DATETIME"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns).",
                "example": "DATETIME"
              },
              "validation": {
                "type": "boolean",
                "readOnly": true,
                "description": "If `true`, validation is enabled for the column values.",
                "example": false
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "ModifiedDateColumnForCreateSheet": {
        "title": "Modified date column for sheet creation",
        "type": "object",
        "description": "A system-populated column of datetime values representing each row's last modification datetime.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ModifiedDateColumn"
          },
          {
            "$ref": "#/components/schemas/ColumnPropsInvalidForCreateSheet"
          }
        ]
      },
      "MultiContactListColumn": {
        "title": "Multi-contact list column",
        "type": "object",
        "description": "A column of predefined contacts from which you can choose multiple for each cell.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "contactOptions": {
                "$ref": "#/components/schemas/contactOptions"
              },
              "type": {
                "type": "string",
                "enum": [
                  "MULTI_CONTACT_LIST"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns)."
              },
              "validation": {
                "type": "boolean",
                "readOnly": true,
                "description": "If `true`, validation is enabled for the column values.",
                "example": false
              },
              "version": {
                "type": "number",
                "enum": [
                  1
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 1
              }
            }
          }
        ]
      },
      "MultiContactListColumnForCreateSheet": {
        "title": "Multi-dropdown list column for sheet creation",
        "type": "object",
        "description": "This column provides a predefined list of values from which you can choose multiple for a cell's value.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/MultiContactListColumn"
          },
          {
            "$ref": "#/components/schemas/ColumnPropsInvalidForCreateSheet"
          }
        ]
      },
      "MultiDropdownListColumn": {
        "title": "Multi-dropdown list column",
        "type": "object",
        "description": "A column of predefined values from which you can choose multiple for each cell.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "formula": {
                "type": "string",
                "description": "A formula that returns a string value that matches a combination of the symbol options exactly, and include new line separators between multiple values.\n\nFor example: =JOIN(Range1@row:Range3@row, CHAR(10))\n\n**Important:** To match multiple symbol option values, the return string must use a new line separator (that is, `CHAR(10)`) between symbol option values.\n",
                "example": ""
              },
              "options": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "An array of the options available to use in the column. A cell value in this column can contain any number of these options.",
                "example": [
                  "Option 1",
                  "Option 2",
                  "Option n"
                ]
              },
              "type": {
                "type": "string",
                "enum": [
                  "MULTI_PICKLIST"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns)."
              },
              "validation": {
                "type": "boolean",
                "description": "If `true`, validation is enabled for the column values.",
                "example": false
              },
              "version": {
                "type": "number",
                "enum": [
                  2
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 2
              }
            }
          }
        ]
      },
      "MultiDropdownListColumnForCreateSheet": {
        "title": "Multi-dropdown list column for sheet creation",
        "type": "object",
        "description": "This column provides a predefined list of values from which you can choose multiple for a cell's value.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/MultiDropdownListColumn"
          },
          {
            "$ref": "#/components/schemas/ColumnPropsInvalidForCreateSheet"
          }
        ]
      },
      "ColumnSymbol": {
        "title": "Column symbol type",
        "type": "string",
        "description": "Specifies any type of symbol the column uses. For details and examples, see [Symbol Columns](/api/smartsheet/openapi/columns).\n",
        "enum": [
          "FLAG",
          "STAR",
          "HARVEY_BALLS",
          "PRIORITY",
          "RYG",
          "PRIORITY_HML",
          "DECISION_SYMBOLS",
          "DECISION_SHAPES",
          "VCR",
          "RYGB",
          "RYGG",
          "WEATHER",
          "PROGRESS",
          "ARROWS_3_WAY",
          "ARROWS_4_WAY",
          "ARROWS_5_WAY",
          "DIRECTIONS_3_WAY",
          "DIRECTIONS_4_WAY",
          "SKI",
          "SIGNAL",
          "STAR_RATING",
          "HEARTS",
          "MONEY",
          "EFFORT",
          "PAIN"
        ],
        "example": "STAR_RATING"
      },
      "SymbolColumn": {
        "title": "Symbol column",
        "type": "object",
        "description": "A column of predefined symbols from which you can choose for each cell.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "formula": {
                "type": "string",
                "description": "A formula that returns a string value that matches one of the symbol options exactly (for example, \"Red\", \"Yellow\", \"Green\").\n\nFor example: =[Literal Rating]@row\n",
                "example": ""
              },
              "options": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "An array of the options available to use in the column.\n\n**Note:** All applicable `options` values are set automatically when you specify the `symbol`.\n\n**Important:** You can't specify or update `options` at the same time you're specifying `symbol`. So leave it unspecified when you're creating a column or updating its `symbol`. If needed, you can update `options` in a separate call.\n",
                "example": []
              },
              "symbol": {
                "$ref": "#/components/schemas/ColumnSymbol"
              },
              "type": {
                "type": "string",
                "enum": [
                  "PICKLIST"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns)."
              },
              "validation": {
                "type": "boolean",
                "readOnly": true,
                "description": "If `true`, validation is enabled for the column values.",
                "example": false
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "SymbolColumnForCreateSheet": {
        "title": "Symbol column for sheet creation",
        "type": "object",
        "description": "This column provides a predefined list of symbols from which to choose for cells.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/SymbolColumn"
          },
          {
            "$ref": "#/components/schemas/ColumnPropsInvalidForCreateSheet"
          }
        ]
      },
      "TextNumberColumn": {
        "title": "Text/number column",
        "type": "object",
        "description": "A column of numeric values or text.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "formula": {
                "description": "The formula for the column, if set.\n\nFor example: =[Column A]@row + [Column B]@row\n",
                "type": "string",
                "example": ""
              },
              "primary": {
                "type": "boolean",
                "description": "If set to `true`, the column is the sheet's Primary Column. This property is returned only if the property is set to `true`.\n",
                "example": false
              },
              "tags": {
                "type": "array",
                "readOnly": true,
                "description": "This property is only present for *dependency-enabled project sheets.*\n\nFor details on Gantt view, refer to <a href=\"https://help.smartsheet.com/articles/765675-work-with-gantt-chart\" target=\"_blank\" rel=\"noopener noreferrer\">Create and work with a Gantt view</a>.\n",
                "example": [],
                "items": {
                  "type": "string",
                  "enum": [
                    "GANTT_DISPLAY_LABEL"
                  ]
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "TEXT_NUMBER"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns)."
              },
              "validation": {
                "type": "boolean",
                "readOnly": true,
                "example": false
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "TextNumberColumnForCreateSheet": {
        "title": "Text/number column for sheet creation",
        "type": "object",
        "description": "Column for numeric values or text.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/TextNumberColumn"
          },
          {
            "$ref": "#/components/schemas/ColumnPropsInvalidForCreateSheet"
          }
        ]
      },
      "ColumnToCreateASheet": {
        "title": "Column to create with sheet",
        "type": "object",
        "description": "When creating a sheet, a column can be one of the following types.\n",
        "allOf": [
          {
            "type": "object",
            "required": [
              "title",
              "type"
            ]
          },
          {
            "oneOf": [
              {
                "$ref": "#/components/schemas/AutoNumberColumnForCreateSheet"
              },
              {
                "$ref": "#/components/schemas/CheckboxColumnForCreateSheet"
              },
              {
                "$ref": "#/components/schemas/ContactListColumnForCreateSheet"
              },
              {
                "$ref": "#/components/schemas/CreatedByColumnForCreateSheet"
              },
              {
                "$ref": "#/components/schemas/CreatedDateColumnForCreateSheet"
              },
              {
                "$ref": "#/components/schemas/DateColumnForCreateSheet"
              },
              {
                "$ref": "#/components/schemas/DropdownListColumnForCreateSheet"
              },
              {
                "$ref": "#/components/schemas/ModifiedByColumnForCreateSheet"
              },
              {
                "$ref": "#/components/schemas/ModifiedDateColumnForCreateSheet"
              },
              {
                "$ref": "#/components/schemas/MultiContactListColumnForCreateSheet"
              },
              {
                "$ref": "#/components/schemas/MultiDropdownListColumnForCreateSheet"
              },
              {
                "$ref": "#/components/schemas/SymbolColumnForCreateSheet"
              },
              {
                "$ref": "#/components/schemas/TextNumberColumnForCreateSheet"
              }
            ]
          }
        ]
      },
      "SheetToCreate": {
        "title": "Sheet to create",
        "x-tags": [
          "sheets"
        ],
        "type": "object",
        "description": "An object that names the sheet to create and defines its initial columns.\n",
        "properties": {
          "columns": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ColumnToCreateASheet"
            }
          },
          "name": {
            "description": "Sheet name.",
            "type": "string"
          }
        }
      },
      "SheetToCreateFromTemplate": {
        "title": "Sheet to create from template",
        "type": "object",
        "description": "Sheet to create from template.",
        "properties": {
          "fromId": {
            "description": "Template ID from which to create the sheet.",
            "type": "number"
          },
          "name": {
            "description": "Sheet name.",
            "type": "string"
          }
        }
      },
      "AbstractDatetimeColumn": {
        "title": "Abstract datetime column",
        "type": "object",
        "description": "Column for datetime values in dependency-enabled project sheets.\n\n> **Important:** For the column to represent Gantt or baseline start/end dates, the project sheet must have dependencies enabled. Workload tracking requires connection to the Resource Management product.\n>\n> For details on dependency-enabled projects and Gantt view, refer to <a href=\"https://help.smartsheet.com/articles/765727-enabling-dependencies-using-predecessors\" target=\"_blank\" rel=\"noopener noreferrer\">Activate dependencies and use predecessors in grid and Gantt view</a>.\n>\n> For details on baselines, refer to <a href=\"https://help.smartsheet.com/articles/2482093-baselines\" target=\"_blank\" rel=\"noopener noreferrer\">Set baselines on a sheet</a>.\n>\n> For details on workload tracking and Resource Management, see <a href=\"https://help.smartsheet.com/articles/2483101-workload-tracking-in-smartsheet\" target=\"_blank\" rel=\"noopener noreferrer\">Workload tracking in Smartsheet</a>.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "formula": {
                "description": "The formula for the column, if set.\n\nFor example: =TODAY(-1)\n",
                "type": "string",
                "example": ""
              },
              "tags": {
                "type": "array",
                "readOnly": true,
                "description": "This property is only present for dependency-enabled project sheets. It indicates what the date represents in terms of the dependency-enabled project.\n",
                "example": [],
                "items": {
                  "type": "string",
                  "enum": [
                    "GANTT_START_DATE",
                    "GANTT_END_DATE",
                    "BASELINE_START_DATE",
                    "BASELINE_END_DATE",
                    "CALENDAR_START_DATE",
                    "CALENDAR_END_DATE"
                  ]
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "ABSTRACT_DATETIME"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns).",
                "example": "ABSTRACT_DATETIME"
              },
              "validation": {
                "type": "boolean",
                "readOnly": true,
                "description": "If `true`, validation is enabled for the column values.",
                "example": false
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "DurationColumn": {
        "title": "Duration column",
        "type": "object",
        "description": "Cell values in a duration column represent the amount of working time between the current row's start time and its end time.\n\n> **Important:** The API doesn't support creating duration columns-you can only create them in the web application. \n> \n> Note, duration columns are for *dependency-enabled project sheets only*.\n>\n> For details on baselines, refer to <a href=\"https://help.smartsheet.com/articles/2482093-baselines\" target=\"_blank\" rel=\"noopener noreferrer\">Set baselines on a sheet</a>.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "tags": {
                "type": "array",
                "readOnly": true,
                "items": {
                  "type": "string",
                  "enum": [
                    "GANTT_DURATION",
                    "BASELINE_VARIANCE"
                  ],
                  "example": "GANTT_DURATION"
                },
                "description": "This property is only present in dependency-enabled project sheets. It indicates what the duration represents in terms of the dependency-enabled project.\n"
              },
              "type": {
                "type": "string",
                "enum": [
                  "DURATION"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns)."
              },
              "validation": {
                "type": "boolean",
                "readOnly": true,
                "description": "If `true`, validation is enabled for the column values.",
                "example": false
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "PercentCompleteColumn": {
        "title": "Percent complete column",
        "type": "object",
        "description": "This column tracks each row's progress in terms of percentage complete.\n- general description\n\n> **Important:** This column type is for *dependency-enabled project sheets only*.\n>\n> For details on dependency-enabled projects and Gantt view, refer to <a href=\"https://help.smartsheet.com/articles/765727-enabling-dependencies-using-predecessors\" target=\"_blank\" rel=\"noopener noreferrer\">Activate dependencies and use predecessors in grid and Gantt view</a>.\n>\n> For details on baselines, refer to <a href=\"https://help.smartsheet.com/articles/2482093-baselines\" target=\"_blank\" rel=\"noopener noreferrer\">Set baselines on a sheet</a>.\n>\n> For details on workload tracking and Resource Management, see <a href=\"https://help.smartsheet.com/articles/2483101-workload-tracking-in-smartsheet\" target=\"_blank\" rel=\"noopener noreferrer\">Workload tracking in Smartsheet</a>.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "tags": {
                "type": "array",
                "readOnly": true,
                "description": "This property is only present for dependency-enabled project sheets.\n\nFor details on Gantt view, refer to <a href=\"https://help.smartsheet.com/articles/765675-work-with-gantt-chart\" target=\"_blank\" rel=\"noopener noreferrer\">Create and work with a Gantt view</a>.\n\nFor details on workload tracking and Resource Management, see <a href=\"https://help.smartsheet.com/articles/2483101-workload-tracking-in-smartsheet\" target=\"_blank\" rel=\"noopener noreferrer\">Workload tracking in Smartsheet</a>.\n",
                "example": [
                  "GANTT_PERCENT_COMPLETE"
                ],
                "items": {
                  "type": "string",
                  "enum": [
                    "GANTT_PERCENT_COMPLETE"
                  ]
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "TEXT_NUMBER"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns)."
              },
              "validation": {
                "type": "boolean",
                "description": "If `true`, validation is enabled for the column values.",
                "example": true
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "PredecessorColumn": {
        "title": "Predecessor column",
        "type": "object",
        "description": "This column specifies zero or more rows on which the current row depends. \n\n> **Important:** This column type is for *dependency-enabled project sheets only*.\n>\n> For details on dependency-enabled projects and Gantt view, refer to <a href=\"https://help.smartsheet.com/articles/765727-enabling-dependencies-using-predecessors\" target=\"_blank\" rel=\"noopener noreferrer\">Activate dependencies and use predecessors in grid and Gantt view</a>.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "tags": {
                "type": "array",
                "readOnly": true,
                "items": {
                  "type": "string",
                  "enum": [
                    "GANTT_PREDECESSOR"
                  ],
                  "example": "GANTT_PREDECESSOR"
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "PREDECESSOR"
                ],
                "example": "PREDECESSOR",
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns)."
              },
              "validation": {
                "type": "boolean",
                "readOnly": true,
                "description": "If `true`, validation is enabled for the column values.",
                "example": false
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "RMAssignedResourceContactColumn": {
        "title": "Assigned resource contact column",
        "type": "object",
        "description": "This column provides a predefined list of contacts from which you can choose a task's assigned resource.\n\n> **Important:** This column type is only for *dependency-enabled project sheets that use Resource Management*.\n>\n> For details on workload tracking and Resource Management, see <a href=\"https://help.smartsheet.com/articles/2483101-workload-tracking-in-smartsheet\" target=\"_blank\" rel=\"noopener noreferrer\">Workload tracking in Smartsheet</a>.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "options": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "An array of contacts available to use in the column. A cell value in this column can contain one contact.",
                "example": [
                  "jane.doe@smartsheet.com",
                  "firstname.lastname@smartsheet.com"
                ]
              },
              "tags": {
                "type": "array",
                "readOnly": true,
                "example": [],
                "description": "This property is only present for dependency-enabled project sheets.\n",
                "items": {
                  "type": "string",
                  "enum": [
                    "GANTT_ASSIGNED_RESOURCE"
                  ]
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "CONTACT_LIST"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns)."
              },
              "validation": {
                "type": "boolean",
                "description": "If `true`, validation is enabled for the column values.",
                "example": true
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "RMAssignedResourceTextColumn": {
        "title": "Assigned resource text column",
        "type": "object",
        "description": "This column represents a resource assigned to each task (row).\n\n> **Important:** This column type is only for *dependency-enabled project sheets that use Resource Management*.\n>\n> For details on workload tracking and Resource Management, see <a href=\"https://help.smartsheet.com/articles/2483101-workload-tracking-in-smartsheet\" target=\"_blank\" rel=\"noopener noreferrer\">Workload tracking in Smartsheet</a>.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "primary": {
                "type": "boolean",
                "description": "Returned only if the column is the Primary Column (value = **true**).",
                "example": false
              },
              "tags": {
                "type": "array",
                "readOnly": true,
                "example": [],
                "description": "This property is only present for dependency-enabled project sheets.\n",
                "items": {
                  "type": "string",
                  "enum": [
                    "GANTT_ASSIGNED_RESOURCE"
                  ]
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "TEXT_NUMBER"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns)."
              },
              "validation": {
                "type": "boolean",
                "description": "If `true`, validation is enabled for the column values.",
                "example": true
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "RMPercentAllocationColumn": {
        "title": "Percent allocation column",
        "type": "object",
        "description": "This column specifies how much of a person's (or placeholder's) time can be allotted to a project assignment (task).\n\n> **Important:** This column type is only for *dependency-enabled project sheets that use Resource Management*.\n>\n> For details on workload tracking and Resource Management, see <a href=\"https://help.smartsheet.com/articles/2483101-workload-tracking-in-smartsheet\" target=\"_blank\" rel=\"noopener noreferrer\">Workload tracking in Smartsheet</a>.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/ColumnBase"
          },
          {
            "type": "object",
            "properties": {
              "tags": {
                "type": "array",
                "readOnly": true,
                "description": "This property is only present for dependency-enabled project sheets.\n\nFor details on Gantt view, refer to <a href=\"https://help.smartsheet.com/articles/765675-work-with-gantt-chart\" target=\"_blank\" rel=\"noopener noreferrer\">Create and work with a Gantt view</a>.\n\nFor details on workload tracking and Resource Management, see <a href=\"https://help.smartsheet.com/articles/2483101-workload-tracking-in-smartsheet\" target=\"_blank\" rel=\"noopener noreferrer\">Workload tracking in Smartsheet</a>.\n",
                "example": [
                  "GANTT_ALLOCATION"
                ],
                "items": {
                  "type": "string",
                  "enum": [
                    "GANTT_ALLOCATION"
                  ]
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "TEXT_NUMBER"
                ],
                "description": "The column's type. See [Column Types](/api/smartsheet/openapi/columns)."
              },
              "validation": {
                "type": "boolean",
                "description": "If `true`, validation is enabled for the column values.",
                "example": true
              },
              "version": {
                "type": "number",
                "enum": [
                  0
                ],
                "readOnly": true,
                "description": "The column's compatibility level.\n\nFor details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility).\n",
                "example": 0
              }
            }
          }
        ]
      },
      "SheetCreated": {
        "title": "Sheet created",
        "type": "object",
        "description": "Sheet created from scratch using the specified columns.",
        "properties": {
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "columns": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Column"
            }
          },
          "id": {
            "description": "Sheet ID.",
            "type": "number"
          },
          "name": {
            "description": "Sheet name.",
            "type": "string"
          },
          "permalink": {
            "description": "URL that represents a direct link to the sheet in Smartsheet.",
            "type": "string"
          }
        }
      },
      "SheetCreatedFromTemplate": {
        "title": "Sheet created from template",
        "type": "object",
        "description": "Sheet created from template.",
        "properties": {
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "id": {
            "description": "Sheet ID.",
            "type": "number"
          },
          "name": {
            "description": "Sheet name.",
            "type": "string"
          },
          "permalink": {
            "description": "URL that represents a direct link to the sheet in Smartsheet.",
            "type": "string"
          }
        }
      },
      "SheetImported": {
        "title": "Sheet imported",
        "type": "object",
        "description": "Sheet imported from CSV / XLSX file.",
        "properties": {
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "id": {
            "description": "Sheet ID.",
            "type": "number"
          },
          "name": {
            "description": "Sheet name.",
            "type": "string"
          },
          "type": {
            "description": "Container type. Has 'sheet' value for the imported sheet.",
            "type": "string"
          },
          "permalink": {
            "description": "URL that represents a direct link to the sheet in Smartsheet.",
            "type": "string"
          }
        }
      },
      "AbstractReportColumnIdentifier": {
        "type": "object",
        "required": [
          "type"
        ],
        "properties": {
          "title": {
            "type": "string",
            "description": "Title of a column to match.\n\n**Note:** If you specified `primary=true` to match primary columns, you can set the resulting report column title to this value.\n"
          },
          "type": {
            "type": "string",
            "enum": [
              "CHECKBOX",
              "DATE",
              "DATETIME",
              "DURATION",
              "CONTACT_LIST",
              "MULTI_CONTACT_LIST",
              "PICKLIST",
              "MULTI_PICKLIST",
              "PREDECESSOR",
              "TEXT_NUMBER"
            ],
            "description": "Type of column to match. See [Column Types](/api/smartsheet/openapi/columns).",
            "example": "PICKLIST"
          },
          "systemColumnType": {
            "type": "string",
            "enum": [
              "CREATED_BY",
              "CREATED_DATE",
              "MODIFIED_BY",
              "MODIFIED_DATE",
              "AUTO_NUMBER"
            ],
            "description": "System column type to match. See [System Columns](/api/smartsheet/openapi/columns).",
            "example": "CREATED_BY"
          },
          "sheetNameColumn": {
            "description": "Set this to `true` to match the special \"Sheet Name\" report column.",
            "type": "boolean",
            "default": false
          }
        }
      },
      "ReportColumnAttributes": {
        "type": "object",
        "properties": {
          "virtualId": {
            "description": "The virtual ID of this report column.",
            "type": "integer",
            "format": "int64",
            "minimum": 1,
            "readOnly": true
          },
          "index": {
            "type": "integer",
            "format": "int32",
            "minimum": 0,
            "description": "Column index or position. This number is zero-based. Indicates the position of the column in the generated report."
          },
          "hidden": {
            "type": "boolean",
            "description": "Indicates whether the column is hidden."
          },
          "version": {
            "type": "integer",
            "readOnly": true,
            "enum": [
              0,
              1,
              2
            ],
            "description": "* `0`: CONTACT_LIST, PICKLIST, or TEXT_NUMBER.\n* `1`: MULTI_CONTACT_LIST.\n* `2`: MULTI_PICKLIST.\n"
          },
          "width": {
            "type": "integer",
            "format": "int32",
            "minimum": 1,
            "description": "Display width of the column in pixels."
          },
          "validation": {
            "type": "boolean",
            "readOnly": true,
            "description": "Indicates whether validation has been enabled for the column (value = **true**)."
          },
          "autoNumberFormat": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AutoNumberFormat"
              },
              {
                "readOnly": true
              }
            ]
          }
        }
      },
      "AbstractDatetimeObjectValue": {
        "title": "Abstract datetime object value",
        "description": "Object representing a calculated datetime",
        "type": "object",
        "properties": {
          "objectType": {
            "type": "string",
            "enum": [
              "ABSTRACT_DATETIME"
            ]
          },
          "value": {
            "description": "Datetime, in the **date-time** format defined by <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\" target=\"_blank\" rel=\"noopener noreferrer\">RFC 3339, section 5.6</a>",
            "type": "string",
            "format": "date-time"
          }
        },
        "example": {
          "objectType": "ABSTRACT_DATETIME",
          "value": "2025-03-03T16:59:59"
        }
      },
      "ContactObjectValue": {
        "title": "Contact object value",
        "description": "Object containing a Contact",
        "type": "object",
        "properties": {
          "objectType": {
            "type": "string",
            "enum": [
              "CONTACT"
            ],
            "example": "CONTACT"
          },
          "email": {
            "description": "Email address of the Contact",
            "type": "string",
            "format": "email",
            "example": "john.doe@acme.com"
          },
          "name": {
            "description": "Name of the Contact",
            "type": "string",
            "example": "John Doe"
          },
          "imageId": {
            "description": "ID of an image associated with the Contact",
            "type": "string",
            "example": "1234!_qwer!_5667zxcvQWER!_ASDF"
          },
          "emailId": {
            "description": "ID of the email address",
            "type": "string",
            "example": "23456789"
          },
          "userId": {
            "description": "User ID of the contact",
            "type": "string",
            "example": "12345678"
          },
          "lookUpName": {
            "description": "Whether or not to look up the contact's name based on their email address.",
            "type": "boolean",
            "example": true
          }
        }
      },
      "DateObjectValue": {
        "title": "Date object value",
        "description": "Object representing a date",
        "type": "object",
        "properties": {
          "objectType": {
            "type": "string",
            "enum": [
              "DATE"
            ]
          },
          "value": {
            "description": "Date in the **full-date** format defined by <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\" target=\"_blank\" rel=\"noopener noreferrer\">RFC 3339, section 5.6</a>\n",
            "type": "string",
            "format": "date"
          }
        },
        "example": {
          "objectType": "DATE",
          "value": "2025-01-14"
        }
      },
      "DatetimeObjectValue": {
        "title": "Datetime object value",
        "description": "Object representing a datetime",
        "type": "object",
        "properties": {
          "objectType": {
            "type": "string",
            "enum": [
              "DATETIME"
            ]
          },
          "value": {
            "description": "Datetime, in the **date-time** format defined by <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\" target=\"_blank\" rel=\"noopener noreferrer\">RFC 3339, section 5.6</a>",
            "type": "string",
            "format": "date-time"
          }
        },
        "example": {
          "objectType": "DATETIME",
          "value": "2025-03-03T16:59:59"
        }
      },
      "DurationObjectValue": {
        "title": "Duration object value",
        "description": "Object representing a duration in days",
        "type": "object",
        "properties": {
          "objectType": {
            "type": "string",
            "enum": [
              "DURATION"
            ]
          },
          "days": {
            "description": "Number of days",
            "type": "number",
            "format": "float"
          }
        },
        "example": {
          "objectType": "DURATION",
          "days": 29
        }
      },
      "MultiContactObjectValue": {
        "title": "Multi-contact object value",
        "description": "Object containing a list of contacts",
        "type": "object",
        "properties": {
          "objectType": {
            "type": "string",
            "enum": [
              "MULTI_CONTACT"
            ],
            "example": "MULTI_CONTACT"
          },
          "value": {
            "description": "List of Contacts",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ContactObjectValue"
            }
          }
        },
        "example": {
          "objectType": "MULTI_CONTACT",
          "value": [
            {
              "objectType": "CONTACT",
              "email": "john.doe@acme.com",
              "name": "John Doe",
              "imageId": "1234!_qwer!_5667zxcvQWER!_ASDF"
            }
          ]
        }
      },
      "MultiPicklistObjectValue": {
        "title": "Multi-picklist object value",
        "description": "Object containing a list of strings to choose from",
        "type": "object",
        "properties": {
          "objectType": {
            "type": "string",
            "enum": [
              "MULTI_PICKLIST"
            ]
          },
          "values": {
            "description": "List of strings to choose from",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "example": {
          "objectType": "MULTI_PICKLIST",
          "values": [
            "foo bar",
            "baz biff"
          ]
        }
      },
      "WorkspaceListing": {
        "title": "Workspace listing",
        "type": "object",
        "properties": {
          "id": {
            "description": "Workspace ID.",
            "type": "number"
          },
          "name": {
            "description": "Workspace name.",
            "type": "string"
          },
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "permalink": {
            "description": "URL that represents a direct link to the workspace in Smartsheet.",
            "type": "string"
          }
        }
      },
      "SightName": {
        "title": "Sight name",
        "type": "object",
        "properties": {
          "name": {
            "description": "Dashboard name.",
            "type": "string"
          }
        }
      },
      "SightResult": {
        "title": "Sight result",
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/SightName"
          }
        ],
        "properties": {
          "id": {
            "description": "Dashboard ID.",
            "type": "number",
            "readOnly": true
          },
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "permalink": {
            "description": "URL that represents a direct link to the dashboard in Smartsheet.",
            "type": "string",
            "readOnly": true
          }
        }
      },
      "SightListItem": {
        "title": "Sight list item",
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/SightResult"
          }
        ],
        "properties": {
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp"
          }
        }
      },
      "ChartColumnInfo": {
        "title": "Chart column type",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "ABSTRACT_DATE_TIME",
              "CHECKBOX",
              "CONTACT_LIST",
              "DATE",
              "DATE_TIME",
              "DURATION",
              "MULTI_CONTACT_LIST",
              "MULTI_PICKLIST",
              "PICKLIST",
              "PREDECESSOR",
              "TEXT_NUMBER"
            ]
          }
        }
      },
      "DashboardFont": {
        "title": "Dashboard font",
        "description": "List of supported fonts in Dashboards",
        "type": "string",
        "enum": [
          "Arial",
          "Courier",
          "Georgia",
          "Gill Sans",
          "Helvetica",
          "Luminari",
          "Monaco",
          "Tahoma",
          "Times New Roman",
          "Verdana"
        ]
      },
      "Axes": {
        "title": "Axes",
        "type": "object",
        "properties": {
          "location": {
            "description": "Describes location of the axis.",
            "type": "string",
            "enum": [
              "BOTTOM",
              "LEFT",
              "NONE",
              "RIGHT",
              "TOP"
            ]
          },
          "title": {
            "description": "Axis title.",
            "type": "string"
          },
          "titleInfo": {
            "$ref": "#/components/schemas/ChartColumnInfo"
          },
          "axisTitleFont": {
            "$ref": "#/components/schemas/DashboardFont"
          },
          "axisLabelFormat": {
            "description": "Describes the axis format (see [Formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)).",
            "type": "string",
            "example": ",,,,,,,,36,,,,,,,,"
          },
          "axisLabelFont": {
            "$ref": "#/components/schemas/DashboardFont"
          },
          "includeZero": {
            "description": "Includes 0 in the axis.",
            "type": "boolean"
          }
        }
      },
      "Legend": {
        "title": "Legend",
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "enum": [
              "BOTTOM",
              "LEFT",
              "NONE",
              "RIGHT",
              "TOP"
            ]
          },
          "legendFormat": {
            "type": "string",
            "description": "The format descriptor (see [Formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). Only returned if the legend has a non-default format applied to it.",
            "example": ",,1,1,,,,,,,,,,,,,"
          },
          "legendFont": {
            "$ref": "#/components/schemas/DashboardFont"
          }
        }
      },
      "WidgetChartDataLabel": {
        "title": "Chart data label",
        "type": "object",
        "properties": {
          "labelType": {
            "type": "string",
            "enum": [
              "NONE",
              "PERCENT",
              "VALUE"
            ]
          }
        }
      },
      "ChartTooltipStyle": {
        "title": "Chart tooltip label type",
        "type": "object",
        "properties": {
          "labelType": {
            "type": "string",
            "enum": [
              "NONE",
              "PERCENT",
              "X_SERIES_Y",
              "X_Y_PERCENT",
              "Y",
              "Y_PERCENT"
            ]
          }
        }
      },
      "SeriesData": {
        "title": "Series data",
        "type": "object",
        "properties": {
          "x": {
            "type": "number"
          },
          "y": {
            "type": "number"
          },
          "xFormat": {
            "type": "string",
            "description": "The format descriptor (see [Formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). Only returned if the series has a non-default format applied to it.",
            "example": ",,1,1,,,,,,,,,,,,,"
          },
          "yFormat": {
            "type": "string",
            "description": "The format descriptor (see [Formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). Only returned if the series has a non-default format applied to it.",
            "example": ",,1,1,,,,,,,,,,,,,"
          },
          "color": {
            "type": "string"
          }
        }
      },
      "Series": {
        "title": "Series",
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "titleInfo": {
            "$ref": "#/components/schemas/ChartColumnInfo"
          },
          "seriesTitleFormat": {
            "type": "string",
            "description": "Series title format (see [Formatting](/api/smartsheet/guides/advanced-topics/cell-formatting))."
          },
          "seriesType": {
            "type": "string",
            "enum": [
              "AREA",
              "BAR",
              "COLUMN",
              "LINE",
              "PIE",
              "SCATTER"
            ]
          },
          "dataLabels": {
            "$ref": "#/components/schemas/WidgetChartDataLabel"
          },
          "tooltips": {
            "$ref": "#/components/schemas/ChartTooltipStyle"
          },
          "lineType": {
            "type": "string",
            "enum": [
              "CURVED",
              "STEPPED",
              "STRAIGHT"
            ]
          },
          "holeSize": {
            "type": "number"
          },
          "isFilled": {
            "type": "boolean"
          },
          "isHalf": {
            "type": "boolean"
          },
          "isStacked": {
            "type": "boolean"
          },
          "xFormat": {
            "type": "string",
            "description": "The format descriptor (see [Formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). Only returned if the series has a non-default format applied to it.",
            "example": ",,1,1,,,,,,,,,,,,,"
          },
          "yFormat": {
            "type": "string",
            "description": "The format descriptor (see [Formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). Only returned if the series has a non-default format applied to it.",
            "example": ",,1,1,,,,,,,,,,,,,"
          },
          "color": {
            "type": "string"
          },
          "axisLocationX": {
            "type": "string",
            "enum": [
              "BOTTOM",
              "LEFT",
              "NONE",
              "RIGHT",
              "TOP"
            ]
          },
          "axisLocationY": {
            "type": "string",
            "enum": [
              "BOTTOM",
              "LEFT",
              "NONE",
              "RIGHT",
              "TOP"
            ]
          },
          "yColumnInfo": {
            "$ref": "#/components/schemas/ChartColumnInfo"
          },
          "xColumnInfo": {
            "$ref": "#/components/schemas/ChartColumnInfo"
          },
          "seriesSelectionOrder": {
            "type": "string",
            "enum": [
              "COLUMNS",
              "ROWS"
            ]
          },
          "seriesData": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SeriesData"
            }
          },
          "selectionRanges": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SelectionRange"
            }
          }
        }
      },
      "WidgetChartGridLine": {
        "title": "Chart grid line",
        "type": "object",
        "properties": {
          "lineStyle": {
            "type": "string",
            "enum": [
              "SOLID"
            ]
          }
        }
      },
      "ReportScope": {
        "type": "object",
        "title": "Report scope object",
        "description": "An object representing a sheet or workspace with ties to a report's scope.\n",
        "required": [
          "assetType",
          "assetId"
        ],
        "properties": {
          "assetType": {
            "description": "The asset's type.",
            "type": "string",
            "enum": [
              "sheet",
              "workspace"
            ]
          },
          "assetId": {
            "type": "integer",
            "format": "int64",
            "description": "The ID of the asset according to its `assetType`.",
            "minimum": 1
          }
        }
      },
      "ReportFilterExpression": {
        "type": "object",
        "description": "An expression to filter on report columns. It is a recursive object that allows at most three levels.\n\nIt must include `operator` and at least one of the following: `criteria` or `nestedCriteria`\n\nHere is a two-level example:\n\n```json\n{\n  \"operator\": \"OR\",\n  \"nestedCriteria\": [\n    {\n      \"operator\": \"AND\",\n      \"criteria\": [\n        {\n          \"column\": { \"title\": \"Price\", \"type\": \"TEXT_NUMBER\" },\n          \"operator\": \"GREATER_THAN\",\n          \"values\": [\"11\"]\n        },\n        {\n          \"column\": { \"primary\": true },\n          \"operator\": \"CONTAINS\",\n          \"values\": [\"PROJ-1\"]\n        }\n      ]\n    },\n    {\n      \"operator\": \"AND\",\n      \"criteria\": [\n        {\n          \"column\": { \"title\": \"Quantity\", \"type\": \"TEXT_NUMBER\" },\n          \"operator\": \"LESS_THAN\",\n          \"values\": [\"12\"]\n        },\n        {\n          \"column\": { \"title\": \"Sold Out\", \"type\": \"CHECKBOX\" },\n          \"operator\": \"IS_CHECKED\"\n        }\n      ]\n    }\n  ]\n}\n```\n\nIt's equivalent to the following pseudo logic:\n\n```\n(\"Price\" > 11 AND \"Primary\" CONTAINS \"PROJ-1\")\nOR\n(\"Quantity\" < 12 AND \"Sold Out\" IS_CHECKED)\n```\n",
        "required": [
          "operator"
        ],
        "properties": {
          "operator": {
            "type": "string",
            "description": "The boolean operator to apply to the list of `criteria` and `nestedCriteria`.",
            "enum": [
              "AND",
              "OR"
            ]
          },
          "nestedCriteria": {
            "type": "array",
            "description": "A recursive list of report filter expressions. Each item is joined to the filter expression with the AND/OR operator defined on this level.",
            "items": {
              "$ref": "#/components/schemas/ReportFilterExpression"
            }
          },
          "criteria": {
            "type": "array",
            "description": "Criteria objects specifying custom criteria against which to match cell values. Each item is joined to the filter expression with the AND/OR operator defined on this level.",
            "items": {
              "type": "object",
              "required": [
                "column",
                "operator"
              ],
              "properties": {
                "column": {
                  "$ref": "#/components/schemas/ReportColumnIdentifierVariants"
                },
                "operator": {
                  "type": "string",
                  "description": "Condition operator.",
                  "enum": [
                    "EQUAL",
                    "NOT_EQUAL",
                    "GREATER_THAN",
                    "LESS_THAN",
                    "CONTAINS",
                    "BETWEEN",
                    "TODAY",
                    "PAST",
                    "FUTURE",
                    "LAST_N_DAYS",
                    "NEXT_N_DAYS",
                    "IS_BLANK",
                    "IS_NOT_BLANK",
                    "IS_NUMBER",
                    "IS_NOT_NUMBER",
                    "IS_DATE",
                    "IS_NOT_DATE",
                    "IS_CHECKED",
                    "IS_UNCHECKED",
                    "IS_ONE_OF",
                    "IS_NOT_ONE_OF",
                    "LESS_THAN_OR_EQUAL",
                    "GREATER_THAN_OR_EQUAL",
                    "DOES_NOT_CONTAIN",
                    "NOT_BETWEEN",
                    "NOT_TODAY",
                    "NOT_PAST",
                    "NOT_FUTURE",
                    "NOT_LAST_N_DAYS",
                    "NOT_NEXT_N_DAYS",
                    "HAS_ANY_OF",
                    "HAS_NONE_OF",
                    "HAS_ALL_OF",
                    "NOT_ALL_OF",
                    "MULTI_IS_EQUAL",
                    "MULTI_IS_NOT_EQUAL"
                  ]
                },
                "values": {
                  "description": "List of filter values.",
                  "type": "array",
                  "items": {
                    "oneOf": [
                      {
                        "type": "string",
                        "nullable": true
                      },
                      {
                        "type": "number"
                      },
                      {
                        "$ref": "#/components/schemas/DateObjectValue"
                      },
                      {
                        "$ref": "#/components/schemas/CurrentUserObjectValue"
                      }
                    ]
                  }
                }
              }
            }
          }
        }
      },
      "ReportColumnIdentifierVariants": {
        "type": "object",
        "description": "An object for matching a source sheet column for a report. It requires one of:\n\n- [`type`, `title`] for **regular columns**\n- [`type`, `systemColumnType`] for **system columns**\n- [`type=TEXT_NUMBER`, `primary=true`] for the **primary column**\n- [`type=TEXT_NUMBER`, `sheetNameColumn=true`] for the special **sheet name report column**\n\n**Note:** You can combine multiple `CHECKBOX` columns or multiple `PICKLIST` columns from different sheets into a single report column, even if their underlying symbols differ. However, you can't combine a `CHECKBOX` column with a `PICKLIST` column, because they're different types.\n\n**Note:** The system column type `AUTO_NUMBER` is matched together with columns having the same `title` and `type=TEXT_NUMBER`. Therefore, `title` is a required property in this case.\n",
        "anyOf": [
          {
            "type": "object",
            "title": "Regular report column",
            "required": [
              "title",
              "type"
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/ReportColumnIdentifier"
              }
            ]
          },
          {
            "type": "object",
            "title": "System report column",
            "required": [
              "type",
              "systemColumnType"
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/ReportColumnIdentifier"
              }
            ]
          },
          {
            "type": "object",
            "title": "Primary report column",
            "required": [
              "type",
              "primary"
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/ReportColumnIdentifier"
              }
            ]
          },
          {
            "type": "object",
            "title": "Sheet name report column",
            "required": [
              "type",
              "sheetNameColumn"
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/ReportColumnIdentifier"
              }
            ]
          }
        ]
      },
      "CurrentUserObjectValue": {
        "title": "Current user object value",
        "description": "Object representing the current user filter",
        "type": "object",
        "required": [
          "objectType"
        ],
        "properties": {
          "objectType": {
            "type": "string",
            "enum": [
              "CURRENT_USER"
            ]
          }
        }
      },
      "ReportGroupingCriterion": {
        "type": "object",
        "description": "Report grouping criterion.",
        "required": [
          "column",
          "sortingDirection"
        ],
        "properties": {
          "column": {
            "$ref": "#/components/schemas/ReportColumnIdentifierVariants"
          },
          "sortingDirection": {
            "type": "string",
            "description": "Sorting direction within the group.",
            "enum": [
              "ASCENDING",
              "DESCENDING"
            ]
          },
          "isExpanded": {
            "type": "boolean",
            "description": "Indicates whether the group is expanded in the UI.",
            "default": true
          }
        }
      },
      "ReportSummarizingCriterion": {
        "description": "Report summarizing criterion.",
        "type": "object",
        "required": [
          "column",
          "aggregationType"
        ],
        "properties": {
          "column": {
            "$ref": "#/components/schemas/ReportColumnIdentifierVariants"
          },
          "aggregationType": {
            "type": "string",
            "description": "Type of aggregation.",
            "enum": [
              "SUM",
              "AVG",
              "MIN",
              "MAX",
              "COUNT",
              "FIRST",
              "LAST"
            ]
          }
        }
      },
      "ReportSortingCriterion": {
        "description": "Report sorting criterion.",
        "type": "object",
        "required": [
          "column",
          "sortingDirection"
        ],
        "properties": {
          "column": {
            "$ref": "#/components/schemas/ReportColumnIdentifierVariants"
          },
          "sortingDirection": {
            "type": "string",
            "description": "Sorting direction.",
            "enum": [
              "ASCENDING",
              "DESCENDING"
            ]
          }
        }
      },
      "ReportDefinition": {
        "type": "object",
        "title": "Report definition",
        "x-tags": [
          "reports"
        ],
        "description": "The report definition contains `filters`, `grouping` and `sorting` properties of the report.\n\n**Note:** When groupingCriteria is defined the primary column of the report will move to the index 0 when it is first rendered by the app.\n",
        "properties": {
          "filters": {
            "$ref": "#/components/schemas/ReportFilterExpression"
          },
          "groupingCriteria": {
            "type": "array",
            "description": "List of report grouping criteria.",
            "items": {
              "$ref": "#/components/schemas/ReportGroupingCriterion"
            }
          },
          "summarizingCriteria": {
            "type": "array",
            "description": "List of report summarizing criteria.",
            "items": {
              "$ref": "#/components/schemas/ReportSummarizingCriterion"
            }
          },
          "sortingCriteria": {
            "type": "array",
            "description": "List of report sorting criteria.",
            "items": {
              "$ref": "#/components/schemas/ReportSortingCriterion"
            }
          }
        },
        "example": {
          "filters": {
            "operator": "AND",
            "criteria": [
              {
                "column": {
                  "title": "Primary Column",
                  "type": "TEXT_NUMBER",
                  "primary": true
                },
                "operator": "EQUAL",
                "values": [
                  "Test"
                ]
              }
            ]
          },
          "groupingCriteria": [
            {
              "column": {
                "title": "Primary Column",
                "type": "TEXT_NUMBER",
                "primary": true
              },
              "sortingDirection": "ASCENDING",
              "isExpanded": true
            }
          ],
          "summarizingCriteria": [
            {
              "column": {
                "title": "Primary Column",
                "type": "TEXT_NUMBER",
                "primary": true
              },
              "aggregationType": "COUNT"
            }
          ],
          "sortingCriteria": [
            {
              "column": {
                "title": "Primary Column",
                "type": "TEXT_NUMBER",
                "primary": true
              },
              "sortingDirection": "ASCENDING"
            }
          ]
        }
      },
      "ContainerDestinationForCreate": {
        "type": "object",
        "title": "Container destination for create",
        "properties": {
          "destinationId": {
            "description": "The ID of the destination container.\n",
            "type": "number"
          },
          "destinationType": {
            "description": "Type of destination container.\n",
            "type": "string",
            "enum": [
              "folder",
              "workspace"
            ]
          }
        },
        "required": [
          "destinationId",
          "destinationType"
        ]
      },
      "CreateReport": {
        "type": "object",
        "required": [
          "name",
          "scope",
          "columns",
          "destination"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 50,
            "minLength": 1,
            "description": "Report name."
          },
          "columns": {
            "type": "array",
            "minItems": 1,
            "maxItems": 400,
            "description": "List of columns to be included in the report.\n\n**Matching Columns:**\n\nThe source sheet columns are matched in these ways:\n\n- [`type`, `title`] for **regular columns**\n- [`type`, `systemColumnType`] for **system columns**\n- [`type=TEXT_NUMBER`, `primary=true`] for the **primary** column\n- [`type=TEXT_NUMBER`, `sheetNameColumn=true`] for the special **sheet name report column**\n\n**Note:** All indexes of the columns must be unique.\n\n**Note:** You can combine multiple `CHECKBOX` columns or multiple `PICKLIST` columns from different sheets into a single report column, even if their underlying symbols differ. However, you can't combine a `CHECKBOX` column with a `PICKLIST` column, because they're different types.\n\n**Note:** The system column type `AUTO_NUMBER` is matched together with columns having the same `title` and `type=TEXT_NUMBER`.\n\n**Note:** For row reports, exactly one column must have `primary=true` and it matches to the primary column of each source sheet.\n\n**Note:** For summary reports, exactly one of the columns must have a `sheetNameColumn=true`.\n",
            "items": {
              "$ref": "#/components/schemas/ReportColumn"
            }
          },
          "scope": {
            "type": "array",
            "description": "An array of objects representing sheets and/or workspaces for adding source sheets to the report.",
            "minItems": 1,
            "maxItems": 100,
            "items": {
              "$ref": "#/components/schemas/ReportScope"
            }
          },
          "reportDefinition": {
            "$ref": "#/components/schemas/ReportDefinition"
          },
          "isSummaryReport": {
            "type": "boolean",
            "default": false,
            "description": "It is `true` if the report is a sheet summary; otherwise it is a row report."
          },
          "destination": {
            "$ref": "#/components/schemas/ContainerDestinationForCreate"
          }
        },
        "example": {
          "name": "Report name",
          "destination": {
            "destinationId": 5678,
            "destinationType": "folder"
          },
          "columns": [
            {
              "title": "Primary column",
              "type": "TEXT_NUMBER",
              "primary": true,
              "index": 0
            },
            {
              "title": "Sheet name",
              "type": "TEXT_NUMBER",
              "sheetNameColumn": true,
              "index": 1
            },
            {
              "title": "Created at",
              "type": "DATETIME",
              "systemColumnType": "CREATED_DATE",
              "index": 2
            },
            {
              "title": "Selected item",
              "type": "PICKLIST",
              "index": 3
            }
          ],
          "scope": [
            {
              "assetType": "sheet",
              "assetId": 1234
            }
          ],
          "reportDefinition": {
            "filters": {
              "operator": "AND",
              "criteria": [
                {
                  "column": {
                    "type": "DATETIME",
                    "systemColumnType": "CREATED_DATE"
                  },
                  "operator": "GREATER_THAN",
                  "values": [
                    {
                      "objectType": "DATE",
                      "value": "2022-08-27"
                    }
                  ]
                }
              ]
            },
            "groupingCriteria": [
              {
                "column": {
                  "title": "Selected item",
                  "type": "PICKLIST"
                },
                "sortingDirection": "ASCENDING",
                "isExpanded": true
              }
            ],
            "summarizingCriteria": [
              {
                "column": {
                  "type": "TEXT_NUMBER",
                  "sheetNameColumn": true
                },
                "aggregationType": "COUNT"
              }
            ],
            "sortingCriteria": [
              {
                "column": {
                  "type": "DATETIME",
                  "systemColumnType": "CREATED_DATE"
                },
                "sortingDirection": "ASCENDING"
              }
            ]
          },
          "isSummaryReport": false
        }
      },
      "CreateReportResult": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "format": "int64",
            "description": "The report's unique identifier.",
            "example": 987654321
          },
          "name": {
            "type": "string",
            "description": "The report's name.",
            "example": "Q2 Earnings"
          },
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "permalink": {
            "type": "string",
            "description": "URL to the report in Smartsheet.",
            "example": "https://app.smartsheet.com/reports/c8gJxw87cXpRCvCC5PPw6jFhFRrf5r8PxCrxvW21"
          },
          "isSummaryReport": {
            "type": "boolean",
            "description": "It is `true` if the report is a sheet summary; otherwise it is a row report."
          },
          "columns": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReportColumn"
            }
          }
        }
      },
      "AddReportColumn": {
        "type": "object",
        "anyOf": [
          {
            "type": "object",
            "title": "Regular report column",
            "required": [
              "index",
              "title",
              "type"
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/AbstractReportColumnIdentifier"
              },
              {
                "$ref": "#/components/schemas/ReportColumnAttributes"
              }
            ]
          },
          {
            "type": "object",
            "title": "System report column",
            "required": [
              "index",
              "type",
              "systemColumnType"
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/AbstractReportColumnIdentifier"
              },
              {
                "$ref": "#/components/schemas/ReportColumnAttributes"
              }
            ]
          },
          {
            "type": "object",
            "title": "Sheet name report column",
            "required": [
              "index",
              "type",
              "sheetNameColumn"
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/AbstractReportColumnIdentifier"
              },
              {
                "$ref": "#/components/schemas/ReportColumnAttributes"
              }
            ]
          }
        ]
      },
      "Recipient_Individual": {
        "title": "Recipient individual",
        "type": "object",
        "description": "Specifies the recipient of an [Email](/api/smartsheet/openapi/schemas/email). The recipient may be either an individual or a group. To specify an individual, set the `email` attribute; to specify a group, set the `groupId` attribute. Either `email` and `groupId` may be set, but not both.\n",
        "properties": {
          "email": {
            "description": "The email address of an individual recipient.",
            "type": "string",
            "format": "email",
            "example": "john.doe@smartsheet.com"
          }
        }
      },
      "Recipient_Group": {
        "title": "Recipient group",
        "type": "object",
        "description": "Specifies the recipient of an [Email](/api/smartsheet/openapi/schemas/email). The recipient may be either an individual or a group. To specify an individual, set the `email` attribute; to specify a group, set the `groupId` attribute. Either **email** and `groupId` may be set, but not both.\n",
        "properties": {
          "groupId": {
            "description": "The ID of a group recipient.",
            "type": "number",
            "example": 2258118617917316
          }
        }
      },
      "ItemResult": {
        "title": "Item result",
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/GenericResult"
          }
        ],
        "properties": {
          "failedItems": {
            "description": "Array of BulkItemFailure objects which represents the items that failed to be added or updated. See [Bulk operations > Partial success](/api/smartsheet/guides/advanced-topics/scalability-options) for more information. Applicable only for bulk operations that support partial success.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BulkItemFailure"
            },
            "nullable": true
          }
        }
      },
      "PathFoldersOrReports": {
        "type": "object",
        "oneOf": [
          {
            "title": "Reports",
            "type": "object",
            "required": [
              "reports"
            ],
            "properties": {
              "reports": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "name",
                    "permalink",
                    "createdAt",
                    "modifiedAt",
                    "accessLevel"
                  ],
                  "properties": {
                    "id": {
                      "type": "integer",
                      "format": "int64",
                      "description": "Report ID.",
                      "example": 4509918431602564
                    },
                    "name": {
                      "type": "string",
                      "description": "Report name.",
                      "example": "Monthly Status Report"
                    },
                    "permalink": {
                      "type": "string",
                      "format": "uri",
                      "description": "URL that represents a direct link to the report in Smartsheet.",
                      "example": "https://api.smartsheet.com/reports/cpG82pf5v8FPrgFfJrFcrM56xCHVGhmV4P4xcQ71"
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time",
                      "example": "2023-01-15T12:34:56Z"
                    },
                    "modifiedAt": {
                      "type": "string",
                      "format": "date-time",
                      "example": "2023-02-20T08:22:33Z"
                    },
                    "accessLevel": {
                      "allOf": [
                        {
                          "$ref": "#/components/schemas/AccessLevel"
                        },
                        {
                          "description": "The access level of the user to the report."
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          {
            "title": "Folders",
            "type": "object",
            "required": [
              "folders"
            ],
            "properties": {
              "folders": {
                "type": "array",
                "description": "Array of a single folder on the path from the asset to its workspace.",
                "items": {
                  "allOf": [
                    {
                      "type": "object",
                      "required": [
                        "id",
                        "name"
                      ],
                      "properties": {
                        "id": {
                          "type": "integer",
                          "format": "int64",
                          "description": "Folder ID.",
                          "example": 1234567890123456
                        },
                        "name": {
                          "type": "string",
                          "description": "Folder name.",
                          "example": "Project Documents"
                        },
                        "permalink": {
                          "type": "string",
                          "format": "uri",
                          "description": "URL that represents a direct link to the folder in Smartsheet.",
                          "example": "https://api.smartsheet.com/folders/abcd1234efgh5678ijkl9012mnop3456"
                        }
                      }
                    },
                    {
                      "$ref": "#/components/schemas/PathFoldersOrReports"
                    }
                  ]
                }
              }
            }
          }
        ]
      },
      "PathReportResponse": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/PathWorkspace"
          },
          {
            "$ref": "#/components/schemas/PathFoldersOrReports"
          }
        ]
      },
      "SearchResultItemCoreAttributes": {
        "title": "Search result item core attributes",
        "type": "object",
        "properties": {
          "text": {
            "description": "Excerpt of the item's matching text.",
            "type": "string"
          },
          "objectType": {
            "description": "The matching item's type.",
            "type": "string",
            "enum": [
              "attachment",
              "sight",
              "discussion",
              "folder",
              "report",
              "row",
              "sheet",
              "summaryField",
              "template",
              "workspace"
            ],
            "example": "row"
          },
          "objectId": {
            "description": "The matching item's ID.",
            "type": "number",
            "example": 12345678
          },
          "contextData": {
            "description": "Additional information about the matching item. If the item has a discussion or attachment belonging to a proof, the context data includes the URL of that proof (for example, `\"proofUrl: https://app.smartsheet.com/b/proofs/sheets/abc123/proofs/def456\"`).\n",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "SearchResultSubItem": {
        "title": "Search result sub-item",
        "x-tags": [
          "search"
        ],
        "description": "Represents an item that matches the search query and is a sub-component of another item.\n\nFor example, a row is a sub-component of a sheet. Both are items that can match a search query.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/SearchResultItemCoreAttributes"
          },
          {
            "type": "object",
            "properties": {
              "parentObjectType": {
                "description": "The type of the item's parent.",
                "type": "string",
                "enum": [
                  "dashboard",
                  "folder",
                  "report",
                  "sheet",
                  "template",
                  "workspace"
                ],
                "example": "sheet"
              },
              "parentObjectId": {
                "description": "The ID of the item's parent.",
                "type": "number",
                "example": 23456789
              },
              "parentObjectName": {
                "description": "The name of the item's parent.",
                "type": "string"
              },
              "parentObjectFavorite": {
                "description": "`true` if the parent is one of the user's favorites.",
                "type": "boolean",
                "example": true
              }
            }
          }
        ]
      },
      "ShareResponse": {
        "title": "Share response",
        "x-tags": [
          "sharing"
        ],
        "type": "object",
        "required": [
          "id",
          "type",
          "accessLevel",
          "scope"
        ],
        "properties": {
          "id": {
            "description": "The ID of the share.\n",
            "type": "string",
            "example": "AAAMCmYGFOeE"
          },
          "email": {
            "description": "User's primary email address for user shares.",
            "type": "string",
            "example": "test.email@smartsheet.com"
          },
          "userId": {
            "description": "User ID if the share is a user share.",
            "type": "number",
            "example": 9876543210
          },
          "groupId": {
            "description": "Group ID if the share is a group share.",
            "type": "number",
            "example": 1234567890
          },
          "name": {
            "description": "If present, the name of the user or group to which the asset is shared.\n",
            "type": "string",
            "example": "Example Name"
          },
          "type": {
            "description": "The type of this share. One of the following values: GROUP or USER.\n",
            "type": "string",
            "example": "USER"
          },
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "scope": {
            "description": "The scope of this share. One of the following values:\n  * **ITEM**: an item-level share (that is, the specific object to which the share applies is shared with\n    the user or group).\n  * **WORKSPACE**: a workspace-level share (that is, the workspace that contains the asset to which the\n    share applies is shared with the user or group).\n",
            "type": "string",
            "enum": [
              "ITEM",
              "WORKSPACE"
            ]
          }
        }
      },
      "CreateShareRequest": {
        "title": "Create share request",
        "type": "object",
        "required": [
          "accessLevel"
        ],
        "x-tags": [
          "sharing"
        ],
        "properties": {
          "email": {
            "description": "The primary email address of a user to share to. Must be provided if `groupId` is not provided.",
            "type": "string",
            "example": "test.email@smartsheet.com"
          },
          "groupId": {
            "description": "The ID of the group to share to. Must be provided if `email` is not provided.",
            "type": "number",
            "example": 1234567890
          },
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "subject": {
            "description": "The subject of the email that is optionally sent to notify the recipient.\n\nMust set the `sendEmail` query parameter to **true** for this parameter to take effect.\n",
            "type": "string"
          },
          "message": {
            "description": "The message included in the body of the email that is optionally sent to the recipient.\n\nMust set the `sendEmail` query parameter to **true** for this parameter to take effect.\n",
            "type": "string"
          },
          "ccMe": {
            "description": "Indicates whether to send a copy of the email to the sharer of the sheet.\n\nMust set the `sendEmail` query parameter to **true** for this parameter to take effect.\n",
            "type": "boolean"
          }
        }
      },
      "UpdateShareRequest": {
        "title": "Update share request",
        "type": "object",
        "required": [
          "accessLevel"
        ],
        "x-tags": [
          "sharing"
        ],
        "properties": {
          "accessLevel": {
            "type": "string",
            "enum": [
              "ADMIN",
              "COMMENTER",
              "EDITOR",
              "EDITOR_SHARE",
              "VIEWER"
            ]
          }
        }
      },
      "schemas-Sheet": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Sheet ID.",
            "type": "number"
          },
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "name": {
            "description": "Sheet name.",
            "type": "string"
          },
          "permalink": {
            "description": "URL that represents a direct link to the sheet in Smartsheet.",
            "type": "string"
          },
          "version": {
            "description": "A number that is incremented every time a sheet is modified.",
            "type": "number"
          },
          "source": {
            "$ref": "#/components/schemas/Source"
          }
        }
      },
      "SheetVersion": {
        "title": "Sheet version",
        "type": "object",
        "properties": {
          "version": {
            "description": "A number that represents the current sheet version.",
            "type": "number"
          }
        }
      },
      "UpdateSheet": {
        "title": "Update sheet",
        "type": "object",
        "properties": {
          "name": {
            "description": "Sheet name.",
            "type": "string"
          },
          "projectSettings": {
            "$ref": "#/components/schemas/ProjectSettings"
          },
          "userSettings": {
            "$ref": "#/components/schemas/SheetUserSettings"
          }
        }
      },
      "ColumnCreateRequestObject": {
        "title": "Column create object",
        "type": "object",
        "description": "An object that defines attributes for creating a column of one of the following types.\n",
        "allOf": [
          {
            "type": "object",
            "required": [
              "index",
              "title",
              "type"
            ]
          },
          {
            "oneOf": [
              {
                "$ref": "#/components/schemas/AutoNumberColumn"
              },
              {
                "$ref": "#/components/schemas/CheckboxColumn"
              },
              {
                "$ref": "#/components/schemas/ContactListColumn"
              },
              {
                "$ref": "#/components/schemas/CreatedByColumn"
              },
              {
                "$ref": "#/components/schemas/CreatedDateColumn"
              },
              {
                "$ref": "#/components/schemas/DateColumn"
              },
              {
                "$ref": "#/components/schemas/DropdownListColumn"
              },
              {
                "$ref": "#/components/schemas/ModifiedByColumn"
              },
              {
                "$ref": "#/components/schemas/ModifiedDateColumn"
              },
              {
                "$ref": "#/components/schemas/MultiContactListColumn"
              },
              {
                "$ref": "#/components/schemas/MultiDropdownListColumn"
              },
              {
                "$ref": "#/components/schemas/SymbolColumn"
              },
              {
                "$ref": "#/components/schemas/TextNumberColumn"
              }
            ]
          }
        ]
      },
      "ColumnUpdateRequestObject": {
        "title": "Column update object",
        "type": "object",
        "description": "A column can be one of the following types.\n",
        "oneOf": [
          {
            "$ref": "#/components/schemas/TextNumberColumn"
          },
          {
            "$ref": "#/components/schemas/AutoNumberColumn"
          },
          {
            "$ref": "#/components/schemas/CheckboxColumn"
          },
          {
            "$ref": "#/components/schemas/ContactListColumn"
          },
          {
            "$ref": "#/components/schemas/CreatedByColumn"
          },
          {
            "$ref": "#/components/schemas/CreatedDateColumn"
          },
          {
            "$ref": "#/components/schemas/DateColumn"
          },
          {
            "$ref": "#/components/schemas/AbstractDatetimeColumn"
          },
          {
            "$ref": "#/components/schemas/DropdownListColumn"
          },
          {
            "$ref": "#/components/schemas/DurationColumn"
          },
          {
            "$ref": "#/components/schemas/ModifiedByColumn"
          },
          {
            "$ref": "#/components/schemas/ModifiedDateColumn"
          },
          {
            "$ref": "#/components/schemas/MultiContactListColumn"
          },
          {
            "$ref": "#/components/schemas/MultiDropdownListColumn"
          },
          {
            "$ref": "#/components/schemas/PercentCompleteColumn"
          },
          {
            "$ref": "#/components/schemas/PredecessorColumn"
          },
          {
            "$ref": "#/components/schemas/RMAssignedResourceContactColumn"
          },
          {
            "$ref": "#/components/schemas/RMAssignedResourceTextColumn"
          },
          {
            "$ref": "#/components/schemas/RMPercentAllocationColumn"
          },
          {
            "$ref": "#/components/schemas/SymbolColumn"
          }
        ]
      },
      "CommentCreateRequest": {
        "title": "Comment request body",
        "type": "object",
        "properties": {
          "text": {
            "description": "Comment body.",
            "type": "string"
          }
        }
      },
      "ContainerDestinationForCopy": {
        "type": "object",
        "title": "Container destination for copy",
        "properties": {
          "destinationId": {
            "description": "The ID of the destination container.\n",
            "type": "number"
          },
          "destinationType": {
            "description": "Type of destination container.\n\nThe `\"home\"` enum is **Deprecated** since March 25, 2025, and will be removed.\n",
            "type": "string",
            "nullable": true,
            "enum": [
              "folder",
              "home",
              "workspace"
            ]
          },
          "newName": {
            "description": "Name of the newly created object (when copying a dashboard, folder, or sheet).",
            "type": "string"
          }
        },
        "required": [
          "destinationId"
        ]
      },
      "SheetCopyMoveResponse": {
        "title": "Sheet index response",
        "type": "object",
        "properties": {
          "id": {
            "description": "Sheet ID.",
            "type": "number"
          },
          "accessLevel": {
            "$ref": "#/components/schemas/AccessLevel"
          },
          "name": {
            "description": "Sheet name.",
            "type": "string"
          },
          "permalink": {
            "description": "URL that represents a direct link to the sheet in Smartsheet.",
            "type": "string"
          }
        }
      },
      "CrossSheetReferenceRequestWithColumnIds": {
        "title": "Cross-sheet reference with column range",
        "type": "object",
        "description": "CrossSheetReference object to create which will refer to the entire columns in the range from startColumnId to endColumnId.",
        "properties": {
          "sourceSheetId": {
            "description": "Sheet ID of source sheet.",
            "type": "number"
          },
          "name": {
            "description": "Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References.",
            "type": "string"
          },
          "endColumnId": {
            "description": "Defines ending edge of range when specifying one or more columns. Must be used with startColumnId.",
            "type": "number"
          },
          "startColumnId": {
            "description": "Defines beginning edge of range when specifying one or more columns. Must be used with endColumnId.",
            "type": "number"
          }
        }
      },
      "CrossSheetReferenceRequestWithRowIds": {
        "title": "Cross-sheet reference with row range",
        "type": "object",
        "description": "CrossSheetReference object to create which will refer to the entire rows in the range from startRowId to endRowId.",
        "properties": {
          "sourceSheetId": {
            "description": "Sheet ID of source sheet.",
            "type": "number"
          },
          "name": {
            "description": "Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References.",
            "type": "string"
          },
          "endRowId": {
            "description": "Defines ending edge of range when specifying one or more rows. Must be used with startRowId.",
            "type": "number"
          },
          "startRowId": {
            "description": "Defines beginning edge of range when specifying one or more rows. Must be used with endRowId.",
            "type": "number"
          }
        }
      },
      "CrossSheetReferenceRequestWithColumnAndRowIds": {
        "title": "Cross-sheet reference with cell range",
        "type": "object",
        "description": "CrossSheetReference object to create with specified cell range.",
        "properties": {
          "sourceSheetId": {
            "description": "Sheet ID of source sheet.",
            "type": "number"
          },
          "name": {
            "description": "Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References.",
            "type": "string"
          },
          "endColumnId": {
            "description": "Defines ending edge of range when specifying one or more columns. Must be used with startColumnId. To specify an entire column, omit the startRowId and endRowId parameters.",
            "type": "number"
          },
          "endRowId": {
            "description": "Defines ending edge of range when specifying one or more rows. Must be used with startRowId. To specify an entire row, omit the startColumnId and endColumnId parameters.",
            "type": "number"
          },
          "startColumnId": {
            "description": "Defines beginning edge of range when specifying one or more columns. Must be used with endColumnId. To specify an entire column, omit the startRowId and endRowId parameters.",
            "type": "number"
          },
          "startRowId": {
            "description": "Defines beginning edge of range when specifying one or more rows. Must be used with endRowId. To specify an entire row, omit the startColumnId and endColumnId parameters.",
            "type": "number"
          }
        }
      },
      "CommentText": {
        "title": "Comment text",
        "description": "Comment text object.",
        "type": "object",
        "properties": {
          "text": {
            "description": "Comment text.",
            "type": "string"
          }
        }
      },
      "DiscussionCreateRequest": {
        "title": "Discussion create request",
        "type": "object",
        "properties": {
          "comment": {
            "$ref": "#/components/schemas/CommentText"
          }
        }
      },
      "DiscussionWithAttachmentCreateRequest": {
        "title": "Discussion create request with attachment",
        "type": "object",
        "properties": {
          "discussion": {
            "type": "object",
            "description": "Discussion.",
            "properties": {
              "comment": {
                "$ref": "#/components/schemas/CommentText"
              },
              "title": {
                "description": "Title for the attachment. Only used with an attachment.",
                "type": "string"
              }
            }
          },
          "file": {
            "description": "File to attach to the new comment. Only used with an attachment.",
            "type": "string",
            "format": "binary"
          }
        }
      },
      "CommentCreateRequestWithAttachment": {
        "title": "Comment with attachment request body",
        "type": "object",
        "properties": {
          "comment": {
            "$ref": "#/components/schemas/CommentText"
          },
          "file": {
            "description": "File to attach to the new comment. Only used with an attachment.",
            "type": "string",
            "format": "binary"
          }
        }
      },
      "PathFoldersOrSheets": {
        "type": "object",
        "oneOf": [
          {
            "title": "Sheets",
            "type": "object",
            "required": [
              "sheets"
            ],
            "properties": {
              "sheets": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "name",
                    "permalink",
                    "createdAt",
                    "modifiedAt",
                    "accessLevel"
                  ],
                  "properties": {
                    "id": {
                      "type": "integer",
                      "format": "int64",
                      "description": "Sheet ID.",
                      "example": 4509918431602564
                    },
                    "name": {
                      "type": "string",
                      "description": "Sheet name.",
                      "example": "Project Plan"
                    },
                    "permalink": {
                      "type": "string",
                      "format": "uri",
                      "description": "URL that represents a direct link to the sheet in Smartsheet.",
                      "example": "https://app.smartsheet.com/sheets/cpG82pf5v8FPrgFfJrFcrM56xCHVGhmV4P4xcQ71"
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time",
                      "example": "2023-01-15T12:34:56Z"
                    },
                    "modifiedAt": {
                      "type": "string",
                      "format": "date-time",
                      "example": "2023-02-20T08:22:33Z"
                    },
                    "accessLevel": {
                      "allOf": [
                        {
                          "$ref": "#/components/schemas/AccessLevel"
                        },
                        {
                          "description": "The access level of the user to the sheet."
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          {
            "title": "Folders",
            "type": "object",
            "required": [
              "folders"
            ],
            "properties": {
              "folders": {
                "type": "array",
                "description": "Array of a single folder on the path from the asset to its workspace.",
                "items": {
                  "allOf": [
                    {
                      "type": "object",
                      "required": [
                        "id",
                        "name"
                      ],
                      "properties": {
                        "id": {
                          "type": "integer",
                          "format": "int64",
                          "description": "Folder ID.",
                          "example": 1234567890123456
                        },
                        "name": {
                          "type": "string",
                          "description": "Folder name.",
                          "example": "Project Plans"
                        },
                        "permalink": {
                          "type": "string",
                          "format": "uri",
                          "description": "URL that represents a direct link to the folder in Smartsheet.",
                          "example": "https://api.smartsheet.com/folders/abcd1234efgh5678ijkl9012mnop3456"
                        }
                      }
                    },
                    {
                      "$ref": "#/components/schemas/PathFoldersOrSheets"
                    }
                  ]
                }
              }
            }
          }
        ]
      },
      "PathSheetResponse": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/PathWorkspace"
          },
          {
            "$ref": "#/components/schemas/PathFoldersOrSheets"
          }
        ]
      },
      "SheetPublishRequest": {
        "title": "Sheet publish request",
        "x-tags": [
          "sheets"
        ],
        "description": "Describes the sheet's publish settings. Used as a request body to set publish status.\n",
        "type": "object",
        "properties": {
          "readOnlyFullAccessibleBy": {
            "description": "Indicates who can access the 'Read-Only Full' view of the published sheet:\n\n  * ALL - available to anyone who has the link.\n  * ORG - available only to members of the sheet owner's Smartsheet organization account.\n  * SHARED - available only to users shared to the item.\n\nOnly returned in the response if `readOnlyFullEnabled = true`.\n",
            "type": "string",
            "enum": [
              "ALL",
              "ORG",
              "SHARED"
            ]
          },
          "readOnlyFullDefaultView": {
            "description": "Indicates which view the user has set for a read-only, default view of the     published sheet. Must be one of the listed enum values.\n",
            "type": "string",
            "enum": [
              "CALENDAR",
              "CARD",
              "GRID"
            ]
          },
          "readOnlyFullEnabled": {
            "description": "If `true`, a rich version of the sheet is published with the ability to download row attachments and discussions.\n",
            "type": "boolean"
          },
          "readOnlyFullShowToolbar": {
            "description": "Indicates whether the left nav toolbar is displayed. The default, or **true**, is to display the toolbar. If `false`, hides the toolbar.\n",
            "type": "boolean",
            "deprecated": true
          },
          "readOnlyLiteEnabled": {
            "description": "If `true`, a lightweight version of the sheet is published without row attachments and discussions.\n",
            "type": "boolean"
          },
          "readWriteAccessibleBy": {
            "description": "Indicates who can access the 'Edit by Anyone' view of the published sheet:\n\n  * ALL - available to anyone who has the link.\n  * ORG - available only to members of the sheet owner's Smartsheet organization account.\n  * SHARED - available only to users shared to the item.\n\nOnly returned in the response if `readWriteEnabled = true`.\n",
            "type": "string",
            "enum": [
              "ALL",
              "ORG",
              "SHARED"
            ]
          },
          "readWriteDefaultView": {
            "description": "Indicates which view the user has set for a read-write, default view of the published sheet. Must be one of the listed enum values.\n",
            "type": "string",
            "enum": [
              "CALENDAR",
              "CARD",
              "GRID"
            ]
          },
          "readWriteEnabled": {
            "description": "If `true`,a rich version of the sheet is published with the ability to edit cells and manage attachments and discussions.\n",
            "type": "boolean"
          },
          "readWriteShowToolbar": {
            "description": "Indicates whether the left nav toolbar is displayed. The default, or **true**, is to display the toolbar. If **false**, hides the toolbar.\n",
            "type": "boolean",
            "deprecated": true
          }
        }
      },
      "cellObjectForRows": {
        "title": "Cell object for rows",
        "type": "object",
        "properties": {
          "columnId": {
            "type": "number",
            "description": "The ID of the column that the cell is located in."
          },
          "columnType": {
            "type": "string",
            "description": "Only returned if the include query string parameter contains **columnType**."
          },
          "value": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              }
            ],
            "description": "A string, number, or a Boolean value -- depending on the cell type and the data in the cell. Cell values larger than 4000 characters are silently truncated. An empty cell returns no value."
          },
          "displayValue": {
            "type": "string",
            "description": "Visual representation of cell contents, as presented to the user in the UI."
          }
        }
      },
      "UpdateRowsObject": {
        "title": "Update rows object",
        "type": "object",
        "properties": {
          "id": {
            "description": "Row ID.",
            "type": "number"
          },
          "rowNumber": {
            "description": "Row number within the sheet.",
            "type": "number",
            "minimum": 1
          },
          "parentRowNumber": {
            "description": "The row number of the parent.",
            "type": "number"
          },
          "parentId": {
            "description": "The ID of the parent.",
            "type": "number"
          },
          "expanded": {
            "description": "Indicates whether the row is expanded or collapsed.",
            "type": "boolean"
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "cells": {
            "description": "Cells objects.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/cellObjectForRows"
            }
          },
          "version": {
            "description": "Sheet version number that is incremented every time a sheet is modified.",
            "type": "number"
          }
        }
      },
      "AddedRowResponseListItem": {
        "title": "Added row",
        "description": "An added row response list item.",
        "type": "object",
        "properties": {
          "id": {
            "description": "Row ID.",
            "type": "number"
          },
          "sheetId": {
            "description": "Parent sheet ID.",
            "type": "number"
          },
          "rowNumber": {
            "description": "Row number within the sheet.",
            "type": "number",
            "minimum": 1
          },
          "expanded": {
            "description": "Indicates whether the row is expanded or collapsed.",
            "type": "boolean"
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "cells": {
            "description": "Cells objects.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/cellObjectForRows"
            }
          },
          "version": {
            "description": "Sheet version number that is incremented every time a sheet is modified.",
            "type": "number"
          }
        }
      },
      "SentUpdateRequestListItem": {
        "title": "Paginated sent update request list item",
        "type": "object",
        "description": "An abbreviated representation of a sent update request.",
        "properties": {
          "id": {
            "description": "The ID of the sent update request.",
            "type": "number"
          },
          "updateRequestId": {
            "description": "The ID of the originating update request.",
            "type": "number"
          },
          "message": {
            "description": "The message of the email. Max 10000 characters.",
            "type": "string"
          },
          "sentAt": {
            "description": "The date and time for when the sent update request was sent to the recipient.\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/Timestamp"
              }
            ]
          },
          "sentBy": {
            "description": "`User` object containing `name` and `email` of the sender.\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/MiniUser"
              }
            ]
          },
          "sentTo": {
            "description": "Recipient object.",
            "allOf": [
              {
                "$ref": "#/components/schemas/Recipient"
              }
            ]
          },
          "status": {
            "description": "The status of the sent update request.",
            "type": "string",
            "enum": [
              "CANCELED",
              "COMPLETE",
              "PENDING"
            ]
          },
          "subject": {
            "description": "The subject of the email.",
            "type": "string"
          }
        }
      },
      "SummaryFieldCreateRequest": {
        "title": "Summary field create request",
        "type": "object",
        "description": "SummaryField object to create.",
        "properties": {
          "contactOptions": {
            "$ref": "#/components/schemas/contactOptions"
          },
          "format": {
            "description": "The format descriptor. Only returned if the include query string parameter contains format and this column has a non-default format applied to it.\n",
            "type": "string"
          },
          "formula": {
            "description": "The formula for a cell, if set.",
            "type": "string"
          },
          "hyperlink": {
            "$ref": "#/components/schemas/Hyperlink"
          },
          "image": {
            "$ref": "#/components/schemas/Image"
          },
          "index": {
            "description": "Field index or position. This number is zero-based.",
            "type": "number"
          },
          "locked": {
            "description": "Indicates whether the field is locked.",
            "type": "boolean"
          },
          "objectValue": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "$ref": "#/components/schemas/ContactObjectValue"
              },
              {
                "$ref": "#/components/schemas/DateObjectValue"
              }
            ]
          },
          "options": {
            "description": "When applicable for PICKLIST column type. Array of the options available for the field.\n",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "symbol": {
            "description": "When applicable for PICKLIST column type.",
            "type": "string"
          },
          "title": {
            "description": "Arbitrary name, must be unique within summary.",
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "ABSTRACT_DATETIME",
              "CHECKBOX",
              "CONTACT_LIST",
              "DATE",
              "DATETIME",
              "DURATION",
              "MULTI_CONTACT_LIST",
              "MULTI_PICKLIST",
              "PICKLIST",
              "PREDECESSOR",
              "TEXT_NUMBER"
            ]
          },
          "validation": {
            "description": "Indicates whether summary field values are restricted to the type.",
            "type": "boolean"
          }
        }
      },
      "SummaryFieldAddImage": {
        "title": "Summary field add image",
        "type": "object",
        "properties": {
          "id": {
            "description": "SummaryField ID.",
            "type": "number"
          },
          "index": {
            "description": "Field index or position. This number is zero-based.",
            "type": "number"
          },
          "title": {
            "description": "Arbitrary name, must be unique within summary.",
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "ABSTRACT_DATETIME",
              "CHECKBOX",
              "CONTACT_LIST",
              "DATE",
              "DATETIME",
              "DURATION",
              "MULTI_CONTACT_LIST",
              "MULTI_PICKLIST",
              "PICKLIST",
              "PREDECESSOR",
              "TEXT_NUMBER"
            ]
          },
          "locked": {
            "description": "Indicates whether the field is locked.",
            "type": "boolean"
          },
          "lockedForUser": {
            "description": "Indicates whether the field is locked for the requesting user.",
            "type": "boolean"
          },
          "objectValue": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "$ref": "#/components/schemas/ContactObjectValue"
              },
              {
                "$ref": "#/components/schemas/DateObjectValue"
              }
            ]
          },
          "formula": {
            "description": "The formula for a cell, if set.",
            "type": "string"
          },
          "image": {
            "$ref": "#/components/schemas/Image"
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp"
          },
          "version": {
            "description": "Sheet version number that is incremented every time a sheet is modified.",
            "type": "number"
          }
        }
      },
      "Timestamp_Writeable": {
        "title": "Timestamp writeable",
        "oneOf": [
          {
            "$ref": "#/components/schemas/Timestamp_date-time"
          },
          {
            "$ref": "#/components/schemas/Timestamp_number"
          }
        ]
      },
      "PathFoldersOrSights": {
        "type": "object",
        "oneOf": [
          {
            "title": "Sights",
            "type": "object",
            "required": [
              "sights"
            ],
            "properties": {
              "sights": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "name",
                    "permalink",
                    "createdAt",
                    "modifiedAt",
                    "accessLevel"
                  ],
                  "properties": {
                    "id": {
                      "type": "integer",
                      "format": "int64",
                      "description": "Sight ID.",
                      "example": 4509918431602564
                    },
                    "name": {
                      "type": "string",
                      "description": "Sight name.",
                      "example": "Executive Dashboard"
                    },
                    "permalink": {
                      "type": "string",
                      "format": "uri",
                      "description": "URL that represents a direct link to the sight in Smartsheet.",
                      "example": "https://app.smartsheet.com/dashboards/cpG82pf5v8FPrgFfJrFcrM56xCHVGhmV4P4xcQ71"
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time",
                      "example": "2023-01-15T12:34:56Z"
                    },
                    "modifiedAt": {
                      "type": "string",
                      "format": "date-time",
                      "example": "2023-02-20T08:22:33Z"
                    },
                    "accessLevel": {
                      "allOf": [
                        {
                          "$ref": "#/components/schemas/AccessLevel"
                        },
                        {
                          "description": "The access level of the user to the dashboard."
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          {
            "title": "Folders",
            "type": "object",
            "required": [
              "folders"
            ],
            "properties": {
              "folders": {
                "type": "array",
                "description": "Array of a single folder on the path from the asset to its workspace.",
                "items": {
                  "allOf": [
                    {
                      "type": "object",
                      "required": [
                        "id",
                        "name"
                      ],
                      "properties": {
                        "id": {
                          "type": "integer",
                          "format": "int64",
                          "description": "Folder ID.",
                          "example": 1234567890123456
                        },
                        "name": {
                          "type": "string",
                          "description": "Folder name.",
                          "example": "Marketing"
                        },
                        "permalink": {
                          "type": "string",
                          "format": "uri",
                          "description": "URL that represents a direct link to the folder in Smartsheet.",
                          "example": "https://api.smartsheet.com/folders/abcd1234efgh5678ijkl9012mnop3456"
                        }
                      }
                    },
                    {
                      "$ref": "#/components/schemas/PathFoldersOrSights"
                    }
                  ]
                }
              }
            }
          }
        ]
      },
      "PathSightResponse": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/PathWorkspace"
          },
          {
            "$ref": "#/components/schemas/PathFoldersOrSights"
          }
        ]
      },
      "ProfileImage": {
        "title": "Profile image",
        "type": "object",
        "properties": {
          "imageId": {
            "description": "Unique image ID.",
            "type": "string",
            "example": "u!1!nAtdn5RJB_o!k6_e_3h2R3w!wmYXPek-yVD"
          },
          "height": {
            "description": "Image height.",
            "type": "integer",
            "format": "int32",
            "example": 1050
          },
          "width": {
            "description": "Image width.",
            "type": "integer",
            "format": "int32",
            "example": 1050
          }
        }
      },
      "SheetList": {
        "title": "Sheet list item",
        "type": "object",
        "properties": {
          "id": {
            "description": "Sheet ID.",
            "type": "number"
          },
          "name": {
            "description": "Sheet name.",
            "type": "string"
          },
          "owner": {
            "description": "Empty string",
            "example": "",
            "type": "string"
          },
          "ownerId": {
            "description": "Set to a static value of \"0\".",
            "example": 0,
            "type": "number"
          }
        }
      },
      "UserUpdate": {
        "title": "User update request",
        "description": "Updates User for the following attributes:\n\n* **admin** (required).\n* **licensedSheetCreator** (required).\n* **firstName** (optional).\n* **groupAdmin** (optional).\n* **lastName** (optional).\n* **resourceViewer** (optional).\n",
        "type": "object",
        "properties": {
          "admin": {
            "description": "Indicates whether the user is a system admin (can manage user accounts and organization account).\n",
            "type": "boolean",
            "default": false,
            "example": true
          },
          "licensedSheetCreator": {
            "description": "Indicates whether the user is a licensed user (can create and own sheets).",
            "type": "boolean",
            "default": false,
            "example": true
          },
          "firstName": {
            "description": "User's first name.",
            "type": "string",
            "example": "Jane"
          },
          "lastName": {
            "description": "User's last name.",
            "type": "string",
            "example": "Doe"
          },
          "groupAdmin": {
            "description": "Indicates whether the user is a group admin (can create and edit groups).",
            "type": "boolean",
            "default": false,
            "example": true
          },
          "resourceViewer": {
            "description": "Indicates whether the user is a resource viewer (can access resource views).\n",
            "type": "boolean",
            "default": false,
            "example": true
          }
        }
      },
      "UserProfileImageResponse": {
        "title": "User profile image",
        "description": "User profile image response.",
        "properties": {
          "email": {
            "description": "User's primary email address.",
            "type": "string",
            "format": "email",
            "example": "jane.doe@smartsheet.com"
          },
          "name": {
            "description": "User's full name (read-only).",
            "type": "string",
            "readOnly": true,
            "example": "Jane Doe"
          },
          "firstName": {
            "description": "User's first name.",
            "type": "string",
            "example": "Jane"
          },
          "lastName": {
            "description": "User's last name.",
            "type": "string",
            "example": "Doe"
          },
          "profileImage": {
            "$ref": "#/components/schemas/ProfileImage"
          },
          "id": {
            "description": "User ID.",
            "type": "number",
            "readOnly": true,
            "example": 48569348493401200
          }
        }
      },
      "AddAlternateEmail": {
        "title": "Alternate email body object",
        "type": "object",
        "properties": {
          "email": {
            "description": "User's alternate email address.",
            "type": "string",
            "example": "johnathan.doe@smartsheet.com"
          }
        }
      },
      "TokenBasedIndexResult": {
        "title": "Token-based index result",
        "type": "object",
        "properties": {
          "lastKey": {
            "description": "The ID of the last item returned in the set. Use as `lastKey` (query parameter) in the request for the next page.",
            "type": "string",
            "example": "48569348493401200",
            "readOnly": true
          }
        }
      },
      "UserPlan": {
        "title": "User plan",
        "x-tags": [
          "users"
        ],
        "description": "User's plan object.",
        "type": "object",
        "properties": {
          "planId": {
            "description": "Unique identifier for the plan.",
            "type": "integer",
            "format": "int64",
            "minimum": 1,
            "readOnly": true,
            "example": 4843937635559300
          },
          "seatType": {
            "description": "User's seat type.\n\n**DEPRECATED - As early as the sunset date specified in this [changelog entry](/api/smartsheet/changelog#deprecated-viewer-seat-type-in-favor-of-contributor-new), `VIEWER` will be removed and replaced by `CONTRIBUTOR` for all free-tier plans users.** Commenting and attachments are free to the `CONTRIBUTOR` seat type. \n",
            "type": "string",
            "readOnly": true,
            "enum": [
              "MEMBER",
              "PROVISIONAL_MEMBER",
              "CONTRIBUTOR",
              "GUEST",
              "VIEWER"
            ],
            "example": "MEMBER"
          },
          "seatTypeLastChangedAt": {
            "description": "Timestamp of the user's last seat type change.",
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "example": "2025-06-14T09:55:30Z"
          },
          "isInternal": {
            "description": "Indicates whether the user is internal to the plan's domain.",
            "type": "boolean",
            "readOnly": true,
            "example": true
          },
          "provisionalExpirationDate": {
            "description": "The expiration timestamp of the user's provisional seat type. It's null if the user doesn't have a `PROVISIONAL_MEMBER` seat type.",
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "nullable": true,
            "example": "2025-06-14T09:55:30Z"
          }
        }
      },
      "WebhookCoreAttributes": {
        "type": "object",
        "properties": {
          "callbackUrl": {
            "type": "string",
            "example": "https://www.myApp.com/webhooks",
            "description": "HTTPS URL where callbacks are sent."
          },
          "name": {
            "type": "string",
            "example": "My webhook",
            "description": "Webhook name."
          },
          "id": {
            "description": "ID of the webhook.",
            "type": "number",
            "readOnly": true,
            "example": 8444254503626628
          },
          "apiClientId": {
            "type": "string",
            "readOnly": true,
            "example": "555555",
            "description": "ID of the corresponding third-party app that created the webhook. It's only present if the webhook was created by a third-party app.\n"
          },
          "apiClientName": {
            "type": "string",
            "readOnly": true,
            "example": "Awesome Smartsheet Application",
            "description": "API client name corresponding to third-party app that created the webhook. It's only present if the webhook was created by a third-party app.\n"
          },
          "createdAt": {
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/Timestamp"
              }
            ]
          },
          "disabledDetails": {
            "type": "string",
            "readOnly": true,
            "description": "Details about the reason the webhook was disabled. It's only present when enabled=false.\n"
          },
          "modifiedAt": {
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/Timestamp"
              }
            ]
          },
          "sharedSecret": {
            "type": "string",
            "readOnly": true,
            "example": "216ejjzdnq17mq1q8xs7d4hu8b",
            "description": "Shared secret for this webhook, randomly generated by Smartsheet.\n\nSee [Authenticating Callbacks](/api/smartsheet/guides/webhooks/webhook-callbacks#authenticating-callbacks-optional) for details about how this value can be used.\n"
          },
          "stats": {
            "type": "object",
            "readOnly": true,
            "properties": {
              "lastCallbackAttempt": {
                "type": "string",
                "format": "date-time",
                "readOnly": true,
                "description": "When this webhook last made a callback attempt."
              },
              "lastCallbackAttemptRetryCount": {
                "type": "number",
                "readOnly": true,
                "description": "The number of retries the webhook had performed as of the last callback attempt.\n"
              },
              "lastSuccessfulCallback": {
                "type": "string",
                "format": "date-time",
                "readOnly": true,
                "description": "When this webhook last made a successful callback."
              }
            }
          }
        }
      },
      "PlanWebhook": {
        "title": "Plan webhook",
        "allOf": [
          {
            "$ref": "#/components/schemas/WebhookCoreAttributes"
          },
          {
            "type": "object",
            "properties": {
              "events": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "*.*",
                    "user.seatType.updated",
                    "user.seatType.*",
                    "user.*"
                  ],
                  "example": "*.*"
                },
                "description": "Array of patterns for matching plan event types.\n\nCan contain either '\\*.\\*' (all events) and/or 'user.seatType.updated' (to monitor user seat type changes). \n"
              },
              "scope": {
                "type": "string",
                "enum": [
                  "plan"
                ],
                "example": "plan",
                "description": "The type of object (that is, `plan`) whose events this webhook is subscribed to. \n"
              },
              "scopeObjectId": {
                "type": "integer",
                "format": "int64",
                "minimum": 1,
                "example": 3285357287499652,
                "description": "ID of the plan whose events this webhook is subscribed to. After creating a webhook, this value is immutable.\n\n**Note:** You can access a plan's ID in the Admin Center UI by clicking on your profile icon in the top-right corner. See the <a href=\"https://help.smartsheet.com/articles/2481889-admin-center-overview\" target=\"_blank\" rel=\"noopener  noreferrer\">Admin Center Overview</a> for details.\n"
              },
              "status": {
                "type": "string",
                "readOnly": true,
                "enum": [
                  "DISABLED_ADMINISTRATIVE",
                  "DISABLED_APP_REVOKED",
                  "DISABLED_BY_OWNER",
                  "DISABLED_CALLBACK_FAILED",
                  "DISABLED_SCOPE_INACCESSIBLE",
                  "DISABLED_VERIFICATION_FAILED",
                  "ENABLED",
                  "NEW_NOT_VERIFIED"
                ],
                "example": "NEW_NOT_VERIFIED",
                "description": "The webhook's status.\n\nSee [Webhook Status](/api/smartsheet/guides/webhooks/webhook-status) for details.\n"
              },
              "version": {
                "type": "number",
                "example": 1,
                "minimum": 1,
                "maximum": 1,
                "description": "Webhook version. Currently, the only supported value is 1. This attribute is intended to ensure backward compatibility as new webhook functionality is released. For example, a webhook with a version of 1 is guaranteed to always be sent callback objects that are compatible with the version 1 release of webhooks.\n"
              },
              "customHeaders": {
                "type": "object",
                "description": "A set of custom headers that your webhook sends in all requests to your callback URL, where each key-value pair represents a header name and its corresponding value.\n\nThis can be useful for passing authentication tokens or other information that your application needs to process the webhook events. \n\n**Important:** Don't use any of the following reserved headers as custom headers:\n\n- Accept-Encoding\n- Connection\n- Content-Length\n- Host\n- Proxy-Authenticate\n- Proxy-Authorization\n- Smartsheet-Change-Agent\n- Smartsheet-Hmac-SHA256\n- Smartsheet-Hook-Challenge\n- Smartsheet-Hook-Response\n- TE\n- Trailer\n- Transfer-Encoding\n- Upgrade\n- User-Agent\n",
                "additionalProperties": {
                  "type": "string"
                },
                "example": {
                  "YOUR_CUSTOM_HEADER_KEY_1": "YOUR_CUSTOM_HEADER_VALUE_1",
                  "YOUR_CUSTOM_HEADER_KEY_2": "YOUR_CUSTOM_HEADER_VALUE_2"
                }
              }
            }
          }
        ]
      },
      "SheetWebhook": {
        "title": "Sheet webhook",
        "allOf": [
          {
            "$ref": "#/components/schemas/WebhookCoreAttributes"
          },
          {
            "type": "object",
            "properties": {
              "events": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "*.*"
                },
                "description": "Array of patterns for matching sheet event types.\n\n**Important:** Currently, it must contain only the string value '\"\\*.\\*\"' (asterisk period asterisk) as its sole element. This pattern matches all sheet event types.\n"
              },
              "scope": {
                "type": "string",
                "enum": [
                  "sheet"
                ],
                "example": "sheet",
                "description": "The type of object (that is, `sheet`) whose events this webhook is subscribed to. \n"
              },
              "scopeObjectId": {
                "type": "integer",
                "format": "int64",
                "minimum": 1,
                "example": 3285357287499652,
                "description": "ID of the sheet whose events this webhook is subscribed to. After creating a webhook, this value is immutable.\n\n**Note:** You can access a sheet's ID in the Smartsheet UI by looking at the sheet's properties under **File > Properties**.\n"
              },
              "status": {
                "type": "string",
                "readOnly": true,
                "enum": [
                  "DISABLED_ADMINISTRATIVE",
                  "DISABLED_APP_REVOKED",
                  "DISABLED_BY_OWNER",
                  "DISABLED_CALLBACK_FAILED",
                  "DISABLED_EXCEEDED_GRID_LIMITS",
                  "DISABLED_SCOPE_INACCESSIBLE",
                  "DISABLED_VERIFICATION_FAILED",
                  "ENABLED",
                  "NEW_NOT_VERIFIED"
                ],
                "example": "NEW_NOT_VERIFIED",
                "description": "The webhook's status.\n\nSee [Webhook Status](/api/smartsheet/guides/webhooks/webhook-status) for details.\n"
              },
              "subscope": {
                "type": "object",
                "description": "Limits the webhook to monitor specific columns designated by an array of sheet column IDs. \n\n**Note:** If a cell in one of the columns is deleted as part of a row deletion, the webhook still sends a `\"row.deleted\"` callback event.\n",
                "properties": {
                  "columnIds": {
                    "type": "array",
                    "items": {
                      "type": "integer",
                      "format": "int64",
                      "minimum": 1
                    },
                    "description": "Array of IDs of the sheet columns to monitor.\n",
                    "example": [
                      7318427511613316,
                      7318427511613123
                    ]
                  }
                }
              },
              "version": {
                "type": "number",
                "minimum": 1,
                "maximum": 1,
                "description": "Webhook version. Currently, the only supported value is 1. This attribute is intended to ensure backward compatibility as new webhook functionality is released. For example, a webhook with a version of 1 is guaranteed to always be sent callback objects that are compatible with the version 1 release of webhooks.\n"
              }
            }
          }
        ]
      },
      "IndexResultWorkspaces": {
        "title": "Index result workspaces",
        "type": "object",
        "properties": {
          "pageNumber": {
            "description": "**DEPRECATED - As early as the sunset date specified in this \n[Changelog entry](/api/smartsheet/changelog#2025-08-04), this response property will not be part \nof the response.**\n\nThe current page in the full result set that the data array represents.\nNOTE when a page number greater than totalPages is requested, the last\npage is instead returned.\n",
            "deprecated": true,
            "type": "number",
            "example": 1,
            "readOnly": true
          },
          "pageSize": {
            "description": "**DEPRECATED - As early as the sunset date specified in this \n[Changelog entry](/api/smartsheet/changelog#2025-08-04), this response property will not be part \nof the response.**\n\nThe number of items in a page. Omitted if there is no limit to page size\n(and hence, all results are included). Unless otherwise specified, this\ndefaults to 100 for most endpoints. Only present when using page-based pagination.\n",
            "deprecated": true,
            "type": "number",
            "example": 50,
            "nullable": true,
            "readOnly": true
          },
          "totalPages": {
            "description": "**DEPRECATED - As early as the sunset date specified in this \n[Changelog entry](/api/smartsheet/changelog#2025-08-04), this response property will not be part \nof the response.**\n\nThe total number of pages in the full result set. Only present when\nusing page-based pagination.\n",
            "deprecated": true,
            "type": "number",
            "example": 25,
            "readOnly": true
          },
          "totalCount": {
            "description": "**DEPRECATED - As early as the sunset date specified in this \n[Changelog entry](/api/smartsheet/changelog#2025-08-04), this response property will not be part \nof the response.**\n\nThe total number of items in the full result set. Only present when\nusing page-based pagination.\n",
            "deprecated": true,
            "type": "number",
            "example": 136,
            "readOnly": true
          }
        }
      },
      "WorkspaceMetadata": {
        "title": "Workspace metadata",
        "x-tags": [
          "workspaces"
        ],
        "description": "The metadata of a Workspace",
        "type": "object",
        "required": [
          "id",
          "name",
          "permalink",
          "createdAt",
          "modifiedAt",
          "accessLevel"
        ],
        "properties": {
          "id": {
            "description": "Workspace ID.",
            "type": "integer",
            "format": "int64"
          },
          "name": {
            "description": "Workspace name.",
            "type": "string"
          },
          "permalink": {
            "description": "URL to the workspace in Smartsheet.",
            "type": "string",
            "format": "uri"
          },
          "createdAt": {
            "$ref": "#/components/schemas/Timestamp2"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Timestamp2"
          },
          "accessLevel": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AccessLevel"
              },
              {
                "description": "The user's access level to the workspace."
              }
            ]
          }
        }
      },
      "CallbackCoreAttributes": {
        "type": "object",
        "properties": {
          "scopeObjectId": {
            "type": "number",
            "description": "ID of the object that corresponds to the scope.",
            "example": 3285357287499652,
            "readOnly": true
          },
          "webhookId": {
            "type": "number",
            "description": "ID of the corresponding webhook.",
            "example": 8444254503626628
          },
          "newWebhookStatus": {
            "type": "string",
            "description": "New status of the corresponding webhook. It is only returned for webhook status change callbacks (null for event callbacks).\n",
            "example": "ENABLED",
            "nullable": true
          },
          "nonce": {
            "type": "string",
            "description": "Random value that is distinct for each callback."
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "description": "Time that the callback was generated."
          }
        }
      },
      "User_SeatTypeUpdate_CallbackEvent": {
        "type": "object",
        "title": "User seat type update webhook event",
        "properties": {
          "planId": {
            "type": "integer",
            "format": "int64",
            "minimum": 1,
            "description": "ID of the plan.",
            "example": 3285357287499652
          },
          "userId": {
            "type": "number",
            "description": "ID of the affected user.",
            "example": 8846083322341252
          },
          "emailAddress": {
            "type": "string",
            "description": "Email address of the affected user.",
            "example": "test.user@example.com"
          },
          "seatType": {
            "type": "string",
            "description": "The new seat type of the affected user.\n\n**DEPRECATED:** The `VIEWER` seat type is deprecated. For backwards compatibility during the deprecation period, all internal, free-tier users will continue to have the `VIEWER` seat type. **On October 30th, 2026**, the `CONTRIBUTOR` seat type will replace it. To prepare for the change, handle both `VIEWER` and `CONTRIBUTOR` as representing the seat type for internal, free-tier users. Refer to this [changelog entry](/api/smartsheet/changelog#deprecated-viewer-seat-type-in-favor-of-contributor-new) for details.\n",
            "enum": [
              "GUEST",
              "VIEWER",
              "CONTRIBUTOR",
              "PROVISIONAL_MEMBER",
              "MEMBER"
            ],
            "nullable": true,
            "example": "PROVISIONAL_MEMBER"
          },
          "isInternal": {
            "description": "This is `true` if the affected user's email address belongs to a domain associated with your Smartsheet plan. It is otherwise `false`.\n",
            "type": "boolean",
            "example": true
          },
          "lastBillableActivity": {
            "type": "string",
            "format": "date-time",
            "description": "Time of the last billable activity for the user.",
            "example": "2025-08-13T12:00:00Z"
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "description": "Time that the event occurred.",
            "example": "2025-08-28T15:00:00Z"
          },
          "updatedByUserId": {
            "type": "number",
            "description": "ID of the user that made the update, or 1 for system updates.",
            "example": 48569348493401210
          },
          "objectType": {
            "type": "string",
            "description": "Type of object affected by the event.",
            "example": "user.seatType"
          },
          "eventType": {
            "type": "string",
            "description": "The action that occurred.",
            "enum": [
              "updated"
            ],
            "example": "updated"
          },
          "provisionalExpirationDate": {
            "description": "The expiration timestamp of the user's provisional seat type. It's null if the user doesn't have a `PROVISIONAL_MEMBER` seat type.",
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "nullable": true,
            "example": "2025-06-14T09:55:30Z"
          }
        }
      },
      "CallbackEventsPlanScoped": {
        "title": "Plan-scoped webhook events",
        "description": "Array of plan-scoped webhook event objects",
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/User_SeatTypeUpdate_CallbackEvent"
        }
      },
      "CallbackPlanScoped": {
        "type": "object",
        "title": "Plan callback",
        "description": "The plan webhook callback object. \n\n> **Note:** Plan callbacks may be accompanied by **custom headers** that you define in the [plan webhook's `customHeaders`](/api/smartsheet/openapi/schemas/planwebhook) attribute. For details, see the [Create webhook](/api/smartsheet/openapi/webhooks/createwebhook) or [Update webhook](/api/smartsheet/openapi/webhooks/updatewebhook) operations.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/CallbackCoreAttributes"
          },
          {
            "type": "object",
            "properties": {
              "scopeObjectId": {
                "type": "integer",
                "format": "int64",
                "description": "ID of the plan  (the object type that corresponds to the scope).",
                "example": 3285357287499652,
                "readOnly": true
              },
              "events": {
                "$ref": "#/components/schemas/CallbackEventsPlanScoped"
              },
              "scope": {
                "type": "string",
                "description": "Scope of the webhook.",
                "enum": [
                  "plan"
                ],
                "example": "plan"
              }
            }
          }
        ]
      },
      "BaseSheetScoped_WebhookEvent": {
        "type": "object",
        "properties": {
          "userId": {
            "type": "number",
            "description": "The ID of the user who caused this event.",
            "example": 48569348493401210
          },
          "changeAgent": {
            "type": "string",
            "description": "A comma-delimited list of values that uniquely identify the agents responsible for making the changes that caused the callback to occur. Only present if the change agent included the Smartsheet-Change-Agent header in the API request that changed data in Smartsheet. For more information, see [Preventing Infinite Loops](/api/smartsheet/guides/webhooks/preventing-webhook-infinite-loops.md).\n"
          },
          "eventType": {
            "type": "string",
            "description": "Type of event that occurred.",
            "enum": [
              "created",
              "deleted",
              "updated"
            ],
            "example": "updated"
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "description": "Time that this event occurred. A callback may contain events with different timestamps, as multiple separate events may be aggregated into a single callback request.\n"
          }
        }
      },
      "Attachment_WebhookEvent": {
        "title": "Attachment webhook event",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "ID of the attachment.\n",
                "example": 3285357287499652
              },
              "objectType": {
                "description": "Type of object for which event occurred.",
                "type": "string",
                "enum": [
                  "attachment"
                ],
                "example": "attachment"
              }
            }
          },
          {
            "$ref": "#/components/schemas/BaseSheetScoped_WebhookEvent"
          }
        ]
      },
      "Cell_WebhookEvent": {
        "title": "Cell webhook event",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "columnId": {
                "type": "number",
                "description": "The ID of the column where the cell is located.\n",
                "nullable": true
              },
              "rowId": {
                "type": "number",
                "description": "The ID of the row where the cell is located.\n",
                "nullable": true
              },
              "objectType": {
                "description": "Type of object for which event occurred.",
                "type": "string",
                "enum": [
                  "cell"
                ],
                "example": "cell"
              }
            }
          },
          {
            "$ref": "#/components/schemas/BaseSheetScoped_WebhookEvent"
          }
        ]
      },
      "Column_WebhookEvent": {
        "title": "Column webhook event",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "ID of the column.\n",
                "example": 3285357287499652
              },
              "objectType": {
                "description": "Type of object for which event occurred.",
                "type": "string",
                "enum": [
                  "column"
                ],
                "example": "column"
              }
            }
          },
          {
            "$ref": "#/components/schemas/BaseSheetScoped_WebhookEvent"
          }
        ]
      },
      "Comment_WebhookEvent": {
        "title": "Comment webhook event",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "ID of the comment.\n",
                "example": 3285357287499652
              },
              "objectType": {
                "description": "Type of object for which event occurred.",
                "type": "string",
                "enum": [
                  "comment"
                ],
                "example": "comment"
              }
            }
          },
          {
            "$ref": "#/components/schemas/BaseSheetScoped_WebhookEvent"
          }
        ]
      },
      "Discussion_WebhookEvent": {
        "title": "Discussion webhook event",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "ID of the discussion.\n",
                "example": 3285357287499652
              },
              "objectType": {
                "description": "Type of object for which event occurred.",
                "type": "string",
                "enum": [
                  "discussion"
                ],
                "example": "discussion"
              }
            }
          },
          {
            "$ref": "#/components/schemas/BaseSheetScoped_WebhookEvent"
          }
        ]
      },
      "Sheet_WebhookEvent": {
        "title": "Sheet webhook event",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "ID of the sheet.\n",
                "example": 3285357287499652
              },
              "objectType": {
                "description": "Type of object for which event occurred.",
                "type": "string",
                "enum": [
                  "sheet"
                ],
                "example": "sheet"
              }
            }
          },
          {
            "$ref": "#/components/schemas/BaseSheetScoped_WebhookEvent"
          }
        ]
      },
      "CallbackEventsSheetScoped": {
        "title": "Sheet-scoped webhook events",
        "description": "Array of sheet-scoped webhook event objects",
        "type": "array",
        "items": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/Attachment_WebhookEvent"
            },
            {
              "$ref": "#/components/schemas/Cell_WebhookEvent"
            },
            {
              "$ref": "#/components/schemas/Column_WebhookEvent"
            },
            {
              "$ref": "#/components/schemas/Comment_WebhookEvent"
            },
            {
              "$ref": "#/components/schemas/Discussion_WebhookEvent"
            },
            {
              "$ref": "#/components/schemas/Sheet_WebhookEvent"
            }
          ]
        }
      },
      "CallbackSheetScoped": {
        "type": "object",
        "title": "Sheet callback",
        "allOf": [
          {
            "$ref": "#/components/schemas/CallbackCoreAttributes"
          },
          {
            "type": "object",
            "properties": {
              "scopeObjectId": {
                "type": "integer",
                "format": "int64",
                "description": "ID of the sheet (the object type that corresponds to the scope).",
                "example": 3285357287499652,
                "readOnly": true
              },
              "events": {
                "$ref": "#/components/schemas/CallbackEventsSheetScoped"
              },
              "scope": {
                "type": "string",
                "description": "Scope of the webhook.",
                "enum": [
                  "sheet"
                ],
                "example": "sheet"
              }
            }
          }
        ]
      },
      "ColumnFilterCriteriaOperator": {
        "title": "Column filter criteria operator",
        "description": "Operator for filtering on column values.",
        "type": "string",
        "enum": [
          "BETWEEN",
          "CONTAINS",
          "DOES_NOT_CONTAIN",
          "EQUAL",
          "FUTURE",
          "GREATER_THAN",
          "GREATER_THAN_OR_EQUAL",
          "HAS_ALL_OF",
          "HAS_ANY_OF",
          "HAS_NONE_OF",
          "IS_BLANK",
          "IS_CHECKED",
          "IS_DATE",
          "IS_NOT_BLANK",
          "IS_NOT_DATE",
          "IS_NOT_NUMBER",
          "IS_NOT_ONE_OF",
          "IS_NUMBER",
          "IS_ONE_OF",
          "IS_UNCHECKED",
          "LAST_N_DAYS",
          "LESS_THAN",
          "LESS_THAN_OR_EQUAL",
          "MULTI_IS_EQUAL",
          "MULTI_IS_NOT_EQUAL",
          "NEXT_N_DAYS",
          "NOT_ALL_OF",
          "NOT_BETWEEN",
          "NOT_EQUAL",
          "NOT_FUTURE",
          "NOT_LAST_N_DAYS",
          "NOT_NEXT_N_DAYS",
          "NOT_PAST",
          "NOT_TODAY",
          "PAST",
          "TODAY"
        ],
        "example": "IS_ONE_OF"
      }
    },
    "securitySchemes": {
      "OAuth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://app.smartsheet.com/b/authorize",
            "tokenUrl": "https://api.smartsheet.com/2.0/token",
            "scopes": {
              "ADMIN_SHEETS": "Modify sheet structure, including column definition, publish state, etc.",
              "ADMIN_SIGHTS": "Modify dashboards structure.",
              "ADMIN_USERS": "Add and remove users from your Smartsheet organization account; create groups and manage membership.",
              "ADMIN_WEBHOOKS": "Create, delete, and update webhooks; get all webhooks; reset shared secret.",
              "ADMIN_WORKSPACES": "Create and manage workspaces and folders, including sharing.",
              "CREATE_SHEETS": "Create new sheets.",
              "CREATE_SIGHTS": "Create new dashboards.",
              "DELETE_SHEETS": "Delete sheets.",
              "DELETE_SIGHTS": "Delete dashboards.",
              "READ_CONTACTS": "Retrieve contacts.",
              "READ_EVENTS": "Retrieve events.",
              "READ_SHEETS": "Read all sheet data, including attachments, discussions, and cell data.",
              "READ_SIGHTS": "Read all dashboards data.",
              "READ_USERS": "Retrieve users and groups for your Smartsheet organization account.",
              "SHARE_SHEETS": "Share sheets, including sending sheets as attachments.",
              "SHARE_SIGHTS": "Share dashboards.",
              "WRITE_SHEETS": "Insert and modify sheet data, including attachments, discussions, and cell data."
            }
          }
        }
      },
      "APIToken": {
        "scheme": "bearer",
        "type": "http",
        "description": "API Token."
      }
    },
    "parameters": {
      "Authorization": {
        "name": "Authorization",
        "in": "header",
        "description": "API Access Token used to authenticate requests to Smartsheet APIs.\n",
        "schema": {
          "type": "string"
        }
      },
      "smartsheetIntegrationSourceHeader": {
        "in": "header",
        "name": "smartsheet-integration-source",
        "schema": {
          "type": "string",
          "description": "Uses the following metadata to distinguish between human-initiated API requests and third-party service-initiated calls by AI Connectors or ITSM:\n\n- Integration source type\n- Organization name\n- Integration source name \n\nFormat:\n\n```\nTYPE,OrgName,SourceName\n```\n\nExamples: \n\n`AI,SampleOrg,My-AI-Connector-v2`\n\n`SCRIPT,SampleOrg2,Accounting-updater-script`\n\n`APPLICATION,SampleOrg3,SheetUpdater`\n",
          "example": "AI,SampleOrg,My-AI-Connector-v2"
        }
      },
      "includeAll": {
        "name": "includeAll",
        "in": "query",
        "required": false,
        "description": "If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified).",
        "schema": {
          "type": "boolean",
          "default": false
        }
      },
      "modifiedSince": {
        "name": "modifiedSince",
        "in": "query",
        "required": false,
        "description": "When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version.",
        "schema": {
          "$ref": "#/components/schemas/Timestamp"
        }
      },
      "numericDates": {
        "name": "numericDates",
        "in": "query",
        "schema": {
          "type": "boolean",
          "default": false
        },
        "description": "You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request."
      },
      "page": {
        "name": "page",
        "in": "query",
        "required": false,
        "description": "Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned.",
        "schema": {
          "type": "number",
          "default": 1
        }
      },
      "pageSize": {
        "name": "pageSize",
        "in": "query",
        "required": false,
        "description": "The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request.",
        "schema": {
          "type": "number",
          "default": 100
        }
      },
      "contactId": {
        "name": "contactId",
        "in": "path",
        "schema": {
          "type": "number"
        },
        "required": true,
        "description": "ID of the contact being accessed."
      },
      "contactInclude": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of optional elements to include in the response:\n  * **profileImage**\n",
        "schema": {
          "type": "string",
          "enum": [
            "profileImage"
          ]
        }
      },
      "Accept-Encoding": {
        "name": "Accept-Encoding",
        "in": "header",
        "description": "Strongly recommended to make sure payload is compressed. Must be set to one of the following values:\n* deflate\n* gzip\n",
        "schema": {
          "type": "string",
          "enum": [
            "deflate",
            "gzip"
          ]
        },
        "required": false
      },
      "ActorId": {
        "name": "x-smar-sc-actor-id",
        "description": "ID of the user.",
        "in": "header",
        "schema": {
          "type": "string",
          "example": "100012"
        }
      },
      "favoriteInclude": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of optional elements to include in the response.\n",
        "schema": {
          "type": "string",
          "enum": [
            "directId",
            "name"
          ]
        }
      },
      "Content-Type": {
        "name": "Content-Type",
        "in": "header",
        "description": "Required for POST and PUT requests. Defines the structure for the request body.\n",
        "schema": {
          "type": "string",
          "default": "application/json"
        }
      },
      "favoriteType": {
        "name": "favoriteType",
        "in": "path",
        "schema": {
          "type": "string",
          "enum": [
            "folder",
            "report",
            "sheet",
            "sight",
            "template",
            "workspace"
          ]
        },
        "required": true,
        "description": "The favorite type."
      },
      "favoriteIds": {
        "name": "objectIds",
        "in": "query",
        "required": true,
        "description": "A comma-separated list of Ids of the favorited item.\n",
        "schema": {
          "type": "string"
        }
      },
      "favoriteId": {
        "name": "favoriteId",
        "in": "path",
        "schema": {
          "type": "number"
        },
        "required": true,
        "description": "ID of the favorite being accessed. For example, the ID of a sheet or report."
      },
      "folderId": {
        "name": "folderId",
        "in": "path",
        "schema": {
          "type": "number"
        },
        "required": true,
        "description": "ID of the folder being accessed."
      },
      "folderWorkspaceInclude": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of optional elements to include in the response:\n  * **source** - adds the Source object indicating which object the folder was created from, if any\n  * **distributionLink**\n  * **ownerInfo** Returns the user with owner permissions, or the user with admin permissions if there is no owner assigned. If no owner or admins are assigned, the Plan Asset Admin is returned. If no Plan Asset Admin is assigned, the System Admin is returned.\n  * **sheetVersion**\n  * **permalinks**\n",
        "schema": {
          "type": "string",
          "enum": [
            "source",
            "distributionLink",
            "ownerInfo",
            "sheetVersion"
          ]
        }
      },
      "Content-Type_AppJsonOnly": {
        "name": "Content-Type",
        "in": "header",
        "required": true,
        "description": "Defines the structure for the request body.",
        "schema": {
          "type": "string",
          "enum": [
            "application/json"
          ]
        }
      },
      "includeSource": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of optional elements to include in the response:\n  * **source** - adds the Source object indicating which object this resource was created from, if any\n",
        "schema": {
          "type": "string",
          "enum": [
            "source"
          ]
        }
      },
      "childrenResourceTypes": {
        "name": "childrenResourceTypes",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of the child types to include in the response.  When `templates` is included, you must also include `sheets` in `childrenResourceTypes` since templates are sheet templates.\n",
        "schema": {
          "type": "string",
          "enum": [
            "sheets",
            "reports",
            "sights",
            "folders",
            "templates"
          ]
        }
      },
      "includeForChildren": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of optional elements to include in the response:\n  * **source** - adds the Source object indicating which object this resource was created from, if any\n  * **ownerInfo** Returns the user with owner permissions, or the user with admin permissions if there is no owner assigned. If no owner or admins are assigned, the Plan Asset Admin is returned. If no Plan Asset Admin is assigned, the System Admin is returned. If no owner or admins are available, no owner info data is returned.\n",
        "schema": {
          "type": "string",
          "enum": [
            "source",
            "ownerInfo"
          ]
        }
      },
      "accessApiLevel": {
        "name": "accessApiLevel",
        "in": "query",
        "required": false,
        "description": "Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1.\n",
        "schema": {
          "type": "number",
          "default": 0
        }
      },
      "lastKey": {
        "name": "lastKey",
        "in": "query",
        "required": false,
        "description": "The lastKey token returned from the previous page of results. If not specified,\nthe first page of results is returned.\n",
        "schema": {
          "type": "string",
          "example": "abcDefGhIjKlMnOpQrStUvWxYz"
        }
      },
      "sheetCopyInclude": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of elements to copy:\n\n- `\"attachments\"` \n- `\"cellLinks\"` - includes cross-sheet references\n- `\"data\"` - includes formatting\n- `\"discussions\"` - includes comments\n- `\"filters\"` \n- `\"forms\"` \n- `\"ruleRecipients\"` -- includes notification recipients, must also include rules when using this attribute\n- `\"rules\"` -- includes notifications and workflow rules\n- `\"shares\"` \n\n**Important:** This operation doesn't copy cell history.\n",
        "schema": {
          "type": "string",
          "enum": [
            "attachments",
            "cellLinks",
            "data",
            "discussions",
            "filters",
            "forms",
            "ruleRecipients",
            "rules",
            "shares"
          ]
        }
      },
      "sheetCopyExclude": {
        "name": "exclude",
        "in": "query",
        "required": false,
        "description": "When specified with a value of **sheetHyperlinks**, excludes this category from the response",
        "schema": {
          "type": "string",
          "enum": [
            "sheetHyperlinks"
          ]
        }
      },
      "skipRemap": {
        "name": "skipRemap",
        "in": "query",
        "description": "A comma-separated list of references to NOT re-map for the newly created folder.",
        "schema": {
          "type": "string",
          "enum": [
            "cellLinks",
            "reports",
            "sheetHyperlinks",
            "sights"
          ]
        },
        "required": false
      },
      "include": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "Additional parameter to create a sheet from template.\nA comma-separated list of elements to copy from the template.\n",
        "schema": {
          "type": "string",
          "enum": [
            "attachments",
            "cellLinks",
            "data",
            "discussions",
            "filters",
            "forms",
            "ruleRecipients",
            "rules"
          ]
        }
      },
      "Content-Disposition": {
        "name": "Content-Disposition",
        "in": "header",
        "description": "Should be equal to \"attachment\" to tell the API that a file is in the body of the POST request, followed by a semicolon, followed by **filename=** and the URL-encoded filename in quotes\n",
        "schema": {
          "type": "string",
          "example": "attachment; filename=\"ProgressReport.docx\""
        }
      },
      "parameters-Content-Type": {
        "name": "Content-Type",
        "in": "header",
        "required": true,
        "description": "Required for POST request to import a sheet from CSV/XLSX file.\n* For CSV files, use: Content-Type: text/csv\n* For XLSX files, use: Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\n",
        "schema": {
          "type": "string",
          "enum": [
            "text/csv",
            "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
          ]
        }
      },
      "sheetName": {
        "name": "sheetName",
        "in": "query",
        "schema": {
          "type": "string"
        },
        "required": true,
        "description": "Desired name of the sheet."
      },
      "headerRowIndex": {
        "name": "headerRowIndex",
        "in": "query",
        "schema": {
          "type": "number"
        },
        "required": false,
        "description": "A zero-based integer indicating the row number to use for column names. Rows before this are omitted.\nIf not specified, the default values are Column1, Column2, etc.\n"
      },
      "primaryColumnIndex": {
        "name": "primaryColumnIndex",
        "in": "query",
        "schema": {
          "type": "number",
          "default": 0
        },
        "required": false,
        "description": "A zero-based integer indicating the column to designate as primary.\n"
      },
      "groupId": {
        "name": "groupId",
        "description": "ID of the group being accessed",
        "in": "path",
        "required": true,
        "schema": {
          "type": "number"
        }
      },
      "userId": {
        "name": "userId",
        "description": "ID of the user being accessed.",
        "in": "path",
        "required": true,
        "schema": {
          "type": "number"
        }
      },
      "Accept": {
        "name": "Accept",
        "in": "header",
        "description": "The Accept request-header field can be used to specify certain media types which are acceptable for the response.",
        "schema": {
          "type": "string"
        },
        "required": false
      },
      "reportId": {
        "name": "reportId",
        "in": "path",
        "schema": {
          "type": "number"
        },
        "required": true,
        "description": "ID of the report being accessed."
      },
      "reportInclude": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of optional elements to include in the response:\n  * **attachments**\n  * **discussions**\n  * **proofs**\n  * **format**\n  * **objectValue** - when used in combination with a level query parameter, includes the email addresses for multi-contact data\n  * **scope** - adds the report's scope to the response\n  * **source** - adds the Source object indicating which report the report was created from, if any\n  * **sourceSheets**\n",
        "schema": {
          "type": "string",
          "enum": [
            "attachments",
            "discussions",
            "proofs",
            "format",
            "objectValue",
            "scope",
            "source",
            "sourceSheets"
          ]
        }
      },
      "reportExclude": {
        "name": "exclude",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of optional elements to not include in the response\n",
        "schema": {
          "type": "string",
          "enum": [
            "linkInFromCellDetails",
            "linksOutToCellsDetails"
          ]
        }
      },
      "reportLevel": {
        "name": "level",
        "in": "query",
        "required": false,
        "description": "specifies whether new functionality, such as multi-contact data is returned in a backwards-compatible, text format (level=0, default), multi-contact data (level=1), or multi-picklist data (level=3).",
        "schema": {
          "type": "integer",
          "default": 0
        }
      },
      "AcceptAppJSONOnly": {
        "name": "Accept",
        "in": "header",
        "description": "Specifies that application/json is the only acceptable media type for the response.",
        "schema": {
          "type": "string",
          "enum": [
            "application/json"
          ],
          "example": "application/json"
        }
      },
      "sharingInclude": {
        "name": "sharingInclude",
        "in": "query",
        "description": "When applicable for the specific object this parameter defines the scope of the share. Possible values are ITEM or WORKSPACE. ITEM is an item-level share (that is, the specific object to which the share applies is shared with the user or group). WORKSPACE is a workspace-level share (that is, the workspace that contains the object to which the share applies is shared with the user or group).",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "ITEM",
            "WORKSPACE"
          ]
        }
      },
      "sendEmail": {
        "name": "sendEmail",
        "in": "query",
        "description": "Either true or false to indicate whether to notify the user by email. Default is false. If true, limit is 1000 emails.",
        "required": false,
        "schema": {
          "type": "boolean",
          "default": false
        }
      },
      "shareId": {
        "name": "shareId",
        "in": "path",
        "schema": {
          "type": "string"
        },
        "required": true,
        "description": "The unique identifier for the share."
      },
      "query": {
        "name": "query",
        "in": "query",
        "required": true,
        "description": "Text with which to perform the search.\n\n**Tip:** To match the exact text, wrap the query in double-quotes.\n",
        "schema": {
          "type": "string"
        }
      },
      "location": {
        "name": "location",
        "in": "query",
        "required": false,
        "description": "**Deprecated** When specified with a value of **personalWorkspace**, limits the response to only those items in the user's workspaces.\n",
        "schema": {
          "type": "string",
          "default": ""
        },
        "deprecated": true
      },
      "parameters-include": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "When specified with a value of `\"favoriteFlag\"`, the response indicates which returned items and item parents belong to the user's favorites.\n\n**Scenarios:**\n\n- If a matching item is a favorite, the search result for that item includes this property setting: `\"favorite\": true`\n- If the parent of a matching item is a favorite, the search result for that item includes this property setting: `\"parentObjectFavorite\": true`\n",
        "schema": {
          "type": "string",
          "enum": [
            "favoriteFlag"
          ]
        }
      },
      "scopes": {
        "name": "scopes",
        "in": "query",
        "required": false,
        "description": "If search fails, try using an array for each type of this comma-separated list of search filters.",
        "schema": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "attachments",
              "cellData",
              "comments",
              "folderNames",
              "reportNames",
              "sheetNames",
              "sightNames",
              "summaryFields",
              "templateNames",
              "workspaceNames"
            ]
          }
        }
      },
      "sheetId": {
        "name": "sheetId",
        "in": "path",
        "schema": {
          "type": "number"
        },
        "required": true,
        "description": "ID of the sheet being accessed."
      },
      "assetType": {
        "name": "assetType",
        "in": "query",
        "required": true,
        "description": "The type of the asset. Used in combination with assetId to determine the asset.\n",
        "schema": {
          "type": "string",
          "enum": [
            "sheet",
            "report",
            "sight",
            "workspace",
            "collection",
            "file"
          ],
          "example": "sheet"
        }
      },
      "assetId": {
        "name": "assetId",
        "in": "query",
        "required": true,
        "description": "The ID of the asset being accessed. It's used in combination with `assetType` to determine the asset.\n\nDepending on the asset, this may be a numeric or string value.\n",
        "schema": {
          "type": "string",
          "example": "1234567890"
        }
      },
      "maxItems": {
        "name": "maxItems",
        "in": "query",
        "description": "Request query parameter used in endpoints that support token based pagination.\n\nThe maximum amount of items to return in the response. The default and minimum are 100.\n",
        "schema": {
          "type": "integer",
          "format": "int32",
          "default": 100,
          "minimum": 100,
          "example": 100
        }
      },
      "sheetInclude": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of optional elements to include in the response:\n* **sheetVersion** - current version number of each sheet, should not be combined with pagination\n* **source** - the Source object for any sheet that was created from another sheet, if any\n",
        "schema": {
          "type": "string",
          "enum": [
            "sheetVersion",
            "source"
          ]
        }
      },
      "parameters-sheetInclude": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of optional elements to include in the response:\n  * **attachments** - includes the metadata for sheet-level and row-level attachments. To include discussion attachments, both attachments and discussions must be present in the include list.\n  * **columnType** -includes columnType attribute in the row's cells indicating the type of the column the cell resides in.\n  * **crossSheetReferences** - includes the cross-sheet references\n  * **discussions** - includes sheet-level and row-level discussions. To include discussion attachments, both attachments and discussions must be present in the include list.\n  * **filters** - includes filteredOut attribute indicating if the row should be displayed or hidden according to the sheet's filters.\n  * **filterDefinitions** - includes type of filter, operators used, and criteria\n  * **format** -  includes column, row, cell, and summary fields formatting.\n  * **ganttConfig** - includes Gantt chart details.\n  * **objectValue** - when used in combination with a level query parameter, includes the email addresses for multi-contact data.\n  * **ownerInfo** - includes the owner's email address and the owner's user ID.\n  * **rowPermalink** - includes permalink attribute that represents a direct link to the row in the Smartsheet application.\n  * **source** - adds the Source object indicating which report, sheet  Sight (aka dashboard), or template the sheet was created from, if any.\n  * **writerInfo** - includes createdBy and modifiedBy attributes on the row or summary fields, indicating the row or summary field's creator, and last modifier.\n",
        "schema": {
          "type": "string",
          "enum": [
            "attachments",
            "columnType",
            "crossSheetReferences",
            "discussions",
            "filters",
            "filterDefinitions",
            "format",
            "ganttConfig",
            "objectValue",
            "ownerInfo",
            "rowPermalink",
            "source",
            "writerInfo"
          ]
        }
      },
      "sheetExclude": {
        "name": "exclude",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of element types to exclude from the response:\n  * **filteredOutRows** - excludes filtered-out rows from response payload if a sheet filter is applied; includes total number of filtered rows\n  * **linkInFromCellDetails** - excludes the following attributes from the **cell.linkInFromCell** object: `columnId`, `rowId`, `status`\n  * **linksOutToCellsDetails** - excludes the following attributes from the **cell.linksOutToCells** array elements: `columnId`, `rowId`, `status`\n  * **nonexistentCells** - excludes empty cells\n",
        "schema": {
          "type": "string",
          "enum": [
            "filteredOutRows",
            "linkInFromCellDetails",
            "linksOutToCellsDetails",
            "nonexistentCells"
          ]
        }
      },
      "sheetColumnIds": {
        "name": "columnIds",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of column ids. The response contains only the specified columns in the \"columns\" array, and individual rows' \"cells\" array only contains cells in the specified columns.\n",
        "schema": {
          "type": "string"
        }
      },
      "sheetFilterId": {
        "name": "filterId",
        "in": "query",
        "required": false,
        "description": "Overrides the existing include={filters} parameter if both are supplied. Applies the given filter (if accessible by the calling user) and marks the affected rows as \"filteredOut\": true.\n",
        "schema": {
          "type": "string"
        }
      },
      "sheetIfVersionAfter": {
        "name": "ifVersionAfter",
        "in": "query",
        "required": false,
        "description": "If version specified is still the current sheet version, then returns an abbreviated Sheet object with only the sheet version property. Otherwise, if the sheet has been modified, returns the complete Sheet object. Intended to allow clients with a cached copy to make sure they have the latest version.\n",
        "schema": {
          "type": "integer"
        }
      },
      "sheetLevel": {
        "name": "level",
        "in": "query",
        "required": false,
        "description": "Specifies whether object data types, such as multi-contact data are returned in a backwards-compatible, text format in text/number columns.<br>  - Set `level=0` (default) to use text/number columns for multi-contact data and multi-picklist data.<br>  - Set `level=1` to use multiple-entry contact list columns for multi-contact data; multi-picklist data is returned in text/number columns.<br>  - Set `level=2` to use multiple-entry contact list columns for multi-contact data and use multiple-entry picklist columns for multi-picklist data.",
        "schema": {
          "type": "integer",
          "default": 0
        }
      },
      "paperSize": {
        "name": "paperSize",
        "in": "query",
        "required": false,
        "description": "applies to PDF format only",
        "schema": {
          "type": "string",
          "enum": [
            "LETTER",
            "LEGAL",
            "WIDE",
            "ARCHD",
            "A4",
            "A3",
            "A2",
            "A1",
            "A0"
          ],
          "default": "LETTER"
        }
      },
      "sheetRowIds": {
        "name": "rowIds",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of row Ids on which to filter the rows included in the result.\n",
        "schema": {
          "type": "string"
        }
      },
      "sheetRowNumbers": {
        "name": "rowNumbers",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of row numbers on which to filter the rows included in the result. Non-existent row numbers are ignored.\n",
        "schema": {
          "type": "string"
        }
      },
      "sheetRowsModifiedSince": {
        "name": "rowsModifiedSince",
        "in": "query",
        "required": false,
        "description": "Filter to return only rows that have been modified since the date/time provided. Date should be in ISO-8601 format.",
        "example": "2020-01-30T13:25:32-07:00",
        "schema": {
          "$ref": "#/components/schemas/Timestamp"
        }
      },
      "attachmentId": {
        "name": "attachmentId",
        "in": "path",
        "required": true,
        "description": "ID of the attachment being accessed.",
        "schema": {
          "type": "string"
        }
      },
      "automationRuleId": {
        "name": "automationRuleId",
        "in": "path",
        "required": true,
        "description": "ID of the automation rule being accessed",
        "schema": {
          "type": "string"
        }
      },
      "columnsLevel": {
        "name": "level",
        "in": "query",
        "required": false,
        "description": "Specifies whether object data types, such as multi-contact data are returned in a backwards-compatible, text format in text/number columns.<br>  - Set `level=0` (default) to use text/number columns for multi-contact data and multi-picklist data.<br>  - Set `level=1` to use multiple-entry contact list columns for multi-contact data; multi-picklist data is returned in text/number columns.<br>  - Set `level=2` to use multiple-entry contact list columns for multi-contact data and use multiple-entry picklist columns for multi-picklist data.",
        "schema": {
          "type": "integer",
          "default": 0
        }
      },
      "columnId": {
        "name": "columnId",
        "in": "path",
        "schema": {
          "type": "number"
        },
        "required": true,
        "description": "ID of the sheet column being accessed."
      },
      "commentId": {
        "name": "commentId",
        "in": "path",
        "required": true,
        "description": "ID of the comment being accessed.",
        "schema": {
          "type": "string"
        }
      },
      "crossSheetReferenceId": {
        "name": "crossSheetReferenceId",
        "in": "path",
        "schema": {
          "type": "number"
        },
        "required": true,
        "description": "ID of the cross-sheet reference being accessed."
      },
      "discussionInclude": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of optional elements to include in the response:\n  * **attachments** - effective only if comments is present, otherwise ignored\n  * **comments** - include all comments in threads\n",
        "schema": {
          "type": "string",
          "enum": [
            "attachments",
            "comments"
          ]
        }
      },
      "discussionId": {
        "name": "discussionId",
        "in": "path",
        "required": true,
        "description": "ID of the discussion being accessed.",
        "schema": {
          "type": "string"
        }
      },
      "proofId": {
        "name": "proofId",
        "in": "path",
        "required": true,
        "description": "ID of the original proof.",
        "schema": {
          "type": "string"
        }
      },
      "proofInclude": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of optional elements to include in the response.\n",
        "schema": {
          "type": "string",
          "enum": [
            "attachments",
            "discussions"
          ]
        }
      },
      "allowPartialSuccess": {
        "name": "allowPartialSuccess",
        "in": "query",
        "description": "When specified with a value of true, enables partial success for this bulk operation. See [Bulk operations > Partial success](/api/smartsheet/guides/advanced-topics/scalability-options) for more information.",
        "schema": {
          "type": "boolean",
          "default": false
        },
        "required": false
      },
      "overrideValidation": {
        "name": "overrideValidation",
        "in": "query",
        "description": "You may use the query string parameter **overrideValidation** with a value of **true** to allow a cell value outside of the validation limits. You must specify **strict** with a value of **false** to bypass value type checking.",
        "schema": {
          "type": "boolean",
          "default": false
        },
        "required": false
      },
      "rowIds": {
        "name": "ids",
        "in": "query",
        "required": true,
        "description": "A comma-separated list of row Ids.\n",
        "schema": {
          "type": "string"
        }
      },
      "ignoreRowsNotFound": {
        "name": "ignoreRowsNotFound",
        "description": "**true** or **false**. If set to **false** and any of the specified row Ids are not found, no rows are deleted, and the \"not found\" [error](/api/smartsheet/openapi/schemas/error) is returned.\n",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean",
          "default": false
        }
      },
      "copyRowsInclude": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of row elements to copy in addition to the cell data:\n  * **all** - specify a value of **all** to include everything (attachments, children, and discussions).\n  * **attachments**\n  * **children** -  if specified, any child rows of the rows specified in the request are also copied to the destination sheet, and parent-child relationships amongst rows are preserved within the destination sheet; if not specified, only the rows specified in the request are copied.\n  * **discussions**\n",
        "schema": {
          "type": "string",
          "enum": [
            "all",
            "attachments",
            "children",
            "discussions"
          ]
        }
      },
      "ignoreRowsNotFoundForCopyRows": {
        "name": "ignoreRowsNotFound",
        "description": "**true** or **false**: default is **false**. If set to **true**, specifying row Ids that do not exist within the source sheet does not cause an error response. If omitted or set to **false**, specifying row Ids that do not exist within the source sheet causes an error response (and no rows are copied).\n",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean",
          "default": false
        }
      },
      "moveRowsInclude": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separate list of row elements to move in addition to the cell data.\n",
        "schema": {
          "type": "string",
          "enum": [
            "attachments",
            "discussions"
          ]
        }
      },
      "ignoreRowsNotFoundForMoveRows": {
        "name": "ignoreRowsNotFound",
        "description": "**true** or **false**: default is **false**. If set to **true**, specifying row Ids that do not exist within the source sheet does not cause an error response. If omitted or set to **false**, specifying row Ids that do not exist within the source sheet causes an error response (and no rows are moved).\n",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean",
          "default": false
        }
      },
      "rowId": {
        "name": "rowId",
        "in": "path",
        "schema": {
          "type": "number"
        },
        "required": true,
        "description": "ID of the sheet row being accessed."
      },
      "rowInclude": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of elements to include in the response.\n\nSee [Row Include Flags](/api/smartsheet/openapi/rows).\n\nAlso supports the **columns** include flag, which adds a columns array that specifies all of the columns for the sheet. This enables you to have the full context of the cells in the row.\n\nThe **filters** include flag returns a **filteredOut** attribute indicating if the row should be displayed or hidden according to the sheet's filters.\n",
        "schema": {
          "type": "string",
          "enum": [
            "columns",
            "filters"
          ]
        }
      },
      "Content-Length": {
        "name": "Content-Length",
        "in": "header",
        "description": "Must be set to the size of the file, in bytes. For example to determine file size using in UNIX:\n$ ls -l ProgressReport.docx\n5463 ProgressReport.docx\n",
        "schema": {
          "type": "integer",
          "example": 5463
        }
      },
      "altText": {
        "name": "altText",
        "in": "query",
        "description": "Url-encoded alternate text for the image",
        "schema": {
          "type": "string"
        },
        "required": false
      },
      "cellHistoryInclude": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of elements to copy:\n  * **columnType** - includes the columnType attribute for each Cell object\n  * **objectValue** - when used in combination with a level query parameter, includes the email addresses for a multi-contact cell.\n",
        "schema": {
          "type": "string",
          "enum": [
            "columnType",
            "objectValue"
          ]
        }
      },
      "sheetSummaryInclude": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of elements to include in the response.\n* **format**: includes format info for cells, rows, and summary fields\n* **writerInfo**: includes createdBy and modifiedBy attributes for rows and summary fields\n",
        "schema": {
          "type": "string",
          "enum": [
            "format",
            "writerInfo"
          ]
        }
      },
      "sheetSummaryExclude": {
        "name": "exclude",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of elements to not include in the response.\n* **displayValue**: excludes displayValue info for cells, rows, and summary fields\n* **image**: excludes image attributes for cells and summary fields\n* **imageAltText**: excludes alt text for cells and summary fields\n",
        "schema": {
          "type": "string",
          "enum": [
            "displayValue",
            "image",
            "imageAltText"
          ]
        }
      },
      "renameIfConflict": {
        "name": "renameIfConflict",
        "description": "Set to true if you want to override the requirement for unique summary field names. Repeated names will be adjusted by appending \"(1)\" or similar after the field name.",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean",
          "default": false
        }
      },
      "sheetSummaryFieldIds": {
        "name": "ids",
        "in": "query",
        "required": true,
        "description": "A comma-separated list of Sheet Summary Field Ids.\n",
        "schema": {
          "type": "string"
        }
      },
      "ignoreSummaryFieldsNotFound": {
        "name": "ignoreSummaryFieldsNotFound",
        "description": "If **true**, the operation will succeed even if some fieldIds are not found.",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean",
          "default": false
        }
      },
      "summaryFieldId": {
        "name": "fieldId",
        "in": "path",
        "schema": {
          "type": "number"
        },
        "required": true,
        "description": "ID of the sheet summary field being accessed."
      },
      "sortRows": {
        "name": "include&exclude",
        "in": "query",
        "required": false,
        "description": "(Optional) Any of the relevant parameters or query parameters listed for [Get Sheet](/api/smartsheet/openapi/sheets/getsheet).\n",
        "schema": {
          "type": "string"
        }
      },
      "sightId": {
        "name": "sightId",
        "in": "path",
        "required": true,
        "description": "ID of the dashboard (sight) being accessed.",
        "schema": {
          "type": "string"
        }
      },
      "sightInclude": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of optional elements to include in the response:\n  * **objectValue** - when used in combination with a **level** query parameter, includes the email addresses for multi-contact data.\n  * **source** - the Source object for any Sight that was created from another Sight, if any\n",
        "schema": {
          "type": "string",
          "enum": [
            "objectValue",
            "source"
          ]
        }
      },
      "sightLevel": {
        "name": "level",
        "in": "query",
        "required": false,
        "description": "Specifies whether new functionality, such as multi-contact data is returned in a backwards-compatible, text format (**level=0**, default), multi-contact data (**level=2**), multi-picklist data (**level=3**), or Metric widget with sheet summary (**level=4**).",
        "schema": {
          "type": "integer",
          "default": 0
        }
      },
      "sightIdNumber": {
        "name": "sightId",
        "in": "path",
        "schema": {
          "type": "number"
        },
        "required": true,
        "description": "ID of the dashboard (sight) being accessed."
      },
      "emailInclude": {
        "name": "email",
        "description": "Comma-separated list of email addresses on which to filter the results.",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      "lastLoginInclude": {
        "name": "include",
        "description": "Set `include=lastLogin` to include the `lastLogin` property in the response, which contains the timestamp of each user's most recent login to Smartsheet.\n\nThe `lastLogin` property appears in the response only when **all** of the following conditions are met:\n\n- The user has logged in to Smartsheet at least once\n- The caller has System Admin permissions\n- The response contains 100 or fewer users\n\nThe property is **excluded from the response** if **any** of the following conditions apply:\n\n- The `includeAll=true` query parameter is present\n- The `planId` query parameter is present\n- The `seatType` query parameter is present\n- The `pageSize` query parameter is set to a value greater than 100\n",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "lastLogin"
          ]
        }
      },
      "planId-query": {
        "name": "planId",
        "description": "Plan ID for which seat types are returned. Adding this query parameter returns users with their seat types associated to the selected planId. As a result the query can include users external to the organization.\n\n**_This query parameter is only available to system administrators_**\n",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int64",
          "minimum": 1,
          "example": 4843937635559300
        }
      },
      "seatType": {
        "name": "seatType",
        "description": "Seat type based on which to filter the results.\n\n**_This query parameter is only available to system administrators_**\n\n**DEPRECATED - As early as the sunset date specified in this [changelog entry](/api/smartsheet/changelog#deprecated-viewer-seat-type-in-favor-of-contributor-new), `VIEWER` will be removed and replaced by `CONTRIBUTOR` for all free-tier plans users.** Commenting and attachments are free to the `CONTRIBUTOR` seat type.\n",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "MEMBER",
            "PROVISIONAL_MEMBER",
            "GUEST",
            "CONTRIBUTOR",
            "VIEWER"
          ],
          "example": "MEMBER"
        }
      },
      "userProfileInclude": {
        "name": "include",
        "description": "When specified with a value of 'groups', response includes an array of groups (groupId, name, and description only) that the user is a member of.",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "groups"
          ]
        }
      },
      "alternateEmailId": {
        "name": "alternateEmailId",
        "description": "ID of the alternate email being accessed.",
        "in": "path",
        "required": true,
        "schema": {
          "type": "number"
        }
      },
      "planId-path": {
        "name": "planId",
        "description": "Plan ID.\n\nYou can access your plan ID in the Admin Center UI by clicking on your profile icon in the top-right corner. See the <a href=\"https://help.smartsheet.com/articles/2481889-admin-center-overview\" target=\"_blank\" rel=\"noopener  noreferrer\">Admin Center Overview</a> for details.\n",
        "in": "path",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int64",
          "minimum": 1
        }
      },
      "webhookId": {
        "name": "webhookId",
        "in": "path",
        "required": true,
        "description": "ID of the webhook being accessed.",
        "schema": {
          "type": "string"
        }
      },
      "paginationType": {
        "name": "paginationType",
        "in": "query",
        "required": false,
        "description": "Specifies the type of pagination to use. When set to 'token', enables\ntoken-based pagination.\n",
        "schema": {
          "type": "string",
          "enum": [
            "token"
          ]
        }
      },
      "maxItemsListWorkspaces": {
        "name": "maxItems",
        "in": "query",
        "description": "Request query parameter used in ListWorkspaces endpoints that support token based pagination.\n\nThe maximum amount of items to return in the response. The default and minimum are 100.\n",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "default": 100,
          "minimum": 100,
          "maximum": 1000,
          "example": 100
        }
      },
      "workspaceId": {
        "name": "workspaceId",
        "in": "path",
        "schema": {
          "type": "string"
        },
        "required": true,
        "description": "ID of the workspace being accessed."
      },
      "workspaceCopyInclude": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "A comma-separated list of elements to include:\n\n  - `\"all\"`\n  - `\"attachments\"`\n  - `\"brand\"`\n  - `\"cellLinks\"` - includes cross-sheet references\n  - `\"data\"` - includes formatting\n  - `\"discussions\"` - includes comments\n  - `\"filters\"`\n  - `\"forms\"`\n  - `\"ruleRecipients\"`\n  - `\"rules\"`\n  - `\"shares\"`\n\n**Important:** This operation doesn't copy cell history.\n",
        "schema": {
          "type": "string",
          "enum": [
            "all",
            "attachments",
            "brand",
            "cellLinks",
            "data",
            "discussions",
            "filters",
            "forms",
            "ruleRecipients",
            "rules",
            "shares"
          ]
        }
      }
    },
    "responses": {
      "400": {
        "description": "Bad Request.  See Smartsheet Error Code and Message for details.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized.  See Smartsheet Error Code and Message for details.\n",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "examples": {
              "1001Example": {
                "summary": "401 - 1001 - An Access Token is required",
                "value": {
                  "errorCode": 1001,
                  "message": "An Access Token is required",
                  "refId": "exlxshtxlpl8"
                }
              },
              "1002Example": {
                "summary": "401 - 1002  - Your Access Token is invalid",
                "value": {
                  "errorCode": 1003,
                  "message": "Your Access Token is invalid",
                  "refId": "exlxshtxlpl8"
                }
              },
              "1003Example": {
                "summary": "401 - 1003 - Your Access Token has expired",
                "value": {
                  "errorCode": 1003,
                  "message": "Your Access Token has expired",
                  "refId": "exlxshtxlpl8"
                }
              },
              "1005Example": {
                "summary": "401 - 1005 - Single Sign-On is required for this account",
                "value": {
                  "errorCode": 1005,
                  "message": "Single Sign-On is required for this account",
                  "refId": "exlxshtxlpl8"
                }
              },
              "1030Example": {
                "summary": "401 - 1030 - You are unable to assume the user specified",
                "value": {
                  "errorCode": 1030,
                  "message": "You are unable to assume the user specified",
                  "refId": "exlxshtxlpl8"
                }
              },
              "1067Example": {
                "summary": "401 - 1067 - Invalid client_id",
                "value": {
                  "errorCode": 1067,
                  "message": "Invalid client_id",
                  "refId": "exlxshtxlpl8"
                }
              }
            }
          }
        }
      },
      "403": {
        "description": "Forbidden.  See Smartsheet Error Code and Message for details.\n",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "404": {
        "description": "Not Found.  See Smartsheet Error Code and Message for details.\n",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "examples": {
              "1006Example": {
                "summary": "404 - 1006 - Not Found",
                "value": {
                  "errorCode": 1006,
                  "message": "Not Found",
                  "refId": "exlxshtxlpl8"
                }
              }
            }
          }
        }
      },
      "405": {
        "description": "Method Not Allowed.  See Smartsheet Error Code and Message for details.\n",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "examples": {
              "1010Example": {
                "summary": "404 - 1010 - HTTP Method Not Supported",
                "value": {
                  "errorCode": 1010,
                  "message": "HTTP Method Not Supported",
                  "refId": "exlxshtxlpl8"
                }
              },
              "1122Example": {
                "summary": "404 - 1122 - Requested URL does not support this method: {0}",
                "value": {
                  "errorCode": 1122,
                  "message": "Requested URL does not support this method: {0}.",
                  "refId": "exlxshtxlpl8"
                }
              }
            }
          }
        }
      },
      "406": {
        "description": "Not Acceptable.  See Smartsheet Error Code and Message for details.\n",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "examples": {
              "1052Example": {
                "summary": "Invalid Accept header. Media type not supported.",
                "value": {
                  "errorCode": 1052,
                  "message": "Invalid Accept header. Media type not supported.",
                  "refId": "exlxshtxlpl8"
                }
              }
            }
          }
        }
      },
      "410": {
        "description": "Gone.  See Smartsheet Error Code and Message for details.\n",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "examples": {
              "4005Example": {
                "summary": "API Version Retired.",
                "value": {
                  "errorCode": 4005,
                  "message": "API Version Retired.",
                  "refId": "exlxshtxlpl8"
                }
              }
            }
          }
        }
      },
      "415": {
        "description": "Gone.  See Smartsheet Error Code and Message for details.\n",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "examples": {
              "1124Example": {
                "summary": "Invalid Content-Type header. Media type not supported.",
                "value": {
                  "errorCode": 1124,
                  "message": "Invalid Content-Type header. Media type not supported.",
                  "refId": "exlxshtxlpl8"
                }
              }
            }
          }
        }
      },
      "429": {
        "description": "Gone.  See Smartsheet Error Code and Message for details.\n",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "examples": {
              "4003Example": {
                "summary": "Rate limit exceeded.",
                "value": {
                  "errorCode": 4003,
                  "message": "Rate limit exceeded.",
                  "refId": "exlxshtxlpl8"
                }
              }
            }
          }
        }
      },
      "500": {
        "description": "Internal Server Error.  See Smartsheet Error Code and Message for details.\n",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "examples": {
              "1119Example": {
                "summary": "500 - 1119 - Failed to complete copy",
                "value": {
                  "errorCode": 1119,
                  "message": "Failed to complete copy.",
                  "refId": "exlxshtxlpl8"
                }
              },
              "1170Example": {
                "summary": "500 - 1170 - The sheet referenced by this widget is unavailable or deleted.",
                "value": {
                  "errorCode": 1170,
                  "message": "The sheet referenced by this widget is unavailable or deleted.",
                  "refId": "exlxshtxlpl8"
                }
              },
              "1171Example": {
                "summary": "500 - 1171 - The report referenced by this widget is unavailable or deleted.",
                "value": {
                  "errorCode": 1171,
                  "message": "The report referenced by this widget is unavailable or deleted.",
                  "refId": "exlxshtxlpl8"
                }
              },
              "1172Example": {
                "summary": "500 - 1172 - The referenced cell is unavailable or deleted.",
                "value": {
                  "errorCode": 1172,
                  "message": "The referenced cell is unavailable or deleted.",
                  "refId": "exlxshtxlpl8"
                }
              },
              "1278Example": {
                "summary": "500 - 1278 - Proofing service error.",
                "value": {
                  "errorCode": 1278,
                  "message": "Proofing service error.",
                  "refId": "exlxshtxlpl8"
                }
              },
              "1285Example": {
                "summary": "500 - 1285 - Dashboard source profile field missing.",
                "value": {
                  "errorCode": 1285,
                  "message": "Dashboard source profile field missing.",
                  "refId": "exlxshtxlpl8"
                }
              },
              "4000Example": {
                "summary": "500 - 4000 - An unexpected error has occurred. Please contact Support for assistance.",
                "value": {
                  "errorCode": 4000,
                  "message": "An unexpected error has occurred. Please contact Support for assistance.",
                  "refId": "exlxshtxlpl8"
                }
              },
              "4001Example": {
                "summary": "500 - 4001 - Smartsheet.com is currently offline for system maintenance. Please check back again shortly.",
                "value": {
                  "errorCode": 4001,
                  "message": "Smartsheet.com is currently offline for system maintenance. Please check back again shortly.",
                  "refId": "exlxshtxlpl8"
                }
              },
              "4002Example": {
                "summary": "500 - 4002 - Server timeout exceeded. Request has failed.",
                "value": {
                  "errorCode": 4002,
                  "message": "Server timeout exceeded. Request has failed.",
                  "refId": "exlxshtxlpl8"
                }
              },
              "4004Example": {
                "summary": "500 - 4004 - An unexpected error has occurred. Please retry your request. If you encounter this error repeatedly, please contact Support for assistance.",
                "value": {
                  "errorCode": 4004,
                  "message": "An unexpected error has occurred. Please retry your request. If you encounter this error repeatedly, please contact Support for assistance.",
                  "refId": "exlxshtxlpl8"
                }
              },
              "4004Example2": {
                "summary": "500 - 4004 - Request failed because sheetId {0} is currently being updated by another request that uses the same access token. Please retry your request once the previous request has completed.",
                "value": {
                  "errorCode": 4004,
                  "message": "Request failed because sheetId {0} is currently being updated by another request that uses the same access token. Please retry your request once the previous request has completed.",
                  "refId": "exlxshtxlpl8"
                }
              },
              "4005Example": {
                "summary": "502 - 4005 - The Smartsheet API encountered an error for this request. Please contact Support for assistance.",
                "value": {
                  "errorCode": 4005,
                  "message": "The Smartsheet API encountered an error for this request. Please contact Support for assistance.",
                  "refId": "exlxshtxlpl8"
                }
              },
              "5151Example": {
                "summary": "500 - 5151 - The action could not be completed because the following people are outside of the approved domain sharing list:[email address]",
                "value": {
                  "errorCode": 5151,
                  "message": "The action could not be completed because the following people are outside of the approved domain sharing list:[email address]",
                  "refId": "exlxshtxlpl8"
                }
              },
              "5502Example": {
                "summary": "500 - 5502 - You must have sheet admin permission to save a notification with recipients other than yourself.",
                "value": {
                  "errorCode": 5502,
                  "message": "You must have sheet admin permission to save a notification with recipients other than yourself.",
                  "refId": "exlxshtxlpl8"
                }
              }
            }
          }
        }
      },
      "503": {
        "description": "Service Unavailable.  See Smartsheet Error Code and Message for details.\n",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "examples": {
              "4001Example": {
                "summary": "503 - 4001 - Service Unavailable",
                "value": {
                  "errorCode": 4001,
                  "message": "Smartsheet.com is currently offline for system maintenance. Please check back again shortly.",
                  "refId": "exlxshtxlpl8"
                }
              }
            }
          }
        }
      }
    }
  }
}