openapi-to-rust 0.4.0

openapi: 3.0.0
info:
  version: 1.5.0
  title: Coda API
  license:
    name: Coda Developer Terms
    url: https://coda.io/trust/developer
  description: >
    # Introduction


    The Coda API is a RESTful API that lets you programmatically interact with
    Coda docs:

     * List and search Coda docs
     * Create new docs and copy existing ones
     * Share and publish docs
     * Discover pages, tables, formulas, and controls
     * Read, insert, upsert, update, and delete rows

    As we update and release newer versions of the API, we reserve the right to
    remove

    older APIs and functionality with a 3-month deprecation notice. We will post
    about such changes as well as announce

    new features in the [Developers
    Central](https://community.coda.io/c/developers-central) section of our
    Community,

    and update the [API updates](https://coda.io/api-updates) doc.


    # Getting Started


    Our [Getting Started
    Guide](https://coda.io/@oleg/getting-started-guide-coda-api) helps you learn
    the

    basic of working with the API and shows a few ways you can use it. Check it
    out, and learn how to:


    - Read data from Coda tables and write back to them

    - Build a one-way sync from one Coda doc to another

    - Automate reminders

    - Sync your Google Calendar to Coda


    # Using the API


    Coda's REST API is designed to be straightforward to use. You can use the
    language and platform of your choice to

    make requests. To get a feel for the API, you can also use a tool like
    [Postman](https://www.getpostman.com/) or

    [Insomnia](https://insomnia.rest/).


    ## API Endpoint


    This API uses a base path of `https://coda.io/apis/v1`.


    ## Resource IDs and Links


    Each resource instance retrieved via the API has the following fields:

      - `id`: The resource's immutable ID, which can be used to refer to it within its context
      - `type`: The type of resource, useful for identifying it in a heterogenous collection of results
      - `href`: A fully qualified URI that can be used to refer to and get the latest details on the resource

    Most resources can be queried by their name or ID. We recommend sticking
    with IDs where possible, as names are

    fragile and prone to being changed by your doc's users.


    ### List Endpoints


    Endpoints supporting listing of resources have the following fields:

      - `items`: An array containing the listed resources, limited by the `limit` or `pageToken` query parameters
      - `nextPageLink`: If more results are available, an API link to the next page of results
      - `nextPageToken`: If more results are available, a page token that can be passed into the `pageToken` query parameter

    **The maximum page size may change at any time, and may be different for
    different endpoints.** Please do not rely on it

    for any behavior of your application. If you pass a `limit` parameter that
    is larger than our maximum allowed limit,

    we will only return as many results as our maximum limit. You should look
    for the presence of the `nextPageToken` on the

    response to see if there are more results available, rather than relying on
    a result set that matches your provided limit.


    To fetch a subsequent page of results, pass the `pageToken` parameter. Set
    this parameter to the value given to you as the `nextPageToken`

    in a page response. If no value is provided, there are no more results
    available. You only need to pass the `pageToken` to get

    the next page of results, you don't need to pass any of the parameters from
    your original request, as they are all

    implied by the `pageToken`. Any other parameters provided alongside a
    `pageToken` will be ignored.


    ### Doc IDs


    While most object IDs will have to be discovered via the API, you may find
    yourself frequently wanting to get the

    ID of a specific Coda doc.


    Here's a handy tool that will extract it for you. (See if you can find the
    pattern!)


    <form>
      <fieldset style="margin: 0px 25px 25px 25px; display: inline;">
        <legend>Doc ID Extractor</legend>
        <input type="text" id="de_docUrl" placeholder="Paste in a Coda doc URL"
               style="width: 250px; padding: 8px; margin-right: 20px;" />
        <span>
          Your doc ID is:&nbsp;&nbsp;&nbsp;
          <input id="de_docId" readonly="true"
                 style="width: 150px; padding: 8px; font-family: monospace; border: 1px dashed gray;" />
      </fieldset>
    </form>


    ## Rate Limiting


    The Coda API sets a reasonable limit on the number of requests that can be
    made per minute. Once this limit is

    reached, calls to the API will start returning errors with an HTTP status
    code of 429.


    These are the current rate limits. They are subject to change at any time
    without notice. For robustness,

    all API scripts should check for HTTP 429 Too Many Requests errors and back
    off and retry the request.

    Limits apply per-user across all endpoints that share the same limit and
    across all docs.


    Reading data (with the exceptions below): 100 requests per 6 seconds

    <br/>

    Writing data (POST/PUT/PATCH): 10 requests per 6 seconds

    <br/>

    Writing doc content data (POST/PUT/PATCH): 5 requests per 10 seconds

    <br/>

    Listing docs: 4 requests per 6 seconds

    <br/>

    Reading analytics: 100 requests per 6 seconds


    ## Consistency


    While edits made in Coda are shared with other collaborators in real-time,
    it can take a few seconds for them to

    become available via the API. You may also notice that changes made via the
    API, such as updating a row, are not

    immediate. These endpoints all return an HTTP 202 status code, instead of a
    standard 200, indicating that the

    edit has been accepted and queued for processing. This generally takes a few
    seconds, and the edit may fail if

    invalid. Each such edit will return a `requestId` in the response, and you
    can pass this `requestId` to the

    [`#getMutationStatus`](#operation/getMutationStatus) endpoint to find out if
    it has been applied.


    Similarly, when you get doc data from the API (rows, pages, columns, etc),
    the data you receive comes from

    the most recent "snapshot" of the doc, which might be slightly stale
    relative to the data you observe in

    your browser. If you want to ensure that the data you receive is up to date
    and are ok getting an error if not,

    you can pass this header in your request: `X-Coda-Doc-Version: latest`. If
    the API's view of the doc is

    not up to date, the API will return an HTTP 400 response.


    ## Volatile Formulas


    Coda exposes a number of "volatile" formulas, as as `Today()`, `Now()`, and
    `User()`. When used in a live Coda

    doc, these formulas affect what's visible in realtime, tailored to the
    current user.


    Such formulas behave differently with the API. Time-based values may only be
    current to the last edit made to the

    doc. User-based values may be blank or invalid.


    ## Free and Paid Workspaces


    We make the Coda API available to all of our users free of charge, in both
    free and paid workspaces. However, API

    usage is subject to the role of the user associated with the API token in
    the workspace applicable to each API

    request. What this means is:


    - For the [`#createDoc`](#operation/createDoc) endpoint specifically, the
    owner of the API token must be a Doc
      Maker (or Admin) in the workspace. If the "Any member can create docs" option in enabled in the workspace
      settings, they can be an Editor and will get auto-promoted to Doc Maker upon using this endpoint. Lastly, if in
      addition, the API key owner matches the "Auto-join email domains" setting, they will be auto-added to the
      workspace and promoted to Doc Maker upon using this endpoint

    This behavior applies to the API as well as any integrations that may use
    it, such as Zapier.


    ## Examples


    To help you get started, this documentation provides code examples in
    Python, Unix shell, and Google Apps Script.

    These examples are based on a simple doc that looks something like this:


    ![](https://cdn.coda.io/external/img/api_example_doc.png)


    ### Python examples


    These examples use Python 3.6+. If you don't already have the `requests`
    module, use `pip` or `easy_install` to

    get it.


    ### Shell examples


    The shell examples are intended to be run in a Unix shell. If you're on
    Windows, you will need to install

    [WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10).


    These examples use the standard cURL utility to pull from the API, and then
    process it with `jq` to extract and

    format example output. If you don't already have it, you can either [install
    it](https://stedolan.github.io/jq/)

    or run the command without it to see the raw JSON output.


    ### Google Apps Script examples


    ![](https://cdn.coda.io/external/img/api_gas.png)


    [Google Apps Script](https://script.google.com/) makes it easy to write code
    in a JavaScript-like syntax and

    easily access many Google products with built-in libraries. You can set up
    your scripts to run periodically,

    which makes it a good environment for writing tools without maintaining your
    own server.


    Coda provides a library for Google Apps Script. To use it, go into
    `Resources -> Libraries...` and enter the

    following library ID:
    `15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl`. If you want to
    see the

    library's source code, it's available

    [here](https://script.google.com/d/15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl/edit).


    Google provides autocomplete for API functions as well as generated docs.
    You can access these docs via the

    Libraries dialog by clicking on the library name. Required parameters that
    would be included in the URL path are

    positional arguments in each of these functions, followed by the request
    body, if applicable. All remaining

    parameters can be specified in the options object.


    ## OpenAPI/Swagger Spec


    In an effort to standardize our API and make it accessible, we offer an
    OpenAPI 3.0 specification:


    - [OpenAPI 3.0 spec - YAML](https://coda.io/apis/v1/openapi.yaml)

    - [OpenAPI 3.0 spec - JSON](https://coda.io/apis/v1/openapi.json)


    #### Postman collection


    To get started with prototyping the API quickly in Postman, you can use one
    of links above to import the Coda API

    into a collection. You'll then need to set the [appropriate
    header](#section/Authentication) and environment

    variables.


    ## Client libraries


    We do not currently support client libraries apart from Google Apps Script.
    To work with the Coda API, you can

    either use standard network libraries for your language, or use the
    appropriate Swagger Generator tool to

    auto-generate Coda API client libraries for your language of choice. We do
    not provide any guarantees that these

    autogenerated libraries are compatible with our API (e.g., some libraries
    may not work with Bearer

    authentication).


    ### OpenAPI 3.0


    [Swagger Generator 3](https://generator3.swagger.io/) (that link takes you
    to the docs for the generator API) can

    generate client libraries for [these
    languages](https://generator3.swagger.io/v2/clients). It's relatively new

    and thus only has support for a limited set of languages at this time.


    ### Third-party client libraries


    Some members of our amazing community have written libraries to work with
    our API. These aren't officially

    supported by Coda, but are listed here for convenience. (Please let us know
    if you've written a library and would

    like to have it included here.)


    - [PHP](https://github.com/danielstieber/CodaPHP) by Daniel Stieber

    - [Node-RED](https://github.com/serene-water/node-red-contrib-coda-io) by
    Mori Sugimoto

    - [NodeJS](https://www.npmjs.com/package/coda-js) by Parker McMullin

    - [Ruby](https://rubygems.org/gems/coda_docs/) by Carlos Muñoz at Getro

    - [Python](https://github.com/Blasterai/codaio) by Mikhail Beliansky

    - [Go](https://github.com/artsafin/coda-schema-generator) by Artur Safin
  termsOfService: https://coda.io/trust/tos
  contact:
    name: API Support
    url: https://coda.io
    email: help+api@coda.io
  x-logo:
    url: https://cdn.coda.io/external/img/apilogo.png
    backgroundColor: transparent
    altText: Coda API
    href: '#'
servers:
  - url: https://coda.io/apis/v1
    description: Coda API (v1)
tags:
  - name: Account
    description: >
      At this time, the API exposes some limited information about your account.
      However, `/whoami` is a good endpoint to hit to verify that you're hitting
      the API correctly and that your token is working as expected.
  - name: Analytics
    description: This API offers analytics data for your docs and Packs over time.
  - name: Automations
    description: This API allows you to trigger automations.
  - name: Columns
    description: >
      While columns in Coda have user-friendly names, they also have immutable
      IDs that are used when reading and writing rows. These endpoints let you
      query the columns in a table and get basic information about them.
  - name: Controls
    description: >
      Controls provide a user-friendly way to input a value that can affect
      other parts of the doc. This API lets you list controls and get their
      current values.
  - name: Docs
    description: >
      Coda docs are foundational, top-level collaborative projects that contain
      pages. The API lets you list and search your docs to obtain basic metadata
      like titles and ownership information.
  - name: Folders
    description: >
      Folders help you organize your docs within workspaces. This API lets you
      list, create, update, and delete folders.
  - name: Formulas
    description: >
      Formulas can be great for performing one-off computations, or used with
      tables and other formulas to compute a single value. With this API, you
      can discover formulas in a doc and obtain computed results.
  - name: Miscellaneous
    description: >
      These endpoints wouldn't fit anywhere else, but you may find them useful
      when working with Coda.
  - name: Packs
    description: >
      This API allows you to manage Packs that you have developed as well as
      list publicly available Coda packs.
  - name: Pages
    description: >
      Pages in Coda offer canvases containing rich text, tables, controls, and
      other objects. At this time, this API lets you list and access pages in a
      doc.
  - name: Permissions
    description: This API lets you manage sharing and permissions for your docs.
  - name: Publishing
    description: >
      Coda docs can be published publicly and associated with categories to help
      the world discover them. This API lets you manage the publishing settings
      of your docs.
  - name: Rows
    description: >
      You'll likely use this part of the API the most. These endpoints let you
      retrieve row data from tables in Coda as well as create, upsert, update,
      and delete them. Most of these endpoints work for both base tables and
      views, but for inserting/upsering rows, you must use a base table.
  - name: Tables and Views
    description: >
      If you're here, you know the power of tables in Coda. This API lets you
      list the tables and views in a Coda doc and obtain basic schema
      information.
  - name: Workspaces
    description: >
      This API allows you to manage your workspace's membership and get
      analytics on membership over time.
x-tagGroups:
  - name: Folders
    tags:
      - Folders
  - name: Docs
    tags:
      - Docs
      - Permissions
      - Publishing
  - name: Doc Structure
    tags:
      - Pages
      - Automations
  - name: Tables and Views
    tags:
      - Tables
      - Columns
      - Rows
  - name: Formulas & Controls
    tags:
      - Formulas
      - Controls
  - name: Miscellaneous
    tags:
      - Account
      - Analytics
      - Miscellaneous
paths:
  /categories:
    get:
      summary: Get doc categories
      description: Gets all available doc categories.
      operationId: listCategories
      tags:
        - Publishing
      responses:
        '200':
          description: List of doc categories
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocCategoryList'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/categories'
            res = requests.get(uri, headers=headers).json()

            print(f'Category count: {res["categories"].length}')
            # => Category count: 10
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/categories' |
              jq .categories.name
            # => "10"
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            var categories = CodaAPI.listCategories();
            Logger.log('Category count: ' + categories.categories.length);
            // => Category count: 10
  /docs:
    get:
      summary: List available docs
      description: >
        Returns a list of Coda docs accessible by the user, and which they have
        opened at least once. These are returned in the same order as on the
        docs page: reverse chronological by the latest event relevant to the
        user (last viewed, edited, or shared).
      operationId: listDocs
      tags:
        - Docs
      parameters:
        - name: isOwner
          in: query
          description: Show only docs owned by the user.
          schema:
            type: boolean
        - name: isPublished
          in: query
          description: Show only published docs.
          schema:
            type: boolean
        - $ref: '#/components/parameters/query'
        - name: sourceDoc
          in: query
          description: Show only docs copied from the specified doc ID.
          schema:
            type: string
        - name: isStarred
          in: query
          description: >-
            If true, returns docs that are starred. If false, returns docs that
            are not starred.
          schema:
            type: boolean
        - name: inGallery
          in: query
          description: Show only docs visible within the gallery.
          schema:
            type: boolean
        - name: workspaceId
          in: query
          description: Show only docs belonging to the given workspace.
          schema:
            type: string
        - name: folderId
          in: query
          description: Show only docs belonging to the given folder.
          schema:
            type: string
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/pageToken'
      responses:
        '200':
          description: List of Coda docs matching the query.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocList'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = 'https://coda.io/apis/v1/docs'
            params = {
              'isOwner': True,
              'query': 'New',
            }
            res = requests.get(uri, headers=headers, params=params).json()

            print(f'First doc is: {res["items"][0]["name"]}')
            # => First doc is: New Document
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs' |
              jq .items[0].name
            # => "New Document"
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            var docs = CodaAPI.listDocs().items;
            Logger.log('First doc is ' + docs[0].name);
            // => First doc is: New Document
    post:
      summary: Create doc
      description: >
        Creates a new Coda doc, optionally copying an existing doc. Note that
        creating a doc requires you to be a Doc Maker in the applicable
        workspace (or be auto-promoted to one).
      operationId: createDoc
      tags:
        - Docs
      requestBody:
        description: Parameters for creating the doc.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocCreate'
      responses:
        '201':
          description: Info about the created doc.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentCreationResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/docs'
            payload = {
              'title': 'Project Tracker',
            }
            req = requests.post(uri, headers=headers, json=payload)
            req.raise_for_status() # Throw if there was an error.
            res = req.json()

            print(f'New doc created with name "{res["name"]}"')
            # => New doc created with name "Project Tracker"
        - label: Shell
          lang: shell
          source: >
            curl -s -H 'Authorization: Bearer <your API token>' -X POST -H
            "Content-Type: application/json" \
              -d '{"title": "Project Tracker"}' \
              'https://coda.io/apis/v1/docs' |
              jq .name
            # => "Project Tracker"
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            var res = CodaAPI.createDoc({title: 'Project Tracker'});
            Logger.log('New doc created with name ' + res.name);
            // => First doc in the results is: New Document
  /docs/{docId}:
    get:
      summary: Get info about a doc
      description: Returns metadata for the specified doc.
      operationId: getDoc
      tags:
        - Docs
      parameters:
        - $ref: '#/components/parameters/docId'
      responses:
        '200':
          description: Basic Coda doc metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Doc'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/docs/<doc ID>'
            res = requests.get(uri, headers=headers).json()

            print(f'The name of the doc is {res["name"]}')
            # => The name of the doc is New Document
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>' |
              jq .name
            # => "New Document"
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            var docInfo = CodaAPI.getDoc('<doc ID>');
            Logger.log('The name of the doc is ' + docInfo.name);
            // => The name of the doc is New Document
    delete:
      summary: Delete doc
      description: Deletes a doc.
      operationId: deleteDoc
      tags:
        - Docs
      parameters:
        - $ref: '#/components/parameters/docId'
      responses:
        '202':
          description: A result indicating that the doc was deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocDelete'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/docs/<doc ID>'
            res = requests.delete(uri, headers=headers).json()
        - label: Shell
          lang: shell
          source: |
            curl -s -X DELETE -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>' |
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            var docInfo = CodaAPI.deleteDoc('<doc ID>');
            // => The given doc is now deleted
    patch:
      summary: Update doc
      description: >-
        Updates metadata for a doc. Note that updating a doc title requires you
        to be a Doc Maker in the applicable workspace.
      operationId: updateDoc
      tags:
        - Docs
      parameters:
        - $ref: '#/components/parameters/docId'
      requestBody:
        description: Parameters for updating the doc.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocUpdate'
      responses:
        '200':
          description: Basic Coda doc metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocUpdateResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/docs/<doc ID>'
            payload = {
              'title': 'New Doc Title',
            }
            req = requests.patch(uri, headers=headers, json=payload)
        - label: Shell
          lang: shell
          source: >
            curl -s -H 'Authorization: Bearer <your API token>' -X PATCH -H
            "Content-Type: application/json" \
              -d '{"title": "New Doc Title"}' \
              'https://coda.io/apis/v1/docs/<doc ID>'
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            CodaAPI.updateDoc(<doc ID>, {title: "New Doc Title"});
  /docs/{docId}/acl/metadata:
    get:
      summary: Get sharing metadata
      description: Returns metadata associated with sharing for this Coda doc.
      operationId: getSharingMetadata
      tags:
        - Permissions
      parameters:
        - $ref: '#/components/parameters/docId'
      responses:
        '200':
          description: Metadata associated with sharing permissions for a doc.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AclMetadata'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/docs/<doc ID>/acl/metadata'
            res = requests.get(uri, headers=headers).json()

            print(f'Can I share this doc with others? {res["canShare"]}')
            # => Can I share this doc with others? true
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/acl/metadata' |
              jq .canShare
            # => "true"
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var docSharingMetadata = CodaAPI.getSharingMetadata('<doc ID>');

            Logger.log('Can I share this doc with others? ' +
            docSharingMetadata.canShare);

            // => Can I share this doc with others? true
  /docs/{docId}/acl/permissions:
    get:
      summary: List permissions
      description: Returns a list of permissions for this Coda doc.
      operationId: getPermissions
      tags:
        - Permissions
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/pageToken'
      responses:
        '200':
          description: List of permissions for a doc.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Acl'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/acl/permissions'

            res = requests.get(uri, headers=headers).json()


            print(f'First user with access is
            {res["items"][0]["principal"]["email"]}')

            # => First user with access is foo@bar.com
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/acl/permissions' |
              jq '.items[].principal.email'
            # => "foo@bar.com", "baz@bar.com"
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var docPermissions = CodaAPI.getPermissions('<doc ID>');

            Logger.log('First user with access is ' +
            docPermissions[0].principal.email);

            // => First user with access is foo@bar.com
    post:
      summary: Add permission
      description: |
        Adds a new permission to the doc.
      operationId: addPermission
      tags:
        - Permissions
      parameters:
        - $ref: '#/components/parameters/docId'
      requestBody:
        description: Parameters for adding the new permission.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddPermissionRequest'
      responses:
        '200':
          description: Confirmation that the request was applied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddPermissionResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/acl/permissions'

            payload = {
              'access': 'write',
              'principal': {
                'type': 'email',
                'email': 'foo@bar.com'
              },
            }

            res = requests.post(uri, headers=headers, json=payload)


            # => Grant 'foo@bar.com' write access to the doc and send a share
            notification email
        - label: Shell
          lang: shell
          source: >
            curl -s -H 'Authorization: Bearer <your API token>' -X POST \
              'https://coda.io/apis/v1/docs/<doc ID>/acl/permissions' \
              -d '{"access": "write", "principal": {"type": "email", "email": "foo@bar.com"}}'
            # => Grant 'foo@bar.com' write access to the doc and send a share
            notification email
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var docPermissions = CodaAPI.addPermission(
              '<doc ID>',
              {access: 'write', principal: {type: 'email', email: 'foo@bar.com'}}
            );

            // => Grant 'foo@bar.com' write access to the doc and send a share
            notification email
  /docs/{docId}/acl/permissions/{permissionId}:
    delete:
      summary: Delete permission
      description: |
        Deletes an existing permission.
      operationId: deletePermission
      tags:
        - Permissions
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/permissionId'
      responses:
        '200':
          description: Confirmation that the request was applied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePermissionResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc
            ID>/acl/permissions/<permission ID>'

            res = requests.delete(uri, headers=headers, json=payload)


            # => Revoke access to the doc
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' -X DELETE \
              'https://coda.io/apis/v1/docs/<doc ID>/acl/permissions/<permission ID>'
            # => Revoke access to the doc
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var docPermissions = CodaAPI.deletePermission('<doc ID>',
            '<permission ID>');

            // => Revoke access to the doc
  /docs/{docId}/acl/principals/search:
    get:
      summary: Search principals
      description: >
        Searches for user and group principals matching the query that this doc
        can be shared with.

        At most 20 results will be returned for both users and groups. If no
        query is given then no results are returned.
      operationId: searchPrincipals
      tags:
        - Permissions
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/query'
      responses:
        '200':
          description: Search results for the given query.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchPrincipalsResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc
            ID>/acl/principals/search?search=foo'

            res = requests.get(uri, headers=headers).json()


            print(f'First user with access is {res["users"][0]["email"]}')

            # => First user with access is foo@bar.com
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/acl/permissions/search?search=foo' |
              jq '.users[].email'
            # => "foo@bar.com", "baz@bar.com"
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var principals = CodaAPI.searchPrincipals('<doc ID>');

            Logger.log('First user with access is ' +
            docPermissions[0].principal.email);

            // => First user with access is foo@bar.com
  /docs/{docId}/acl/settings:
    get:
      summary: Get ACL settings
      description: Returns settings associated with ACLs for this Coda doc.
      operationId: getAclSettings
      tags:
        - Permissions
      parameters:
        - $ref: '#/components/parameters/docId'
      responses:
        '200':
          description: Settings associated with access control for a doc.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AclSettings'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/acl/settings'

            res = requests.get(uri, headers=headers).json()


            print(f'Can editors change sharing permissions?
            {res["allowEditorsToChangePermissions"]}')

            # => Can editors change sharing permissions? false
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/acl/settings' |
              jq .allowEditorsToChangePermissions
            # => "false"
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var settings = CodaAPI.getAclSettings('<doc ID>');

            Logger.log('Can editors change sharing permissions? ' +
            settings.allowEditorsToChangePermissions);

            // => Can editors change sharing permissions? true
    patch:
      summary: Update ACL settings
      description: Update settings associated with ACLs for this Coda doc.
      operationId: updateAclSettings
      tags:
        - Permissions
      parameters:
        - $ref: '#/components/parameters/docId'
      requestBody:
        description: Parameters for updating the ACL settings.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAclSettingsRequest'
      responses:
        '200':
          description: Settings associated with access control for a doc.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AclSettings'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /docs/{docId}/publish:
    put:
      summary: Publish doc
      description: Update publish settings for a doc.
      operationId: publishDoc
      tags:
        - Publishing
      parameters:
        - $ref: '#/components/parameters/docId'
      requestBody:
        description: Parameters for changing publish settings.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocPublish'
      responses:
        '202':
          description: Confirmation that the publish request was accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/docs/<doc ID>/publish'
            payload = {
              'discoverable': true,
            }
            req = requests.put(uri, headers=headers, json=payload)
            req.raise_for_status() # Throw if there was an error.
            res = req.json()

            print(f'Discoverable will be true')
            # => Discoverable will be true
        - label: Shell
          lang: shell
          source: >
            curl -s -H 'Authorization: Bearer <your API token>' -X POST -H
            "Content-Type: application/json" \
              -d '{"discoverable": true}' \
              'https://coda.io/apis/v1/docs/<doc ID>/publish'
              # => Will be discoverable
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            var res = CodaAPI.publishDoc(<doc ID>, {discoverable: true});
            Logger.log('Discoverable will be true');
            // => Discoverable will be true
    delete:
      summary: Unpublish doc
      description: Unpublishes a doc.
      operationId: unpublishDoc
      tags:
        - Publishing
      parameters:
        - $ref: '#/components/parameters/docId'
      responses:
        '200':
          description: A result indicating that the doc was unpublished.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnpublishResult'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/docs/<doc ID>/publish'
            res = requests.unpublishDoc(uri, headers=headers).json()
        - label: Shell
          lang: shell
          source: |
            curl -s -X DELETE -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/unpublish' |
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            var docInfo = CodaAPI.unpublishDoc('<doc ID>');
            // => The given doc is now unpublished
  /docs/{docId}/pages:
    get:
      summary: List pages
      description: Returns a list of pages in a Coda doc.
      operationId: listPages
      tags:
        - Pages
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/pageToken'
      responses:
        '200':
          description: List of pages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageList'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/docs/<doc ID>/pages'
            res = requests.get(uri, headers=headers).json()

            print(f'The name of the first page is {res["items"][0]["name"]}')
            # => The name of the first page is Page 1
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/pages' |
              jq '.items[0].name'
            # => "Page 1"
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            var pages = CodaAPI.listPages('<doc ID>').items;
            Logger.log('The name of the first page is ' + pages[0].name);
            // => The name of the first page is Page 1
    post:
      summary: Create a page
      description: >
        Create a new page in a doc. Note that creating a page requires you to be
        a Doc Maker in the applicable workspace.
      operationId: createPage
      tags:
        - Pages
      parameters:
        - $ref: '#/components/parameters/docId'
      requestBody:
        description: Parameters for creating a page.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PageCreate'
      responses:
        '202':
          description: >-
            A result indicating that the creation request was queued for
            processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageCreateResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/docs/<doc ID>/pages'
            payload = {
              'name': 'New Page Name',
            }
            req = requests.post(uri, headers=headers, json=payload)
            req.raise_for_status() # Throw if there was an error.
            res = req.json()

            print(f'Created page {res["id"]}')
            # => Created page <page ID>
        - label: Shell
          lang: shell
          source: >
            curl -s -H 'Authorization: Bearer <your API token>' -X POST -H
            "Content-Type: application/json" \
              -d '{"name": "New Page Name"}' \
              'https://coda.io/apis/v1/docs/<doc ID>/pages' |
              jq '"Created page " + .id'
            # => "Created page <page ID>"
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            var res = CodaAPI.createPage(<doc ID>, {name: "New Page Name"});
            Logger.log('Created page ' + res.id);
            // => Created page <page ID>
  /docs/{docId}/pages/{pageIdOrName}:
    get:
      summary: Get a page
      description: Returns details about a page.
      operationId: getPage
      tags:
        - Pages
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/pageIdOrName'
      responses:
        '200':
          description: Info about a page.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '410':
          $ref: '#/components/responses/GoneError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/docs/<doc ID>/pages/<page ID>'
            res = requests.get(uri, headers=headers).json()

            print(f'The name of this page is {res["name"]}')
            # => The name of this page is Page 1
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/pages/<page ID>' |
              jq '.name'
            # => "Page 1"
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            var page = CodaAPI.getPage('<doc ID>', '<page ID>');
            Logger.log('The name of this page is ' + page.name);
            // => The name of this page is Page 1
    put:
      summary: Update a page
      description: >
        Update properties for a page. Note that updating a page title or icon
        requires you to be a Doc Maker in the applicable workspace.
      operationId: updatePage
      tags:
        - Pages
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/pageIdOrName'
      requestBody:
        description: Parameters for updating a page.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PageUpdate'
      responses:
        '202':
          description: A result indicating that the update was queued for processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageUpdateResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/docs/<doc ID>/pages/<page ID>'
            payload = {
              'name': 'New Page Name',
            }
            req = requests.put(uri, headers=headers, json=payload)
            req.raise_for_status() # Throw if there was an error.
            res = req.json()

            print(f'Updated page {res["id"]}')
            # => Updated page <page ID>
        - label: Shell
          lang: shell
          source: >
            curl -s -H 'Authorization: Bearer <your API token>' -X PUT -H
            "Content-Type: application/json" \
              -d '{"name": "New Page Name"}' \
              'https://coda.io/apis/v1/docs/<doc ID>/pages/<page ID>' |
              jq '"Updated page " + .id'
            # => "Updated page <page ID>"
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var res = CodaAPI.updatePage(<doc ID>, <page ID>, {name: "New Page
            Name"});

            Logger.log('Updated page ' + res.id);

            // => Updated page <page ID>
    delete:
      summary: Delete a page
      description: Deletes the specified page.
      operationId: deletePage
      tags:
        - Pages
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/pageIdOrName'
      responses:
        '202':
          description: A result indicating that the delete was queued for processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageDeleteResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/docs/<doc ID>/pages/<page ID>'
            req = requests.delete(uri, headers=headers)
            req.raise_for_status() # Throw if there was an error.
            res = req.json()

            print(f'Deleted page')
            # => Deleted page
        - label: Shell
          lang: shell
          source: >
            curl -s -H 'Authorization: Bearer <your API token>' -X DELETE -H
            "Content-Type: application/json" \
              'https://coda.io/apis/v1/docs/<doc ID>/pages/<page ID>' |
              jq 'if .statusMessage? == null then "Deleted page" else . end'
            # => "Deleted pages"
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            CodaAPI.deleteRows('<doc ID>', '<page ID>');
            Logger.log('Deleted 2 rows');
            // => Deleted page
  /docs/{docId}/pages/{pageIdOrName}/content:
    get:
      summary: List page content
      description: Returns a list of content elements in a page.
      operationId: listPageContent
      tags:
        - Pages
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/pageIdOrName'
        - $ref: '#/components/parameters/pageContentLimit'
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/contentFormat'
      responses:
        '200':
          description: List of page content elements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageContentList'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '410':
          $ref: '#/components/responses/GoneError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/pages/<page
            ID>/content'

            res = requests.get(uri, headers=headers).json()


            print(f'The page has {len(res["items"])} content elements')

            # => The page has 10 content elements
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/pages/<page ID>/content' |
              jq '.items | length'
            # => 10
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var content = CodaAPI.listPageContent('<doc ID>', '<page ID>');

            Logger.log('The page has ' + content.items.length + ' content
            elements');

            // => The page has 10 content elements
    delete:
      summary: Delete page content
      description: >
        Delete content from a page. You can delete specific elements by
        providing their IDs, or delete all content from the page.
      operationId: deletePageContent
      tags:
        - Pages
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/pageIdOrName'
      requestBody:
        description: Parameters for deleting page content.
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PageContentDelete'
      responses:
        '202':
          description: A result indicating that the deletion was queued for processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageContentDeleteResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}


            # Delete all content from the page

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/pages/<page
            ID>/content'

            req = requests.delete(uri, headers=headers)

            req.raise_for_status()

            res = req.json()

            print(f'Deleted all content from page {res["id"]}')

            # => Deleted all content from page <page ID>


            # Delete specific elements

            payload = {'elementIds': ['cl-abc123', 'cl-def456']}

            req = requests.delete(uri, headers=headers, json=payload)

            req.raise_for_status()

            res = req.json()

            print(f'Deleted {len(payload["elementIds"])} elements from page
            {res["id"]}')

            # => Deleted 2 elements from page <page ID>
        - label: Shell
          lang: shell
          source: |
            # Delete specific elements
            curl -s -H 'Authorization: Bearer <your API token>' -X DELETE \
              -H "Content-Type: application/json" \
              -d '{"elementIds": ["cl-abc123", "cl-def456"]}' \
              'https://coda.io/apis/v1/docs/<doc ID>/pages/<page ID>/content' |
              jq '"Deleted elements from page " + .id'
            # => "Deleted elements from page <page ID>"
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');

            // Delete all content
            var res = CodaAPI.deletePageContent('<doc ID>', '<page ID>');
            Logger.log('Deleted all content from page ' + res.id);
            // => Deleted all content from page <page ID>
  /docs/{docId}/pages/{pageIdOrName}/export:
    post:
      summary: Begin content export
      description: Initiate an export of content for the given page.
      operationId: beginPageContentExport
      tags:
        - Pages
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/pageIdOrName'
      requestBody:
        description: Parameters for requesting a page content export.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BeginPageContentExportRequest'
      responses:
        '202':
          description: Export page content response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeginPageContentExportResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '410':
          $ref: '#/components/responses/GoneError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/pages/<page
            ID>/export'

            payload = {
              'outputFormat': 'html',
            }

            req = requests.post(uri, headers=headers, json=payload)

            req.raise_for_status() # Throw if there was an error.

            res = req.json()


            print(f'Export status available at {res["href"]}')

            # => Export status available at <status URL>
        - label: Shell
          lang: shell
          source: >
            curl -s -H 'Authorization: Bearer <your API token>' -X POST -H
            "Content-Type: application/json" \
              -d '{"outputFormat": "html"}' \
              'https://coda.io/apis/v1/docs/<doc ID>/pages/<page ID>/export' |
              jq '"Export status available at " + .href'
            # => Export status available at <status URL>
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var page = CodaAPI.beginPageContentExport('<doc ID>', '<page ID>',
            {outputFormat: 'html'});

            Logger.log('Export status available at ' + page.href);

            // => Export status available at <status URL>
  /docs/{docId}/pages/{pageIdOrName}/export/{requestId}:
    get:
      summary: Content export status
      description: Check the status of a page content export
      operationId: getPageContentExportStatus
      tags:
        - Pages
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/pageIdOrName'
        - $ref: '#/components/parameters/requestId'
      responses:
        '200':
          description: Info about the page content export request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageContentExportStatusResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '410':
          $ref: '#/components/responses/GoneError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/pages/<page
            ID>/export/<request ID>'

            res = requests.get(uri, headers=headers).json()


            print(f'Request status: {res["status"]}')

            # => Request status: completed
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              -d '{"outputFormat": "html"}' \
              'https://coda.io/apis/v1/docs/<doc ID>/pages/<page ID>/export/<request ID>' |
              jq .status
            # => completed
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var response = CodaAPI.getPageContentExportStatus('<doc ID>', '<page
            ID>', '<request ID>');

            Logger.log('Export status: ' + response.status);

            // => Export status: completed
  /docs/{docId}/tables:
    get:
      summary: List tables
      description: Returns a list of tables in a Coda doc.
      operationId: listTables
      tags:
        - Tables
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/sortBy'
        - $ref: '#/components/parameters/tableTypes'
      responses:
        '200':
          description: List of tables or views in a doc.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableList'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables'
            res = requests.get(uri, headers=headers).json()

            print(f'The name of the first table is {res["items"][0]["name"]}')
            # => The name of the first table is To-do List
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/tables' |
              jq '.items[0].name'
            # => "To-do List"
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            var tables = CodaAPI.listTables('<doc ID>').items;
            Logger.log('The name of the first table is ' + tables[0].name);
            // => The name of the first table is To-do List
  /docs/{docId}/tables/{tableIdOrName}:
    get:
      summary: Get a table
      description: Returns details about a specific table or view.
      operationId: getTable
      tags:
        - Tables
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/tableIdOrName'
        - name: useUpdatedTableLayouts
          in: query
          description: >-
            Return "detail" and "form" for the `layout` field of detail and form
            layouts respectively (instead of "masterDetail" for both)
          schema:
            type: boolean
      responses:
        '200':
          description: Info about a table.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Table'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>'
            res = requests.get(uri, headers=headers).json()

            print(f'Table {res["name"]} has {res["rowCount"]} rows')
            # => Table To-do List has 2 rows
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>' |
              jq '"Table " + .name + " has " + (.rowCount | tostring) + " rows"'
            # => "Table To-do List has 2 rows"
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var table = CodaAPI.getTable('<doc ID>', '<table ID>');

            Logger.log('Table ' + table.name + ' has ' + table.rowCount + '
            rows');

            // => Table To-do List has 2 rows
  /docs/{docId}/tables/{tableIdOrName}/columns:
    get:
      summary: List columns
      description: Returns a list of columns in a table.
      operationId: listColumns
      tags:
        - Columns
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/tableIdOrName'
        - name: limit
          description: Maximum number of results to return in this query.
          in: query
          example: 10
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - $ref: '#/components/parameters/pageToken'
        - name: visibleOnly
          description: >-
            If true, returns only visible columns for the table. This parameter
            only applies to base tables, and not views.
          in: query
          example: true
          schema:
            type: boolean
      responses:
        '200':
          description: List of columns in the table.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ColumnList'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table
            ID>/columns'

            res = requests.get(uri, headers=headers).json()


            print(f'This table\'s columns: {", ".join(c["name"] for c in
            res["items"])}')

            # => This table's columns: Task, Duration (hr), Duration (min)
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/columns' |
              jq '.items | map(.name) | join(", ")'
            # => "Task, Duration (hr), Duration (min)"
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            var columns = CodaAPI.listColumns('<doc ID>', '<table ID>').items;
            var names = columns.map(function(column) { return column.name; });
            Logger.log('This table\'s columns: ' + names.join(', '));
            // => This table's columns: Task, Duration (hr), Duration (min)
  /docs/{docId}/tables/{tableIdOrName}/rows:
    get:
      summary: List table rows
      description: >
        Returns a list of rows in a table.

        ### Value results

        The `valueFormat` parameter dictates in what format the API should
        return values for individual cells.

        * `simple` (default): Returns cell values as the following JSON values:
        `string`, `number`, or `boolean`. Array values (like multiselects) are
        returned as comma-delimited strings.

        * `simpleWithArrays`: Singleton values are returned as `simple`. Array
        values are returned as JSON arrays and the values within are `simple`
        values (including nested arrays).

        * `rich`: If applicable, returns many values with further encoding,
        allowing API users to have lossless access to data in Coda.
          * For `text` values, returns data in Markdown syntax. If the text field is simple text (e.g. has no formatting),
          the field will be fully escaped with triple-ticks. E.g
          `
          ```This is plain text```
          `
          * For `currency`, `lookup`, `image`, `person` and `hyperlink` values, the value will be encoded in [JSON-LD](https://json-ld.org/) format.

        ```
          // Currency
          {
            "@context": "http://schema.org",
            "@type": "MonetaryAmount",
            "currency": "USD",
            "amount": 42.42
          }

          // Lookup
          {
            "@context": "http://schema.org",
            "@type": "StructuredValue",
            "additionalType": "row",
            "name": "Row Name",
            "rowId": "i-123456789",
            "tableId": "grid-123456789",
            "tableUrl": "https://coda.io/d/_d123456789/grid-123456789",
            "url": "https://coda.io/d/_d123456789/grid-123456789#_r42",
          }

          // Hyperlink
          {
            "@context": "http://schema.org",
            "@type": "WebPage",
            "name": "Coda",
            "url": "https://coda.io"
          }

          // Image
          {
            "@context": "http://schema.org",
            "@type": "ImageObject",
            "name": "Coda logo",
            "url": "https://coda.io/logo.jpg"
          }

          // People
          {
            "@context": "http://schema.org",
            "@type": "Person",
            "name": "Art Vandalay",
            "email": "art@vandalayindustries.com"
          }
        ```
      operationId: listRows
      tags:
        - Rows
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/tableIdOrName'
        - name: query
          description: >
            Query used to filter returned rows, specified as
            `<column_id_or_name>:<value>`. If you'd like to use a column name
            instead of an ID, you must quote it (e.g., `"My Column":123`). Also
            note that `value` is a JSON value; if you'd like to use a string,
            you must surround it in quotes (e.g., `"groceries"`).
          in: query
          example: c-tuVwxYz:"Apple"
          schema:
            type: string
        - name: sortBy
          in: query
          description: >
            Specifies the sort order of the rows returned. If left unspecified,
            rows are returned by creation time ascending. "UpdatedAt" sort
            ordering is the order of rows based upon when they were last
            updated. This does not include updates to calculated values.
            "Natural" sort ordering is the order that the rows appear in the
            table view in the application. This ordering is only meaningfully
            defined for rows that are visible (unfiltered). Because of this,
            using this sort order will imply visibleOnly=true, that is, to only
            return visible rows. If you pass sortBy=natural and
            visibleOnly=false explicitly, this will result in a Bad Request
            error as this condition cannot be satisfied.
          schema:
            $ref: '#/components/schemas/RowsSortBy'
        - $ref: '#/components/parameters/useColumnNames'
        - name: valueFormat
          in: query
          description: The format that cell values are returned as.
          schema:
            $ref: '#/components/schemas/ValueFormat'
        - name: visibleOnly
          description: If true, returns only visible rows and columns for the table.
          in: query
          example: true
          schema:
            type: boolean
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/syncToken'
      responses:
        '200':
          description: List of rows in the table.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RowList'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table
            ID>/rows'

            params = {
              'query': '<column ID>:"Work out"',
            }

            req = requests.get(uri, headers=headers, params=params)

            req.raise_for_status() # Throw if there was an error.

            res = req.json()


            print(f'Matching rows: {len(res["items"])}')

            # => Matching rows: 1
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              -G --data-urlencode 'query=<column ID>:"Work out"' \
              'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/rows' |
              jq '"Matching rows: " + (.items | length | tostring)'
            # => "Matching rows: 1"
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var query = '<column ID>:"Work out"';

            var rows = CodaAPI.listRows('<doc ID>', '<table ID>', {query:
            query}).items;

            Logger.log('Matching rows: ' + rows.length);

            // => Matching rows: 1
    post:
      summary: Insert/upsert rows
      description: >
        Inserts rows into a table, optionally updating existing rows if any
        upsert key columns are provided. This endpoint will always return a 202,
        so long as the doc and table exist and are accessible (and the update is
        structurally valid). Row inserts/upserts are generally processed within
        several seconds. Note: this endpoint only works for base tables, not
        views.

        When upserting, if multiple rows match the specified key column(s), they
        will all be updated with the specified value.
      operationId: upsertRows
      tags:
        - Rows
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/tableIdOrName'
        - name: disableParsing
          description: If true, the API will not attempt to parse the data in any way.
          in: query
          example: true
          schema:
            type: boolean
      requestBody:
        description: Rows to insert or upsert.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RowsUpsert'
      responses:
        '202':
          description: A result indicating that the upsert was queued for processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RowsUpsertResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table
            ID>/rows'

            payload = {
              'rows': [
                {
                  'cells': [
                    {'column': '<column ID>', 'value': 'Feed Baker'},
                  ],
                },
              ],
            }

            req = requests.post(uri, headers=headers, json=payload)

            req.raise_for_status() # Throw if there was an error.

            res = req.json()


            print(f'Inserted 1 row')

            # => Inserted 1 row
        - label: Shell
          lang: shell
          source: >
            curl -s -H 'Authorization: Bearer <your API token>' -X POST -H
            "Content-Type: application/json" \
              -d '{"rows": [{"cells": [{"column": "<column ID>", "value": "Feed Baker"}]}]}' \
              'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/rows' |
              jq 'if .statusMessage? == null then "Inserted 1 row" else . end'
            # => "Inserted 1 row"
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            var body = {
              'rows': [
                {
                  'cells': [
                    {'column': '<column ID>', 'value': 'Feed Baker'},
                  ],
                },
              ],
            };
            CodaAPI.upsertRows('<doc ID>', '<table ID>', body);
            Logger.log('Inserted 1 row');
            // => Inserted 1 row
    delete:
      summary: Delete multiple rows
      description: >
        Deletes the specified rows from the table or view. This endpoint will
        always return a 202. Row deletions are generally processed within
        several seconds.
      operationId: deleteRows
      tags:
        - Rows
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/tableIdOrName'
      requestBody:
        description: Rows to delete.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RowsDelete'
      responses:
        '202':
          description: A result indicating that the delete was queued for processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RowsDeleteResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table
            ID>/rows'

            payload = {
              'rowIds': ['i-aBcDeFgH', 'i-AbCdEfGh'],
            }

            req = requests.delete(uri, headers=headers, json=payload)

            req.raise_for_status() # Throw if there was an error.

            res = req.json()


            print(f'Deleted 2 rows')

            # => Deleted 2 rows
        - label: Shell
          lang: shell
          source: >
            curl -s -H 'Authorization: Bearer <your API token>' -X DELETE -H
            "Content-Type: application/json" \
              -d '{"rowIds": ['i-aBcDeFgH', 'i-AbCdEfGh']}' \
              'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/rows' |
              jq 'if .statusMessage? == null then "Deleted 2 rows" else . end'
            # => "Deleted 2 rows"
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            var body = {
              'rowIds': ['i-aBcDeFgH', 'i-AbCdEfGh'],
            };
            CodaAPI.deleteRows('<doc ID>', '<table ID>', body);
            Logger.log('Deleted 2 rows');
            // => Deleted 2 rows
  /docs/{docId}/tables/{tableIdOrName}/rows/{rowIdOrName}:
    get:
      summary: Get a row
      description: Returns details about a row in a table.
      operationId: getRow
      tags:
        - Rows
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/tableIdOrName'
        - $ref: '#/components/parameters/rowIdOrName'
        - $ref: '#/components/parameters/useColumnNames'
        - name: valueFormat
          in: query
          description: The format that cell values are returned as.
          schema:
            $ref: '#/components/schemas/ValueFormat'
      responses:
        '200':
          description: >
            Info about a row. If this row was retrieved by name, only one
            matching row will be returned, with no guarantees as to which one it
            is.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RowDetail'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table
            ID>/rows/<row ID>'

            req = requests.get(uri, headers=headers)

            req.raise_for_status() # Throw if there was an error.

            res = req.json()


            print(f'Row values are: {", ".join(str(v) for v in
            res["values"].values())}')

            # => Row values are: Get groceries, 1, 60
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/rows/<row ID>' |
              jq '.values | map(tostring) | join(", ")'
            # => "Get groceries, 1, 60"
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var row = CodaAPI.getRow('<doc ID>', '<table ID>', '<row ID>');

            var values = Object.keys(row.values).map(function(colId) { return
            row.values[colId]; });

            Logger.log('Row values are: ' + values.join(', '));

            // => Row values are: Get groceries, 1, 60
    put:
      summary: Update row
      description: >
        Updates the specified row in the table. This endpoint will always return
        a 202, so long as the row exists and is accessible (and the update is
        structurally valid). Row updates are generally processed within several
        seconds. When updating using a name as opposed to an ID, an arbitrary
        row will be affected.
      operationId: updateRow
      tags:
        - Rows
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/tableIdOrName'
        - $ref: '#/components/parameters/rowIdOrName'
        - name: disableParsing
          description: If true, the API will not attempt to parse the data in any way.
          in: query
          example: true
          schema:
            type: boolean
      requestBody:
        description: Row update.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RowUpdate'
      responses:
        '202':
          description: A result indicating that the update was queued for processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RowUpdateResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table
            ID>/rows/<row ID>'

            payload = {
              'row': {
                'cells': [
                  {'column': '<column ID>', 'value': 'Get groceries from Whole Foods'},
                ],
              },
            }

            req = requests.put(uri, headers=headers, json=payload)

            req.raise_for_status() # Throw if there was an error.

            res = req.json()


            print(f'Updated row {res["id"]}')

            # => Updated row <row ID>
        - label: Shell
          lang: shell
          source: >
            curl -s -H 'Authorization: Bearer <your API token>' -X PUT -H
            "Content-Type: application/json" \
              -d '{"row": {"cells": [{"column": "<column ID>", "value": "Get groceries from Whole Foods"}]}}' \
              'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/rows/<row ID>' |
              jq '"Updated row " + .id'
            # => "Updated row <row ID>"
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var body = {
              row: {
                cells: [
                  {'column': '<column ID>', 'value': 'Get groceries from Whole Foods'},
                ],
              },
            };

            var row = CodaAPI.updateRow('<doc ID>', '<table ID>', '<row ID>',
            body);

            Logger.log('Updated row ' + row.id);

            // => Updated row <row ID>
    delete:
      summary: Delete row
      description: >
        Deletes the specified row from the table or view. This endpoint will
        always return a 202, so long as the row exists and is accessible (and
        the update is structurally valid). Row deletions are generally processed
        within several seconds. When deleting using a name as opposed to an ID,
        an arbitrary row will be removed.
      operationId: deleteRow
      tags:
        - Rows
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/tableIdOrName'
        - $ref: '#/components/parameters/rowIdOrName'
      responses:
        '202':
          description: A result indicating that the deletion was queued for processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RowDeleteResult'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table
            ID>/rows/<row ID>'

            req = requests.delete(uri, headers=headers)

            req.raise_for_status() # Throw if there was an error.

            res = req.json()


            print(f'Deleted row {res["id"]}')

            # => Deleted row <row ID>
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' -X DELETE \
              'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/rows/<row ID>' |
              jq '"Deleted row " + .id'
            # => "Deleted row <row ID>"
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            var row = CodaAPI.deleteRow('<doc ID>', '<table ID>', '<row ID>');
            Logger.log('Deleted row ' + row.id);
            // => Deleted row <row ID>
  /docs/{docId}/tables/{tableIdOrName}/rows/{rowIdOrName}/buttons/{columnIdOrName}:
    post:
      summary: Push a button
      description: >
        Pushes a button on a row in a table.

        Authorization note: This action is available to API tokens that are
        authorized to write to the table. However, the underlying button can
        perform any action on the document, including writing to other tables
        and performing Pack actions.
      operationId: pushButton
      tags:
        - Rows
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/tableIdOrName'
        - $ref: '#/components/parameters/rowIdOrName'
        - $ref: '#/components/parameters/columnIdOrName'
      responses:
        '202':
          description: >-
            A result indicating that the push button action was queued for
            processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushButtonResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table
            ID>/rows/<row ID>/buttons/<column ID>'

            req = requests.post(uri, headers=headers)

            req.raise_for_status() # Throw if there was an error.

            res = req.json()

            print(f'Pushed button')

            # => Pushed button
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' -X POST \
              'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/rows/<row ID>/buttons/<column ID>' |
              jq 'if .statusMessage? == null then "Pushed button" else . end'
              # => Pushed button
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            CodaAPI.pushButton('<doc ID>', '<table ID>', '<row ID>', '<column
            ID>');

            Logger.log('Pushed button');

            // => Pushed button
  /docs/{docId}/tables/{tableIdOrName}/columns/{columnIdOrName}:
    get:
      summary: Get a column
      description: Returns details about a column in a table.
      operationId: getColumn
      tags:
        - Columns
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/tableIdOrName'
        - $ref: '#/components/parameters/columnIdOrName'
      responses:
        '200':
          description: Info about a column.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ColumnDetail'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table
            ID>/columns/<column ID>'

            res = requests.get(uri, headers=headers).json()


            is_default = res.get("display", False)

            print(f'Column {res["name"]} {"is" if is_default else "is not"} the
            display column')

            # => Column Task is the display column
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/columns/<column ID>' |
              jq '"Column " + .name + (if .display then " is" else " is not" end) + " the display column"'
            # => "Column Task is the display column"
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var column = CodaAPI.getColumn('<doc ID>', '<table ID>', '<column
            ID>');

            Logger.log('Column ' + column.name + (column.display ? ' is' : ' is
            not') + ' the display column');

            # => Column Task is the display column
  /docs/{docId}/formulas:
    get:
      summary: List formulas
      description: Returns a list of named formulas in a Coda doc.
      operationId: listFormulas
      tags:
        - Formulas
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/sortBy'
      responses:
        '200':
          description: List of formulas that have names in a doc.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormulaList'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/formulas'

            res = requests.get(uri, headers=headers).json()


            print(f'This doc\'s formulas are: {", ".join(i["name"] for i in
            res["items"])}')

            # => This doc's formulas are: Total Duration, Time Now
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/formulas' |
              jq '.items | map(.name) | join(", ")'
            # => "Total Duration, Time Now"
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var formulas = CodaAPI.listFormulas('<doc ID>').items;

            var names = formulas.map(function(formula) { return formula.name;
            });

            Logger.log('This doc\'s formulas are: ' + names.join(', '));

            // => This doc's formulas are: Total Duration, Time Now
  /docs/{docId}/formulas/{formulaIdOrName}:
    get:
      summary: Get a formula
      description: Returns info on a formula.
      operationId: getFormula
      tags:
        - Formulas
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/formulaIdOrName'
      responses:
        '200':
          description: Details about a formula.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Formula'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/docs/<doc ID>/formulas/<formula ID>'
            res = requests.get(uri, headers=headers).json()

            print(f'It will take {res["value"]} hours to complete everything')
            # => It will take 3 hours to complete everything
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/formulas/<formula ID>' |
              jq '"It will take " + (.value | tostring) + " hours to complete everything"'
            # => "It will take 3 hours to complete everything"
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var formula = CodaAPI.getFormula('<doc ID>', '<formula ID>');

            Logger.log('It will take ' + formula.value + ' hours to complete
            everything');

            // => It will take 3 hours to complete everything
  /docs/{docId}/controls:
    get:
      summary: List controls
      description: Returns a list of controls in a Coda doc.
      operationId: listControls
      tags:
        - Controls
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/sortBy'
      responses:
        '200':
          description: List of controls in a doc.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControlList'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = f'https://coda.io/apis/v1/docs/<doc ID>/controls'

            res = requests.get(uri, headers=headers).json()


            print(f'Controls here are: {", ".join(i["name"] for i in
            res["items"])}')

            # => Controls here are: Control 1, Control 2
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/controls' |
              jq '.items | map(.name) | join(", ")'
            # => "Control 1, Control 2"
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            var controls = CodaAPI.listControls('<doc ID>').items;

            var names = controls.map(function(control) { return control.name;
            });

            Logger.log('Controls here are: ' + names.join(', '));

            // => Controls here are: Control 1, Control 2
  /docs/{docId}/controls/{controlIdOrName}:
    get:
      summary: Get a control
      description: Returns info on a control.
      operationId: getControl
      tags:
        - Controls
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/controlIdOrName'
      responses:
        '200':
          description: Details about a control.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Control'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = f'https://coda.io/apis/v1/docs/<doc ID>/controls/<control ID>'
            res = requests.get(uri, headers=headers).json()

            print(f'The control is a {res["controlType"]}')
            # => The control is a slider
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/docs/<doc ID>/controls/<control ID>' |
              jq '"The control is a " + .controlType'
            # => "The control is a slider"
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            var control = CodaAPI.getControl('<doc ID>', '<control ID>');
            Logger.log('The control is a ' + control.controlType);
            // => The control is a slider
  /docs/${docId}/domains:
    get:
      summary: List custom doc domains
      description: List all custom domains for a published doc.
      operationId: listCustomDocDomains
      tags:
        - CustomDocDomains
      parameters:
        - $ref: '#/components/parameters/docId'
      responses:
        '200':
          description: List of custom domains for a published doc.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDocDomainList'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    post:
      summary: Add custom domain
      description: Add a custom domain to a published doc.
      operationId: addCustomDocDomain
      tags:
        - CustomDocDomains
      parameters:
        - $ref: '#/components/parameters/docId'
      requestBody:
        description: Parameters for adding a custom domain to a published doc.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddCustomDocDomainRequest'
      responses:
        '202':
          description: Confirmation that the custom domain was added to the doc.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddCustomDocDomainResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /docs/{docId}/domains/{customDocDomain}:
    delete:
      summary: Deletes a custom domain
      description: Deletes a custom domain from a published doc.
      operationId: deleteCustomDocDomain
      tags:
        - CustomDocDomains
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/customDocDomain'
      responses:
        '200':
          description: A result indicating that the custom domain was deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCustomDocDomainResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    patch:
      summary: Updates a custom domain
      description: Updates properties of a document's custom domain.
      operationId: updateCustomDocDomain
      tags:
        - CustomDocDomains
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/customDocDomain'
      requestBody:
        description: Properties of a custom domain to update.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomDocDomainRequest'
      responses:
        '200':
          description: The custom domain object with the updates applied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCustomDocDomainResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /domains/provider/{customDocDomain}:
    get:
      summary: Gets custom doc domains providers
      description: Gets the provider (ie. GoDaddy) of a custom domain.
      operationId: getCustomDocDomainProvider
      tags:
        - CustomDocDomains
      parameters:
        - $ref: '#/components/parameters/customDocDomain'
      responses:
        '200':
          description: Provider of the custom domain
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDocDomainProviderResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /folders:
    get:
      summary: List folders
      description: |
        Returns a list of folders the user has access to.
      operationId: listFolders
      tags:
        - Folders
      parameters:
        - name: workspaceId
          in: query
          description: Show only folders belonging to the given workspace.
          schema:
            type: string
          example: ws-1Ab234
        - name: isStarred
          in: query
          description: >-
            If true, returns folders that are starred. If false, returns folders
            that are not starred. If not specified, returns all folders.
          schema:
            type: boolean
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/pageToken'
      responses:
        '200':
          description: List of folders.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolderList'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = 'https://coda.io/apis/v1/folders'
            res = requests.get(uri, headers=headers).json()

            for folder in res['items']:
                print(f'Folder: {folder["name"]}')
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/folders' |
              jq '.items[].name'
    post:
      summary: Create folder
      description: |
        Creates a new folder.
      operationId: createFolder
      tags:
        - Folders
      requestBody:
        description: Parameters for creating the folder.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFolderRequest'
      responses:
        '201':
          description: The created folder.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = 'https://coda.io/apis/v1/folders'
            payload = {'name': 'My New Folder'}
            res = requests.post(uri, headers=headers, json=payload).json()

            print(f'Created folder: {res["id"]}')
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              -H 'Content-Type: application/json' \
              -d '{"name": "My New Folder"}' \
              'https://coda.io/apis/v1/folders' |
              jq .id
  /folders/{folderId}:
    get:
      summary: Get folder
      description: |
        Returns the requested folder.
      operationId: getFolder
      tags:
        - Folders
      parameters:
        - $ref: '#/components/parameters/folderId'
      responses:
        '200':
          description: The requested Coda folder.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = 'https://coda.io/apis/v1/folders/<your folder id>'
            res = requests.get(uri, headers=headers).json()

            print(f'Folder name is: {res["name"]}')
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/folders/<your folder id>' |
              jq .name
    patch:
      summary: Update folder
      description: |
        Updates metadata for a folder.
      operationId: updateFolder
      tags:
        - Folders
      parameters:
        - $ref: '#/components/parameters/folderId'
      requestBody:
        description: Parameters for updating the folder.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFolderRequest'
      responses:
        '200':
          description: The updated folder.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = 'https://coda.io/apis/v1/folders/<your folder id>'
            payload = {'name': 'Updated Folder Name'}
            res = requests.patch(uri, headers=headers, json=payload).json()

            print(f'Updated folder: {res["name"]}')
        - label: Shell
          lang: shell
          source: |
            curl -s -X PATCH -H 'Authorization: Bearer <your API token>' \
              -H 'Content-Type: application/json' \
              -d '{"name": "Updated Folder Name"}' \
              'https://coda.io/apis/v1/folders/<your folder id>' |
              jq .name
    delete:
      summary: Delete folder
      description: |
        Deletes a folder. The folder must be empty (contain no docs).
      operationId: deleteFolder
      tags:
        - Folders
      parameters:
        - $ref: '#/components/parameters/folderId'
      responses:
        '200':
          description: Folder was successfully deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteFolderResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = 'https://coda.io/apis/v1/folders/<your folder id>'
            res = requests.delete(uri, headers=headers)

            print(f'Deleted: {res.status_code == 200}')
        - label: Shell
          lang: shell
          source: |
            curl -s -X DELETE -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/folders/<your folder id>'
  /whoami:
    get:
      summary: Get user info
      description: Returns basic info about the current user.
      operationId: whoami
      parameters: []
      tags:
        - Account
      responses:
        '200':
          description: Info about the current user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = 'https://coda.io/apis/v1/whoami'
            res = requests.get(uri, headers=headers).json()

            print(f'Your name is {res["name"]}')
            # => Your name is John Doe
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/whoami' |
              jq .name
            # => "John Doe"
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            Logger.log('Your name is ' + CodaAPI.whoami().name);
            // => Your name is John Doe
  /resolveBrowserLink:
    get:
      summary: Resolve browser link
      description: >
        Given a browser link to a Coda object, attempts to find it and return
        metadata that can be used to get more info on it. Returns a 400 if the
        URL does not appear to be a Coda URL or a 404 if the resource cannot be
        located with the current credentials.
      operationId: resolveBrowserLink
      tags:
        - Miscellaneous
      parameters:
        - name: url
          description: The browser link to try to resolve.
          in: query
          required: true
          example: https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO
          schema:
            type: string
            format: url
        - name: degradeGracefully
          description: >
            By default, attempting to resolve the Coda URL of a deleted object
            will result in an error. If this flag is set, the next-available
            object, all the way up to the doc itself, will be resolved.
          in: query
          example: true
          schema:
            type: boolean
      responses:
        '200':
          description: Metadata for the resolved resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiLink'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-pack-hidden: true
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = 'https://coda.io/apis/v1/resolveBrowserLink'
            params = {
              'url': 'https://coda.io/d/Some-Doc_d<doc ID>/#To-do-List_tu<table ID>',
            }
            res = requests.get(uri, headers=headers, params=params).json()
            resolved_uri = res["resource"]["href"]

            res = requests.get(resolved_uri, headers=headers).json()
            print(f'This link points to a {res["type"]} named {res["name"]}')
            # => This link points to a table named To-do List
        - label: Shell
          lang: shell
          source: >
            RESOLVED_RESOURCE_URI="$(curl -s -H 'Authorization: Bearer <your API
            token>' \
              -G --data-urlencode 'url=https://coda.io/d/Some-Doc_d<doc ID>/#To-do-List_tu<table ID>' \
              'https://coda.io/apis/v1/resolveBrowserLink' |
              jq -r '.resource.href')"
            curl -s -H 'Authorization: Bearer <your API token>' \
              "$RESOLVED_RESOURCE_URI" |
              jq '"This link points to a " + .type + " named " + .name'
            # => "This link points to a table named To-do List"
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');


            var url = 'https://coda.io/d/Some-Doc_d<doc ID>/#To-do-List_tu<table
            ID>';

            var res = CodaAPI.resolveBrowserLink({url: url});

            Logger.log('This link points to a ' + res.type + ' named ' +
            res.name);

            // => This link points to a table named To-do List
  /mutationStatus/{requestId}:
    get:
      summary: Get mutation status
      description: >
        Get the status for an asynchronous mutation to know whether or not it
        has been completed. Each API endpoint that mutates a document will
        return a request id that you can pass to this endpoint to check the
        completion status. Status information is not guaranteed to be available
        for more than one day after the mutation was completed. It is intended
        to be used shortly after the request was made.
      operationId: getMutationStatus
      tags:
        - Miscellaneous
      parameters:
        - $ref: '#/components/parameters/requestId'
      responses:
        '200':
          description: Info about the mutation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MutationStatus'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = 'https://coda.io/apis/v1/mutationStatus/some-request-id'
            res = requests.get(uri, headers=headers).json()

            print(f'Request has completed? {res["completed"]}')
            # => Request has completed? false
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/mutationStatus/some-request-id' |
              jq .completed
            # => true
        - label: Google Apps Script
          lang: javascript
          source: >
            // Import the CodaAPI library via Resource->Libraries...:

            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl

            CodaAPI.authenticate('<your API token>');

            Logger.log('Request has completed? ' +
            CodaAPI.mutationStatus('some-request-id').completed);

            // => Request has completed? false
  /docs/{docId}/hooks/automation/{ruleId}:
    post:
      summary: Trigger automation
      description: Triggers webhook-invoked automation
      operationId: triggerWebhookAutomation
      tags:
        - Automations
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/ruleId'
      requestBody:
        description: Payload for webhook
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookTriggerPayload'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/WebhookTriggerPayload'
          text/plain:
            schema:
              type: string
      responses:
        '202':
          description: >-
            A result indicating that the automation trigger was queued for
            processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTriggerResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '422':
          $ref: '#/components/responses/UnprocessableEntityError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /analytics/docs:
    get:
      summary: List doc analytics
      description: |
        Returns analytics data for available docs per day.
      operationId: listDocAnalytics
      tags:
        - Analytics
      parameters:
        - $ref: '#/components/parameters/docIds'
        - $ref: '#/components/parameters/workspaceIdInQuery'
        - $ref: '#/components/parameters/query'
        - $ref: '#/components/parameters/isPublished'
        - $ref: '#/components/parameters/sinceDate'
        - $ref: '#/components/parameters/untilDate'
        - $ref: '#/components/parameters/scale'
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/docAnalyticsOrderBy'
        - $ref: '#/components/parameters/direction'
        - name: limit
          description: Maximum number of results to return in this query.
          in: query
          example: 10
          schema:
            type: integer
            minimum: 1
            maximum: 5000
            default: 1000
      responses:
        '200':
          description: List of Coda doc analytics.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocAnalyticsCollection'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = 'https://coda.io/apis/v1/analytics/docs'
            params = {
              'limit': 10,
            }
            res = requests.get(uri, headers=headers, params=params).json()

            print(f'First doc is: {res["items"][0]["doc"]["title"]}')
            # => First doc is: New Document
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/analytics/docs' |
              jq .items[0].doc.title
            # => "New Document"
  /analytics/docs/{docId}/pages:
    get:
      summary: List page analytics
      description: >
        Returns analytics data for a given doc within the day.

        This method will return a 401 if the given doc is not in an Enterprise
        workspace.
      operationId: listPageAnalytics
      tags:
        - Analytics
      parameters:
        - $ref: '#/components/parameters/docId'
        - $ref: '#/components/parameters/sinceDate'
        - $ref: '#/components/parameters/untilDate'
        - $ref: '#/components/parameters/pageToken'
        - name: limit
          description: Maximum number of results to return in this query.
          in: query
          example: 10
          schema:
            type: integer
            minimum: 1
            maximum: 5000
            default: 1000
      responses:
        '200':
          description: List of page analytics for the given Coda doc.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageAnalyticsCollection'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = 'https://coda.io/apis/v1/analytics/docs/abcdefghi/pages'
            params = {
              'limit': 10,
            }
            res = requests.get(uri, headers=headers, params=params).json()

            print(f'First page is: {res["items"][0]["page"]["name"]}')
            # => First page is: My Page
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/analytics/docs/abcdefghi/pages' |
              jq .items[0].page.name
            # => "My Page"
  /analytics/docs/summary:
    get:
      summary: Get doc analytics summary
      description: |
        Returns summarized analytics data for available docs.
      operationId: listDocAnalyticsSummary
      tags:
        - Analytics
      parameters:
        - $ref: '#/components/parameters/isPublished'
        - $ref: '#/components/parameters/sinceDate'
        - $ref: '#/components/parameters/untilDate'
        - $ref: '#/components/parameters/workspaceIdInQuery'
      responses:
        '200':
          description: Response of Coda doc summary analytics.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocAnalyticsSummary'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /analytics/packs:
    get:
      summary: List Pack analytics
      description: |
        Returns analytics data for Packs the user can edit.
      operationId: listPackAnalytics
      tags:
        - Analytics
      parameters:
        - $ref: '#/components/parameters/packIds'
        - $ref: '#/components/parameters/workspaceIdInQuery'
        - $ref: '#/components/parameters/query'
        - $ref: '#/components/parameters/sinceDate'
        - $ref: '#/components/parameters/untilDate'
        - $ref: '#/components/parameters/scale'
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/packAnalyticsOrderBy'
        - $ref: '#/components/parameters/direction'
        - $ref: '#/components/parameters/isPublishedNoDefault'
        - name: limit
          description: Maximum number of results to return in this query.
          in: query
          example: 10
          schema:
            type: integer
            minimum: 1
            maximum: 5000
            default: 1000
      responses:
        '200':
          description: Response of Coda Pack analytics.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackAnalyticsCollection'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = 'https://coda.io/apis/v1/analytics/packs'
            params = {
              'limit': 10,
            }
            res = requests.get(uri, headers=headers, params=params).json()

            print(f'First Pack is: {res["items"][0]["pack"]["name"]}')
            # => First Pack is: New Pack
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/analytics/packs' |
              jq .items[0].pack.name
            # => "New Pack"
  /analytics/packs/summary:
    get:
      summary: Get Pack analytics summary
      description: |
        Returns summarized analytics data for Packs the user can edit.
      operationId: listPackAnalyticsSummary
      tags:
        - Analytics
      parameters:
        - $ref: '#/components/parameters/packIds'
        - $ref: '#/components/parameters/workspaceIdInQuery'
        - $ref: '#/components/parameters/isPublishedNoDefault'
        - $ref: '#/components/parameters/sinceDate'
        - $ref: '#/components/parameters/untilDate'
      responses:
        '200':
          description: Response of Coda Pack summary analytics.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackAnalyticsSummary'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /analytics/packs/{packId}/formulas:
    get:
      summary: List Pack formula analytics
      description: |
        Returns analytics data for Pack formulas.
      operationId: listPackFormulaAnalytics
      tags:
        - Analytics
      parameters:
        - name: packFormulaNames
          description: >-
            A list of Pack formula names (case-sensitive) for which to retrieve
            analytics.
          in: query
          explode: false
          example: SquareRoot,CubeRoot
          schema:
            type: array
            items:
              type: string
        - name: packFormulaTypes
          description: >-
            A list of Pack formula types corresponding to the
            `packFormulaNames`. If specified, this must have the same length as
            `packFormulaNames`.
          in: query
          explode: false
          example: action,formula
          schema:
            type: array
            items:
              $ref: '#/components/schemas/PackFormulaType'
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/sinceDate'
        - $ref: '#/components/parameters/untilDate'
        - $ref: '#/components/parameters/scale'
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/packFormulaAnalyticsOrderBy'
        - $ref: '#/components/parameters/direction'
        - name: limit
          description: Maximum number of results to return in this query.
          in: query
          example: 10
          schema:
            type: integer
            minimum: 1
            maximum: 5000
            default: 1000
      responses:
        '200':
          description: Response of Coda Pack formula analytics.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackFormulaAnalyticsCollection'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /analytics/updated:
    get:
      summary: Get analytics last updated day
      description: >
        Returns days based on Pacific Standard Time when analytics were last
        updated.
      operationId: getAnalyticsLastUpdated
      tags:
        - Analytics
      responses:
        '200':
          description: Response of analytics last updated days.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsLastUpdatedResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /workspaces/{workspaceId}/users:
    get:
      summary: List workspace users
      description: >
        Returns a list of members in the given workspace. This list will be
        ordered with the requesting user first and then ordered by role.
      operationId: listWorkspaceMembers
      tags:
        - Workspaces
      parameters:
        - $ref: '#/components/parameters/workspaceId'
        - name: includedRoles
          description: >-
            Show only the members that match the included roles. Multiple roles
            can be specified with a comma-delimited list.
          in: query
          explode: false
          example: Editor,DocMaker
          schema:
            type: array
            items:
              $ref: '#/components/schemas/WorkspaceUserRole'
        - $ref: '#/components/parameters/pageToken'
      responses:
        '200':
          description: List of workspace members matching the query.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceMembersList'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = 'https://coda.io/apis/v1/workspaces/<your workspace id>/users'
            params = {
              'limit': 10,
            }
            res = requests.get(uri, headers=headers, params=params).json()

            print(f'First user is: {res["items"][0]["email"]}')
            # => First user is: hello@coda.io
  /workspaces/{workspaceId}/users/role:
    post:
      summary: Updates user role
      description: >
        Updates the workspace user role of a user that matches the parameters.
        Only succeeds if the requesting user has admin permissions in the
        workspace.
      operationId: changeUserRole
      tags:
        - Workspaces
      parameters:
        - $ref: '#/components/parameters/workspaceId'
      requestBody:
        description: Parameters for changing the user role.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeRole'
      responses:
        '200':
          description: User's info that was updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeRoleResult'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: >
            import requests


            headers = {'Authorization': 'Bearer <your API token>'}

            uri = 'https://coda.io/apis/v1/workspaces/<your workspace
            id>/users/role'

            params = {
              'limit': 10,
            }

            res = requests.post(uri, headers=headers, params=params).json()


            print(f'First user is: {res["items"][0]["email"]}')

            # => First user is: hello@coda.io
  /workspaces/{workspaceId}/roles:
    get:
      summary: List workspace roles
      description: >
        Returns a list of the counts of users over time by role for the
        workspace.
      operationId: listWorkspaceRoleActivity
      tags:
        - Workspaces
      parameters:
        - $ref: '#/components/parameters/workspaceId'
      responses:
        '200':
          description: List of role activity over time for the workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspaceRoleActivity'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = 'https://coda.io/apis/v1/workspaces/<your workspace id>/roles'
            params = {
              'limit': 10,
            }
            res = requests.get(uri, headers=headers, params=params).json()

            print(f'First month is: {res["items"][0]["month"]}')
            # => First month is: 2020-09-15
  /packs:
    get:
      summary: List Packs
      description: |
        Get the list of accessible Packs.
      operationId: listPacks
      tags:
        - Packs
      parameters:
        - name: accessType
          description: >-
            Deprecated, use accessTypes instead. Filter to only return the Packs
            for which the current user has this access type
          in: query
          example: edit
          schema:
            $ref: '#/components/schemas/PackAccessType'
        - name: accessTypes
          description: >-
            Filter to only return the Packs for which the current user has these
            access types.
          in: query
          explode: false
          example: edit
          schema:
            type: array
            items:
              $ref: '#/components/schemas/PackAccessType'
        - name: sortBy
          description: The sort order of the Packs returned.
          in: query
          example: true
          schema:
            $ref: '#/components/schemas/PacksSortBy'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/direction'
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/onlyWorkspaceId'
        - $ref: '#/components/parameters/parentWorkspaceIds'
        - $ref: '#/components/parameters/excludePublicPacks'
        - $ref: '#/components/parameters/excludeIndividualAcls'
        - $ref: '#/components/parameters/excludeWorkspaceAcls'
        - $ref: '#/components/parameters/packEntrypoint'
      responses:
        '200':
          description: List of Pack summaries.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackSummaryList'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    post:
      summary: Create Pack
      description: >
        Creates a new Pack, essentially registering a new Pack ID. The contents
        of the Pack will be uploaded separately.
      operationId: createPack
      tags:
        - Packs
      requestBody:
        description: Parameters for creating the Pack.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePackRequest'
      responses:
        '200':
          description: Info about the Pack that was just created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePackResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
      x-codeSamples:
        - label: Python 3.13
          lang: python
          source: |
            import requests

            headers = {'Authorization': 'Bearer <your API token>'}
            uri = 'https://coda.io/apis/v1/packs'
            res = requests.post(uri, headers=headers).json()

            print(f'Your new Pack ID is {res["packId"]}')
            # => Your new Pack ID is 123
        - label: Shell
          lang: shell
          source: |
            curl -s -H 'Authorization: Bearer <your API token>' \
              'https://coda.io/apis/v1/packs' |
              jq .packId
            # => 123
        - label: Google Apps Script
          lang: javascript
          source: |
            // Import the CodaAPI library via Resource->Libraries...:
            // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
            CodaAPI.authenticate('<your API token>');
            Logger.log('Your new Pack ID is ' + CodaAPI.createPack().packId);
            // => Your new Pack ID is 123
  /packs/{packId}:
    get:
      summary: Get a single Pack
      description: |
        Returns a single Pack.
      operationId: getPack
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      responses:
        '200':
          description: The requested Pack.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pack'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    patch:
      summary: Update Pack
      description: |
        Update an existing Pack for non-versioned fields.
      operationId: updatePack
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      requestBody:
        description: Parameters for updating the Pack.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePackRequest'
      responses:
        '200':
          description: Info about the Pack that was just updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pack'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    delete:
      summary: Delete Pack
      description: |
        Delete a given Pack.
      operationId: deletePack
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      responses:
        '200':
          description: Confirmation that the Pack deletion was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePackResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/configurations/schema:
    get:
      summary: Gets the JSON Schema for Pack configuration.
      description: >
        Returns a JSON Schema applicable for customizing the pack using Pack
        configurations.
      operationId: getPackConfigurationSchema
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      responses:
        '200':
          description: Response containing the JSON Schema of the pack configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPackConfigurationJsonSchemaResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/versions:
    get:
      summary: List the versions for a Pack.
      description: |
        Get the list of versions of a Pack.
      operationId: listPackVersions
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/pageToken'
      tags:
        - Packs
      responses:
        '200':
          description: List of Pack versions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackVersionList'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/nextVersion:
    post:
      summary: Get the next valid version for a Pack.
      description: |
        Get the next valid version based on the proposed metadata.
      operationId: getNextPackVersion
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetNextPackVersionRequest'
      responses:
        '200':
          description: Next Pack version info.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NextPackVersionInfo'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/versions/{basePackVersion}/diff/{targetPackVersion}:
    get:
      summary: Get the difference between two pack versions.
      description: >
        Gets information about the difference between the specified previous
        version and next version of a Pack.
      operationId: getPackVersionDiffs
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/basePackVersion'
        - $ref: '#/components/parameters/targetPackVersion'
      responses:
        '200':
          description: Diffs between the two pack versions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackVersionDiffs'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/versions/{packVersion}/register:
    post:
      summary: Register Pack version
      description: >
        Registers a new Pack version. This simply returns a signed URL to use
        for uploading the Pack version definition. Following the completion of
        the upload, POST to /apis/v1/packs/{packId}/versions/{packVersion}
        trigger the rest of the creation process.
      operationId: registerPackVersion
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/packVersion'
      requestBody:
        description: Parameters for registering the Pack.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterPackVersionRequest'
      responses:
        '200':
          description: >-
            The information indicating where to upload the Pack version
            definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackVersionUploadInfo'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/versions/{packVersion}/uploadComplete:
    post:
      summary: Pack version upload complete
      description: >
        Note the completion of the upload of a Pack version bundle in order to
        create that Pack version.
      operationId: packVersionUploadComplete
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/packVersion'
      requestBody:
        description: Parameters for Pack version upload complete.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePackVersionRequest'
      responses:
        '200':
          description: Confirmation of successful Pack version creation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePackVersionResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/releases:
    post:
      summary: Create a new Pack release.
      description: |
        Creates a new Pack release based on an existing Pack version.
      operationId: createPackRelease
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      requestBody:
        description: Parameters to create the Pack release.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePackReleaseRequest'
      responses:
        '200':
          description: The newly created Pack release.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackRelease'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    get:
      summary: List the releases for a Pack.
      description: |
        Get the list of releases of a Pack.
      operationId: listPackReleases
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/pageToken'
      tags:
        - Packs
      responses:
        '200':
          description: List of Pack releases.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackReleaseList'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/releases/{packReleaseId}:
    put:
      summary: Update an existing Pack release.
      description: |
        Update details of a Pack release.
      operationId: updatePackRelease
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/packReleaseId'
      requestBody:
        description: Parameters to update the Pack release.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePackReleaseRequest'
      responses:
        '200':
          description: The updated Pack release.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackRelease'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/reviews:
    get:
      summary: List pack reviews
      description: List reviews for a specific pack.
      operationId: listPackReviews
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - name: limit
          in: query
          description: Maximum number of results to return.
          schema:
            type: integer
            minimum: 1
            default: 25
        - $ref: '#/components/parameters/pageToken'
        - name: status
          in: query
          description: Filter reviews by status.
          schema:
            $ref: '#/components/schemas/PackReviewStatus'
      responses:
        '200':
          description: List of pack reviews
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPackReviewsResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    post:
      summary: Create pack review
      description: Submit a pack for review in Superhuman GO.
      operationId: createPackReview
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      requestBody:
        description: Parameters for creating pack review.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePackReviewRequest'
      responses:
        '200':
          description: Pack review created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePackReviewResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/reviews/pending/cancel:
    post:
      summary: Cancel pending pack review
      description: >-
        Cancel the pending pack review for this pack. Any user with edit
        permission on the pack can cancel the review.
      operationId: cancelPackReview
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      responses:
        '200':
          description: Pack review canceled successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPackReviewResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/listingDraft:
    get:
      summary: Get Pack listing draft
      description: Get the current listing draft for a Pack.
      operationId: getPackListingDraft
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      responses:
        '200':
          description: The Pack listing draft
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPackListingDraftResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    put:
      summary: Upsert Pack listing draft
      description: Create or update the listing draft for a Pack.
      operationId: upsertPackListingDraft
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      requestBody:
        description: The listing draft data to save.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertPackListingDraftRequest'
      responses:
        '200':
          description: The saved Pack listing draft
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpsertPackListingDraftResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    delete:
      summary: Delete Pack listing draft
      description: Delete the listing draft for a Pack, discarding any unsaved changes.
      operationId: deletePackListingDraft
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      responses:
        '200':
          description: The Pack listing draft was deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePackListingDraftResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/oauthConfig:
    put:
      summary: Set the OAuth configurations of the Pack.
      description: >
        Set the OAuth configurations of the Pack, including client id and
        secret.
      operationId: setPackOauthConfig
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      requestBody:
        description: Parameters to set the Pack OAuth configuration.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetPackOauthConfigRequest'
      responses:
        '200':
          description: The updated OAuth configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackOauthConfigMetadata'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    get:
      summary: Retrieve the OAuth configuration of the Pack.
      description: >
        Retrieve the OAuth configuration of the Pack for display purpose.
        Secrets will be returned with masks.
      operationId: getPackOauthConfig
      parameters:
        - $ref: '#/components/parameters/packId'
      tags:
        - Packs
      responses:
        '200':
          description: The Pack's OAuth configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackOauthConfigMetadata'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/systemConnection:
    put:
      summary: Set the system connection credentials of the Pack.
      description: |
        Set the system connection credentials of the Pack.
      operationId: setPackSystemConnection
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      requestBody:
        description: Parameters to set the Pack system connection credentials.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetPackSystemConnectionRequest'
      responses:
        '200':
          description: The updated system connection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackSystemConnectionMetadata'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    patch:
      summary: Patch the system connection credentials of the Pack.
      description: |
        Patch the system connection credentials of the Pack.
      operationId: patchPackSystemConnection
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      requestBody:
        description: Parameters to patch the Pack system connection credentials.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchPackSystemConnectionRequest'
      responses:
        '200':
          description: The updated system connection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackSystemConnectionMetadata'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    get:
      summary: Retrieve the system connection metadata of the Pack.
      description: |
        Retrieve the system connection metadata of the Pack.
      operationId: getPackSystemConnection
      parameters:
        - $ref: '#/components/parameters/packId'
      tags:
        - Packs
      responses:
        '200':
          description: The system connection metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackSystemConnectionMetadata'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/permissions:
    get:
      summary: List permissions for a Pack
      description: |
        Get user, workspace, and/or global permissions for a given Pack.
      operationId: getPackPermissions
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      responses:
        '200':
          description: List of Pack permissions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackPermissionList'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    post:
      summary: Add a permission for Pack
      description: >
        Create or modify user, workspace, organization, group, or global
        permissions for a given Pack.
      operationId: addPackPermission
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      requestBody:
        description: Parameters for creating/updating Pack permissions.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddPackPermissionRequest'
      responses:
        '200':
          description: Confirmation of successfully upserting a Pack permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddPackPermissionResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    delete:
      summary: Delete a user's own permissions for Pack
      description: |
        Delete a user's own permissions for a given Pack.
      operationId: deleteUserPackPermission
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      responses:
        '200':
          description: >-
            Confirmation of successfully deleting a user's permissions for a
            Pack.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteUserPackPermissionsResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/permissions/{permissionId}:
    delete:
      summary: Delete a permission for Pack
      description: |
        Delete user, workspace, or global permissions for a given Pack.
      operationId: deletePackPermission
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/permissionId'
      responses:
        '200':
          description: Confirmation of successfully deleting a Pack permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePackPermissionResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/invitations:
    get:
      summary: List pending Pack invitations for the current user
      description: |
        Get pending Pack invitations for the authenticated user.
      operationId: listUserPackInvitations
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/pageToken'
      responses:
        '200':
          description: List of Pack invitations for the user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackInvitationWithPackList'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/invitations:
    get:
      summary: List invitations for a Pack
      description: |
        Get pending invitations for a given Pack.
      operationId: listPackInvitations
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/pageToken'
      responses:
        '200':
          description: List of Pack invitations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackInvitationList'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    post:
      summary: Create an invitation for Pack
      description: |
        Create an invitation for a user to access a Pack.
      operationId: createPackInvitation
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      requestBody:
        description: Parameters for creating Pack invitation.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePackInvitationRequest'
      responses:
        '200':
          description: Confirmation of successfully creating a Pack invitation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePackInvitationResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/invitations/{invitationId}:
    put:
      summary: Update an invitation for Pack
      description: |
        Update the access level of an existing Pack invitation.
      operationId: updatePackInvitation
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/invitationId'
      requestBody:
        description: Parameters for updating Pack invitation.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePackInvitationRequest'
      responses:
        '200':
          description: Confirmation of successfully updating a Pack invitation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePackInvitationResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    delete:
      summary: Revoke an invitation for Pack
      description: |
        Revoke a pending Pack invitation.
      operationId: deletePackInvitation
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/invitationId'
      responses:
        '200':
          description: Confirmation of successfully revoking a Pack invitation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePackInvitationResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/invitations/{invitationId}/reply:
    post:
      summary: Reply to a Pack invitation
      description: >
        Reply to a Pack invitation (accept or reject). Requires authentication
        as the invited user.
      operationId: replyToPackInvitation
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/invitationId'
      requestBody:
        description: Parameters for replying to Pack invitation.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HandlePackInvitationRequest'
      responses:
        '200':
          description: Confirmation of successfully replying to a Pack invitation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HandlePackInvitationResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/makers:
    get:
      summary: List makers for Pack
      description: |
        List makers for a given pack.
      operationId: listPackMakers
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      responses:
        '200':
          description: Confirmation of successfully retrieving Pack makers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPackMakersResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/maker:
    post:
      summary: Add a maker for Pack
      description: >
        Set a maker for a given Pack. Used to display makers for a pack in the
        corresponding packs page.
      operationId: addPackMaker
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      requestBody:
        description: Payload for adding a Pack maker.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddPackMakerRequest'
      responses:
        '200':
          description: Confirmation of successfully adding a Pack maker.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddPackMakerResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/maker/{loginId}:
    delete:
      summary: Delete a maker for Pack
      description: >
        Delete a maker for a given Pack, who will not be displayed in the
        corresponding packs page.
      operationId: deletePackMaker
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/loginId'
      responses:
        '200':
          description: Confirmation of successfully deleting a Pack maker.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePackMakerResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/categories:
    get:
      summary: List categories for Pack
      description: |
        List publishing categories for a given pack.
      operationId: listPackCategories
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      responses:
        '200':
          description: Confirmation of successfully retrieving Pack categories
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPackCategoriesResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/category:
    post:
      summary: Add a category for Pack
      description: |
        Add a publishing category for a given pack.
      operationId: addPackCategory
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      requestBody:
        description: Payload for adding a Pack category.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddPackCategoryRequest'
      responses:
        '200':
          description: Confirmation of successfully adding a Pack category
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddPackCategoryResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/category/{categoryName}:
    delete:
      summary: Delete a category for Pack
      description: |
        Delete a publishing category for a given pack.
      operationId: deletePackCategory
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/categoryName'
      responses:
        '200':
          description: Confirmation of successfully deleting a Pack category
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePackCategoryResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/uploadAsset:
    post:
      summary: Upload a Pack asset.
      description: |
        Request a signed s3 URL to upload your Pack asset.
      operationId: uploadPackAsset
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      requestBody:
        description: Parameters to specify the asset being uploaded.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadPackAssetRequest'
      responses:
        '200':
          description: The information indicating where to upload the Pack asset.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackAssetUploadInfo'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/uploadSourceCode:
    post:
      summary: Upload Pack source code.
      description: |
        Request a signed s3 URL to upload your Pack source code.
      operationId: uploadPackSourceCode
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      requestBody:
        description: Parameters to specify the source code being uploaded.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadPackSourceCodeRequest'
      responses:
        '200':
          description: The information indicating where to upload the Pack source code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackSourceCodeUploadInfo'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/assets/{packAssetId}/assetType/{packAssetType}/uploadComplete:
    post:
      summary: Pack asset upload complete
      description: |
        Note the completion of the upload of a Pack asset.
      operationId: packAssetUploadComplete
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/packAssetId'
        - $ref: '#/components/parameters/packAssetType'
      responses:
        '200':
          description: Confirmation of successful Pack asset creation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackAssetUploadCompleteResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/versions/{packVersion}/sourceCode/uploadComplete:
    post:
      summary: Pack source code upload complete
      description: |
        Note the completion of the upload of a Pack source code.
      operationId: packSourceCodeUploadComplete
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/packVersion'
      requestBody:
        description: Parameters to specify the source code being uploaded.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackSourceCodeUploadCompleteRequest'
      responses:
        '200':
          description: Confirmation of successful Pack asset creation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackSourceCodeUploadCompleteResponse'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/versions/{packVersion}/sourceCode:
    get:
      summary: get the source code for a Pack version.
      description: >
        Get temporary links used to download the source code for the given
        packId and version
      operationId: getPackSourceCode
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/packVersion'
      responses:
        '200':
          description: The source code associated with the given packId/version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackSourceCodeInfo'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/listings:
    get:
      summary: List the Pack listings accessible to a user.
      description: |
        Get listings of public Packs and Packs created by you.
      operationId: listPackListings
      parameters:
        - $ref: '#/components/parameters/packAccessTypes'
        - $ref: '#/components/parameters/packIds'
        - $ref: '#/components/parameters/onlyWorkspaceId'
        - $ref: '#/components/parameters/parentWorkspaceIds'
        - $ref: '#/components/parameters/excludePublicPacks'
        - $ref: '#/components/parameters/excludeWorkspaceAcls'
        - $ref: '#/components/parameters/excludeIndividualAcls'
        - $ref: '#/components/parameters/packEntrypoint'
        - $ref: '#/components/parameters/certifiedAgentsOnly'
        - name: sortBy
          in: query
          description: Specify a sort order for the returned Pack listings returned.
          schema:
            $ref: '#/components/schemas/PackListingsSortBy'
        - name: orderBy
          in: query
          description: 'Deprecated: use sortBy instead.'
          schema:
            $ref: '#/components/schemas/PackListingsSortBy'
        - $ref: '#/components/parameters/direction'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/pageToken'
        - name: installContext
          in: query
          description: >-
            Type of installation context for which Pack information is being
            requested.
          example: workspace
          required: false
          schema:
            $ref: '#/components/schemas/PackListingInstallContextType'
      tags:
        - Packs
      responses:
        '200':
          description: Public Pack listings and Pack listings created by you.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackListingList'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/listing:
    get:
      summary: Get detailed listing information for a Pack.
      description: |
        Get detailed listing information for a Pack.
      operationId: getPackListing
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - name: workspaceId
          description: >-
            ID of the target workspace (if applicable) for checking installation
            privileges.
          in: query
          example: ws-1Ab234
          schema:
            type: string
        - name: docId
          description: ID of the target document for checking installation privileges
          in: query
          example: fleHfrkw3L
          schema:
            type: string
        - name: ingestionId
          description: ID of the target ingestion for checking limit settings
          in: query
          example: uuid-uuid-uuid-uuid
          schema:
            type: string
        - name: installContext
          in: query
          description: >-
            Type of installation context for which Pack information is being
            requested.
          example: workspace
          required: false
          schema:
            $ref: '#/components/schemas/PackListingInstallContextType'
        - name: releaseChannel
          in: query
          description: Release channel for which Pack information is being requested.
          example: LIVE
          required: false
          schema:
            $ref: '#/components/schemas/IngestionPackReleaseChannel'
      responses:
        '200':
          description: The Pack listing detail.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackListingDetail'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/docs/{docId}/logs:
    get:
      summary: Retrieve the logs of a Pack.
      description: |
        Retrieve the logs of a Pack for debugging purpose.
      operationId: listPackLogs
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - name: limit
          description: Maximum number of results to return in this query.
          in: query
          example: 10
          schema:
            type: integer
            minimum: 1
            default: 25
            maximum: 100
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/docId'
        - name: logTypes
          description: Only return logs of the given types.
          in: query
          explode: false
          example: fetcher,custom
          schema:
            type: array
            items:
              $ref: '#/components/schemas/PackLogType'
        - name: beforeTimestamp
          description: |
            Only return logs before the given time (non-inclusive).
          in: query
          required: false
          example: '2018-04-11T00:18:57.946Z'
          schema:
            type: string
            format: date-time
        - name: afterTimestamp
          description: |
            Only return logs after the given time (non-inclusive).
          in: query
          required: false
          example: '2018-04-11T00:18:57.946Z'
          schema:
            type: string
            format: date-time
        - name: order
          description: >
            Specifies if the logs will be returned in time desc or asc. Default
            is desc.
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: q
          description: |
            A search query that follows Lucene syntax.
          in: query
          required: false
          example: context.doc_id:"fleHfrkw3L" AND event.action:"FormulaRequest"
          schema:
            type: string
            x-allow-empty: true
        - name: requestIds
          description: Only return logs matching provided request IDs.
          in: query
          explode: false
          example: 416faabf,4127faag
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Pack logs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackLogsList'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/tenantId/{tenantId}/rootIngestionId/{rootIngestionId}/logs:
    get:
      summary: Retrieve the logs of a Ingestion.
      description: Retrieve the logs of a Ingestion for debugging purpose.
      operationId: listIngestionLogs
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - name: limit
          description: Maximum number of results to return in this query.
          in: query
          example: 10
          schema:
            type: integer
            minimum: 1
            default: 25
            maximum: 100
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/tenantId'
        - $ref: '#/components/parameters/rootIngestionId'
        - name: logTypes
          description: Only return logs of the given types.
          in: query
          explode: false
          example: fetcher,custom
          schema:
            type: array
            items:
              $ref: '#/components/schemas/PackLogType'
        - name: ingestionExecutionId
          description: ID of the ingestion execution.
          in: query
          required: false
          example: a4e293c4-4a85-45a4-b2ba-7f305cba2703
          schema:
            type: string
            format: uuid
        - name: beforeTimestamp
          description: |
            Only return logs before the given time (non-inclusive).
          in: query
          required: false
          example: '2018-04-11T00:18:57.946Z'
          schema:
            type: string
            format: date-time
        - name: afterTimestamp
          description: |
            Only return logs after the given time (non-inclusive).
          in: query
          required: false
          example: '2018-04-11T00:18:57.946Z'
          schema:
            type: string
            format: date-time
        - name: ingestionStatus
          description: >
            Only fetch logs with the given ingestion status. This only works in
            combination with the onlyExecutionCompletions parameter.
          in: query
          schema:
            $ref: '#/components/schemas/IngestionStatus'
        - name: onlyExecutionCompletions
          description: Only fetch logs that represent the completion of a child execution.
          in: query
          schema:
            type: boolean
        - name: order
          description: >
            Specifies if the logs will be returned in time desc or asc. Default
            is desc.
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: q
          description: |
            A search query that follows Lucene syntax.
          in: query
          required: false
          example: context.doc_id:"fleHfrkw3L" AND event.action:"FormulaRequest"
          schema:
            type: string
            x-allow-empty: true
        - name: requestIds
          description: Only return logs matching provided request IDs.
          in: query
          explode: false
          example: 416faabf,4127faag
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Pack logs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackLogsList'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/docs/{docId}/groupedLogs:
    get:
      summary: Retrieve the grouped logs of a Pack.
      description: |
        Retrieve the grouped logs of a Pack for debugging purpose.
      operationId: listGroupedPackLogs
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - name: limit
          description: Maximum number of results to return in this query.
          in: query
          example: 10
          schema:
            type: integer
            minimum: 1
            default: 25
            maximum: 100
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/docId'
        - name: beforeTimestamp
          description: |
            Only return logs before the given time (non-inclusive).
          in: query
          required: false
          example: '2018-04-11T00:18:57.946Z'
          schema:
            type: string
            format: date-time
        - name: afterTimestamp
          description: |
            Only return logs after the given time (non-inclusive).
          in: query
          required: false
          example: '2018-04-11T00:18:57.946Z'
          schema:
            type: string
            format: date-time
        - name: order
          description: >
            Specifies if the logs will be returned in time desc or asc. Default
            is desc.
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: q
          description: |
            A search query that follows Lucene syntax.
          in: query
          required: false
          example: context.doc_id:"fleHfrkw3L" AND event.action:"FormulaRequest"
          schema:
            type: string
            x-allow-empty: true
      responses:
        '200':
          description: Grouped pack logs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupedPackLogsList'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/tenantId/{tenantId}/rootIngestionId/{rootIngestionId}/groupedLogs:
    get:
      summary: Retrieve the grouped logs of a Pack for a specific ingestionExecutionId.
      description: |
        Retrieve the grouped logs of a Pack for debugging purpose.
      operationId: listGroupedIngestionLogs
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - name: limit
          description: Maximum number of results to return in this query.
          in: query
          example: 10
          schema:
            type: integer
            minimum: 1
            default: 25
            maximum: 100
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/tenantId'
        - $ref: '#/components/parameters/rootIngestionId'
        - $ref: '#/components/parameters/ingestionExecutionId'
        - name: beforeTimestamp
          description: |
            Only return logs before the given time (non-inclusive).
          in: query
          required: false
          example: '2018-04-11T00:18:57.946Z'
          schema:
            type: string
            format: date-time
        - name: afterTimestamp
          description: |
            Only return logs after the given time (non-inclusive).
          in: query
          required: false
          example: '2018-04-11T00:18:57.946Z'
          schema:
            type: string
            format: date-time
        - name: order
          description: >
            Specifies if the logs will be returned in time desc or asc. Default
            is desc.
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: q
          description: |
            A search query that follows Lucene syntax.
          in: query
          required: false
          example: context.doc_id:"fleHfrkw3L" AND event.action:"FormulaRequest"
          schema:
            type: string
            x-allow-empty: true
      responses:
        '200':
          description: Grouped pack logs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupedPackLogsList'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/tenantId/{tenantId}/rootIngestionId/{rootIngestionId}/ingestionBatchExecutions:
    get:
      summary: >-
        Retrieve a list of ingestion batch executions for the given root
        ingestion id.
      description: >
        Retrieve the ingestion batch executions of a root ingestion for
        debugging purpose.
      operationId: listIngestionBatchExecutions
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/tenantId'
        - $ref: '#/components/parameters/rootIngestionId'
        - $ref: '#/components/parameters/pageToken'
        - name: limit
          description: Maximum number of results to return in this query.
          in: query
          example: 10
          schema:
            type: integer
            minimum: 1
            default: 25
            maximum: 100
        - name: datasource
          description: Only show batch executions for this datasource (sync table).
          in: query
          required: false
          schema:
            type: string
            x-allow-empty: true
        - name: executionType
          description: Only show batch executions with this execution type.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/IngestionExecutionType'
        - name: includeDeletedIngestions
          description: Include deleted ingestion executions in the response
          in: query
          required: false
          schema:
            type: boolean
        - name: ingestionExecutionId
          description: Only retrieve this single batch execution.
          in: query
          required: false
          schema:
            type: string
        - name: ingestionId
          description: Only show batch executions for this sync table ingestion.
          in: query
          required: false
          schema:
            type: string
        - name: ingestionStatus
          description: Only show batch executions with this status.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/IngestionStatus'
      responses:
        '200':
          description: list of ingestion batch executions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IngestionBatchExecutionsList'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/tenantId/{tenantId}/rootIngestionId/{rootIngestionId}/ingestionBatchExecutions/{ingestionExecutionId}/parentItems:
    get:
      summary: >-
        Retrieve a list of parent items for the given ingestion batch execution
        id.
      description: >
        Retrieve the parent items of a ingestion batch execution for debugging
        purpose.
      operationId: listIngestionParentItems
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/tenantId'
        - $ref: '#/components/parameters/rootIngestionId'
        - $ref: '#/components/parameters/pageToken'
        - name: limit
          description: Maximum number of results to return in this query.
          in: query
          example: 10
          schema:
            type: integer
            minimum: 1
            default: 25
            maximum: 100
        - name: ingestionExecutionId
          description: Only show parent items for this ingestion batch execution.
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: ingestionId
          description: The ID of the sync table ingestion. Enables faster lookup.
          in: query
          required: true
          schema:
            type: string
            format: uuid
        - name: ingestionStatus
          description: Only show parent items with this status.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/IngestionStatus'
      responses:
        '200':
          description: list of ingestion parent items.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IngestionParentItemsList'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/tenantId/{tenantId}/rootIngestionId/{rootIngestionId}/logs/{logId}:
    get:
      summary: Retrieve the information for a specific log.
      description: >
        Retrieve the ingestion execution ids of a root ingestion for debugging
        purpose.
      operationId: getPackLogDetails
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
        - $ref: '#/components/parameters/tenantId'
        - $ref: '#/components/parameters/rootIngestionId'
        - name: logId
          in: path
          description: |
            The id of the log to retrieve.
          required: true
          schema:
            type: string
            x-allow-empty: false
        - name: detailsKey
          in: query
          description: |
            The key of the details to retrieve.
          required: true
          schema:
            type: string
            x-allow-empty: false
      responses:
        '200':
          description: Pack log details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackLogDetails'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /packs/{packId}/featuredDocs:
    get:
      summary: List featured docs for a Pack
      description: |
        Returns a list of featured doc ids for a Pack.
      operationId: listPackFeaturedDocs
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      responses:
        '200':
          description: The featured docs for a Pack.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackFeaturedDocsResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    put:
      summary: Update featured docs for a Pack
      description: |
        Create or replace the featured docs for a Pack.
      operationId: updatePackFeaturedDocs
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/packId'
      requestBody:
        description: Parameters for updating the Pack's featured docs.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePackFeaturedDocsRequest'
      responses:
        '200':
          description: Update Pack's featured docs success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePackFeaturedDocsResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /organizations/{organizationId}/goLinks:
    post:
      summary: Add a go link
      description: Adds a new go link for the organization.
      operationId: addGoLink
      tags:
        - Go Links
      parameters:
        - $ref: '#/components/parameters/organizationId'
      requestBody:
        description: The request body for creating a go link.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddGoLinkRequest'
      responses:
        '200':
          description: Confirmation that the go link was added.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddGoLinkResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
  /go/tenants/{tenantId}/agentInstances/{agentInstanceId}/agentSessionIds:
    get:
      summary: Retrieve the chat sessions of an agent instance.
      description: Retrieve the chat sessions of an agent instance for debugging purpose.
      operationId: listAgentSessionIds
      tags:
        - Packs
      parameters:
        - name: limit
          description: Maximum number of results to return in this query.
          in: query
          example: 10
          schema:
            type: integer
            minimum: 1
            default: 25
            maximum: 100
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/tenantId'
        - $ref: '#/components/parameters/agentInstanceId'
        - name: agentSessionId
          description: ID of the agent chat session.
          in: query
          required: false
          example: a4e293c4-4a85-45a4-b2ba-7f305cba2703
          schema:
            type: string
            format: uuid
        - name: logTypes
          description: Only return logs of the given types.
          in: query
          explode: false
          example: fetcher,custom
          schema:
            type: array
            items:
              $ref: '#/components/schemas/PackLogType'
        - name: beforeTimestamp
          description: |
            Only return logs before the given time (non-inclusive).
          in: query
          required: false
          example: '2018-04-11T00:18:57.946Z'
          schema:
            type: string
            format: date-time
        - name: afterTimestamp
          description: |
            Only return logs after the given time (non-inclusive).
          in: query
          required: false
          example: '2018-04-11T00:18:57.946Z'
          schema:
            type: string
            format: date-time
        - name: order
          description: >
            Specifies if the logs will be returned in time desc or asc. Default
            is desc.
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: q
          description: |
            A search query that follows Lucene syntax.
          in: query
          required: false
          example: >-
            trace.id:"a4e293c4-4a85-45a4-b2ba-7f305cba2703" AND
            event.action:"FormulaRequest"
          schema:
            type: string
            x-allow-empty: true
        - name: requestIds
          description: Only return logs matching provided request IDs.
          in: query
          explode: false
          example: 416faabf,4127faag
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Pack logs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackLogsList'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /go/tenants/{tenantId}/agentInstances/{agentInstanceId}/logs:
    get:
      summary: Retrieve the logs of an agent instance.
      description: Retrieve the logs of an agent instance for debugging purpose.
      operationId: listAgentLogs
      tags:
        - Packs
      parameters:
        - name: limit
          description: Maximum number of results to return in this query.
          in: query
          example: 10
          schema:
            type: integer
            minimum: 1
            default: 25
            maximum: 100
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/tenantId'
        - $ref: '#/components/parameters/agentInstanceId'
        - name: logTypes
          description: Only return logs of the given types.
          in: query
          explode: false
          example: fetcher,custom
          schema:
            type: array
            items:
              $ref: '#/components/schemas/PackLogType'
        - name: agentSessionId
          description: ID of the agent chat session.
          in: query
          required: false
          example: a4e293c4-4a85-45a4-b2ba-7f305cba2703
          schema:
            type: string
            format: uuid
        - name: beforeTimestamp
          description: |
            Only return logs before the given time (non-inclusive).
          in: query
          required: false
          example: '2018-04-11T00:18:57.946Z'
          schema:
            type: string
            format: date-time
        - name: afterTimestamp
          description: |
            Only return logs after the given time (non-inclusive).
          in: query
          required: false
          example: '2018-04-11T00:18:57.946Z'
          schema:
            type: string
            format: date-time
        - name: order
          description: >
            Specifies if the logs will be returned in time desc or asc. Default
            is desc.
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: q
          description: |
            A search query that follows Lucene syntax.
          in: query
          required: false
          example: >-
            trace.id:"a4e293c4-4a85-45a4-b2ba-7f305cba2703" AND
            event.action:"FormulaRequest"
          schema:
            type: string
            x-allow-empty: true
        - name: requestIds
          description: Only return logs matching provided request IDs.
          in: query
          explode: false
          example: 416faabf,4127faag
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Pack logs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackLogsList'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /go/tenants/{tenantId}/agentInstances/{agentInstanceId}/logs/{logId}:
    get:
      summary: Retrieve the information for a specific log.
      description: |
        Retrieve the log details of given logId.
      operationId: getAgentPackLogDetails
      tags:
        - Packs
      parameters:
        - $ref: '#/components/parameters/tenantId'
        - $ref: '#/components/parameters/agentInstanceId'
        - name: logId
          in: path
          description: |
            The id of the log to retrieve.
          required: true
          schema:
            type: string
            x-allow-empty: false
        - name: detailsKey
          in: query
          description: |
            The key of the details to retrieve.
          required: true
          schema:
            type: string
            x-allow-empty: false
      responses:
        '200':
          description: Pack log details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackLogDetails'
        '400':
          $ref: '#/components/responses/BadRequestWithValidationErrors'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
components:
  schemas:
    Type:
      x-schema-name: Type
      description: A constant identifying the type of the resource.
      type: string
      enum:
        - aclMetadata
        - aclPermissions
        - aclSettings
        - agentPackLog
        - analyticsLastUpdated
        - apiLink
        - automation
        - column
        - control
        - doc
        - customDocDomain
        - customDocDomainProvider
        - docAnalytics
        - docAnalyticsSummary
        - docAnalyticsV2
        - folder
        - formula
        - goLink
        - ingestionBatchExecution
        - ingestionExecution
        - ingestionExecutionAttempt
        - ingestionPackLog
        - ingestionParentItem
        - mutationStatus
        - pack
        - packAclPermissions
        - packAnalytics
        - packAnalyticsSummary
        - packAsset
        - packCategory
        - packConfigurationSchema
        - packFeaturedDocs
        - packFormulaAnalytics
        - packInvitation
        - packListingDraft
        - packLog
        - packMaker
        - packOauthConfig
        - packRelease
        - packReview
        - packSourceCode
        - packSystemConnection
        - packVersion
        - page
        - pageContentExport
        - pageContentExportStatus
        - principal
        - row
        - table
        - user
        - workspace
      x-tsEnumNames:
        - AclMetadata
        - AclPermissions
        - AclSettings
        - AgentPackLog
        - AnalyticsLastUpdated
        - ApiLink
        - Automation
        - Column
        - Control
        - Doc
        - CustomDocDomain
        - CustomDocDomainProvider
        - DocAnalytics
        - DocAnalyticsSummary
        - DocAnalyticsV2
        - Folder
        - Formula
        - GoLink
        - IngestionBatchExecution
        - IngestionExecution
        - IngestionExecutionAttempt
        - IngestionPackLog
        - IngestionParentItem
        - MutationStatus
        - Pack
        - PackAclPermissions
        - PackAnalytics
        - PackAnalyticsSummary
        - PackAsset
        - PackCategory
        - PackConfigurationSchema
        - PackFeaturedDocs
        - PackFormulaAnalytics
        - PackInvitation
        - PackListingDraft
        - PackLog
        - PackMaker
        - PackOauthConfig
        - PackRelease
        - PackReview
        - PackSourceCode
        - PackSystemConnection
        - PackVersion
        - Page
        - PageContentExport
        - PageContentExportStatus
        - Principal
        - Row
        - Table
        - User
        - Workspace
    PrincipalType:
      x-schema-name: PrincipalType
      description: Type of principal.
      type: string
      enum:
        - email
        - group
        - domain
        - workspace
        - anyone
        - internalAccess
      x-tsEnumNames:
        - Email
        - Group
        - Domain
        - Workspace
        - Anyone
        - InternalAccess
    AddedPrincipal:
      x-schema-name: AddedPrincipal
      description: Metadata about a principal to add to a doc.
      oneOf:
        - $ref: '#/components/schemas/AddedEmailPrincipal'
        - $ref: '#/components/schemas/AddedGroupPrincipal'
        - $ref: '#/components/schemas/AddedDomainPrincipal'
        - $ref: '#/components/schemas/AddedWorkspacePrincipal'
        - $ref: '#/components/schemas/AddedAnyonePrincipal'
      discriminator:
        propertyName: type
        mapping:
          email: '#/components/schemas/AddedEmailPrincipal'
          group: '#/components/schemas/AddedGroupPrincipal'
          domain: '#/components/schemas/AddedDomainPrincipal'
          workspace: '#/components/schemas/AddedWorkspacePrincipal'
          anyone: '#/components/schemas/AddedAnyonePrincipal'
    AddedEmailPrincipal:
      type: object
      required:
        - email
        - type
      additionalProperties: false
      properties:
        type: &ref_0
          type: string
          description: The type of this principal.
          enum:
            - email
          x-tsType: PrincipalType.Email
        email: &ref_1
          type: string
          description: Email for the principal.
          example: example@domain.com
    AddedGroupPrincipal:
      type: object
      required:
        - groupId
        - type
      additionalProperties: false
      properties:
        type: &ref_2
          type: string
          description: The type of this principal.
          enum:
            - group
          x-tsType: PrincipalType.Group
        groupId: &ref_3
          type: string
          description: Group ID for the principal.
          example: grp-6SM9xrKcqW
    AddedDomainPrincipal:
      type: object
      required:
        - domain
        - type
      additionalProperties: false
      properties:
        type: &ref_4
          type: string
          description: The type of this principal.
          enum:
            - domain
          x-tsType: PrincipalType.Domain
        domain: &ref_5
          type: string
          description: Domain for the principal.
          example: domain.com
    AddedWorkspacePrincipal:
      type: object
      required:
        - type
        - workspaceId
      additionalProperties: false
      properties:
        type: &ref_6
          type: string
          description: The type of this principal.
          enum:
            - workspace
          x-tsType: PrincipalType.Workspace
        workspaceId: &ref_7
          type: string
          description: WorkspaceId for the principal.
          example: ws-sdfmsdf9
    AddedAnyonePrincipal:
      type: object
      required:
        - type
      additionalProperties: false
      properties:
        type: &ref_8
          type: string
          description: The type of this principal.
          enum:
            - anyone
          x-tsType: PrincipalType.Anyone
    Principal:
      x-schema-name: Principal
      description: Metadata about a principal.
      oneOf:
        - $ref: '#/components/schemas/EmailPrincipal'
        - $ref: '#/components/schemas/GroupPrincipal'
        - $ref: '#/components/schemas/DomainPrincipal'
        - $ref: '#/components/schemas/WorkspacePrincipal'
        - $ref: '#/components/schemas/AnyonePrincipal'
        - $ref: '#/components/schemas/InternalAccessPrincipal'
      discriminator:
        propertyName: type
        mapping:
          email: '#/components/schemas/EmailPrincipal'
          group: '#/components/schemas/GroupPrincipal'
          domain: '#/components/schemas/DomainPrincipal'
          workspace: '#/components/schemas/WorkspacePrincipal'
          anyone: '#/components/schemas/AnyonePrincipal'
          internalAccess: '#/components/schemas/InternalAccessPrincipal'
    EmailPrincipal:
      type: object
      required:
        - email
        - type
      additionalProperties: false
      properties:
        type: *ref_0
        email: *ref_1
    GroupPrincipal:
      type: object
      required:
        - groupId
        - groupName
        - type
      additionalProperties: false
      properties:
        type: *ref_2
        groupId: *ref_3
        groupName:
          type: string
          description: Name of the group.
          example: Marketing team
    DomainPrincipal:
      type: object
      required:
        - domain
        - type
      additionalProperties: false
      properties:
        type: *ref_4
        domain: *ref_5
    WorkspacePrincipal:
      type: object
      required:
        - type
        - workspaceId
      additionalProperties: false
      properties:
        type: *ref_6
        workspaceId: *ref_7
    AnyonePrincipal:
      type: object
      required:
        - type
      additionalProperties: false
      properties:
        type: *ref_8
    InternalAccessPrincipal:
      type: object
      required:
        - type
        - internalAccessType
      additionalProperties: false
      properties:
        type:
          type: string
          description: The type of this principal.
          enum:
            - internalAccess
          x-tsType: PrincipalType.InternalAccess
        internalAccessType:
          type: string
          description: The type of internal access (e.g., support).
          example: support
    AccessType:
      x-schema-name: AccessType
      description: Type of access.
      type: string
      enum:
        - readonly
        - write
        - comment
        - none
      x-tsEnumNames:
        - ReadOnly
        - Write
        - Comment
        - None
    AccessTypeNotNone:
      x-schema-name: AccessTypeNotNone
      description: Type of access (excluding none).
      type: string
      enum:
        - readonly
        - write
        - comment
      x-tsEnumNames:
        - ReadOnly
        - Write
        - Comment
    Permission:
      x-schema-name: Permission
      description: A specific permission granted to a principal.
      type: object
      required:
        - principal
        - id
        - access
      additionalProperties: false
      properties:
        principal:
          $ref: '#/components/schemas/Principal'
        id:
          type: string
          description: Id for the Permission
        access:
          $ref: '#/components/schemas/AccessType'
    AddPermissionRequest:
      x-schema-name: AddPermissionRequest
      description: Payload for granting a new permission.
      type: object
      required:
        - access
        - principal
      additionalProperties: false
      properties:
        access:
          $ref: '#/components/schemas/AccessTypeNotNone'
        principal:
          $ref: '#/components/schemas/AddedPrincipal'
        suppressEmail:
          type: boolean
          description: When true suppresses email notification
    Acl:
      x-schema-name: Acl
      description: List of Permissions.
      type: object
      required:
        - items
        - href
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Permission'
        href:
          type: string
          format: url
          description: API link to these results
          example: https://coda.io/apis/v1/docs/AbCDeFGH/acl?limit=20
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: https://coda.io/apis/v1/docs/AbCDeFGH/acl?pageToken=eyJsaW1pd
    AclMetadata:
      x-schema-name: Acl
      description: Doc level metadata associated with ACL.
      type: object
      required:
        - canShare
        - canShareWithWorkspace
        - canShareWithOrg
        - canCopy
      additionalProperties: false
      properties:
        canShare:
          type: boolean
          description: When true, the user of the api can share
        canShareWithWorkspace:
          type: boolean
          description: When true, the user of the api can share with the workspace
        canShareWithOrg:
          type: boolean
          description: When true, the user of the api can share with the org
        canCopy:
          type: boolean
          description: When true, the user of the api can copy the doc
    AclSettings:
      x-schema-name: AclSettings
      description: Sharing settings for the doc.
      type: object
      required:
        - allowEditorsToChangePermissions
        - allowCopying
        - allowViewersToRequestEditing
      additionalProperties: false
      properties:
        allowEditorsToChangePermissions:
          type: boolean
          description: >
            When true, allows editors to change doc permissions. When false,
            only doc owner can change doc permissions.
        allowCopying:
          type: boolean
          description: When true, allows doc viewers to copy the doc.
        allowViewersToRequestEditing:
          type: boolean
          description: When true, allows doc viewers to request editing permissions.
    AddPermissionResult:
      x-schema-name: AddPermissionResult
      description: The result of sharing a doc.
      type: object
      additionalProperties: false
      properties: {}
    DeletePermissionResult:
      x-schema-name: DeletePermissionResult
      description: The result of deleting a permission.
      type: object
      additionalProperties: false
      properties: {}
    SearchPrincipalsResponse:
      x-schema-name: SearchPrincipalsResponse
      description: Metadata about the principals that match the given query.
      type: object
      required:
        - users
        - groups
      additionalProperties: false
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/UserSummary'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/GroupPrincipal'
    UpdateAclSettingsRequest:
      x-schema-name: UpdateAclSettingsRequest
      description: Request to update ACL settings for a doc.
      type: object
      additionalProperties: false
      properties:
        allowEditorsToChangePermissions:
          type: boolean
          description: >
            When true, allows editors to change doc permissions. When false,
            only doc owner can change doc permissions.
        allowCopying:
          type: boolean
          description: When true, allows doc viewers to copy the doc.
        allowViewersToRequestEditing:
          type: boolean
          description: When true, allows doc viewers to request editing permissions.
    DocReference:
      x-schema-name: DocReference
      description: Reference to a Coda doc.
      type: object
      required:
        - id
        - type
        - browserLink
        - href
      additionalProperties: false
      properties:
        id: &ref_9
          type: string
          description: ID of the Coda doc.
          example: AbCDeFGH
        type: &ref_10
          type: string
          description: The type of this resource.
          enum:
            - doc
          x-tsType: Type.Doc
        href: &ref_11
          type: string
          format: url
          description: API link to the Coda doc.
          example: https://coda.io/apis/v1/docs/AbCDeFGH
        browserLink:
          type: string
          format: url
          description: Browser-friendly link to the Coda doc.
          example: https://coda.io/d/_dAbCDeFGH
    Doc:
      x-schema-name: Doc
      description: Metadata about a Coda doc.
      type: object
      required:
        - id
        - type
        - href
        - browserLink
        - name
        - owner
        - ownerName
        - createdAt
        - updatedAt
        - workspace
        - folder
        - workspaceId
        - folderId
      additionalProperties: false
      properties:
        id: *ref_9
        type: *ref_10
        href: *ref_11
        browserLink: &ref_12
          type: string
          format: url
          description: Browser-friendly link to the Coda doc.
          example: https://coda.io/d/_dAbCDeFGH
        icon: &ref_13
          $ref: '#/components/schemas/Icon'
        name: &ref_14
          type: string
          description: Name of the doc.
          example: Product Launch Hub
        owner: &ref_15
          type: string
          format: email
          description: Email address of the doc owner.
          example: user@example.com
        ownerName: &ref_16
          type: string
          description: Name of the doc owner.
          example: Some User
        docSize: &ref_17
          $ref: '#/components/schemas/DocSize'
        sourceDoc: &ref_18
          allOf:
            - type: object
              description: Reference to a Coda doc from which this doc was copied, if any.
              additionalProperties: false
            - $ref: '#/components/schemas/DocReference'
        createdAt: &ref_19
          type: string
          format: date-time
          description: Timestamp for when the doc was created.
          example: '2018-04-11T00:18:57.946Z'
        updatedAt: &ref_20
          type: string
          format: date-time
          description: Timestamp for when the doc was last modified.
          example: '2018-04-11T00:18:57.946Z'
        published: &ref_21
          $ref: '#/components/schemas/DocPublished'
        folder: &ref_22
          $ref: '#/components/schemas/FolderReference'
        workspace: &ref_23
          $ref: '#/components/schemas/WorkspaceReference'
        workspaceId: &ref_24
          type: string
          description: ID of the Coda workspace containing this doc.
          example: ws-1Ab234
          deprecated: true
        folderId: &ref_25
          type: string
          description: ID of the Coda folder containing this doc.
          example: fl-1Ab234
          deprecated: true
    DocCategory:
      x-schema-name: DocCategory
      type: object
      description: The category applied to a doc.
      required:
        - name
      additionalProperties: false
      properties:
        name:
          type: string
          description: Name of the category.
          example: Project Management
    DocCategoryList:
      x-schema-name: DocCategoryList
      type: object
      description: A list of categories that can be applied to a doc.
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          description: Categories for the doc.
          items:
            $ref: '#/components/schemas/DocCategory'
    DocList:
      x-schema-name: DocList
      description: List of Coda docs.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Doc'
        href:
          type: string
          format: url
          description: API link to these results
          example: https://coda.io/apis/v1/docs?limit=20
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: https://coda.io/apis/v1/docs?pageToken=eyJsaW1pd
    DocCreate:
      x-schema-name: DocCreate
      description: Payload for creating a new doc.
      type: object
      additionalProperties: false
      properties:
        title:
          type: string
          description: Title of the new doc. Defaults to 'Untitled'.
          example: Project Tracker
        sourceDoc:
          type: string
          description: An optional doc ID from which to create a copy.
          example: iJKlm_noPq
        timezone:
          type: string
          description: The timezone to use for the newly created doc.
          example: America/Los_Angeles
        folderId:
          type: string
          description: >
            The ID of the folder within which to create this doc. Defaults to
            your "My docs" folder in the oldest workspace you joined; this is
            subject to change. You can get this ID by opening the folder in the
            docs list on your computer and grabbing the `folderId` query
            parameter.
          example: fl-ABcdEFgHJi
        initialPage:
          allOf:
            - type: object
              description: The contents of the initial page of the doc.
              additionalProperties: false
            - $ref: '#/components/schemas/PageCreate'
    DocDelete:
      x-schema-name: DocDelete
      description: The result of a doc deletion.
      type: object
      additionalProperties: false
      properties: {}
    DocUpdate:
      x-schema-name: DocUpdate
      description: Payload for updating a doc.
      type: object
      additionalProperties: false
      properties:
        title:
          type: string
          description: Title of the doc.
          example: Project Tracker
        iconName:
          type: string
          description: Name of the icon.
          example: rocket
    DocSize:
      x-schema-name: DocSize
      description: The number of components within a Coda doc.
      type: object
      required:
        - totalRowCount
        - tableAndViewCount
        - pageCount
        - overApiSizeLimit
      additionalProperties: false
      properties:
        totalRowCount:
          type: number
          description: The number of rows contained within all tables of the doc.
          example: 31337
        tableAndViewCount:
          type: number
          description: The total number of tables and views contained within the doc.
          example: 42
        pageCount:
          type: number
          description: The total number of page contained within the doc.
          example: 10
        overApiSizeLimit:
          type: boolean
          description: If true, indicates that the doc is over the API size limit.
          example: false
    DocPublish:
      x-schema-name: DocPublish
      description: Payload for publishing a doc or or updating its publishing information.
      type: object
      additionalProperties: false
      properties:
        slug:
          type: string
          description: Slug for the published doc.
          example: my-doc
        discoverable:
          type: boolean
          description: If true, indicates that the doc is discoverable.
          example: true
        earnCredit:
          type: boolean
          description: >
            If true, new users may be required to sign in to view content within
            this document. You will receive Coda credit for each user who signs
            up via your doc.
          example: true
        categoryNames:
          type: array
          description: The names of categories to apply to the document.
          example:
            - Project management
          items:
            type: string
        mode:
          $ref: '#/components/schemas/DocPublishMode'
    DocPublished:
      x-schema-name: DocPublished
      description: Information about the publishing state of the document.
      type: object
      required:
        - browserLink
        - discoverable
        - earnCredit
        - mode
        - categories
      additionalProperties: false
      properties:
        description:
          type: string
          description: Description of the published doc.
          example: Hello World!
        browserLink:
          type: string
          description: URL to the published doc.
          example: https://coda.io/@coda/hello-world
        imageLink:
          type: string
          description: URL to the cover image for the published doc.
        discoverable:
          type: boolean
          description: If true, indicates that the doc is discoverable.
          example: true
        earnCredit:
          type: boolean
          description: >
            If true, new users may be required to sign in to view content within
            this document. You will receive Coda credit for each user who signs
            up via your doc.
          example: true
        mode:
          $ref: '#/components/schemas/DocPublishMode'
        categories:
          type: array
          description: Categories applied to the doc.
          example:
            - Project Management
          items:
            $ref: '#/components/schemas/DocCategory'
    DocPublishMode:
      x-schema-name: DocPublishMode
      description: Which interaction mode the published doc should use.
      type: string
      enum:
        - view
        - play
        - edit
      x-tsEnumNames:
        - View
        - Play
        - Edit
    PublishResult:
      x-schema-name: PublishResult
      description: The result of publishing a doc.
      allOf:
        - $ref: '#/components/schemas/DocumentMutateResponse'
        - type: object
          additionalProperties: false
          properties: {}
    UnpublishResult:
      x-schema-name: UnpublishResult
      description: The result of unpublishing a doc.
      type: object
      additionalProperties: false
      properties: {}
    DocumentCreationResult:
      x-schema-name: Doc
      description: The result of a doc creation.
      type: object
      required:
        - id
        - type
        - href
        - browserLink
        - name
        - owner
        - ownerName
        - createdAt
        - updatedAt
        - workspace
        - folder
        - workspaceId
        - folderId
      additionalProperties: false
      properties:
        id: *ref_9
        type: *ref_10
        href: *ref_11
        browserLink: *ref_12
        icon: *ref_13
        name: *ref_14
        owner: *ref_15
        ownerName: *ref_16
        docSize: *ref_17
        sourceDoc: *ref_18
        createdAt: *ref_19
        updatedAt: *ref_20
        published: *ref_21
        folder: *ref_22
        workspace: *ref_23
        workspaceId: *ref_24
        folderId: *ref_25
        requestId:
          type: string
          description: An arbitrary unique identifier for this request.
          example: abc-123-def-456
    DocUpdateResult:
      x-schema-name: DocUpdate
      description: The result of a doc update
      type: object
      additionalProperties: false
      properties: {}
    CustomDocDomainList:
      x-schema-name: CustomDocDomainList
      type: object
      description: List of all custom domains added to a published doc.
      required:
        - customDocDomains
      additionalProperties: false
      properties:
        customDocDomains:
          type: array
          description: Custom domains for the published doc.
          items:
            $ref: '#/components/schemas/CustomDocDomain'
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: >-
                https://coda.io/apis/v1/docs/AbCDeFGH/domains?pageToken=eyJsaW1pd
    CustomDocDomain:
      x-schema-name: CustomDocDomain
      type: object
      description: The custom domain added to a published doc.
      required:
        - customDocDomain
        - hasCertificate
        - hasDnsDocId
        - setupStatus
        - domainStatus
      additionalProperties: false
      properties:
        customDocDomain:
          type: string
          description: The custom domain.
          example: example.com
        hasCertificate:
          type: boolean
          description: Whether the domain has a certificate
          example: true
        hasDnsDocId:
          type: boolean
          description: Whether the domain DNS points back to this doc.
          example: true
        setupStatus:
          $ref: '#/components/schemas/CustomDocDomainSetupStatus'
        domainStatus:
          $ref: '#/components/schemas/CustomDomainConnectedStatus'
        lastVerifiedTimestamp:
          type: string
          format: date-time
          description: When the domain DNS settings were last checked.
          example: '2018-04-11T00:18:57.946Z'
    CustomDocDomainProvider:
      x-schema-name: CustomDocDomainProvider
      type: string
      enum:
        - GoDaddy
        - Namecheap
        - Hover (Tucows)
        - Network Solutions
        - Google Domains
        - Other
      x-tsEnumNames:
        - GoDaddy
        - Namecheap
        - Hover
        - NetworkSolutions
        - GoogleDomains
        - Other
    CustomDocDomainSetupStatus:
      x-schema-name: CustomDocDomainSetupStatus
      type: string
      enum:
        - pending
        - succeeded
        - failed
      x-tsEnumNames:
        - Pending
        - Succeeded
        - Failed
    CustomDomainConnectedStatus:
      x-schema-name: CustomDomainConnectedStatus
      type: string
      enum:
        - connected
        - notConnected
      x-tsEnumNames:
        - Connected
        - NotConnected
    AddCustomDocDomainResponse:
      x-schema-name: AddCustomDocDomainResponse
      type: object
      description: The result of adding a custom domain to a published doc.
      additionalProperties: false
      properties: {}
    AddCustomDocDomainRequest:
      x-schema-name: AddCustomDocDomainRequest
      type: object
      description: Payload for adding a custom published doc domain.
      required:
        - customDocDomain
      additionalProperties: false
      properties:
        customDocDomain:
          type: string
          description: The custom domain.
          example: example.com
    UpdateCustomDocDomainResponse:
      x-schema-name: UpdateCustomDocDomainResponse
      type: object
      description: The result of updating a custom domain for a published doc.
      additionalProperties: false
      properties: {}
    UpdateCustomDocDomainRequest:
      x-schema-name: UpdateCustomDocDomainRequest
      type: object
      description: Payload for updating the properties of a custom published doc domain.
      additionalProperties: false
      properties: {}
    DeleteCustomDocDomainResponse:
      x-schema-name: DeleteCustomDocDomainResponse
      type: object
      description: The result of deleting a custom domain from a published doc.
      additionalProperties: false
      properties: {}
    CustomDocDomainProviderResponse:
      x-schema-name: CustomDocDomainProviderResponse
      type: object
      description: The result of determining the domain provider for a custom doc domain.
      required:
        - provider
      additionalProperties: false
      properties:
        provider:
          $ref: '#/components/schemas/CustomDocDomainProvider'
    Folder:
      x-schema-name: Folder
      description: A Coda folder.
      type: object
      required:
        - id
        - type
        - name
        - browserLink
        - workspace
      additionalProperties: false
      properties:
        id:
          type: string
          description: ID of the Coda folder.
          example: fl-1Ab234
        type:
          type: string
          description: The type of this resource.
          enum:
            - folder
          x-tsType: Type.Folder
        name:
          type: string
          description: The name of the folder.
          example: Projects
        browserLink:
          type: string
          format: url
          description: Browser-friendly link to the folder.
          example: https://coda.io/folders/fl-1Ab234
        description:
          type: string
          description: The description of the folder.
          example: A collection of project docs.
        icon:
          $ref: '#/components/schemas/Icon'
        createdAt:
          type: string
          format: date-time
          description: Timestamp for when the folder was created.
          example: '2018-04-11T00:18:57.946Z'
        canEdit:
          type: boolean
          description: >-
            Whether the folder settings can be edited. E.g., some folder types
            (like personal folders - "My Docs") cannot be edited.
          example: true
        workspace:
          $ref: '#/components/schemas/WorkspaceReference'
    FolderList:
      x-schema-name: FolderList
      description: List of folders.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Folder'
        href:
          type: string
          format: url
          description: API link to these results.
          example: https://coda.io/apis/v1/folders?workspaceId=ws-1Ab234
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: https://coda.io/apis/v1/folders?pageToken=xyz
    CreateFolderRequest:
      x-schema-name: CreateFolderRequest
      description: Request for creating a folder.
      type: object
      required:
        - name
        - workspaceId
      additionalProperties: false
      properties:
        name:
          type: string
          description: Name of the folder.
          example: Projects
        workspaceId:
          type: string
          description: ID of the workspace where the folder should be created.
          example: ws-1Ab234
        description:
          type: string
          description: Description of the folder.
          example: A collection of project docs.
    UpdateFolderRequest:
      x-schema-name: UpdateFolderRequest
      description: Request for updating a folder.
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
          description: Name of the folder.
          example: Projects
        description:
          type: string
          description: Description of the folder.
          example: A collection of project docs.
    DeleteFolderResult:
      x-schema-name: DeleteFolderResult
      description: The result of a folder deletion.
      type: object
      additionalProperties: false
    PageReference:
      x-schema-name: PageReference
      description: Reference to a page.
      type: object
      required:
        - id
        - type
        - browserLink
        - href
        - name
      additionalProperties: false
      properties:
        id: &ref_26
          type: string
          description: ID of the page.
          example: canvas-IjkLmnO
        type: &ref_27
          type: string
          description: The type of this resource.
          enum:
            - page
          x-tsType: Type.Page
        href: &ref_28
          type: string
          format: url
          description: API link to the page.
          example: https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO
        browserLink:
          type: string
          format: url
          description: Browser-friendly link to the page.
          example: https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO
        name:
          type: string
          description: Name of the page.
          example: Launch Status
    PageContentItemType:
      x-schema-name: PageContentItemType
      description: The type of content item in a page.
      type: string
      enum:
        - line
      x-tsEnumNames:
        - Line
    PageContentItemContentFormat:
      x-schema-name: PageContentItemContentFormat
      description: Content format for the item.
      type: string
      enum:
        - plainText
      x-tsEnumNames:
        - PlainText
    PageContentItemContent:
      x-schema-name: PageContentItemContent
      description: Content details of the item.
      type: object
      required:
        - style
        - format
        - content
      additionalProperties: false
      properties:
        style:
          $ref: '#/components/schemas/PageLineStyle'
        format:
          $ref: '#/components/schemas/PageContentItemContentFormat'
        content:
          type: string
          description: Content of the item in the specified format.
          example: This is a paragraph of text.
        lineLevel:
          type: integer
          description: >
            Indentation level of the element. Present for indentable elements
            (paragraphs, blockquotes, and list items).
          example: 0
    PageContentItem:
      x-schema-name: PageContentItem
      description: Content item in a page (canvas).
      type: object
      required:
        - id
        - type
      additionalProperties: false
      properties:
        id:
          type: string
          description: ID of the content item.
          example: cl-2ZUJuRhNuN
        type:
          $ref: '#/components/schemas/PageContentItemType'
        itemContent:
          $ref: '#/components/schemas/PageContentItemContent'
    PageContentList:
      x-schema-name: PageContentList
      description: List of page content elements.
      type: object
      required:
        - items
        - href
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PageContentItem'
        href:
          type: string
          format: url
          description: API link to these results
          example: >-
            https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO/content?limit=20
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: >-
                https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO/content?pageToken=eyJsaW1pd
    Page:
      x-schema-name: Page
      description: Metadata about a page.
      type: object
      required:
        - id
        - type
        - href
        - name
        - isHidden
        - isEffectivelyHidden
        - browserLink
        - children
        - contentType
      additionalProperties: false
      properties:
        id: *ref_26
        type: *ref_27
        href: *ref_28
        browserLink:
          type: string
          format: url
          description: Browser-friendly link to the page.
          example: https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO
        name:
          type: string
          description: Name of the page.
          example: Launch Status
        subtitle:
          type: string
          description: Subtitle of the page.
          example: See the status of launch-related tasks.
        icon:
          $ref: '#/components/schemas/Icon'
        image:
          $ref: '#/components/schemas/Image'
        contentType:
          $ref: '#/components/schemas/PageType'
        isHidden:
          type: boolean
          description: Whether the page is hidden in the UI.
          example: true
        isEffectivelyHidden:
          type: boolean
          description: Whether the page or any of its parents is hidden in the UI.
          example: true
        parent:
          $ref: '#/components/schemas/PageReference'
        children:
          type: array
          items:
            $ref: '#/components/schemas/PageReference'
        authors:
          description: Authors of the page
          type: array
          items:
            $ref: '#/components/schemas/PersonValue'
        createdAt:
          type: string
          format: date-time
          description: Timestamp for when the page was created.
          example: '2018-04-11T00:18:57.946Z'
        createdBy:
          $ref: '#/components/schemas/PersonValue'
        updatedAt:
          type: string
          format: date-time
          description: Timestamp for when page content was last modified.
          example: '2018-04-11T00:18:57.946Z'
        updatedBy:
          $ref: '#/components/schemas/PersonValue'
    PageList:
      x-schema-name: PageList
      description: List of pages.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Page'
        href:
          type: string
          format: url
          description: API link to these results
          example: https://coda.io/apis/v1/docs/AbCDeFGH/pages?limit=20
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: https://coda.io/apis/v1/docs/AbCDeFGH/pages?pageToken=eyJsaW1pd
    PageCreate:
      x-schema-name: PageCreate
      description: Payload for creating a new page in a doc.
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
          description: Name of the page.
          example: Launch Status
        subtitle:
          type: string
          description: Subtitle of the page.
          example: See the status of launch-related tasks.
        iconName:
          type: string
          description: Name of the icon.
          example: rocket
        imageUrl:
          type: string
          description: Url of the cover image to use.
          example: https://example.com/image.jpg
        parentPageId:
          type: string
          description: The ID of this new page's parent, if creating a subpage.
          example: canvas-tuVwxYz
        pageContent:
          $ref: '#/components/schemas/PageCreateContent'
    PageCreateContent:
      x-schema-name: PageCreateContent
      description: >-
        Content that can be added to a page at creation time, either text (or
        rich text) or a URL to create a full-page embed.
      discriminator:
        propertyName: type
      oneOf:
        - type: object
          required:
            - type
            - canvasContent
          additionalProperties: false
          properties:
            type:
              type: string
              description: Indicates a page containing canvas content.
              enum:
                - canvas
              x-tsType: PageType.Canvas
            canvasContent:
              $ref: '#/components/schemas/PageContent'
        - type: object
          required:
            - type
            - url
          additionalProperties: false
          properties:
            type:
              type: string
              description: Indicates a page that embeds other content.
              enum:
                - embed
              x-tsType: PageType.Embed
            url:
              type: string
              description: The URL of the content to embed.
              example: https://example.com
            renderMethod:
              $ref: '#/components/schemas/PageEmbedRenderMethod'
        - discriminator:
            propertyName: mode
          oneOf:
            - type: object
              required:
                - type
                - mode
                - sourcePageId
                - includeSubpages
                - sourceDocId
              additionalProperties: false
              properties:
                type:
                  type: string
                  description: Indicates a page that embeds other Coda content.
                  enum:
                    - syncPage
                  x-tsType: PageType.SyncPage
                mode:
                  type: string
                  description: Indicates a single-page sync page.
                  enum:
                    - page
                  x-tsType: SyncPageType.Page
                includeSubpages:
                  type: boolean
                  description: Include subpages in the sync page.
                sourcePageId:
                  type: string
                  description: The page id to insert as a sync page.
                  example: canvas-IjkLmnO
                sourceDocId:
                  type: string
                  description: The id of the document to insert as a sync page.
                  example: sHbI4uIwiK
            - type: object
              required:
                - type
                - mode
                - sourceDocId
              additionalProperties: false
              properties:
                type:
                  type: string
                  description: Indicates a page that embeds other content.
                  enum:
                    - syncPage
                  x-tsType: PageType.SyncPage
                mode:
                  type: string
                  description: Indicates a full doc sync page.
                  enum:
                    - document
                  x-tsType: SyncPageType.Document
                sourceDocId:
                  type: string
                  description: The id of the document to insert as a sync page.
                  example: sHbI4uIwiK
    PageCreateResult:
      x-schema-name: PageCreateResult
      description: The result of a page creation.
      allOf:
        - $ref: '#/components/schemas/DocumentMutateResponse'
        - type: object
          required:
            - id
          additionalProperties: false
          properties:
            id:
              type: string
              description: ID of the created page.
              example: canvas-tuVwxYz
    PageUpdate:
      x-schema-name: PageUpdate
      description: Payload for updating a page.
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
          description: Name of the page.
          example: Launch Status
        subtitle:
          type: string
          description: Subtitle of the page.
          example: See the status of launch-related tasks.
        iconName:
          type: string
          description: Name of the icon.
          example: rocket
        imageUrl:
          type: string
          description: Url of the cover image to use.
          example: https://example.com/image.jpg
        isHidden:
          type: boolean
          description: >-
            Whether the page is hidden or not. Note that for pages that cannot
            be hidden, like the sole top-level page in a doc, this will be
            ignored.
          example: true
        contentUpdate:
          allOf:
            - type: object
              description: Content with which to update an existing page.
              additionalProperties: false
            - $ref: '#/components/schemas/PageContentUpdate'
    PageUpdateResult:
      x-schema-name: PageUpdateResult
      description: The result of a page update.
      allOf:
        - $ref: '#/components/schemas/DocumentMutateResponse'
        - type: object
          required:
            - id
          additionalProperties: false
          properties:
            id:
              type: string
              description: ID of the updated page.
              example: canvas-tuVwxYz
    PageDeleteResult:
      x-schema-name: PageDeleteResult
      description: The result of a page deletion.
      allOf:
        - $ref: '#/components/schemas/DocumentMutateResponse'
        - type: object
          required:
            - id
          additionalProperties: false
          properties:
            id:
              type: string
              description: ID of the page to be deleted.
              example: canvas-tuVwxYz
    PageContentDelete:
      x-schema-name: PageContentDelete
      description: Payload for deleting content from a page.
      type: object
      additionalProperties: false
      properties:
        elementIds:
          type: array
          description: >
            IDs of the elements to delete from the page. If omitted or empty,
            all content will be deleted.
          items:
            type: string
          example:
            - cl-lzqh0Q0poT
            - cl-abc123def
    PageContentDeleteResult:
      x-schema-name: PageContentDeleteResult
      description: The result of a page content deletion.
      allOf:
        - $ref: '#/components/schemas/DocumentMutateResponse'
        - type: object
          required:
            - id
          additionalProperties: false
          properties:
            id:
              type: string
              description: ID of the page whose content was deleted.
              example: canvas-tuVwxYz
    PageContentInsertionMode:
      x-schema-name: PageContentInsertionMode
      description: Mode for updating the content on an existing page.
      type: string
      enum:
        - append
        - prepend
        - replace
      x-tsEnumNames:
        - Append
        - Prepend
        - Replace
    PageContentUpdate:
      x-schema-name: PageContentUpdate
      description: Payload for updating the content of an existing page.
      type: object
      additionalProperties: false
      required:
        - insertionMode
        - canvasContent
      properties:
        insertionMode:
          $ref: '#/components/schemas/PageContentInsertionMode'
        elementId:
          type: string
          example: cl-lzqh0Q0poT
          description: >
            ID of the element on the page to use as a reference point for
            editing content. If provided, the operation will be relative to this
            element (e.g., append after it, prepend before it, replace it). If
            omitted, the operation will be performed on the entire page (e.g.,
            append to end, prepend to beginning, replace all).
        canvasContent:
          $ref: '#/components/schemas/PageContent'
    BeginPageContentExportRequest:
      x-schema-name: BeginPageContentExportRequest
      description: Request for beginning an export of page content.
      type: object
      additionalProperties: false
      required:
        - outputFormat
      properties:
        outputFormat:
          $ref: '#/components/schemas/PageContentOutputFormat'
    BeginPageContentExportResponse:
      x-schema-name: BeginPageContentExportResponse
      description: Response when beginning an export of page content.
      type: object
      additionalProperties: false
      required:
        - id
        - status
        - href
      properties:
        id:
          type: string
          description: The identifier of this export request.
          example: AbCDeFGH
        status:
          type: string
          description: The status of this export.
          example: complete
        href:
          type: string
          description: >-
            The URL that reports the status of this export. Poll this URL to get
            the content URL when the export has completed.
          example: >-
            https://coda.io/apis/v1/docs/somedoc/pages/somepage/export/some-request-id
    PageContentOutputFormat:
      x-schema-name: PageContentOutputFormat
      description: >-
        Supported output content formats that can be requested for getting
        content for an existing page.
      type: string
      enum:
        - html
        - markdown
      x-tsEnumNames:
        - Html
        - Markdown
    PageContentExportStatus:
      x-schema-name: PageContentExportStatus
      description: Status of a page content export.
      type: string
      enum:
        - inProgress
        - failed
        - complete
      x-tsEnumNames:
        - InProgress
        - Failed
        - Complete
    PageContentExportStatusResponse:
      x-schema-name: PageContentExportStatusResponse
      description: Response when requesting the status of a page content export.
      type: object
      additionalProperties: false
      required:
        - id
        - status
        - href
      properties:
        id:
          type: string
          description: The identifier of this export request.
          example: AbCDeFGH
        status:
          type: string
          description: The status of this export.
          example: complete
        href:
          type: string
          description: The URL that reports the status of this export.
          example: >-
            https://coda.io/apis/v1/docs/somedoc/pages/somepage/export/some-request-id
        downloadLink:
          type: string
          description: >-
            Once the export completes, the location where the resulting export
            file can be downloaded; this link typically expires after a short
            time.  Call this method again to get a fresh link.
          example: https://coda.io/blobs/DOC_EXPORT_RENDERING/some-request-id
        error:
          type: string
          description: Message describing an error, if this export failed.
    PageEmbedRenderMethod:
      x-schema-name: PageEmbedRenderMethod
      description: Render mode for a page using the Embed page type.
      type: string
      enum:
        - compatibility
        - standard
      x-tsEnumNames:
        - Compatibility
        - Standard
    Layout:
      x-schema-name: Layout
      description: Layout type of the table or view.
      type: string
      enum:
        - default
        - areaChart
        - barChart
        - bubbleChart
        - calendar
        - card
        - detail
        - form
        - ganttChart
        - lineChart
        - masterDetail
        - pieChart
        - scatterChart
        - slide
        - wordCloud
      x-tsEnumNames:
        - Default
        - AreaChart
        - BarChart
        - BubbleChart
        - Calendar
        - Card
        - Detail
        - Form
        - GanttChart
        - LineChart
        - MasterDetail
        - PieChart
        - ScatterChart
        - Slide
        - WordCloud
    PageContent:
      x-schema-name: PageContent
      description: |
        Content to be added or replaced with in a page (canvas).
      type: object
      additionalProperties: false
      required:
        - format
        - content
      properties:
        format:
          $ref: '#/components/schemas/PageContentFormat'
        content:
          type: string
          description: The actual page content.
          example: <p><b>This</b> is rich text</p>
    PageContentFormat:
      x-schema-name: PageContentFormat
      description: Supported content types for page (canvas) content.
      type: string
      enum:
        - html
        - markdown
      x-tsEnumNames:
        - Html
        - Markdown
    PageType:
      x-schema-name: PageType
      description: The type of a page in a doc.
      type: string
      enum:
        - canvas
        - embed
        - syncPage
      x-tsEnumNames:
        - Canvas
        - Embed
        - SyncPage
    PageLineStyle:
      x-schema-name: PageLineStyle
      description: The style of a line element in a canvas page.
      type: string
      enum:
        - blockQuote
        - bulletedList
        - checkboxList
        - code
        - collapsibleList
        - h1
        - h2
        - h3
        - numberedList
        - paragraph
        - pullQuote
      x-tsEnumNames:
        - BlockQuote
        - BulletedList
        - CheckboxList
        - Code
        - CollapsibleList
        - H1
        - H2
        - H3
        - NumberedList
        - Paragraph
        - PullQuote
    Sort:
      x-schema-name: Sort
      description: A sort applied to a table or view.
      type: object
      required:
        - column
        - direction
      additionalProperties: false
      properties:
        column:
          $ref: '#/components/schemas/ColumnReference'
        direction:
          $ref: '#/components/schemas/SortDirection'
    SortDirection:
      x-schema-name: SortDirection
      description: Direction of a sort for a table or view.
      type: string
      enum:
        - ascending
        - descending
      x-tsEnumNames:
        - Ascending
        - Descending
    SyncPageType:
      x-schema-name: SyncPageType
      description: The type of sync page in a doc
      type: string
      enum:
        - page
        - document
      x-tsEnumNames:
        - Page
        - Document
    DocumentMutateResponse:
      x-schema-name: DocumentMutateResponse
      description: Base response type for an operation that mutates a document.
      type: object
      additionalProperties: false
      required:
        - requestId
      properties:
        requestId:
          type: string
          description: An arbitrary unique identifier for this request.
          example: abc-123-def-456
    ValidationError:
      x-schema-name: ValidationError
      description: Detail about why a particular field failed request validation.
      type: object
      additionalProperties: false
      required:
        - path
        - message
      properties:
        path:
          type: string
          description: A path indicating the affected field, in OGNL notation.
          example: parent.child[0]
        message:
          type: string
          description: An error message.
          example: Expected a string but got a number
    TableReference:
      x-schema-name: TableReference
      description: Reference to a table or view.
      type: object
      required:
        - id
        - type
        - tableType
        - browserLink
        - href
        - name
      additionalProperties: false
      properties:
        id: &ref_29
          type: string
          description: ID of the table.
          example: grid-pqRst-U
        type: &ref_30
          type: string
          description: The type of this resource.
          enum:
            - table
          x-tsType: Type.Table
        tableType: &ref_31
          $ref: '#/components/schemas/TableType'
        href: &ref_32
          type: string
          format: url
          description: API link to the table.
          example: https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U
        browserLink: &ref_33
          type: string
          format: url
          description: Browser-friendly link to the table.
          example: https://coda.io/d/_dAbCDeFGH/#Teams-and-Tasks_tpqRst-U
        name: &ref_34
          type: string
          description: Name of the table.
          example: Tasks
        parent: &ref_35
          $ref: '#/components/schemas/PageReference'
    Table:
      x-schema-name: Table
      description: Metadata about a table.
      type: object
      required:
        - id
        - type
        - tableType
        - href
        - name
        - parent
        - browserLink
        - displayColumn
        - rowCount
        - sorts
        - layout
        - createdAt
        - updatedAt
        - viewId
      additionalProperties: false
      properties:
        id: *ref_29
        type: *ref_30
        tableType: *ref_31
        href: *ref_32
        browserLink: *ref_33
        name: *ref_34
        parent: *ref_35
        parentTable:
          $ref: '#/components/schemas/TableReference'
        displayColumn:
          $ref: '#/components/schemas/ColumnReference'
        rowCount:
          type: integer
          description: Total number of rows in the table.
          example: 130
        sorts:
          type: array
          description: Any sorts applied to the table.
          items:
            $ref: '#/components/schemas/Sort'
        layout:
          $ref: '#/components/schemas/Layout'
        filter:
          allOf:
            - description: >-
                Detailed information about the filter formula for the table, if
                applicable.
              additionalProperties: false
            - $ref: '#/components/schemas/FormulaDetail'
        createdAt:
          type: string
          format: date-time
          description: Timestamp for when the table was created.
          example: '2018-04-11T00:18:57.946Z'
        updatedAt:
          type: string
          format: date-time
          description: Timestamp for when the table was last modified.
          example: '2018-04-11T00:18:57.946Z'
    TableList:
      x-schema-name: TableList
      description: List of tables.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/TableReference'
        href:
          type: string
          format: url
          description: API link to these results
          example: https://coda.io/apis/v1/docs/AbCDeFGH/tables?limit=20
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: https://coda.io/apis/v1/docs/AbCDeFGH/tables?pageToken=eyJsaW1pd
    ColumnReference:
      x-schema-name: ColumnReference
      description: Reference to a column.
      type: object
      required:
        - id
        - type
        - href
      additionalProperties: false
      properties:
        id: &ref_36
          type: string
          description: ID of the column.
          example: c-tuVwxYz
        type: &ref_37
          type: string
          description: The type of this resource.
          enum:
            - column
          x-tsType: Type.Column
        href: &ref_38
          type: string
          format: url
          description: API link to the column.
          example: >-
            https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/columns/c-tuVwxYz
    Column:
      x-schema-name: Column
      description: Info about a column.
      type: object
      required:
        - id
        - type
        - href
        - name
        - format
      additionalProperties: false
      properties:
        id: *ref_36
        type: *ref_37
        href: *ref_38
        name: &ref_39
          type: string
          description: Name of the column.
          example: Completed
        display: &ref_40
          type: boolean
          description: Whether the column is the display column.
          example: true
        calculated: &ref_41
          type: boolean
          description: Whether the column has a formula set on it.
          example: true
        formula: &ref_42
          type: string
          description: Formula on the column.
          example: thisRow.Created()
        defaultValue: &ref_43
          type: string
          description: Default value formula for the column.
          example: Test
        format: &ref_44
          $ref: '#/components/schemas/ColumnFormat'
    ColumnDetail:
      x-schema-name: ColumnDetail
      description: Info about a column.
      type: object
      required:
        - id
        - type
        - href
        - name
        - parent
        - format
      additionalProperties: false
      properties:
        id: *ref_36
        type: *ref_37
        href: *ref_38
        name: *ref_39
        display: *ref_40
        calculated: *ref_41
        formula: *ref_42
        defaultValue: *ref_43
        format: *ref_44
        parent:
          $ref: '#/components/schemas/TableReference'
    SimpleColumnFormat:
      x-schema-name: SimpleColumnFormat
      description: Format of a simple column.
      type: object
      required:
        - type
        - isArray
      additionalProperties: false
      properties:
        type:
          $ref: '#/components/schemas/ColumnFormatType'
        isArray:
          type: boolean
          description: Whether or not this column is an array.
          example: true
    ReferenceColumnFormat:
      x-schema-name: ReferenceColumnFormat
      description: Format of a column that refers to another table.
      allOf:
        - $ref: '#/components/schemas/SimpleColumnFormat'
        - type: object
          additionalProperties: false
          required:
            - table
          properties:
            table:
              allOf:
                - description: Reference to the table this column refers to, if applicable.
                  additionalProperties: false
                - $ref: '#/components/schemas/TableReference'
    NumericColumnFormat:
      x-schema-name: NumericColumnFormat
      description: Format of a numeric column.
      allOf:
        - $ref: '#/components/schemas/SimpleColumnFormat'
        - type: object
          additionalProperties: false
          properties:
            precision:
              type: integer
              minimum: 0
              maximum: 10
              description: The decimal precision.
              example: 2
            useThousandsSeparator:
              type: boolean
              description: >-
                Whether to use a thousands separator (like ",") to format the
                numeric value.
              example: true
    CurrencyColumnFormat:
      x-schema-name: CurrencyColumnFormat
      description: Format of a currency column.
      allOf:
        - $ref: '#/components/schemas/SimpleColumnFormat'
        - type: object
          additionalProperties: false
          properties:
            currencyCode:
              type: string
              description: The currency symbol
              example: $
            precision:
              type: integer
              minimum: 0
              maximum: 10
              description: The decimal precision.
              example: 2
            format:
              $ref: '#/components/schemas/CurrencyFormatType'
    CurrencyFormatType:
      x-schema-name: CurrencyFormatType
      description: >-
        How the numeric value should be formatted (with or without symbol,
        negative numbers in parens).
      type: string
      enum:
        - currency
        - accounting
        - financial
      x-tsEnumNames:
        - Currency
        - Accounting
        - Financial
    DateColumnFormat:
      x-schema-name: DateColumnFormat
      description: Format of a date column.
      allOf:
        - $ref: '#/components/schemas/SimpleColumnFormat'
        - type: object
          additionalProperties: false
          properties:
            format:
              type: string
              description: >-
                A format string using Moment syntax:
                https://momentjs.com/docs/#/displaying/
              example: YYYY-MM-DD
    EmailColumnFormat:
      x-schema-name: EmailColumnFormat
      description: Format of an email column.
      allOf:
        - $ref: '#/components/schemas/SimpleColumnFormat'
        - type: object
          additionalProperties: false
          properties:
            display:
              $ref: '#/components/schemas/EmailDisplayType'
            autocomplete:
              type: boolean
    EmailDisplayType:
      x-schema-name: EmailDisplayType
      description: How an email address should be displayed in the user interface.
      type: string
      enum:
        - iconAndEmail
        - iconOnly
        - emailOnly
      x-tsEnumNames:
        - IconAndEmail
        - IconOnly
        - EmailOnly
    ImageReferenceColumnFormat:
      x-schema-name: ImageReferenceColumnFormat
      description: Format of an image reference column.
      allOf:
        - $ref: '#/components/schemas/SimpleColumnFormat'
        - type: object
          additionalProperties: false
          required:
            - width
            - height
            - style
          properties:
            width:
              allOf:
                - description: The image width.
                  additionalProperties: false
                - $ref: '#/components/schemas/NumberOrNumberFormula'
            height:
              allOf:
                - description: The image height.
                  additionalProperties: false
                - $ref: '#/components/schemas/NumberOrNumberFormula'
            style:
              $ref: '#/components/schemas/ImageShapeStyle'
    ImageShapeStyle:
      x-schema-name: ImageShapeStyle
      description: How an image should be displayed.
      type: string
      enum:
        - auto
        - circle
      x-tsEnumNames:
        - Auto
        - Circle
    LinkColumnFormat:
      x-schema-name: LinkColumnFormat
      description: Format of a link column.
      allOf:
        - $ref: '#/components/schemas/SimpleColumnFormat'
        - type: object
          additionalProperties: false
          properties:
            display:
              $ref: '#/components/schemas/LinkDisplayType'
            force:
              type: boolean
              description: >-
                Force embeds to render on the client instead of the server (for
                sites that require user login).
              example: true
    LinkDisplayType:
      x-schema-name: LinkDisplayType
      description: How a link should be displayed in the user interface.
      type: string
      enum:
        - iconOnly
        - url
        - title
        - card
        - embed
      x-tsEnumNames:
        - IconOnly
        - Url
        - Title
        - Card
        - Embed
    TimeColumnFormat:
      x-schema-name: TimeColumnFormat
      description: Format of a time column.
      allOf:
        - $ref: '#/components/schemas/SimpleColumnFormat'
        - type: object
          additionalProperties: false
          properties:
            format:
              type: string
              description: >-
                A format string using Moment syntax:
                https://momentjs.com/docs/#/displaying/
              example: h:mm:ss A
    DateTimeColumnFormat:
      x-schema-name: DateTimeColumnFormat
      description: Format of a date column.
      allOf:
        - $ref: '#/components/schemas/SimpleColumnFormat'
        - type: object
          additionalProperties: false
          properties:
            dateFormat:
              type: string
              description: >-
                A format string using Moment syntax:
                https://momentjs.com/docs/#/displaying/
              example: YYYY-MM-DD
            timeFormat:
              type: string
              description: >-
                A format string using Moment syntax:
                https://momentjs.com/docs/#/displaying/
              example: h:mm:ss A
    DurationColumnFormat:
      x-schema-name: DurationColumnFormat
      description: Format of a duration column.
      allOf:
        - $ref: '#/components/schemas/SimpleColumnFormat'
        - type: object
          additionalProperties: false
          properties:
            precision:
              type: integer
              example: 2
            maxUnit:
              allOf:
                - description: >-
                    The maximum unit of precision, e.g. "hours" if this duration
                    need not include minutes.
                  additionalProperties: false
                - $ref: '#/components/schemas/DurationUnit'
    DurationUnit:
      x-schema-name: DurationUnit
      description: A time unit used as part of a duration value.
      type: string
      enum:
        - days
        - hours
        - minutes
        - seconds
      x-tsEnumNames:
        - Days
        - Hours
        - Minutes
        - Seconds
    NumberOrNumberFormula:
      x-schema-name: NumberOrNumberFormula
      description: A number or a string representing a formula that evaluates to a number.
      oneOf:
        - type: number
          description: A numeric value.
          example: 1
        - type: string
          description: A formula that evaluates to a numeric value.
          example: 5 * 10
    SliderColumnFormat:
      x-schema-name: SliderColumnFormat
      description: Format of a numeric column that renders as a slider.
      allOf:
        - $ref: '#/components/schemas/SimpleColumnFormat'
        - type: object
          additionalProperties: false
          properties:
            minimum:
              allOf:
                - description: The minimum allowed value for this slider.
                  additionalProperties: false
                - $ref: '#/components/schemas/NumberOrNumberFormula'
            maximum:
              allOf:
                - description: The maximum allowed value for this slider.
                  additionalProperties: false
                - $ref: '#/components/schemas/NumberOrNumberFormula'
            step:
              allOf:
                - description: The step size (numeric increment) for this slider.
                  additionalProperties: false
                - $ref: '#/components/schemas/NumberOrNumberFormula'
            displayType:
              $ref: '#/components/schemas/SliderDisplayType'
            showValue:
              type: boolean
              description: Whether the underyling numeric value is also displayed.
              example: true
    ButtonColumnFormat:
      x-schema-name: ButtonColumnFormat
      description: Format of a button column.
      allOf:
        - $ref: '#/components/schemas/SimpleColumnFormat'
        - type: object
          additionalProperties: false
          properties:
            label:
              type: string
              description: Label formula for the button.
              example: Click me
            disableIf:
              type: string
              description: DisableIf formula for the button.
              example: False()
            action:
              type: string
              description: Action formula for the button.
              example: OpenUrl("www.google.com")
    IconSet:
      x-schema-name: IconSet
      description: List of available icon sets.
      type: string
      enum:
        - star
        - circle
        - fire
        - bug
        - diamond
        - bell
        - thumbsup
        - heart
        - chili
        - smiley
        - lightning
        - currency
        - coffee
        - person
        - battery
        - cocktail
        - cloud
        - sun
        - checkmark
        - lightbulb
      x-tsEnumNames:
        - Star
        - Circle
        - Fire
        - Bug
        - Diamond
        - Bell
        - ThumbsUp
        - Heart
        - Chili
        - Smiley
        - Lightning
        - Currency
        - Coffee
        - Person
        - Battery
        - Cocktail
        - Cloud
        - Sun
        - Checkmark
        - LightBulb
    ScaleColumnFormat:
      x-schema-name: ScaleColumnFormat
      description: Format of a numeric column that renders as a scale, like star ratings.
      allOf:
        - $ref: '#/components/schemas/SimpleColumnFormat'
        - type: object
          additionalProperties: false
          required:
            - maximum
            - icon
          properties:
            maximum:
              type: number
              description: The maximum number allowed for this scale.
              example: 5
            icon:
              allOf:
                - description: >-
                    The icon set to use when rendering the scale, e.g. render a
                    5 star scale.
                  additionalProperties: false
                - $ref: '#/components/schemas/IconSet'
    SelectColumnFormat:
      x-schema-name: SelectColumnFormat
      description: Format of a select column.
      allOf:
        - $ref: '#/components/schemas/SimpleColumnFormat'
        - type: object
          additionalProperties: false
          properties:
            options:
              type: array
              description: >-
                For select format columns, the list of available options. Only
                returned for select lists that used a fixed set of options.
                Returns the first 5000 options.
              items:
                $ref: '#/components/schemas/SelectOption'
    SelectOption:
      x-schema-name: SelectOption
      description: An option for a select column.
      type: object
      required:
        - name
      additionalProperties: false
      properties:
        name:
          type: string
          description: The name of the option.
          example: Option 1
        backgroundColor:
          type: string
          description: The background color of the option.
          example: '#ff0000'
        foregroundColor:
          type: string
          description: The foreground color of the option.
          example: '#ffffff'
    SliderDisplayType:
      x-schema-name: SliderDisplayType
      description: How the slider should be rendered.
      type: string
      enum:
        - slider
        - progress
      x-tsEnumNames:
        - Slider
        - Progress
    CheckboxColumnFormat:
      x-schema-name: CheckboxColumnFormat
      description: Format of a checkbox column.
      allOf:
        - $ref: '#/components/schemas/SimpleColumnFormat'
        - type: object
          additionalProperties: false
          required:
            - displayType
          properties:
            displayType:
              $ref: '#/components/schemas/CheckboxDisplayType'
    CheckboxDisplayType:
      x-schema-name: CheckboxDisplayType
      description: How a checkbox should be displayed.
      type: string
      enum:
        - toggle
        - check
      x-tsEnumNames:
        - Toggle
        - Check
    ColumnFormat:
      x-schema-name: ColumnFormat
      description: Format of a column.
      oneOf:
        - $ref: '#/components/schemas/ButtonColumnFormat'
        - $ref: '#/components/schemas/CheckboxColumnFormat'
        - $ref: '#/components/schemas/DateColumnFormat'
        - $ref: '#/components/schemas/DateTimeColumnFormat'
        - $ref: '#/components/schemas/DurationColumnFormat'
        - $ref: '#/components/schemas/EmailColumnFormat'
        - $ref: '#/components/schemas/LinkColumnFormat'
        - $ref: '#/components/schemas/CurrencyColumnFormat'
        - $ref: '#/components/schemas/ImageReferenceColumnFormat'
        - $ref: '#/components/schemas/NumericColumnFormat'
        - $ref: '#/components/schemas/ReferenceColumnFormat'
        - $ref: '#/components/schemas/SelectColumnFormat'
        - $ref: '#/components/schemas/SimpleColumnFormat'
        - $ref: '#/components/schemas/ScaleColumnFormat'
        - $ref: '#/components/schemas/SliderColumnFormat'
        - $ref: '#/components/schemas/TimeColumnFormat'
      discriminator:
        propertyName: type
        mapping:
          text: '#/components/schemas/SimpleColumnFormat'
          person: '#/components/schemas/ReferenceColumnFormat'
          lookup: '#/components/schemas/ReferenceColumnFormat'
          number: '#/components/schemas/NumericColumnFormat'
          percent: '#/components/schemas/NumericColumnFormat'
          currency: '#/components/schemas/CurrencyColumnFormat'
          date: '#/components/schemas/DateColumnFormat'
          dateTime: '#/components/schemas/DateTimeColumnFormat'
          time: '#/components/schemas/TimeColumnFormat'
          duration: '#/components/schemas/DurationColumnFormat'
          slider: '#/components/schemas/SliderColumnFormat'
          scale: '#/components/schemas/ScaleColumnFormat'
          image: '#/components/schemas/SimpleColumnFormat'
          imageReference: '#/components/schemas/ImageReferenceColumnFormat'
          attachments: '#/components/schemas/SimpleColumnFormat'
          button: '#/components/schemas/ButtonColumnFormat'
          checkbox: '#/components/schemas/CheckboxColumnFormat'
          select: '#/components/schemas/SelectColumnFormat'
          packObject: '#/components/schemas/SimpleColumnFormat'
          canvas: '#/components/schemas/SimpleColumnFormat'
          other: '#/components/schemas/SimpleColumnFormat'
    ColumnFormatType:
      x-schema-name: ColumnFormatType
      description: Format type of the column
      type: string
      enum:
        - text
        - person
        - lookup
        - number
        - percent
        - currency
        - date
        - dateTime
        - time
        - duration
        - email
        - link
        - slider
        - scale
        - image
        - imageReference
        - attachments
        - button
        - checkbox
        - select
        - packObject
        - reaction
        - canvas
        - other
      x-tsEnumNames:
        - Text
        - Person
        - Lookup
        - Number
        - Percent
        - Currency
        - Date
        - DateTime
        - Time
        - Duration
        - Email
        - Link
        - Slider
        - Scale
        - Image
        - ImageReference
        - Attachments
        - Button
        - Checkbox
        - Select
        - PackObject
        - Reaction
        - Canvas
        - Other
    ColumnList:
      x-schema-name: ColumnList
      description: List of columns.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Column'
        href:
          type: string
          format: url
          description: API link to these results
          example: >-
            https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/columns?limit=20
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: >-
                https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/columns?pageToken=eyJsaW1pd
    Row:
      x-schema-name: Row
      description: Info about a row.
      type: object
      required:
        - id
        - type
        - href
        - name
        - index
        - browserLink
        - createdAt
        - updatedAt
        - values
      additionalProperties: false
      properties:
        id: &ref_45
          type: string
          description: ID of the row.
          example: i-tuVwxYz
        type: &ref_46
          type: string
          description: The type of this resource.
          enum:
            - row
          x-tsType: Type.Row
        href: &ref_47
          type: string
          format: url
          description: API link to the row.
          example: >-
            https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/rows/i-RstUv-W
        name: &ref_48
          type: string
          description: The display name of the row, based on its identifying column.
          example: Apple
        index: &ref_49
          type: integer
          description: Index of the row within the table.
          example: 7
        browserLink: &ref_50
          type: string
          format: url
          description: Browser-friendly link to the row.
          example: https://coda.io/d/_dAbCDeFGH#Teams-and-Tasks_tpqRst-U/_rui-tuVwxYz
        createdAt: &ref_51
          type: string
          format: date-time
          description: Timestamp for when the row was created.
          example: '2018-04-11T00:18:57.946Z'
        updatedAt: &ref_52
          type: string
          format: date-time
          description: Timestamp for when the row was last modified.
          example: '2018-04-11T00:18:57.946Z'
        values: &ref_53
          type: object
          description: >
            Values for a specific row, represented as a hash of column IDs (or
            names with `useColumnNames`) to values.
          additionalProperties:
            $ref: '#/components/schemas/CellValue'
          example:
            c-tuVwxYz: Apple
            c-bCdeFgh:
              - $12.34
              - $56.78
    RowDetail:
      x-schema-name: RowDetail
      description: Details about a row.
      type: object
      required:
        - id
        - type
        - href
        - name
        - index
        - browserLink
        - createdAt
        - updatedAt
        - values
        - parent
      additionalProperties: false
      properties:
        id: *ref_45
        type: *ref_46
        href: *ref_47
        name: *ref_48
        index: *ref_49
        browserLink: *ref_50
        createdAt: *ref_51
        updatedAt: *ref_52
        values: *ref_53
        parent:
          $ref: '#/components/schemas/TableReference'
    RowList:
      x-schema-name: RowList
      description: List of rows.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Row'
        href:
          type: string
          format: url
          description: API link to these results
          example: >-
            https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/rows?limit=20
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: >-
                https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/rows?pageToken=eyJsaW1pd
        nextSyncToken:
          $ref: '#/components/schemas/nextSyncToken'
    ScalarValue:
      x-schema-name: ScalarValue
      description: A Coda result or entity expressed as a primitive type.
      oneOf:
        - type: string
          example: $12.34
        - type: number
          example: 12.34
        - type: boolean
          example: true
    Value:
      x-schema-name: Value
      description: >-
        A Coda result or entity expressed as a primitive type, or array of
        primitive types.
      additionalProperties: false
      oneOf:
        - $ref: '#/components/schemas/ScalarValue'
        - type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/ScalarValue'
              - type: array
                items:
                  $ref: '#/components/schemas/ScalarValue'
    RichSingleValue:
      x-schema-name: RichSingleValue
      description: >
        A value that contains rich structured data. Cell values are composed of
        these values or arrays of these values.
      oneOf:
        - $ref: '#/components/schemas/ScalarValue'
        - $ref: '#/components/schemas/CurrencyValue'
        - $ref: '#/components/schemas/ImageUrlValue'
        - $ref: '#/components/schemas/PersonValue'
        - $ref: '#/components/schemas/UrlValue'
        - $ref: '#/components/schemas/RowValue'
      discriminator:
        propertyName: '@type'
    RichValue:
      x-schema-name: RichValue
      description: A cell value that contains rich structured data.
      oneOf:
        - $ref: '#/components/schemas/RichSingleValue'
        - type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/RichSingleValue'
              - type: array
                items:
                  $ref: '#/components/schemas/RichSingleValue'
    RowValue:
      x-schema-name: RowValue
      description: A value representing a Coda row.
      allOf:
        - $ref: '#/components/schemas/LinkedDataObject'
        - type: object
          additionalProperties: false
          required:
            - '@type'
            - name
            - url
            - tableId
            - tableUrl
            - rowId
            - additionalType
          properties:
            '@type':
              type: string
              enum:
                - StructuredValue
              x-tsType: LinkedDataType.StructuredValue
            name:
              type: string
              description: The display name of the row, based on its identifying column.
              example: Apple
            url:
              type: string
              description: The url of the row.
              example: >-
                https://coda.io/d/_dAbCDeFGH#Teams-and-Tasks_tpqRst-U/_rui-tuVwxYz
            tableId:
              type: string
              description: The ID of the table
              example: grid-pqRst-U
            rowId:
              type: string
              description: The ID of the table
              example: i-tuVwxYz
            tableUrl:
              type: string
              description: The url of the table.
              example: https://coda.io/d/_dAbCDeFGH#Teams-and-Tasks_tpqRst-U
            additionalType:
              type: string
              description: The type of this resource.
              enum:
                - row
              x-tsType: Type.Row
    LinkedDataObject:
      x-schema-name: LinkedDataObject
      description: Base type for a JSON-LD (Linked Data) object.
      type: object
      additionalProperties: false
      required:
        - '@context'
        - '@type'
      properties:
        '@context':
          type: string
          description: >-
            A url describing the schema context for this object, typically
            "http://schema.org/".
          example: http://schema.org/
        '@type':
          $ref: '#/components/schemas/LinkedDataType'
        additionalType:
          type: string
          description: >
            An identifier of additional type info specific to Coda that may not
            be present in a schema.org taxonomy,
    LinkedDataType:
      x-schema-name: LinkedDataType
      description: A schema.org identifier for the object.
      type: string
      enum:
        - ImageObject
        - MonetaryAmount
        - Person
        - WebPage
        - StructuredValue
      x-tsEnumNames:
        - ImageObject
        - MonetaryAmount
        - Person
        - WebPage
        - StructuredValue
    UrlValue:
      x-schema-name: UrlValue
      description: A named hyperlink to an arbitrary url.
      allOf:
        - $ref: '#/components/schemas/LinkedDataObject'
        - type: object
          additionalProperties: false
          required:
            - '@type'
            - url
          properties:
            '@type':
              type: string
              enum:
                - WebPage
              x-tsType: LinkedDataType.WebPage
            name:
              type: string
              description: The user-visible text of the hyperlink.
              example: Click me
            url:
              type: string
              description: The url of the hyperlink.
              example: https://coda.io
    ImageUrlValue:
      x-schema-name: ImageUrlValue
      description: A named url of an image along with metadata.
      allOf:
        - $ref: '#/components/schemas/LinkedDataObject'
        - type: object
          additionalProperties: false
          required:
            - '@type'
          properties:
            '@type':
              type: string
              enum:
                - ImageObject
              x-tsType: LinkedDataType.ImageObject
            name:
              type: string
              description: The name of the image.
              example: Dogs Playing Poker
            url:
              type: string
              description: The url of the image.
              example: https://example.com/dogs-playing-poker.jpg
            height:
              type: number
              description: The height of the image in pixels.
              example: 480
            width:
              type: number
              description: The width of the image in pixels.
              example: 640
            status:
              $ref: '#/components/schemas/ImageStatus'
    ImageStatus:
      x-schema-name: ImageStatus
      description: The status values that an image object can have.
      type: string
      enum:
        - live
        - deleted
        - failed
      x-tsEnumNames:
        - Live
        - Deleted
        - Failed
    PersonValue:
      x-schema-name: PersonValue
      description: >-
        A named reference to a person, where the person is identified by email
        address.
      allOf:
        - $ref: '#/components/schemas/LinkedDataObject'
        - type: object
          additionalProperties: false
          required:
            - '@type'
            - name
          properties:
            '@type':
              type: string
              enum:
                - Person
              x-tsType: LinkedDataType.Person
            name:
              type: string
              description: The full name of the person.
              example: Alice Atkins
            email:
              type: string
              description: The email address of the person.
              example: alice@atkins.com
    CurrencyAmount:
      x-schema-name: CurrencyAmount
      description: A numeric monetary amount as a string or number.
      oneOf:
        - type: string
          example: '12.99'
        - type: number
          example: 42
    CurrencyValue:
      x-schema-name: CurrencyValue
      description: A monetary value with its associated currency code.
      allOf:
        - $ref: '#/components/schemas/LinkedDataObject'
        - type: object
          additionalProperties: false
          required:
            - '@type'
            - currency
            - amount
          properties:
            '@type':
              type: string
              enum:
                - MonetaryAmount
              x-tsType: LinkedDataType.MonetaryAmount
            currency:
              type: string
              description: The 3-letter currency code.
              example: USD
            amount:
              $ref: '#/components/schemas/CurrencyAmount'
    CellValue:
      x-schema-name: CellValue
      description: All values that a row cell can contain.
      oneOf:
        - $ref: '#/components/schemas/Value'
        - $ref: '#/components/schemas/RichValue'
    CellEdit:
      x-schema-name: CellEdit
      description: An edit made to a particular cell in a row.
      type: object
      required:
        - column
        - value
      additionalProperties: false
      properties:
        column:
          type: string
          description: >-
            Column ID, URL, or name (fragile and discouraged) associated with
            this edit.
          example: c-tuVwxYz
        value:
          $ref: '#/components/schemas/Value'
    PushButtonResult:
      x-schema-name: PushButtonResult
      description: The result of a push button.
      allOf:
        - $ref: '#/components/schemas/DocumentMutateResponse'
        - type: object
          required:
            - rowId
            - columnId
          additionalProperties: false
          properties:
            rowId:
              type: string
              description: ID of the row where the button exists.
              example: i-tuVwxYz
            columnId:
              type: string
              description: ID of the column where the button exists.
              example: i-tuVwxYz
    RowEdit:
      x-schema-name: RowEdit
      description: An edit made to a particular row.
      type: object
      required:
        - cells
      additionalProperties: false
      properties:
        cells:
          type: array
          items:
            $ref: '#/components/schemas/CellEdit'
    RowUpdate:
      x-schema-name: RowUpdate
      description: Payload for updating a row in a table.
      type: object
      required:
        - row
      additionalProperties: false
      properties:
        row:
          $ref: '#/components/schemas/RowEdit'
    RowUpdateResult:
      x-schema-name: RowUpdateResult
      description: The result of a row update.
      allOf:
        - $ref: '#/components/schemas/DocumentMutateResponse'
        - type: object
          required:
            - id
          additionalProperties: false
          properties:
            id:
              type: string
              description: ID of the updated row.
              example: i-tuVwxYz
    RowsDelete:
      x-schema-name: RowsDelete
      description: Payload for deleting rows from a table.
      type: object
      required:
        - rowIds
      additionalProperties: false
      properties:
        rowIds:
          description: |
            Row IDs to delete.
          example:
            - i-bCdeFgh
            - i-CdEfgHi
          type: array
          items:
            type: string
    RowsDeleteResult:
      x-schema-name: RowsDeleteResult
      description: The result of a rows delete operation.
      allOf:
        - $ref: '#/components/schemas/DocumentMutateResponse'
        - type: object
          required:
            - rowIds
          additionalProperties: false
          properties:
            rowIds:
              description: Row IDs to delete.
              example:
                - i-bCdeFgh
                - i-CdEfgHi
              type: array
              items:
                type: string
    RowsUpsert:
      x-schema-name: RowsUpsert
      description: Payload for upserting rows in a table.
      type: object
      required:
        - rows
      additionalProperties: false
      properties:
        rows:
          type: array
          items:
            $ref: '#/components/schemas/RowEdit'
        keyColumns:
          description: >-
            Optional column IDs, URLs, or names (fragile and discouraged),
            specifying columns to be used as upsert keys.
          example:
            - c-bCdeFgh
          type: array
          items:
            type: string
    RowsUpsertResult:
      x-schema-name: RowsUpsertResult
      description: The result of a rows insert/upsert operation.
      allOf:
        - $ref: '#/components/schemas/DocumentMutateResponse'
        - type: object
          additionalProperties: false
          properties:
            addedRowIds:
              description: >-
                Row IDs for rows that will be added. Only applicable when
                keyColumns is not set or empty.
              example:
                - i-bCdeFgh
                - i-CdEfgHi
              type: array
              items:
                type: string
    RowDeleteResult:
      x-schema-name: RowDeleteResult
      description: The result of a row deletion.
      allOf:
        - $ref: '#/components/schemas/DocumentMutateResponse'
        - type: object
          required:
            - id
          additionalProperties: false
          properties:
            id:
              type: string
              description: ID of the row to be deleted.
              example: i-tuVwxYz
    RowsSortBy:
      x-schema-name: RowsSortBy
      description: Determines how the rows returned are sorted
      type: string
      enum:
        - createdAt
        - natural
        - updatedAt
      x-tsEnumNames:
        - CreatedAt
        - Natural
        - UpdatedAt
    ValueFormat:
      x-schema-name: ValueFormat
      description: The format that cell values are returned as.
      type: string
      enum:
        - simple
        - simpleWithArrays
        - rich
      x-tsEnumNames:
        - Simple
        - SimpleWithArrays
        - Rich
    FormulaReference:
      x-schema-name: FormulaReference
      description: Reference to a formula.
      type: object
      required:
        - id
        - type
        - href
        - name
      additionalProperties: false
      properties:
        id: &ref_54
          type: string
          description: ID of the formula.
          example: f-fgHijkLm
        type: &ref_55
          type: string
          description: The type of this resource.
          enum:
            - formula
          x-tsType: Type.Formula
        href: &ref_56
          type: string
          format: url
          description: API link to the formula.
          example: https://coda.io/apis/v1/docs/AbCDeFGH/formulas/f-fgHijkLm
        name: &ref_57
          type: string
          description: Name of the formula.
          example: Sum of expenses
        parent: &ref_58
          $ref: '#/components/schemas/PageReference'
    Formula:
      x-schema-name: Formula
      description: Details about a formula.
      type: object
      required:
        - id
        - type
        - href
        - name
        - value
      additionalProperties: false
      properties:
        id: *ref_54
        type: *ref_55
        href: *ref_56
        name: *ref_57
        parent: *ref_58
        value:
          $ref: '#/components/schemas/Value'
    FormulaList:
      x-schema-name: FormulaList
      description: List of formulas.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/FormulaReference'
        href:
          type: string
          format: url
          description: API link to these results
          example: https://coda.io/apis/v1/docs/AbCDeFGH/formulas?limit=20
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: >-
                https://coda.io/apis/v1/docs/AbCDeFGH/formulas?pageToken=eyJsaW1pd
    ControlReference:
      x-schema-name: ControlReference
      description: Reference to a control.
      type: object
      required:
        - id
        - type
        - href
        - name
      additionalProperties: false
      properties:
        id: &ref_59
          type: string
          description: ID of the control.
          example: ctrl-cDefGhij
        type: &ref_60
          type: string
          description: The type of this resource.
          enum:
            - control
          x-tsType: Type.Control
        href: &ref_61
          type: string
          format: url
          description: API link to the control.
          example: https://coda.io/apis/v1/docs/AbCDeFGH/controls/ctrl-cDefGhij
        name: &ref_62
          type: string
          description: Name of the control.
          example: Cost
        parent: &ref_63
          $ref: '#/components/schemas/PageReference'
    Control:
      x-schema-name: Control
      description: Details about a control.
      type: object
      required:
        - id
        - type
        - href
        - name
        - controlType
        - value
      additionalProperties: false
      properties:
        id: *ref_59
        type: *ref_60
        href: *ref_61
        name: *ref_62
        parent: *ref_63
        controlType:
          $ref: '#/components/schemas/ControlType'
        value:
          $ref: '#/components/schemas/Value'
    ControlList:
      x-schema-name: ControlList
      description: List of controls.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ControlReference'
        href:
          type: string
          format: url
          description: API link to these results
          example: https://coda.io/apis/v1/docs/AbCDeFGH/controls?limit=20
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: >-
                https://coda.io/apis/v1/docs/AbCDeFGH/controls?pageToken=eyJsaW1pd
    ControlType:
      x-schema-name: ControlType
      description: Type of the control.
      type: string
      example: slider
      enum:
        - aiBlock
        - button
        - checkbox
        - datePicker
        - dateRangePicker
        - dateTimePicker
        - lookup
        - multiselect
        - select
        - scale
        - slider
        - reaction
        - textbox
        - timePicker
      x-tsEnumNames:
        - AIBlock
        - Button
        - Checkbox
        - DatePicker
        - DateRangePicker
        - DateTimePicker
        - Lookup
        - Multiselect
        - Select
        - Scale
        - Slider
        - Reaction
        - Textbox
        - TimePicker
    User:
      x-schema-name: User
      description: Info about the user.
      type: object
      required:
        - name
        - loginId
        - type
        - scoped
        - tokenName
        - href
        - workspace
      additionalProperties: false
      properties:
        name: &ref_64
          type: string
          description: Name of the user.
          example: John Doe
        loginId: &ref_65
          type: string
          description: Email address of the user.
          example: user@example.com
        type: &ref_66
          type: string
          description: The type of this resource.
          enum:
            - user
          x-tsType: Type.User
        pictureLink: &ref_67
          type: string
          format: url
          description: Browser-friendly link to the user's avatar image.
          example: https://cdn.coda.io/avatars/default_avatar.png
        scoped:
          type: boolean
          description: >-
            True if the token used to make this request has restricted/scoped
            access to the API.
          example: false
        tokenName:
          type: string
          description: Returns the name of the token used for this request.
          example: My API token
        href:
          type: string
          format: url
          description: API link to the user.
          example: https://coda.io/apis/v1beta/whoami
        workspace:
          $ref: '#/components/schemas/WorkspaceReference'
    UserSummary:
      x-schema-name: UserSummary
      description: Summary about the user.
      type: object
      required:
        - name
        - loginId
        - type
      additionalProperties: false
      properties:
        name: *ref_64
        loginId: *ref_65
        type: *ref_66
        pictureLink: *ref_67
    nextPageToken:
      description: If specified, an opaque token used to fetch the next page of results.
      type: string
      example: eyJsaW1pd
    nextPageLink:
      description: If specified, a link that can be used to fetch the next page of results.
      type: string
      format: url
    nextSyncToken:
      description: >
        If specified, an opaque token that can be passed back later to retrieve
        new results that match the parameters specified when the sync token was
        created.
      type: string
      example: eyJsaW1pd
    PublishingCategory:
      x-schema-name: PublishingCategory
      description: Info about a publishing category
      type: object
      required:
        - categoryId
        - categoryName
      additionalProperties: false
      properties:
        categoryId:
          type: string
          description: The ID for this category.
          example: aBCdEFg
        categoryName:
          type: string
          description: The name of the category.
          example: Project management
        categorySlug:
          type: string
          description: The URL identifier of the category.
          example: project-management
    Maker:
      x-schema-name: Maker
      description: Info about the maker
      type: object
      required:
        - name
        - loginId
      additionalProperties: false
      properties:
        name: &ref_68
          type: string
          description: Name of the maker.
          example: John Doe
        pictureLink: &ref_69
          type: string
          format: url
          description: Browser-friendly link to the maker's avatar image.
          example: https://cdn.coda.io/avatars/default_avatar.png
        slug: &ref_70
          type: string
          description: Maker profile identifier for the maker.
        jobTitle: &ref_71
          type: string
          description: Job title for maker.
        employer: &ref_72
          type: string
          description: Employer for maker.
        description: &ref_73
          type: string
          description: Description for the maker.
        loginId:
          type: string
          description: Email address of the user.
          example: user@example.com
    MakerSummary:
      x-schema-name: MakerSummary
      description: Summary about a maker
      type: object
      required:
        - name
      additionalProperties: false
      properties:
        name: *ref_68
        pictureLink: *ref_69
        slug: *ref_70
        jobTitle: *ref_71
        employer: *ref_72
        description: *ref_73
    ApiLink:
      x-schema-name: ApiLink
      description: Info about a resolved link to an API resource.
      type: object
      required:
        - type
        - href
        - resource
      additionalProperties: false
      properties:
        type:
          type: string
          description: The type of this resource.
          enum:
            - apiLink
          x-tsType: Type.ApiLink
        href:
          type: string
          format: url
          description: Self link to this query.
          example: >-
            https://coda.io/apis/v1/resolveBrowserLink?url=https%3A%2F%2Fcoda.io%2Fd%2F_dAbCDeFGH%2FLaunch-Status_sumnO
        browserLink:
          type: string
          format: url
          description: Canonical browser-friendly link to the resolved resource.
          example: https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO
        resource:
          $ref: '#/components/schemas/ApiLinkResolvedResource'
    ApiLinkResolvedResource:
      x-schema-name: ApiLinkResolvedResource
      type: object
      description: Reference to the resolved resource.
      required:
        - id
        - href
        - type
      additionalProperties: false
      properties:
        type:
          $ref: '#/components/schemas/Type'
        id:
          type: string
          description: ID of the resolved resource.
          example: canvas-IjkLmnO
        name:
          type: string
          description: Name of the resource.
          example: My Page
        href:
          type: string
          format: url
          description: >-
            API link to the resolved resource that can be queried to get further
            information.
          example: https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO
    Icon:
      x-schema-name: icon
      description: Info about the icon.
      type: object
      required:
        - name
        - type
        - browserLink
      additionalProperties: false
      properties:
        name:
          type: string
          description: Name of the icon.
        type:
          type: string
          description: MIME type of the icon
        browserLink:
          type: string
          format: url
          description: Browser-friendly link to an icon.
          example: https://cdn.coda.io/icons/png/color/icon-32.png
    Image:
      x-schema-name: Image
      description: Info about the image.
      type: object
      required:
        - browserLink
      additionalProperties: false
      properties:
        browserLink:
          type: string
          format: url
          description: Browser-friendly link to an image.
          example: >-
            https://codahosted.io/docs/nUYhlXysYO/blobs/bl-lYkYKNzkuT/3f879b9ecfa27448
        type:
          type: string
          description: MIME type of the image.
        width:
          type: number
          description: The width in pixels of the image.
          example: 800
        height:
          type: number
          description: The height in pixels of the image.
          example: 600
    SortBy:
      x-schema-name: SortBy
      description: Determines how the objects returned are sorted
      type: string
      enum:
        - name
      x-tsEnumNames:
        - Name
    TableType:
      x-schema-name: TableType
      type: string
      enum:
        - table
        - view
      x-tsEnumNames:
        - Table
        - View
    FormulaDetail:
      x-schema-name: FormulaDetail
      description: Detailed information about a formula.
      type: object
      required:
        - valid
      additionalProperties: false
      properties:
        valid:
          type: boolean
          description: Returns whether or not the given formula is valid.
          example: true
        isVolatile:
          type: boolean
          description: >
            Returns whether or not the given formula can return different
            results in different contexts (for example, for different users).
          example: false
        hasUserFormula:
          type: boolean
          description: >-
            Returns whether or not the given formula has a User() formula within
            it.
          example: false
        hasTodayFormula:
          type: boolean
          description: >-
            Returns whether or not the given formula has a Today() formula
            within it.
          example: false
        hasNowFormula:
          type: boolean
          description: >-
            Returns whether or not the given formula has a Now() formula within
            it.
          example: false
    MutationStatus:
      x-schema-name: MutationStatus
      description: The status of an asynchronous mutation.
      type: object
      required:
        - completed
      additionalProperties: false
      properties:
        completed:
          type: boolean
          description: Returns whether the mutation has completed.
          example: true
        warning:
          type: string
          description: A warning if the mutation completed but with caveats.
          example: Initial page HTML was invalid.
    WebhookTriggerPayload:
      x-schema-name: WebhookTriggerPayload
      description: Payload for webhook trigger
      type: object
      properties: {}
      additionalProperties: true
      example:
        message: The doc that brings words, data, & teams together.
    WebhookTriggerResult:
      x-schema-name: WebhookTriggerResult
      description: The result of triggering a webhook
      allOf:
        - $ref: '#/components/schemas/DocumentMutateResponse'
        - type: object
          additionalProperties: false
          properties: {}
    FolderReference:
      x-schema-name: FolderReference
      description: Reference to a Coda folder.
      type: object
      required:
        - id
        - type
        - browserLink
      additionalProperties: false
      properties:
        id:
          type: string
          description: ID of the Coda folder.
          example: fl-1Ab234
        type:
          type: string
          description: The type of this resource.
          enum:
            - folder
          x-tsType: Type.Folder
        browserLink:
          type: string
          format: url
          description: Browser-friendly link to the folder.
          example: https://coda.io/folders/fl-1Ab234
        name:
          type: string
          description: Name of the folder; included if the user has access to the folder.
          example: My docs
    WorkspaceReference:
      x-schema-name: WorkspaceReference
      description: Reference to a Coda workspace.
      type: object
      required:
        - id
        - type
        - browserLink
      additionalProperties: false
      properties:
        id: &ref_74
          type: string
          description: ID of the Coda workspace.
          example: ws-1Ab234
        type: &ref_75
          type: string
          description: The type of this resource.
          enum:
            - workspace
          x-tsType: Type.Workspace
        organizationId: &ref_76
          type: string
          description: ID of the organization bound to this workspace, if any.
          example: org-2Bc456
        browserLink: &ref_77
          type: string
          format: url
          description: Browser-friendly link to the Coda workspace.
          example: https://coda.io/docs?workspaceId=ws-1Ab234
        name:
          type: string
          description: >-
            Name of the workspace; included if the user has access to the
            workspace.
          example: My workspace
    Workspace:
      x-schema-name: Workspace
      description: Metadata about a Coda workspace.
      type: object
      required:
        - id
        - type
        - browserLink
        - name
      additionalProperties: false
      properties:
        id: *ref_74
        type: *ref_75
        organizationId: *ref_76
        browserLink: *ref_77
        name:
          type: string
          description: Name of the workspace.
          example: coda.io
        description:
          type: string
          description: Description of the workspace.
          example: The central place for our team's knowledge.
    WorkspaceUser:
      x-schema-name: WorkspaceUser
      description: Metadata of a workspace user.
      type: object
      required:
        - email
        - name
        - role
        - registeredAt
      additionalProperties: false
      properties:
        email:
          type: string
          description: Email of the user.
          example: hello@coda.io
        name:
          type: string
          description: Name of the user.
          example: Sally Jane
        role:
          $ref: '#/components/schemas/WorkspaceUserRole'
        pictureUrl:
          type: string
          description: Picture url of the user.
          format: url
          example: codahosted.io/123
        registeredAt:
          type: string
          format: date-time
          description: Timestamp for when the user registered in this workspace
          example: '2018-04-11T00:18:57.946Z'
        roleChangedAt:
          type: string
          format: date-time
          description: Timestamp for when the user's role last changed in this workspace.
          example: '2018-04-11T00:18:57.946Z'
        lastActiveAt:
          type: string
          format: date
          description: Date when the user last took an action in any workspace.
          example: '2018-04-11'
        ownedDocs:
          type: number
          description: Number of docs the user owns in this workspace.
          example: 2
        docsLastActiveAt:
          type: string
          format: date
          description: >-
            Date when anyone last accessed a doc that the user owns in this
            workspace.
          example: '2018-04-11'
        docCollaboratorCount:
          type: number
          description: >-
            Number of collaborators that have interacted with docs owned by the
            user in the last 90 days.
          example: 2
        totalDocs:
          type: number
          description: >-
            Number of docs the user owns, manages, or to which they have added
            pages in the last 90 days.
          example: 2
        totalDocsLastActiveAt:
          type: string
          format: date
          description: >-
            Date when anyone last accessed a doc the member owns or contributed
            to.
          example: '2018-04-11'
        totalDocCollaboratorsLast90Days:
          type: number
          description: >-
            Number of unique users that have viewed any doc the user owns,
            manages, or has added pages to in the last 90 days.
          example: 2
    WorkspaceUserRole:
      x-schema-name: WorkspaceUserRole
      type: string
      enum:
        - Admin
        - DocMaker
        - Editor
      x-tsEnumNames:
        - Admin
        - DocMaker
        - Editor
    WorkspaceRoleActivity:
      x-schema-name: WorkspaceRoleActivity
      description: Metadata for workspace role activity.
      type: object
      required:
        - month
        - activeAdminCount
        - activeDocMakerCount
        - activeEditorCount
        - inactiveAdminCount
        - inactiveDocMakerCount
        - inactiveEditorCount
      additionalProperties: false
      properties:
        month:
          type: string
          description: Month corresponding to the data.
          example: '2020-09-15'
        activeAdminCount:
          type: number
          description: Number of active Admins.
          example: 2
        activeDocMakerCount:
          type: number
          description: Number of active Doc Makers.
          example: 2
        activeEditorCount:
          type: number
          description: Number of active Editors.
          example: 2
        inactiveAdminCount:
          type: number
          description: Number of inactive Admins.
          example: 2
        inactiveDocMakerCount:
          type: number
          description: Number of inactive Doc Makers.
          example: 2
        inactiveEditorCount:
          type: number
          description: Number of inactive Editor users.
          example: 2
    WorkspaceMembersList:
      x-schema-name: WorkspaceMembersList
      description: Response for listing workspace users.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceUser'
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: >-
                https://coda.io/apis/v1/workspaces/{workspaceId}/users?pageToken=xyz
    GetWorkspaceRoleActivity:
      x-schema-name: GetWorkspaceRoleActivity
      description: Response for getting workspace role activity.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceRoleActivity'
    ChangeRole:
      x-schema-name: ChangeRole
      description: Parameters for changing a workspace user role.
      type: object
      required:
        - email
        - newRole
      additionalProperties: false
      properties:
        email:
          type: string
          description: Email of the user.
          example: hello@coda.io
        newRole:
          $ref: '#/components/schemas/WorkspaceUserRole'
    ChangeRoleResult:
      x-schema-name: ChangeRoleResult
      description: The result of changing a user's workspace user role.
      type: object
      required:
        - roleChangedAt
      additionalProperties: false
      properties:
        roleChangedAt:
          type: string
          format: date-time
          description: Timestamp for when the user's role last changed in this workspace.
          example: '2018-04-11T00:18:57.946Z'
    DocAnalyticsItem:
      x-schema-name: DocAnalyticsItem
      description: Analytics data for a Coda doc.
      type: object
      required:
        - doc
        - metrics
      additionalProperties: false
      properties:
        doc:
          $ref: '#/components/schemas/DocAnalyticsDetails'
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/DocAnalyticsMetrics'
    DocAnalyticsCollection:
      x-schema-name: DocAnalyticsCollection
      description: List of analytics for Coda docs over a date range.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DocAnalyticsItem'
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: https://coda.io/apis/v1/analytics/docs?pageToken=xyz
    DocAnalyticsMetrics:
      x-schema-name: DocAnalyticsMetrics
      description: Analytics metrics for a Coda Doc.
      type: object
      required:
        - date
        - views
        - copies
        - likes
        - sessionsMobile
        - sessionsDesktop
        - sessionsOther
        - totalSessions
        - aiCreditsChat,
        - aiCreditsBlock,
        - aiCreditsColumn,
        - aiCreditsAssistant,
        - aiCreditsReviewer,
        - aiCredits,
      additionalProperties: false
      properties:
        date:
          type: string
          format: date
          description: Date of the analytics data.
          example: '2020-09-02'
        views:
          type: integer
          description: Number of times the doc was viewed.
          example: 980
        copies:
          type: integer
          description: Number of times the doc was copied.
          example: 24
        likes:
          type: integer
          description: Number of times the doc was liked.
          example: 342
        sessionsMobile:
          type: integer
          description: Number of unique visitors to this doc from a mobile device.
          example: 530
        sessionsDesktop:
          type: integer
          description: Number of unique visitors to this doc from a desktop device.
          example: 212
        sessionsOther:
          type: integer
          description: Number of unique visitors to this doc from an unknown device type.
          example: 10
        totalSessions:
          type: integer
          description: Sum of the total sessions from any device.
          example: 1000
        aiCreditsChat:
          type: integer
          description: Number of credits used for AI chat.
          example: 10
        aiCreditsBlock:
          type: integer
          description: Number of credits used for AI block.
          example: 10
        aiCreditsColumn:
          type: integer
          description: Number of credits used for AI column.
          example: 10
        aiCreditsAssistant:
          type: integer
          description: Number of credits used for AI assistant.
          example: 10
        aiCreditsReviewer:
          type: integer
          description: Number of credits used for AI reviewer.
          example: 10
        aiCredits:
          type: integer
          description: Total number of AI credits used.
          example: 50
    DocAnalyticsOrderBy:
      x-schema-name: DocAnalyticsOrderBy
      description: Determines how the Doc analytics returned are sorted.
      type: string
      enum:
        - date
        - docId
        - title
        - createdAt
        - publishedAt
        - likes
        - copies
        - views
        - sessionsDesktop
        - sessionsMobile
        - sessionsOther
        - totalSessions
        - aiCreditsChat
        - aiCreditsBlock
        - aiCreditsColumn
        - aiCreditsAssistant
        - aiCreditsReviewer
        - aiCredits
      x-tsEnumNames:
        - AnalyticsDate
        - DocId
        - Title
        - CreatedAt
        - PublishedAt
        - Likes
        - Copies
        - Views
        - SessionsDesktop
        - SessionsMobile
        - SessionsOther
        - TotalSessions
        - AiCreditsChat
        - AiCreditsBlock
        - AiCreditsColumn
        - AiCreditsAssistant
        - AiCreditsReviewer
        - AiCredits
    DocAnalyticsDetails:
      allOf:
        - $ref: '#/components/schemas/DocReference'
        - type: object
          description: Metadata about a doc relevant to analytics.
          required:
            - title
            - createdAt
          additionalProperties: false
          properties:
            title:
              type: string
              description: The name of the doc.
              example: Cool Geometry Formulas
            icon:
              $ref: '#/components/schemas/Icon'
              example: https://coda.io/d/_dAbCDeFGH
            createdAt:
              type: string
              format: date-time
              description: Creation time of the doc.
              example: '2022-04-11T00:18:57.946Z'
            publishedAt:
              type: string
              format: date-time
              description: Published time of the doc.
              example: '2022-04-12T00:18:57.946Z'
    DocAnalyticsSummary:
      x-schema-name: DocAnalyticsSummary
      description: Summarized metrics for Coda docs.
      type: object
      required:
        - totalSessions
      additionalProperties: false
      properties:
        totalSessions:
          type: integer
          description: Total number of sessions across all docs.
          example: 1337
    PageAnalyticsMetrics:
      x-schema-name: PageAnalyticsMetrics
      description: Analytics metrics for a page within a Coda doc.
      type: object
      required:
        - date
        - views
        - sessions
        - users
        - averageSecondsViewed
        - medianSecondsViewed
        - tabs
      additionalProperties: false
      properties:
        date:
          type: string
          format: date
          description: Date of the analytics data.
          example: '2022-06-03'
        views:
          type: integer
          description: Number of times the page was viewed within the given day.
          example: 980
        sessions:
          type: integer
          description: Number of unique browsers that viewed the page on the given day.
          example: 24
        users:
          type: integer
          description: Number of unique Coda users that viewed the page on the given day.
          example: 42
        averageSecondsViewed:
          type: integer
          description: Average number of seconds that the page was viewed on the given day.
          example: 42
        medianSecondsViewed:
          type: integer
          description: Median number of seconds that the page was viewed on the given day.
          example: 42
        tabs:
          type: integer
          description: Number of unique tabs that opened the doc on the given day.
          example: 10
    PageAnalyticsItem:
      x-schema-name: PageAnalyticsItem
      description: Analytics data for a page within a Coda doc.
      type: object
      required:
        - page
        - metrics
      additionalProperties: false
      properties:
        page:
          $ref: '#/components/schemas/PageAnalyticsDetails'
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/PageAnalyticsMetrics'
    PageAnalyticsDetails:
      x-schema-name: PageAnalyticsDetails
      description: Metadata about a page relevant to analytics.
      required:
        - id
        - name
      additionalProperties: false
      properties:
        id:
          type: string
          description: ID of the page.
          example: section-IjkLmnO
        name:
          type: string
          description: Name of the page.
          example: Launch Status
        icon:
          $ref: '#/components/schemas/Icon'
          example: https://coda.io/d/_dAbCDeFGH
    PageAnalyticsCollection:
      x-schema-name: PageAnalyticsCollection
      description: List of analytics for pages within a Coda doc over a date range.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PageAnalyticsItem'
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: >-
                https://coda.io/apis/v1/analytics/docs/DOC_ID/pages?pageToken=xyz
    PackAnalyticsDetails:
      x-schema-name: PackAnalyticsDetails
      description: Metadata about a Pack relevant to analytics.
      type: object
      additionalProperties: false
      required:
        - id
        - name
        - createdAt
      properties:
        id:
          type: number
          description: ID of the Pack.
          example: 1003
        name:
          type: string
          description: The name of the Pack.
          example: Cool Geometry Formulas
        logoUrl:
          type: string
          format: url
          description: The link to the logo of the Pack.
        createdAt:
          type: string
          format: date-time
          description: Creation time of the Pack.
          example: '2022-04-11T00:18:57.946Z'
    PackAnalyticsCollection:
      x-schema-name: PackAnalyticsCollection
      description: List of analytics for Coda Packs over a date range.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PackAnalyticsItem'
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: https://coda.io/apis/v1/analytics/packs?pageToken=xyz
    PackAnalyticsItem:
      x-schema-name: PackAnalyticsItem
      description: Analytics data for a Coda Pack.
      type: object
      required:
        - pack
        - metrics
      additionalProperties: false
      properties:
        pack:
          $ref: '#/components/schemas/PackAnalyticsDetails'
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/PackAnalyticsMetrics'
    PackAnalyticsMetrics:
      x-schema-name: PackAnalyticsMetrics
      description: Analytics metrics for a Coda Pack.
      type: object
      additionalProperties: false
      required:
        - date
        - docInstalls
        - workspaceInstalls
        - numFormulaInvocations
        - numActionInvocations
        - numSyncInvocations
        - numMetadataInvocations
        - docsActivelyUsing
        - docsActivelyUsing7Day
        - docsActivelyUsing30Day
        - docsActivelyUsing90Day
        - docsActivelyUsingAllTime
        - workspacesActivelyUsing
        - workspacesActivelyUsing7Day
        - workspacesActivelyUsing30Day
        - workspacesActivelyUsing90Day
        - workspacesActivelyUsingAllTime
        - workspacesActivelyTrialing
        - workspacesActivelyTrialing7Day
        - workspacesActivelyTrialing30Day
        - workspacesActivelyTrialing90Day
        - workspacesActivelyTrialingAllTime
        - workspacesNewlySubscribed
        - workspacesWithActiveSubscriptions
        - workspacesWithSuccessfulTrials
        - revenueUsd
      properties:
        date:
          type: string
          format: date
          description: Date of the analytics data.
          example: '2020-09-02'
        docInstalls:
          type: integer
          description: Number of unique documents that have installed this Pack.
          example: 100
        workspaceInstalls:
          type: integer
          description: Number of unique workspaces that have installed this Pack.
          example: 10
        numFormulaInvocations:
          type: integer
          description: Number of times regular formulas have been called.
          example: 100
        numActionInvocations:
          type: integer
          description: Number of times action formulas have been called.
          example: 100
        numSyncInvocations:
          type: integer
          description: Number of times sync table formulas have been called.
          example: 100
        numMetadataInvocations:
          type: integer
          description: Number of times metadata formulas have been called.
          example: 100
        docsActivelyUsing: &ref_78
          type: integer
          description: >-
            Number of unique docs that have invoked a formula from this Pack in
            the past day.
          example: 50
        docsActivelyUsing7Day: &ref_79
          type: integer
          description: >-
            Number of unique docs that have invoked a formula from this Pack in
            the past 7 days.
          example: 100
        docsActivelyUsing30Day: &ref_80
          type: integer
          description: >-
            Number of unique docs that have invoked a formula from this Pack in
            the past 30 days.
          example: 200
        docsActivelyUsing90Day: &ref_81
          type: integer
          description: >-
            Number of unique docs that have invoked a formula from this Pack in
            the past 90 days.
          example: 300
        docsActivelyUsingAllTime: &ref_82
          type: integer
          description: >-
            Number of unique docs that have invoked a formula from this Pack
            ever.
          example: 500
        workspacesActivelyUsing: &ref_83
          type: integer
          description: >-
            Number of unique workspaces that have invoked a formula from this
            Pack in the past day.
          example: 10
        workspacesActivelyUsing7Day: &ref_84
          type: integer
          description: >-
            Number of unique workspaces that have invoked a formula from this
            Pack in the past 7 days.
          example: 15
        workspacesActivelyUsing30Day: &ref_85
          type: integer
          description: >-
            Number of unique workspaces that have invoked a formula from this
            Pack in the past 30 days.
          example: 20
        workspacesActivelyUsing90Day: &ref_86
          type: integer
          description: >-
            Number of unique workspaces that have invoked a formula from this
            Pack in the past 90 days.
          example: 30
        workspacesActivelyUsingAllTime: &ref_87
          type: integer
          description: >-
            Number of unique workspaces that have invoked a formula from this
            Pack ever.
          example: 50
        workspacesActivelyTrialing: &ref_88
          type: integer
          description: Number of unique workspaces that are currently involved in a trial.
        workspacesActivelyTrialing7Day: &ref_89
          type: integer
          description: >-
            Number of unique workspaces that have been involved in a trial in
            the last 7 days.
        workspacesActivelyTrialing30Day: &ref_90
          type: integer
          description: >-
            Number of unique workspaces that have been involved in a trial in
            the last 30 days.
        workspacesActivelyTrialing90Day: &ref_91
          type: integer
          description: >-
            Number of unique workspaces that have been involved in a trial in
            the last 90 days.
        workspacesActivelyTrialingAllTime: &ref_92
          type: integer
          description: Number of unique workspaces that have been involved in a trial ever.
        workspacesNewlySubscribed: &ref_93
          type: integer
          description: >-
            Number of unique workspaces that have recently subscribed to the
            Pack.
        workspacesWithActiveSubscriptions: &ref_94
          type: integer
          description: >-
            Number of unique workspaces that are currently subscribed to the
            Pack.
        workspacesWithSuccessfulTrials: &ref_95
          type: integer
          description: >-
            Number of unique workspaces that subscribed after undertaking a Pack
            trial.
        revenueUsd: &ref_96
          type: string
          description: Amount of revenue (in USD) that the Pack has produced.
    PackAnalyticsOrderBy:
      x-schema-name: PackAnalyticsOrderBy
      description: Determines how the Pack analytics returned are sorted.
      type: string
      enum:
        - date
        - packId
        - name
        - createdAt
        - docInstalls
        - workspaceInstalls
        - numFormulaInvocations
        - numActionInvocations
        - numSyncInvocations
        - numMetadataInvocations
        - docsActivelyUsing
        - docsActivelyUsing7Day
        - docsActivelyUsing30Day
        - docsActivelyUsing90Day
        - docsActivelyUsingAllTime
        - workspacesActivelyUsing
        - workspacesActivelyUsing7Day
        - workspacesActivelyUsing30Day
        - workspacesActivelyUsing90Day
        - workspacesActivelyUsingAllTime
        - workspacesWithActiveSubscriptions
        - workspacesWithSuccessfulTrials
        - revenueUsd
      x-tsEnumNames:
        - AnalyticsDate
        - PackId
        - Name
        - CreatedAt
        - DocInstalls
        - WorkspaceInstalls
        - NumFormulaInvocations
        - NumActionInvocations
        - NumSyncInvocations
        - NumMetadataInvocations
        - DocsActivelyUsing
        - DocsActivelyUsing7Day
        - DocsActivelyUsing30Day
        - DocsActivelyUsing90Day
        - DocsActivelyUsingAllTime
        - WorkspacesActivelyUsing
        - WorkspacesActivelyUsing7Day
        - WorkspacesActivelyUsing30Day
        - WorkspacesActivelyUsing90Day
        - WorkspacesActivelyUsingAllTime
        - WorkspacesWithActiveSubscriptions
        - WorkspacesWithSuccessfulTrials
        - RevenueUsd
    PackAnalyticsSummary:
      x-schema-name: PackAnalyticsSummary
      description: Summary analytics for Packs.
      type: object
      required:
        - totalDocInstalls
        - totalWorkspaceInstalls
        - totalInvocations
      additionalProperties: false
      properties:
        totalDocInstalls:
          type: integer
          description: The number of times this Pack was installed in docs.
        totalWorkspaceInstalls:
          type: integer
          description: The number of times this Pack was installed in workspaces.
        totalInvocations:
          type: integer
          description: The number of times formulas in this Pack were invoked.
    AnalyticsScale:
      x-schema-name: AnalyticsScale
      description: Quantization period over which to view analytics.
      type: string
      enum:
        - daily
        - cumulative
      x-tsEnumNames:
        - Daily
        - Cumulative
    PackFormulaAnalyticsMetrics:
      x-schema-name: PackFormulaAnalyticsMetrics
      description: Analytics metrics for a Coda Pack formula.
      type: object
      required:
        - date
        - formulaInvocations
        - errors
        - docsActivelyUsing
        - docsActivelyUsing7Day
        - docsActivelyUsing30Day
        - docsActivelyUsing90Day
        - docsActivelyUsingAllTime
        - workspacesActivelyUsing
        - workspacesActivelyUsing7Day
        - workspacesActivelyUsing30Day
        - workspacesActivelyUsing90Day
        - workspacesActivelyUsingAllTime
      additionalProperties: false
      properties:
        date:
          type: string
          format: date
          description: Date of the analytics data.
          example: '2020-09-02'
        formulaInvocations:
          type: integer
          description: Number of times this formula has been invoked.
          example: 123
        errors:
          type: integer
          description: Number of errors from invocations.
          example: 5
        medianLatencyMs:
          type: integer
          description: >-
            Median latency of an invocation in milliseconds. Only present for
            daily metrics.
          example: 500
        medianResponseSizeBytes:
          type: integer
          description: Median response size in bytes. Only present for daily metrics.
          example: 300
        docsActivelyUsing: *ref_78
        docsActivelyUsing7Day: *ref_79
        docsActivelyUsing30Day: *ref_80
        docsActivelyUsing90Day: *ref_81
        docsActivelyUsingAllTime: *ref_82
        workspacesActivelyUsing: *ref_83
        workspacesActivelyUsing7Day: *ref_84
        workspacesActivelyUsing30Day: *ref_85
        workspacesActivelyUsing90Day: *ref_86
        workspacesActivelyUsingAllTime: *ref_87
        workspacesActivelyTrialing: *ref_88
        workspacesActivelyTrialing7Day: *ref_89
        workspacesActivelyTrialing30Day: *ref_90
        workspacesActivelyTrialing90Day: *ref_91
        workspacesActivelyTrialingAllTime: *ref_92
        workspacesNewlySubscribed: *ref_93
        workspacesWithActiveSubscriptions: *ref_94
        workspacesWithSuccessfulTrials: *ref_95
        revenueUsd: *ref_96
    PackFormulaAnalyticsItem:
      x-schema-name: PackFormulaAnalyticsItem
      description: Analytics data for a Coda Pack formula.
      type: object
      required:
        - formula
        - metrics
      additionalProperties: false
      properties:
        formula:
          $ref: '#/components/schemas/PackFormulaIdentifier'
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/PackFormulaAnalyticsMetrics'
    PackFormulaAnalyticsCollection:
      x-schema-name: PackFormulaAnalyticsCollection
      description: A collection of analytics for Coda Packs formulas over a date range.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PackFormulaAnalyticsItem'
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: >-
                https://coda.io/apis/v1/analytics/packs/:packId/formulas?pageToken=xyz
    PackFormulaAnalyticsOrderBy:
      x-schema-name: PackFormulaAnalyticsOrderBy
      description: Determines how the Pack formula analytics returned are sorted.
      type: string
      enum:
        - date
        - formulaName
        - formulaType
        - formulaInvocations
        - medianLatencyMs
        - medianResponseSizeBytes
        - errors
        - docsActivelyUsing
        - docsActivelyUsing7Day
        - docsActivelyUsing30Day
        - docsActivelyUsing90Day
        - docsActivelyUsingAllTime
        - workspacesActivelyUsing
        - workspacesActivelyUsing7Day
        - workspacesActivelyUsing30Day
        - workspacesActivelyUsing90Day
        - workspacesActivelyUsingAllTime
      x-tsEnumNames:
        - AnalyticsDate
        - FormulaName
        - FormulaType
        - FormulaInvocations
        - MedianLatencyMs
        - MedianResponseSizeBytes
        - Errors
        - DocsActivelyUsing
        - DocsActivelyUsing7Day
        - DocsActivelyUsing30Day
        - DocsActivelyUsing90Day
        - DocsActivelyUsingAllTime
        - WorkspacesActivelyUsing
        - WorkspacesActivelyUsing7Day
        - WorkspacesActivelyUsing30Day
        - WorkspacesActivelyUsing90Day
        - WorkspacesActivelyUsingAllTime
    AnalyticsLastUpdatedResponse:
      x-schema-name: AnalyticsLastUpdatedResponse
      description: Response representing the last day analytics were updated.
      type: object
      required:
        - docAnalyticsLastUpdated
        - packAnalyticsLastUpdated
        - packFormulaAnalyticsLastUpdated
      additionalProperties: false
      properties:
        docAnalyticsLastUpdated:
          type: string
          format: date
          description: Date that doc analytics were last updated.
          example: '2022-05-01'
        packAnalyticsLastUpdated:
          type: string
          format: date
          description: Date that Pack analytics were last updated.
          example: '2022-05-01'
        packFormulaAnalyticsLastUpdated:
          type: string
          format: date
          description: Date that Pack formula analytics were last updated.
          example: '2022-05-01'
    Pack:
      x-schema-name: Pack
      description: Details about a Pack.
      type: object
      additionalProperties: false
      required: &ref_97
        - id
        - name
        - description
        - shortDescription
        - workspaceId
        - categories
      properties:
        id: &ref_98
          type: number
          description: ID of the Pack.
          example: 1003
        logoUrl: &ref_99
          type: string
          format: url
          description: The link to the logo of the Pack.
        coverUrl: &ref_100
          type: string
          format: url
          description: The link to the cover photo of the Pack.
        exampleImages: &ref_101
          type: array
          description: The example images for the Pack.
          items:
            $ref: '#/components/schemas/PackImageFile'
        agentImages: &ref_102
          type: array
          description: The agent images for the Pack.
          items:
            $ref: '#/components/schemas/PackImageFile'
        workspaceId: &ref_103
          type: string
          description: The parent workspace for the Pack.
          example: ws-asdf
        categories: &ref_104
          type: array
          description: Publishing categories associated with this Pack.
          items:
            $ref: '#/components/schemas/PublishingCategory'
        certified: &ref_105
          type: boolean
          description: Denotes if the pack is certified by Coda.
        certifiedAgent: &ref_106
          type: boolean
          description: >-
            Denotes if the pack is certified by Grammarly to be optimized for
            agent usage.
        sourceCodeVisibility:
          $ref: '#/components/schemas/PackSourceCodeVisibility'
        packEntrypoints: &ref_107
          type: array
          description: Pack entrypoints where this pack is available
          items:
            $ref: '#/components/schemas/PackEntrypoint'
        verifiedVersion: &ref_108
          type: string
          description: >-
            The latest released pack version that has been verified (approved)
            for use. For agent packs, this is the most recent release that
            passed review. For non-agent packs or legacy releases, this is the
            most recent release.
          example: 1.0.0
        name: &ref_109
          type: string
          description: The name of the Pack.
          example: Cool Geometry Formulas
          maxLength: 128
        description: &ref_110
          type: string
          description: The full description of the Pack.
          example: >-
            This Pack allows users to calculate the surface area and volume of a
            few common 3D shapes, like cubes and pyramids.
          maxLength: 8192
        shortDescription: &ref_111
          type: string
          description: A short version of the description of the Pack.
          example: Calculate cool geometric formulas like surface area.
          maxLength: 256
        agentShortDescription: &ref_112
          type: string
          description: A short description for the pack as an agent.
          example: >-
            Chat with a tool that can calculate cool geometric formulas like
            surface area.
          maxLength: 256
        agentDescription: &ref_113
          type: string
          description: A full description for the pack as an agent.
          example: >-
            Chat with a comprehensive tool that can calculate cool geometric
            formulas like surface area, volume, and other mathematical
            operations. This agent can help with complex calculations and
            provide detailed explanations.
          x-allow-empty: true
          maxLength: 8192
        supportEmail: &ref_114
          type: string
          description: A contact email for the Pack.
          example: user@email.com
          maxLength: 512
        termsOfServiceUrl: &ref_115
          type: string
          format: url
          description: A Terms of Service URL for the Pack.
          maxLength: 512
        privacyPolicyUrl: &ref_116
          type: string
          format: url
          description: A Privacy Policy URL for the Pack.
          maxLength: 512
        overallRateLimit:
          $ref: '#/components/schemas/PackRateLimit'
        perConnectionRateLimit:
          $ref: '#/components/schemas/PackRateLimit'
        featuredDocStatus:
          $ref: '#/components/schemas/FeaturedDocStatus'
        additionalInformation:
          $ref: '#/components/schemas/PackListingAdditionalInformation'
    PackSummary:
      x-schema-name: PackSummary
      description: Summary of a Pack.
      type: object
      additionalProperties: false
      required: *ref_97
      properties:
        id: *ref_98
        logoUrl: *ref_99
        coverUrl: *ref_100
        exampleImages: *ref_101
        agentImages: *ref_102
        workspaceId: *ref_103
        categories: *ref_104
        certified: *ref_105
        certifiedAgent: *ref_106
        sourceCodeVisibility:
          $ref: '#/components/schemas/PackSourceCodeVisibility'
        packEntrypoints: *ref_107
        verifiedVersion: *ref_108
        name: *ref_109
        description: *ref_110
        shortDescription: *ref_111
        agentShortDescription: *ref_112
        agentDescription: *ref_113
        supportEmail: *ref_114
        termsOfServiceUrl: *ref_115
        privacyPolicyUrl: *ref_116
    PackSummaryList:
      x-schema-name: PackSummaryList
      description: List of Pack summaries.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PackSummary'
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: https://coda.io/apis/v1/packs?pageToken=xyz
    PackRateLimit:
      x-schema-name: PackRateLimit
      description: Rate limit in Pack settings.
      type: object
      additionalProperties: false
      required: &ref_151
        - intervalSeconds
        - operationsPerInterval
      properties: &ref_152
        intervalSeconds:
          type: integer
          description: The rate limit interval in seconds.
          example: 3600
          minimum: 1
          maximum: 86400
        operationsPerInterval:
          type: integer
          description: >-
            The maximum number of Pack operations that can be performed in a
            given interval.
          example: 20
          minimum: 0
    PacksSortBy:
      x-schema-name: PacksSortBy
      description: Determines how the Packs returned are sorted.
      type: string
      enum:
        - title
        - createdAt
        - updatedAt
      x-tsEnumNames:
        - Title
        - CreatedAt
        - UpdatedAt
    PackListingsSortBy:
      x-schema-name: PackListingsSortBy
      description: Determines how the Pack listings returned are sorted.
      type: string
      enum:
        - packId
        - name
        - packVersion
        - packVersionModifiedAt
        - agentDirectorySort
      x-tsEnumNames:
        - PackId
        - Name
        - PackVersion
        - PackVersionModifiedAt
        - AgentDirectorySort
    PackVersionUploadInfo:
      x-schema-name: PackVersionUploadInfo
      description: Information indicating where to upload the Pack version definition.
      type: object
      required:
        - uploadUrl
        - headers
      additionalProperties: false
      properties:
        uploadUrl:
          type: string
          description: A URL to be used for uploading a Pack version definition.
          example: >-
            https://coda-us-west-2-prod-packs-upload.s3.amazonaws.com/packs/123/versions/1.0.0
        headers:
          type: object
          additionalProperties:
            type: string
          description: >-
            Key-value pairs of authorization headers to include in the upload
            request.
          example: '{"header1": "value1"}'
    PackPrincipal:
      x-schema-name: PackPrincipal
      description: Metadata about a Pack principal.
      oneOf:
        - $ref: '#/components/schemas/PackUserPrincipal'
        - $ref: '#/components/schemas/PackWorkspacePrincipal'
        - $ref: '#/components/schemas/PackGlobalPrincipal'
        - $ref: '#/components/schemas/PackNomosOrganizationPrincipal'
        - $ref: '#/components/schemas/PackGroupPrincipal'
        - $ref: '#/components/schemas/PackGrammarlyInstitutionPrincipal'
      discriminator:
        propertyName: type
        mapping:
          user: '#/components/schemas/PackUserPrincipal'
          workspace: '#/components/schemas/PackWorkspacePrincipal'
          global: '#/components/schemas/PackGlobalPrincipal'
          nomosOrganization: '#/components/schemas/PackNomosOrganizationPrincipal'
          group: '#/components/schemas/PackGroupPrincipal'
          grammarlyInstitution: '#/components/schemas/PackGrammarlyInstitutionPrincipal'
    PackPrincipalType:
      x-schema-name: PackPrincipalType
      description: Type of Pack permissions.
      type: string
      enum:
        - user
        - workspace
        - worldwide
        - nomosOrganization
        - group
        - grammarlyInstitution
      x-tsEnumNames:
        - User
        - Workspace
        - Worldwide
        - NomosOrganization
        - Group
        - GrammarlyInstitution
    PackAccessType:
      x-schema-name: PackAccessType
      type: string
      enum:
        - none
        - view
        - test
        - edit
        - admin
      x-tsEnumNames:
        - None
        - View
        - Test
        - Edit
        - Admin
    PackAccessTypes:
      x-schema-name: PackAccessTypes
      description: Access types for a Pack.
      additionalProperties: false
      type: array
      items:
        $ref: '#/components/schemas/PackAccessType'
    PackEntrypoint:
      x-schema-name: PackEntrypoint
      type: string
      enum:
        - go
        - docs
      x-tsEnumNames:
        - Go
        - Docs
    PackUserPrincipal:
      x-schema-name: PackUserPrincipal
      type: object
      required:
        - type
        - email
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - user
          x-tsType: PackPrincipalType.User
        email:
          type: string
    PackWorkspacePrincipal:
      x-schema-name: PackWorkspacePrincipal
      type: object
      required:
        - type
        - workspaceId
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - workspace
          x-tsType: PackPrincipalType.Workspace
        workspaceId:
          type: string
    PackGlobalPrincipal:
      x-schema-name: PackGlobalPrincipal
      type: object
      required:
        - type
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - worldwide
          x-tsType: PackPrincipalType.Worldwide
    PackNomosOrganizationPrincipal:
      x-schema-name: PackNomosOrganizationPrincipal
      type: object
      required:
        - type
        - nomosOrganizationId
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - nomosOrganization
          x-tsType: PackPrincipalType.NomosOrganization
        nomosOrganizationId:
          type: string
    PackGroupPrincipal:
      x-schema-name: PackGroupPrincipal
      type: object
      required:
        - type
        - groupId
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - group
          x-tsType: PackPrincipalType.Group
        groupId:
          type: string
        groupName:
          type: string
    PackGrammarlyInstitutionPrincipal:
      x-schema-name: PackGrammarlyInstitutionPrincipal
      type: object
      required:
        - type
        - grammarlyInstitutionId
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - grammarlyInstitution
          x-tsType: PackPrincipalType.GrammarlyInstitution
        grammarlyInstitutionId:
          type: integer
          format: int64
          minimum: 1
    PackPermissionList:
      x-schema-name: PackPermissionList
      description: List of Pack permissions.
      type: object
      required:
        - items
        - permissionUsers
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PackPermission'
        permissionUsers:
          type: array
          items:
            $ref: '#/components/schemas/UserSummary'
    PackPermission:
      x-schema-name: PackPermission
      description: Metadata about a Pack permission.
      type: object
      required:
        - id
        - principal
        - access
      additionalProperties: false
      properties:
        id:
          type: string
          description: Id for the Permission
        principal:
          $ref: '#/components/schemas/PackPrincipal'
        access:
          $ref: '#/components/schemas/PackAccessType'
    PackInvitation:
      x-schema-name: PackInvitation
      description: Metadata about a Pack invitation.
      type: object
      required:
        - invitationId
        - packId
        - inviteeEmail
        - inviterUserId
        - access
        - createdAt
        - expiresAt
      additionalProperties: false
      properties:
        invitationId:
          type: string
          description: ID of the invitation
          example: 550e8400-e29b-41d4-a716-446655440000
        packId:
          type: number
          description: ID of the Pack
          example: 123
        inviteeEmail:
          type: string
          description: Email address of the invited user
          example: user@example.com
        inviterUserId:
          type: integer
          description: User ID of the user who created this invitation
          example: 456
        access:
          $ref: '#/components/schemas/PackAccessType'
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the invitation was created
        expiresAt:
          type: string
          format: date-time
          description: Timestamp when the invitation expires
    PackInvitationList:
      x-schema-name: PackInvitationList
      description: List of Pack invitations.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PackInvitation'
        nextPageToken:
          type: string
          nullable: true
          description: Token for fetching the next page of results
        nextPageLink:
          type: string
          format: url
          nullable: true
          description: URL for fetching the next page of results
    PackInvitationWithPack:
      x-schema-name: PackInvitationWithPack
      description: Pack invitation with Pack metadata.
      type: object
      required:
        - invitation
        - pack
        - makers
        - networkDomains
      additionalProperties: false
      properties:
        invitation:
          $ref: '#/components/schemas/PackInvitation'
        pack:
          $ref: '#/components/schemas/PackSummary'
        makers:
          type: array
          items:
            $ref: '#/components/schemas/Maker'
        networkDomains:
          type: array
          items:
            type: string
          description: Network domain of the Pack
    PackInvitationWithPackList:
      x-schema-name: PackInvitationWithPackList
      description: List of Pack invitations with Pack metadata.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PackInvitationWithPack'
        nextPageToken:
          type: string
          nullable: true
          description: Token for fetching the next page of results
        nextPageLink:
          type: string
          format: url
          nullable: true
          description: URL for fetching the next page of results
    PackImageFile:
      x-schema-name: PackImageFile
      description: A Pack image file.
      type: object
      additionalProperties: false
      required:
        - filename
        - imageUrl
        - assetId
      properties:
        filename:
          type: string
          description: The name of the image file.
        imageUrl:
          type: string
          format: url
          description: The URL to the image file.
        assetId:
          type: string
          description: The asset id of the Pack's image.
        altText:
          type: string
          description: The alt text for the image.
        mimeType:
          type: string
          description: The media type of the image.
          example: image/jpeg
    PackAssetType:
      x-schema-name: PackAssetType
      type: string
      enum:
        - logo
        - cover
        - exampleImage
        - agentImage
      x-tsEnumNames:
        - Logo
        - Cover
        - ExampleImage
        - AgentImage
    PackAssetUploadInfo:
      x-schema-name: PackAssetUploadInfo
      description: >-
        Information indicating where to upload the Pack asset, and an endpoint
        to mark the upload as complete.
      type: object
      required:
        - uploadUrl
        - packAssetUploadedPathName
        - headers
      additionalProperties: false
      properties:
        uploadUrl:
          type: string
          format: url
          description: A signed URL to be used for uploading a Pack asset.
          example: >-
            https://coda-us-west-2-prod-blobs-upload.s3-accelerate.amazonaws.com/packs/123/assets/logo/e23fcb5e564f08b71183d424c2c380c0
        packAssetUploadedPathName:
          type: string
          description: An endpoint to mark the upload as complete.
          example: /packs/123/assets/e23fcb5e564f08b71183d424c2c380c0
        headers:
          type: object
          additionalProperties:
            type: string
          description: >-
            Key-value pairs of authorization headers to include in the upload
            request.
          example: '{"header1": "value1"}'
    PackConfigurationEntry:
      x-schema-name: PackConfigurationEntry
      description: >-
        Basic details about a configuration that can be used in conjunction with
        a pack
      type: object
      required:
        - configurationId
        - name
      additionalProperties: false
      properties:
        configurationId:
          type: string
        name:
          description: Name of the configuration
          type: string
        policy:
          type: object
          description: Policy associated with the configuration
          additionalProperties: true
    PackOrganizationAccessForDocs:
      x-schema-name: PackOrganizationAccessForDocs
      description: Describes restrictions that a user's organization has placed on a pack
      type: object
      required:
        - canRequestAccess
        - hasRequestedAccess
        - requiresConfiguration
      additionalProperties: false
      properties:
        canRequestAccess: &ref_146
          type: boolean
        hasRequestedAccess: &ref_147
          type: boolean
        requiresConfiguration: &ref_148
          type: boolean
        allowedConfigurations: &ref_149
          type: array
          items:
            $ref: '#/components/schemas/PackConfigurationEntry'
        allowedPackIds: &ref_150
          type: array
          items:
            type: number
        incompatibleDocPermissions:
          type: array
          items:
            $ref: '#/components/schemas/Permission'
        incompatibleDocOwner:
          $ref: '#/components/schemas/UserSummary'
        incompatibleDocFolder:
          $ref: '#/components/schemas/FolderReference'
        isDocOwner:
          type: boolean
    PackVersion:
      x-schema-name: PackVersion
      description: Details about a Pack version.
      type: object
      additionalProperties: false
      required:
        - packId
        - buildNotes
        - createdAt
        - creationUserLoginId
        - packVersion
      properties:
        packId:
          type: number
          description: ID of the Pack.
          example: 1003
        buildNotes:
          type: string
          description: Developer notes.
          example: Adding a new formula.
        createdAt:
          type: string
          format: date-time
          description: Timestamp for when the version was created.
          example: '2018-04-11T00:18:57.946Z'
        creationUserLoginId:
          type: string
          description: The login ID of creation user of the Pack version.
          example: api@coda.io
        releaseId:
          type: number
          description: The release number of the Pack version if it has one.
          example: 2
        packVersion:
          type: string
          description: The semantic format of the Pack version.
          example: 1.0.3
        sdkVersion:
          type: string
          description: What Packs SDK version was this version built on.
          example: 1.5.1
        source:
          $ref: '#/components/schemas/PackSource'
    PackVersionList:
      x-schema-name: PackVersionList
      description: List of Pack versions.
      type: object
      required:
        - items
        - creationUsers
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PackVersion'
        creationUsers:
          type: array
          items:
            $ref: '#/components/schemas/UserSummary'
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: https://coda.io/apis/v1/packs/1/versions?pageToken=xyz
    PackRelease:
      x-schema-name: PackRelease
      description: Details about a Pack release.
      type: object
      additionalProperties: false
      required:
        - packId
        - releaseId
        - releaseNotes
        - createdAt
        - packVersion
        - sdkVersion
      properties:
        packId:
          type: number
          description: ID of the Packs.
          example: 1003
        releaseNotes:
          type: string
          description: Developer notes.
          example: The first release.
        createdAt:
          type: string
          format: date-time
          description: Timestamp for when the release was created.
          example: '2018-04-11T00:18:57.946Z'
        releaseId:
          type: number
          description: The release number of the Pack version if it has one.
          example: 2
        packVersion:
          type: string
          description: The semantic format of the Pack version.
          example: 1.0.3
        sdkVersion:
          type: string
          description: What Packs SDK version was this version built on.
          example: 1.5.1
    PackReleaseList:
      x-schema-name: PackReleaseList
      description: List of Pack releases.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PackRelease'
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: https://coda.io/apis/v1/packs/1/releases?pageToken=xyz
    CreatePackReviewRequest:
      x-schema-name: CreatePackReviewRequest
      description: Request to create a pack review
      type: object
      additionalProperties: false
      properties:
        packVersion:
          type: string
          description: Pack version to review (for code reviews)
        releaseNotes:
          type: string
          maxLength: 8192
          description: >-
            Release notes for this version (used when pack is approved and
            released)
    CreatePackReviewResponse:
      x-schema-name: CreatePackReviewResponse
      description: Response containing created review information
      type: object
      required:
        - packReviewId
      additionalProperties: false
      properties:
        packReviewId:
          type: string
          format: uuid
          description: ID of the created review
    CancelPackReviewResponse:
      x-schema-name: CancelPackReviewResponse
      description: Response confirming the pack review was canceled
      type: object
      additionalProperties: false
      properties: {}
    PackReviewStatus:
      x-schema-name: PackReviewStatus
      description: The status of a pack review
      type: string
      enum:
        - pending
        - approved
        - denied
        - canceled
        - superseded
      x-tsEnumNames:
        - Pending
        - Approved
        - Denied
        - Canceled
        - Superseded
    PackReview:
      x-schema-name: PackReview
      description: A pack review submission
      type: object
      required:
        - packReviewId
        - packId
        - packReviewStatus
        - submittedByUserId
        - submissionTimestamp
      additionalProperties: false
      properties:
        packReviewId:
          type: string
          format: uuid
          description: ID of the review
        packId:
          type: integer
          description: ID of the pack being reviewed
        packVersion:
          type: string
          description: Pack version being reviewed (for code reviews)
        includesListingReview:
          type: boolean
          description: Whether listing info was included in the review scope
        packReviewStatus:
          $ref: '#/components/schemas/PackReviewStatus'
        submittedByUserId:
          type: integer
          description: User ID of the person who submitted the review
        submissionTimestamp:
          type: string
          format: date-time
          description: When the review was submitted
        additionalInformation:
          $ref: '#/components/schemas/PackReviewAdditionalInformation'
    PackReviewAdditionalInformation:
      x-schema-name: PackReviewAdditionalInformation
      description: Additional information about the pack review
      type: object
      additionalProperties: false
      properties:
        videoWalkthrough:
          type: string
          nullable: true
          description: URL or reference to video walkthrough for agent verification.
          maxLength: 512
        additionalDetails:
          type: string
          nullable: true
          description: Additional details for the pack review.
          maxLength: 8192
        privacyCollectsPersonalInfo:
          type: boolean
          nullable: true
          description: >-
            Whether the agent or third-party partners collect personal
            information.
        privacyPersonalInfoCategories:
          type: array
          nullable: true
          items:
            type: string
          description: Categories of personal information collected by the agent.
        privacyDataUsagePurposes:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Purposes for which collected data is used by the agent or
            third-party partners.
        privacyDataCollectedBy:
          type: array
          nullable: true
          items:
            type: string
          description: Whether data is collected by the developer, a third party, or both.
    ListPackReviewsResponse:
      x-schema-name: ListPackReviewsResponse
      description: Response containing pack reviews
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          description: List of pack reviews
          items:
            $ref: '#/components/schemas/PackReview'
        nextPageToken:
          type: string
          description: Token for fetching the next page of results
        nextPageLink:
          type: string
          format: url
          description: Link for fetching the next page of results
    PackListingDraftData:
      x-schema-name: PackListingDraftData
      description: Draft listing data for a Pack. All fields are optional.
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
          description: The name of the Pack.
          maxLength: 128
        description:
          type: string
          description: The full description of the Pack.
          maxLength: 8192
        shortDescription:
          type: string
          description: A short version of the description of the Pack.
          maxLength: 256
        logo:
          $ref: '#/components/schemas/PackImageFile'
        cover:
          $ref: '#/components/schemas/PackImageFile'
        exampleImages:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/PackImageFile'
        agentImages:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/PackImageFile'
        categoryIds:
          type: array
          items:
            type: string
        supportEmail:
          type: string
          nullable: true
          maxLength: 512
        termsOfServiceUrl:
          type: string
          format: url
          nullable: true
          maxLength: 512
        privacyPolicyUrl:
          type: string
          format: url
          nullable: true
          maxLength: 512
        sourceCodeVisibility:
          $ref: '#/components/schemas/PackSourceCodeVisibility'
        agentShortDescription:
          type: string
          nullable: true
          maxLength: 256
        agentDescription:
          type: string
          nullable: true
          maxLength: 8192
        additionalInformation:
          $ref: '#/components/schemas/PackListingAdditionalInformation'
    PackListingAdditionalInformation:
      x-schema-name: PackListingAdditionalInformation
      description: Additional information saved with the pack listing draft
      type: object
      additionalProperties: false
      properties:
        videoWalkthrough:
          type: string
          nullable: true
          description: URL or reference to video walkthrough for agent verification.
          maxLength: 512
        additionalDetails:
          type: string
          nullable: true
          description: Additional details for the pack review.
          maxLength: 8192
        privacyCollectsPersonalInfo:
          type: boolean
          nullable: true
          description: >-
            Whether the agent or third-party partners collect personal
            information.
        privacyPersonalInfoCategories:
          type: array
          nullable: true
          items:
            type: string
          description: Categories of personal information collected by the agent.
        privacyDataUsagePurposes:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Purposes for which collected data is used by the agent or
            third-party partners.
        privacyDataCollectedBy:
          type: array
          nullable: true
          items:
            type: string
          description: Whether data is collected by the developer, a third party, or both.
    GetPackListingDraftResponse:
      x-schema-name: GetPackListingDraftResponse
      description: Response containing the Pack listing draft
      type: object
      additionalProperties: false
      properties:
        packListingDraftId:
          type: string
          format: uuid
          description: ID of the listing draft
        listingData:
          $ref: '#/components/schemas/PackListingDraftData'
    UpsertPackListingDraftRequest:
      x-schema-name: UpsertPackListingDraftRequest
      description: Request to create or update a Pack listing draft
      type: object
      required:
        - listingData
      additionalProperties: false
      properties:
        listingData:
          $ref: '#/components/schemas/PackListingDraftData'
    UpsertPackListingDraftResponse:
      x-schema-name: UpsertPackListingDraftResponse
      description: Response containing the upserted Pack listing draft
      type: object
      required:
        - packListingDraftId
        - packId
        - listingData
      additionalProperties: false
      properties:
        packListingDraftId:
          type: string
          format: uuid
          description: ID of the listing draft
        packId:
          type: number
          description: ID of the Pack
        listingData:
          $ref: '#/components/schemas/PackListingDraftData'
    DeletePackListingDraftResponse:
      x-schema-name: DeletePackListingDraftResponse
      description: Response after deleting a Pack listing draft
      type: object
      additionalProperties: false
    PackSource:
      x-schema-name: PackSource
      type: string
      enum:
        - web
        - cli
      x-tsEnumNames:
        - Web
        - Cli
    PackSourceCodeUploadInfo:
      x-schema-name: PackSourceCodeUploadInfo
      description: >-
        Information indicating where to upload the Pack source code, and an
        endpoint to mark the upload as complete.
      type: object
      required:
        - uploadUrl
        - uploadedPathName
        - headers
      additionalProperties: false
      properties:
        uploadUrl:
          type: string
          format: url
          description: A signed URL to be used for uploading a Pack source code.
          example: >-
            https://coda-us-west-2-prod-packs-upload.s3-accelerate.amazonaws.com/packUploads/123/1/main.ts
        uploadedPathName:
          type: string
          description: An endpoint to mark the upload as complete.
          example: /packs/123/versions/1/sourceCode/uploadComplete
        headers:
          type: object
          additionalProperties:
            type: string
          description: >-
            Key-value pairs of authorization headers to include in the upload
            request.
          example: '{"header1": "value1"}'
    PackSourceCodeInfo:
      x-schema-name: PackSourceCodeInfo
      description: >-
        Information indicating where to upload the Pack source code, and an
        endpoint to mark the upload as complete.
      type: object
      required:
        - files
      additionalProperties: false
      properties:
        files:
          type: array
          items:
            $ref: '#/components/schemas/PackSourceCode'
    PackSourceCode:
      x-schema-name: PackSourceCode
      description: Details about a Pack's source code.
      type: object
      additionalProperties: false
      required:
        - filename
        - url
      properties:
        filename:
          type: string
          description: name of the file
          example: main.ts
        url:
          type: string
          description: The URL to download the source code from
          example: >-
            https://coda-us-west-2-prod-packs.s3.us-west-2.amazonaws.com/packs/123/1/main.ts
    PackDiscoverability:
      x-schema-name: PackDiscoverability
      description: Widest principal a Pack is available to.
      type: string
      enum:
        - public
        - nomosOrganization
        - group
        - grammarlyInstitution
        - workspace
        - private
      x-tsEnumNames:
        - Public
        - NomosOrganization
        - Group
        - GrammarlyInstitution
        - Workspace
        - Private
    PackListing:
      x-schema-name: PackListing
      description: A Pack listing.
      type: object
      additionalProperties: false
      required:
        - packId
        - packVersion
        - name
        - shortDescription
        - description
        - logoUrl
        - logo
        - externalMetadataUrl
        - categories
        - makers
        - sdkVersion
      properties:
        packId: &ref_117
          type: number
          description: ID of the Pack.
          example: 1003
        packVersion: &ref_118
          type: string
          description: The version of the Pack.
          example: 1.0.3
        releaseId: &ref_119
          type: number
          description: >-
            The current release number of the Pack if released, otherwise
            undefined.
          example: 2
        lastReleasedAt: &ref_120
          type: string
          format: date-time
          description: The timestamp of the latest release of this Pack.
          example: '2018-04-11T00:18:57.946Z'
        logoUrl: &ref_121
          type: string
          format: url
          description: The link to the logo of the Pack.
          deprecated: true
        logo: &ref_122
          $ref: '#/components/schemas/PackImageFile'
        coverUrl: &ref_123
          type: string
          format: url
          description: The link to the cover photo of the Pack.
          deprecated: true
        cover: &ref_124
          $ref: '#/components/schemas/PackImageFile'
        exampleImages: &ref_125
          type: array
          items:
            $ref: '#/components/schemas/PackImageFile'
          description: The example images for the Pack.
        agentImages: &ref_126
          type: array
          items:
            $ref: '#/components/schemas/PackImageFile'
          description: The agent images for the Pack.
        name: &ref_127
          type: string
          description: The name of the Pack.
          example: Cool Geometry Formulas
        description: &ref_128
          type: string
          description: The full description of the Pack.
          example: >-
            This Pack allows users to calculate the surface area and volume of a
            few common 3D shapes, like cubes and pyramids.
          maxLength: 8192
        shortDescription: &ref_129
          type: string
          description: A short version of the description of the Pack.
          example: Calculate cool geometric formulas like surface area.
        agentShortDescription: &ref_130
          type: string
          description: A short description for the pack as an agent.
          example: >-
            Chat with a tool that can calculate cool geometric formulas like
            surface area.
        agentDescription: &ref_131
          type: string
          description: A full description for the pack as an agent.
          example: >-
            Chat with a comprehensive tool that can calculate cool geometric
            formulas like surface area, volume, and other mathematical
            operations. This agent can help with complex calculations and
            provide detailed explanations.
        supportEmail: &ref_132
          type: string
          description: A contact email for the Pack.
          example: user@email.com
        termsOfServiceUrl: &ref_133
          type: string
          format: url
          description: A Terms of Service URL for the Pack.
        privacyPolicyUrl: &ref_134
          type: string
          format: url
          description: A Privacy Policy URL for the Pack.
        categories: &ref_135
          type: array
          description: Publishing Categories associated with this Pack.
          items:
            $ref: '#/components/schemas/PublishingCategory'
        makers: &ref_136
          type: array
          description: Makers associated with this Pack.
          items:
            $ref: '#/components/schemas/MakerSummary'
        certified: &ref_137
          type: boolean
          description: Denotes if the pack is certified by Coda.
        certifiedAgent: &ref_138
          type: boolean
          description: >-
            Denotes if the pack is certified by Grammarly to be optimized for
            agent usage.
        minimumFeatureSet: &ref_139
          $ref: '#/components/schemas/FeatureSet'
        unrestrictedFeatureSet: &ref_140
          $ref: '#/components/schemas/FeatureSet'
        externalMetadataUrl: &ref_141
          type: string
          description: >-
            The URL where complete metadata about the contents of the Pack
            version can be downloaded.
          example: https://codahosted.io/packs/12345/1.2.3/metadata/0c892064aa5cb.json
        standardPackPlan: &ref_142
          $ref: '#/components/schemas/StandardPackPlan'
        bundledPackPlan: &ref_143
          $ref: '#/components/schemas/BundledPackPlan'
        sourceCodeVisibility: &ref_144
          $ref: '#/components/schemas/PackSourceCodeVisibility'
        sdkVersion: &ref_145
          type: string
          description: What Packs SDK version was this version built on.
          example: 1.5.1
    PackListingDetail:
      x-schema-name: PackListingDetail
      description: A detailed Pack listing.
      type: object
      additionalProperties: false
      required:
        - packId
        - packVersion
        - name
        - shortDescription
        - description
        - logoUrl
        - logo
        - discoverability
        - categories
        - makers
        - userAccess
        - externalMetadataUrl
        - sdkVersion
      properties:
        packId: *ref_117
        packVersion: *ref_118
        releaseId: *ref_119
        lastReleasedAt: *ref_120
        logoUrl: *ref_121
        logo: *ref_122
        coverUrl: *ref_123
        cover: *ref_124
        exampleImages: *ref_125
        agentImages: *ref_126
        name: *ref_127
        description: *ref_128
        shortDescription: *ref_129
        agentShortDescription: *ref_130
        agentDescription: *ref_131
        supportEmail: *ref_132
        termsOfServiceUrl: *ref_133
        privacyPolicyUrl: *ref_134
        categories: *ref_135
        makers: *ref_136
        certified: *ref_137
        certifiedAgent: *ref_138
        minimumFeatureSet: *ref_139
        unrestrictedFeatureSet: *ref_140
        externalMetadataUrl: *ref_141
        standardPackPlan: *ref_142
        bundledPackPlan: *ref_143
        sourceCodeVisibility: *ref_144
        sdkVersion: *ref_145
        discoverability:
          $ref: '#/components/schemas/PackDiscoverability'
        userAccess:
          $ref: '#/components/schemas/PackUserAccess'
        codaHelpCenterUrl:
          type: string
          description: >-
            The URL of a Coda Help Center article with documentation about the
            Pack. This will only exist for select Coda-authored Packs.
        configuration:
          $ref: '#/components/schemas/PackConfigurationEntry'
    PackListingList:
      x-schema-name: PackListingList
      description: A list of Pack listings.
      type: object
      additionalProperties: false
      required:
        - items
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PackListing'
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: https://coda.io/apis/v1/packs/listings?pageToken=xyz
    PackSystemConnectionMetadata:
      x-schema-name: PackSystemConnectionMetadata
      description: Metadata of a Pack system connection.
      oneOf:
        - $ref: '#/components/schemas/PackConnectionHeaderMetadata'
        - $ref: '#/components/schemas/PackConnectionMultiHeaderMetadata'
        - $ref: '#/components/schemas/PackConnectionUrlParamMetadata'
        - $ref: '#/components/schemas/PackConnectionHttpBasicMetadata'
        - $ref: '#/components/schemas/PackConnectionCustomMetadata'
        - $ref: '#/components/schemas/PackConnectionOauth2ClientCredentialsMetadata'
        - $ref: '#/components/schemas/PackConnectionGoogleServiceAccountMetadata'
        - $ref: '#/components/schemas/PackConnectionAwsAssumeRoleMetadata'
        - $ref: '#/components/schemas/PackConnectionAwsAccessKeyMetadata'
      discriminator:
        propertyName: type
        mapping:
          header: '#/components/schemas/PackConnectionHeaderMetadata'
          multiHeader: '#/components/schemas/PackConnectionMultiHeaderMetadata'
          urlParam: '#/components/schemas/PackConnectionUrlParamMetadata'
          httpBasic: '#/components/schemas/PackConnectionHttpBasicMetadata'
          custom: '#/components/schemas/PackConnectionCustomMetadata'
          oauth2ClientCredentials: '#/components/schemas/PackConnectionOauth2ClientCredentialsMetadata'
          googleServiceAccount: '#/components/schemas/PackConnectionGoogleServiceAccountMetadata'
          awsAssumeRole: '#/components/schemas/PackConnectionAwsAssumeRoleMetadata'
          awsAccessKey: '#/components/schemas/PackConnectionAwsAccessKeyMetadata'
    PackUserAccess:
      x-schema-name: PackUserAccess
      type: object
      description: The access capabilities the current user has for this Pack.
      example: >-
        {"canEdit": false, "canTest": false, "canView": true, "canInstall":
        true}
      required:
        - canEdit
        - canTest
        - canView
        - canInstall
        - canPurchase
        - requiresTrial
        - canConnectAccount
      additionalProperties: false
      properties:
        canEdit:
          type: boolean
        canTest:
          type: boolean
        canView:
          type: boolean
        canInstall:
          type: boolean
        canPurchase:
          type: boolean
        requiresTrial:
          type: boolean
        canConnectAccount:
          type: boolean
        organization:
          oneOf:
            - $ref: '#/components/schemas/PackOrganizationAccessForDocs'
            - $ref: '#/components/schemas/PackOrganizationAccessForCodaBrain'
        ingestionLimitSettings:
          $ref: '#/components/schemas/IngestionLimitSettings'
    PackListingInstallContextType:
      x-schema-name: PackListingInstallContextType
      description: Type of context in which a Pack is being installed.
      type: string
      enum:
        - workspace
        - doc
      x-tsEnumNames:
        - Workspace
        - Doc
    IngestionPackReleaseChannel:
      x-schema-name: IngestionPackReleaseChannel
      description: Live or Latest version of pack
      type: string
      enum:
        - LIVE
        - LATEST
      x-tsEnumNames:
        - Live
        - Latest
    PackOauthConfigMetadata:
      x-schema-name: PackOauthConfigMetadata
      description: The Pack OAuth configuration metadata.
      type: object
      additionalProperties: false
      required:
        - maskedClientId
        - maskedClientSecret
        - authorizationUrl
        - tokenUrl
        - redirectUri
      properties:
        maskedClientId:
          type: string
          description: Masked OAuth client id. If not set, empty string will be returned.
        maskedClientSecret:
          type: string
          description: >-
            Masked OAuth client secret. If not set, empty string will be
            returned.
        authorizationUrl:
          type: string
          description: Authorization URL of the OAuth provider.
        tokenUrl:
          type: string
          description: Token URL of the OAuth provider.
        tokenPrefix:
          type: string
          description: Optional token prefix that's used to make the API request.
        scopes:
          type: string
          description: Optional scopes of the OAuth client.
        redirectUri:
          type: string
          description: Redirect URI of the Pack.
        useDynamicClientRegistration:
          type: boolean
          description: Whether this Pack uses Dynamic Client Registration for OAuth.
    PackOrganizationAccessForCodaBrain:
      x-schema-name: PackOrganizationAccessForCodaBrain
      description: >-
        Describes restrictions that a user's organization has placed on a pack
        for Coda Brain ingestions
      type: object
      required:
        - canRequestAccess
        - hasRequestedAccess
        - requiresConfiguration
      additionalProperties: false
      properties:
        canRequestAccess: *ref_146
        hasRequestedAccess: *ref_147
        requiresConfiguration: *ref_148
        allowedConfigurations: *ref_149
        allowedPackIds: *ref_150
    CreatePackRequest:
      x-schema-name: CreatePackRequest
      description: Payload for creating a Pack.
      type: object
      additionalProperties: false
      properties:
        workspaceId:
          type: string
          description: >-
            The parent workspace for the Pack. If unspecified, the user's
            default workspace will be used.
          example: ws-asdf
        name:
          type: string
          description: The name for the Pack.
          example: Trigonometry
        description:
          type: string
          description: A brief description of the Pack.
          example: Common trigonometric functions.
        sourcePackId:
          type: number
          description: The ID of the new Pack's source, if this new Pack was forked.
          nullable: true
          example: 10029
    CreatePackResponse:
      x-schema-name: CreatePackResponse
      description: Info about a Pack that was just created.
      type: object
      required:
        - packId
      additionalProperties: false
      properties:
        packId:
          type: number
          description: The ID assigned to the newly-created Pack.
          example: 123
    GetNextPackVersionRequest:
      x-schema-name: GetNextPackVersionRequest
      description: Payload for getting the next version of a Pack.
      type: object
      additionalProperties: false
      required:
        - proposedMetadata
      properties:
        proposedMetadata:
          type: string
          description: The metadata for the next version of the Pack.
          example: >-
            {"formulas": [{"description": "my formula", "name": "foo",
            "parameters": [], "resultType": 0}]}
        sdkVersion:
          type: string
          description: The SDK version the metadata was built on.
          example: 1.0.0
    PackConnectionType:
      x-schema-name: PackConnectionType
      description: Type of Pack connections.
      type: string
      enum:
        - header
        - multiHeader
        - urlParam
        - httpBasic
        - custom
        - oauth2ClientCredentials
        - googleServiceAccount
        - awsAssumeRole
        - awsAccessKey
      x-tsEnumNames:
        - Header
        - MultiHeader
        - UrlParam
        - HttpBasic
        - Custom
        - OAuth2ClientCredentials
        - GoogleServiceAccount
        - AwsAssumeRole
        - AwsAccessKey
    PackOAuth2ClientCredentialsLocation:
      x-schema-name: PackOAuth2ClientCredentialsLocation
      description: Location of including OAuth2 client credentials in a request.
      type: string
      enum:
        - automatic
        - body
        - header
      x-tsEnumNames:
        - Automatic
        - Body
        - Header
    PackSystemConnectionCredentials:
      x-schema-name: PackSystemConnectionCredentials
      description: Credentials of a Pack connection.
      oneOf:
        - $ref: '#/components/schemas/PackConnectionHeaderCredentials'
        - $ref: '#/components/schemas/PackConnectionMultiHeaderCredentials'
        - $ref: '#/components/schemas/PackConnectionUrlParamCredentials'
        - $ref: '#/components/schemas/PackConnectionHttpBasicCredentials'
        - $ref: '#/components/schemas/PackConnectionCustomCredentials'
        - $ref: '#/components/schemas/PackConnectionOauth2ClientCredentials'
        - $ref: '#/components/schemas/PackConnectionGoogleServiceAccountCredentials'
        - $ref: '#/components/schemas/PackConnectionAwsAssumeRoleCredentials'
        - $ref: '#/components/schemas/PackConnectionAwsAccessKeyCredentials'
      discriminator:
        propertyName: type
        mapping:
          header: '#/components/schemas/PackConnectionHeaderCredentials'
          multiHeader: '#/components/schemas/PackConnectionMultiHeaderCredentials'
          urlParam: '#/components/schemas/PackConnectionUrlParamCredentials'
          httpBasic: '#/components/schemas/PackConnectionHttpBasicCredentials'
          custom: '#/components/schemas/PackConnectionCustomCredentials'
          oauth2ClientCredentials: '#/components/schemas/PackConnectionOauth2ClientCredentials'
          googleServiceAccount: '#/components/schemas/PackConnectionGoogleServiceAccountCredentials'
          awsAssumeRole: '#/components/schemas/PackConnectionAwsAssumeRoleCredentials'
          awsAccessKey: '#/components/schemas/PackConnectionAwsAccessKeyCredentials'
    PackConnectionHeaderMetadata:
      x-schema-name: PackConnectionHeaderMetadata
      type: object
      required:
        - type
        - headerName
        - tokenPrefix
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - header
          x-tsType: PackConnectionType.Header
        maskedToken:
          type: string
        headerName:
          type: string
        tokenPrefix:
          type: string
    PackConnectionMultiHeaderMetadata:
      x-schema-name: PackConnectionMultiHeaderMetadata
      type: object
      required:
        - type
        - headers
        - presets
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - multiHeader
          x-tsType: PackConnectionType.MultiHeader
        headers:
          type: array
          items:
            type: object
            required:
              - headerName
              - maskedToken
            additionalProperties: false
            properties:
              headerName:
                type: string
              maskedToken:
                type: string
              tokenPrefix:
                type: string
        presets:
          type: array
          items:
            type: object
            required:
              - headerName
            additionalProperties: false
            properties:
              headerName:
                type: string
              tokenPrefix:
                type: string
    PackConnectionUrlParamMetadata:
      x-schema-name: PackConnectionUrlParamMetadata
      type: object
      required:
        - type
        - params
        - domain
        - presetKeys
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - urlParam
          x-tsType: PackConnectionType.UrlParam
        params:
          type: array
          items:
            type: object
            required:
              - key
              - maskedValue
            additionalProperties: false
            properties:
              key:
                type: string
              maskedValue:
                type: string
        domain:
          type: string
        presetKeys:
          type: array
          items:
            type: string
    PackConnectionHttpBasicMetadata:
      x-schema-name: PackConnectionHttpBasicMetadata
      type: object
      required:
        - type
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - httpBasic
          x-tsType: PackConnectionType.HttpBasic
        maskedUsername:
          type: string
        maskedPassword:
          type: string
    PackConnectionCustomMetadata:
      x-schema-name: PackConnectionCustomMetadata
      type: object
      required:
        - type
        - params
        - domain
        - presetKeys
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - custom
          x-tsType: PackConnectionType.Custom
        params:
          type: array
          description: An array of objects containing the parameter key and masked value.
          items:
            type: object
            required:
              - key
              - maskedValue
            additionalProperties: false
            properties:
              key:
                type: string
              maskedValue:
                type: string
        domain:
          type: string
          description: >-
            The domain corresponding to the pre-authorized network domain in the
            pack.
        presetKeys:
          type: array
          description: >-
            An array containing the keys of parameters specified by the
            authentication config.
          items:
            type: string
    PackConnectionOauth2ClientCredentialsMetadata:
      x-schema-name: PackConnectionOauth2ClientCredentialsMetadata
      type: object
      required:
        - type
        - location
        - maskedClientId
        - maskedClientSecret
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - oauth2ClientCredentials
          x-tsType: PackConnectionType.OAuth2ClientCredentials
        location:
          $ref: '#/components/schemas/PackOAuth2ClientCredentialsLocation'
        maskedClientId:
          type: string
        maskedClientSecret:
          type: string
    PackConnectionGoogleServiceAccountMetadata:
      x-schema-name: PackConnectionGoogleServiceAccountMetadata
      type: object
      required:
        - type
        - maskedServiceAccountKey
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - googleServiceAccount
          x-tsType: PackConnectionType.GoogleServiceAccount
        maskedServiceAccountKey:
          type: string
    PackConnectionAwsAssumeRoleMetadata:
      x-schema-name: PackConnectionAwsAssumeRoleMetadata
      type: object
      required:
        - type
        - service
        - roleArn
        - externalId
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - awsAssumeRole
          x-tsType: PackConnectionType.AwsAssumeRole
        service:
          type: string
        roleArn:
          type: string
        externalId:
          type: string
    PackConnectionAwsAccessKeyMetadata:
      x-schema-name: PackConnectionAwsAccessKeyMetadata
      type: object
      required:
        - type
        - service
        - maskedAccessKeyId
        - maskedSecretAccessKey
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - awsAccessKey
          x-tsType: PackConnectionType.AwsAccessKey
        service:
          type: string
        maskedAccessKeyId:
          type: string
        maskedSecretAccessKey:
          type: string
    PackConnectionHeaderCredentials:
      x-schema-name: PackConnectionHeaderCredentials
      type: object
      required:
        - type
        - token
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - header
          x-tsType: PackConnectionType.Header
        token:
          type: string
    PackConnectionMultiHeaderCredentials:
      x-schema-name: PackConnectionMultiHeaderCredentials
      type: object
      required:
        - type
        - tokens
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - multiHeader
          x-tsType: PackConnectionType.MultiHeader
        tokens:
          type: array
          items:
            type: object
            required:
              - key
              - value
            additionalProperties: false
            properties:
              key:
                type: string
              value:
                type: string
    PackConnectionUrlParamCredentials:
      x-schema-name: PackConnectionUrlParamCredentials
      type: object
      required:
        - type
        - params
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - urlParam
          x-tsType: PackConnectionType.UrlParam
        params:
          type: array
          items:
            type: object
            required:
              - key
              - value
            additionalProperties: false
            properties:
              key:
                type: string
              value:
                type: string
    PackConnectionHttpBasicCredentials:
      x-schema-name: PackConnectionHttpBasicCredentials
      type: object
      required:
        - type
        - username
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - httpBasic
          x-tsType: PackConnectionType.HttpBasic
        username:
          type: string
        password:
          type: string
          x-allow-empty: true
    PackConnectionCustomCredentials:
      x-schema-name: PackConnectionCustomCredentials
      type: object
      required:
        - type
        - params
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - custom
          x-tsType: PackConnectionType.Custom
        params:
          type: array
          items:
            type: object
            required:
              - key
              - value
            additionalProperties: false
            properties:
              key:
                type: string
              value:
                type: string
    PackConnectionOauth2ClientCredentials:
      x-schema-name: PackConnectionOauth2ClientCredentials
      type: object
      required:
        - type
        - clientId
        - clientSecret
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - oauth2ClientCredentials
          x-tsType: PackConnectionType.OAuth2ClientCredentials
        clientId:
          type: string
          maxLength: 512
        clientSecret:
          type: string
          maxLength: 512
    PackConnectionGoogleServiceAccountCredentials:
      x-schema-name: PackConnectionGoogleServiceAccountCredentials
      type: object
      required:
        - type
        - serviceAccountKey
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - googleServiceAccount
          x-tsType: PackConnectionType.GoogleServiceAccount
        serviceAccountKey:
          type: string
    PackConnectionAwsAssumeRoleCredentials:
      x-schema-name: PackConnectionAwsAssumeRoleCredentials
      type: object
      required:
        - type
        - roleArn
        - externalId
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - awsAssumeRole
          x-tsType: PackConnectionType.AwsAssumeRole
        roleArn:
          type: string
        externalId:
          type: string
    PackConnectionAwsAccessKeyCredentials:
      x-schema-name: PackConnectionAwsAccessKeyCredentials
      type: object
      required:
        - type
        - accessKeyId
        - secretAccessKey
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - awsAccessKey
          x-tsType: PackConnectionType.AwsAccessKey
        accessKeyId:
          type: string
        secretAccessKey:
          type: string
    PackConnectionHeaderPatch:
      x-schema-name: PackConnectionHeaderPatch
      type: object
      required:
        - type
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - header
          x-tsType: PackConnectionType.Header
        token:
          type: string
    PackConnectionMultiHeaderPatch:
      x-schema-name: PackConnectionMultiHeaderPatch
      type: object
      required:
        - type
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - multiHeader
          x-tsType: PackConnectionType.MultiHeader
        tokensToPatch:
          type: array
          items:
            type: object
            required:
              - key
              - value
            additionalProperties: false
            properties:
              key:
                type: string
              value:
                type: string
    PackConnectionUrlParamPatch:
      x-schema-name: PackConnectionUrlParamPatch
      type: object
      required:
        - type
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - urlParam
          x-tsType: PackConnectionType.UrlParam
        paramsToPatch:
          type: array
          items:
            type: object
            required:
              - key
              - value
            additionalProperties: false
            properties:
              key:
                type: string
              value:
                type: string
    PackConnectionHttpBasicPatch:
      x-schema-name: PackConnectionHttpBasicPatch
      type: object
      required:
        - type
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - httpBasic
          x-tsType: PackConnectionType.HttpBasic
        username:
          type: string
        password:
          type: string
          x-allow-empty: true
    GroupedPackLogsList:
      x-schema-name: GroupedPackLogsList
      description: List of grouped Pack logs.
      type: object
      required:
        - items
        - incompleteRelatedLogs
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/GroupedPackLog'
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: https://coda.io/apis/v1/packs/1/groupedLogs?pageToken=xyz
        incompleteRelatedLogs:
          type: boolean
          description: >-
            This flag will be set to true if the result doens't include all the
            related logs.
    IngestionBatchExecutionsList:
      x-schema-name: IngestionBatchExecutionsList
      description: List of Ingestion Batch Executions.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/IngestionBatchExecution'
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
    IngestionExecutionsList:
      x-schema-name: IngestionExecutionsList
      description: List of Ingestion Executions.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/IngestionExecutionContext'
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
    IngestionExecutionAttemptsList:
      x-schema-name: IngestionExecutionAttemptsList
      description: List of Ingestion Execution Attempts.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/IngestionExecutionAttempt'
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
    IngestionParentItemsList:
      x-schema-name: IngestionParentItemsList
      description: List of Ingestion Parent Items.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/IngestionParentItem'
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
    PackAgentRuntimeLogDetails:
      x-schema-name: PackAgentRuntimeLogDetails
      description: Details for pack agent runtime logs
      type: object
      required:
        - type
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - agentRuntime
          x-tsType: PackLogType.AgentRuntime
        input:
          type: string
          description: The input to the turn.
        output:
          type: string
          description: The output from the turn.
    PackFetcherLogDetails:
      x-schema-name: PackFetcherLogDetails
      description: Details for pack fetcher logs
      type: object
      required:
        - type
        - request
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - fetcher
          x-tsType: PackLogType.Fetcher
        request:
          type: string
        response:
          type: string
    PackInvocationLogDetails:
      x-schema-name: PackInvocationLogDetails
      description: Details for pack invocation logs
      type: object
      required:
        - type
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - invocation
          x-tsType: PackLogType.Invocation
        result:
          type: object
          required:
            - stringVal
            - int64Val
            - doubleVal
            - objectVal
            - boolVal
            - dateVal
          additionalProperties: false
          properties:
            stringVal:
              type: string
            int64Val:
              type: number
            doubleVal:
              type: number
            objectVal:
              type: string
            boolVal:
              type: boolean
            dateVal:
              type: number
        resultDetail:
          type: string
          description: Supplementary information about the result.
        continuationJson:
          type: string
          description: Only used by sync invocations.
        completionJson:
          type: string
          description: Only used by sync invocations.
        deletedItemIdsJson:
          type: string
          description: Only used by sync invocations.
        permissionsContextJson:
          type: string
          description: Only used by sync invocations.
    PackLogDetails:
      x-schema-name: PackLogDetails
      description: Details for a pack log.
      oneOf:
        - $ref: '#/components/schemas/PackFetcherLogDetails'
        - $ref: '#/components/schemas/PackInvocationLogDetails'
        - $ref: '#/components/schemas/PackAgentRuntimeLogDetails'
      discriminator:
        propertyName: type
        mapping:
          invocation: '#/components/schemas/PackInvocationLogDetails'
          fetcher: '#/components/schemas/PackFetcherLogDetails'
          agentRuntime: '#/components/schemas/PackAgentRuntimeLogDetails'
    PackConnectionCustomPatch:
      x-schema-name: PackConnectionCustomPatch
      type: object
      required:
        - type
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - custom
          x-tsType: PackConnectionType.Custom
        paramsToPatch:
          type: array
          items:
            type: object
            required:
              - key
              - value
            additionalProperties: false
            properties:
              key:
                type: string
              value:
                type: string
    PackConnectionOauth2ClientCredentialsPatch:
      x-schema-name: PackConnectionOauth2ClientCredentialsPatch
      type: object
      required:
        - type
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - oauth2ClientCredentials
          x-tsType: PackConnectionType.OAuth2ClientCredentials
        clientId:
          type: string
          maxLength: 512
        clientSecret:
          type: string
          maxLength: 512
    PackConnectionGoogleServiceAccountPatch:
      x-schema-name: PackConnectionGoogleServiceAccountPatch
      type: object
      required:
        - type
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - googleServiceAccount
          x-tsType: PackConnectionType.GoogleServiceAccount
        serviceAccountKey:
          type: string
          maxLength: 512
    PackConnectionAwsAssumeRolePatch:
      x-schema-name: PackConnectionAwsAssumeRolePatch
      type: object
      required:
        - type
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - awsAssumeRole
          x-tsType: PackConnectionType.AwsAssumeRole
        roleArn:
          type: string
        externalId:
          type: string
    PackConnectionAwsAccessKeyPatch:
      x-schema-name: PackConnectionAwsAccessKeyPatch
      type: object
      required:
        - type
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - awsAccessKey
          x-tsType: PackConnectionType.AwsAccessKey
        accessKeyId:
          type: string
        secretAccessKey:
          type: string
    PackLogsList:
      x-schema-name: PackLogsList
      description: List of Pack logs.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PackLog'
        nextPageToken:
          $ref: '#/components/schemas/nextPageToken'
        nextPageLink:
          allOf:
            - $ref: '#/components/schemas/nextPageLink'
            - type: string
              example: https://coda.io/apis/v1/packs/1/logs?pageToken=xyz
    GroupedPackLog:
      x-schema-name: GroupedPackLog
      description: A record of grouped Pack log.
      oneOf:
        - $ref: '#/components/schemas/GroupedPackInvocationLog'
        - $ref: '#/components/schemas/GroupedPackAuthLog'
      discriminator:
        propertyName: type
        mapping:
          invocation: '#/components/schemas/GroupedPackInvocationLog'
          auth: '#/components/schemas/GroupedPackAuthLog'
    PackLog:
      x-schema-name: PackLog
      description: A record of Pack log.
      oneOf:
        - $ref: '#/components/schemas/PackCustomLog'
        - $ref: '#/components/schemas/PackInvocationLog'
        - $ref: '#/components/schemas/PackFetcherLog'
        - $ref: '#/components/schemas/PackInternalLog'
        - $ref: '#/components/schemas/PackAuthLog'
        - $ref: '#/components/schemas/PackIngestionLifecycleLog'
        - $ref: '#/components/schemas/PackIngestionDebugLog'
        - $ref: '#/components/schemas/PackAgentRuntimeLog'
        - $ref: '#/components/schemas/PackMcpLog'
      discriminator:
        propertyName: type
        mapping:
          custom: '#/components/schemas/PackCustomLog'
          fetcher: '#/components/schemas/PackInvocationLog'
          invocation: '#/components/schemas/PackFetcherLog'
          internal: '#/components/schemas/PackInternalLog'
          auth: '#/components/schemas/PackAuthLog'
          ingestionLifecycle: '#/components/schemas/PackIngestionLifecycleLog'
          ingestionDebug: '#/components/schemas/PackIngestionDebugLog'
          agentRuntime: '#/components/schemas/PackAgentRuntimeLog'
          mcp: '#/components/schemas/PackMcpLog'
    PackLogContext:
      x-schema-name: PackLogContext
      description: Logging context that comes with a Pack log.
      type: object
      required:
        - logId
        - docId
        - createdAt
        - packId
        - packVersion
        - formulaName
        - userId
        - connectionId
        - requestId
        - requestType
        - detailsKey
      additionalProperties: false
      properties:
        docId:
          type: string
        packId:
          type: string
        packVersion:
          type: string
        formulaName:
          type: string
        userId:
          type: string
        connectionId:
          type: string
        connectionName:
          type: string
        requestId:
          type: string
          description: >
            A unique identifier of the Pack invocation that can be used to
            associate all log types generated in one call of a Pack formula.
        requestType:
          $ref: '#/components/schemas/PackLogRequestType'
        createdAt:
          type: string
          format: date-time
          description: Creation time of the log.
          example: '2018-04-11T00:18:57.946Z'
        logId:
          type: string
          description: Unique identifier of this log record.
        docObjectId:
          type: string
          description: Doc canvas object id where the formula was fired from.
        docRowId:
          type: string
          description: Doc canvas row id where the formula was fired from.
        docColumnId:
          type: string
          description: Doc canvas column id where the formula was fired from.
        isSyncTable:
          type: boolean
          description: >-
            True if this is a formula invocation loading a page of a sync table,
            or metadata for a sync table (like creating a dynamic schema).
        isContinuedSyncTable:
          type: boolean
          description: >-
            True if this is an execution of a sync table which received a
            pagination parameter.
        autocompleteParameterName:
          type: string
          description: >-
            If this formula invocation was for a parameter auto-complete, this
            names the parameter.
        invocationSource:
          type: string
          description: >-
            If this formula was invoked by something other than a user action,
            this should say what that was.
        detailsKey:
          type: string
          description: Key to be used in fetching log details.
        ingestionChildExecutionIndex:
          type: number
          description: Child execution id for this ingestion log.
        ingestionId:
          type: string
          description: Unique identifier of the ingestion that triggered this log.
        rootIngestionId:
          type: string
          description: Unique identifier of the root ingestion that triggered this log.
        ingestionExecutionId:
          type: string
          description: >-
            Unique identifier of the ingestion execution that triggered this
            log.
        ingestionStage:
          type: string
          description: Stage along the ingestion lifecycle that this log was created in.
        ingestionParentStage:
          type: string
          description: >-
            An ingestion lifecycle stage that this ingestion log is bundled
            under.
        ingestionExecutionAttempt:
          type: integer
          description: Execution attempt for this ingestion log.
        ingestionParentItemId:
          type: string
          description: Parent item id for this ingestion log.
        ingestionProcessId:
          type: string
          description: >-
            Unique identifier of the ingestion processing call that triggered
            this log.
        additionalMetadata:
          type: object
          description: Additional metadata for the ingestion log.
        agentSessionId:
          type: string
          description: Agent chat session id.
        agentInstanceId:
          type: string
          description: Agent instance id.
        executingAgentInstanceId:
          type: string
          description: Executing agent instance id.
    PackCustomLog:
      x-schema-name: PackCustomLog
      description: Pack log generated by developer's custom logging with context.logger.
      type: object
      required:
        - type
        - context
        - message
        - level
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - custom
          x-tsType: PackLogType.Custom
        context:
          $ref: '#/components/schemas/PackLogContext'
        message:
          type: string
          description: The message that's passed into context.logger.
          example: The formula is called!
        level:
          $ref: '#/components/schemas/LogLevel'
    PackInvocationLog:
      x-schema-name: PackInvocationLog
      description: System logs of the invocations of the Pack.
      type: object
      required:
        - type
        - context
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - invocation
          x-tsType: PackLogType.Invocation
        context:
          $ref: '#/components/schemas/PackLogContext'
        cacheHit:
          type: boolean
          description: True if the formula returned a prior result without executing.
        duration:
          type: number
          description: Duration of the formula exeuction in miliseconds.
        error:
          description: Error info if this invocation resulted in an error.
          type: object
          required:
            - message
          additionalProperties: false
          properties:
            message:
              type: string
            stack:
              type: string
    GroupedPackInvocationLog:
      x-schema-name: GroupedPackInvocationLog
      description: Grouped logs of the invocations of the Pack.
      type: object
      required:
        - type
        - invocationLog
        - relatedLogs
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - invocation
          x-tsType: PackLogType.Invocation
        invocationLog:
          $ref: '#/components/schemas/PackInvocationLog'
        relatedLogs:
          type: array
          items:
            $ref: '#/components/schemas/PackLog'
    GroupedPackAuthLog:
      x-schema-name: GroupedPackAuthLog
      description: Grouped logs of the Pack's auth requests.
      type: object
      required:
        - type
        - authLog
        - relatedLogs
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - auth
          x-tsType: PackLogType.Auth
        authLog:
          $ref: '#/components/schemas/PackAuthLog'
        relatedLogs:
          type: array
          items:
            $ref: '#/components/schemas/PackLog'
    PackAgentRuntimeLog:
      x-schema-name: PackAgentRuntimeLog
      description: Pack log generated by an executing agent runtime.
      type: object
      required:
        - type
        - context
        - turnType
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - agentRuntime
          x-tsType: PackLogType.AgentRuntime
        context:
          $ref: '#/components/schemas/PackLogContext'
        turnType:
          type: string
          description: The type of LLM agent turn that this log is for.
        durationMs:
          type: number
          description: The duration of the turn in milliseconds.
        name:
          type: string
          description: The name of the turn target.
        model:
          type: string
          description: The model used for the turn.
        tokenUsage:
          type: string
          description: The token usage for the turn.
        instructions:
          type: string
          description: The instructions for the turn.
        fromAgent:
          type: string
          description: The name of the agent that initiated the turn.
        toAgent:
          type: string
          description: The name of the agent that received the turn.
    PackMcpLog:
      x-schema-name: PackMcpLog
      description: Pack log generated by an MCP (Model Context Protocol) operation.
      type: object
      required:
        - type
        - context
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - mcp
          x-tsType: PackLogType.Mcp
        context:
          $ref: '#/components/schemas/PackLogContext'
        message:
          type: string
          description: A descriptive message about the MCP operation.
        error:
          description: Error info if this invocation resulted in an error.
          type: object
          required:
            - message
          additionalProperties: false
          properties:
            message:
              type: string
            stack:
              type: string
    PackFetcherLog:
      x-schema-name: PackFetcherLog
      description: System logs of Pack calls to context.fetcher.
      type: object
      required:
        - type
        - context
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - fetcher
          x-tsType: PackLogType.Fetcher
        context:
          $ref: '#/components/schemas/PackLogContext'
        requestSizeBytes:
          type: number
          description: The number of bytes in the HTTP request sent
        responseCode:
          type: number
        responseSizeBytes:
          type: number
          description: The number of bytes in the HTTP response received
        method:
          type: string
          enum:
            - GET
            - POST
            - PUT
            - DELETE
            - PATCH
            - HEAD
        baseUrl:
          type: string
          description: >-
            base URL of the fetcher request, with all query parameters stripped
            off.
          example: https://coda.io/api
        cacheHit:
          type: boolean
          description: >-
            true if the fetcher request hits catche instead of actually
            requesting the remote service.
        duration:
          description: Duration of the fetcher request in miliseconds.
          type: number
    PackInternalLog:
      x-schema-name: PackInternalLog
      description: >-
        Coda internal logs from the packs infrastructure. Only visible to
        Codans.
      type: object
      required:
        - type
        - context
        - message
        - level
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - internal
          x-tsType: PackLogType.Internal
        context:
          $ref: '#/components/schemas/PackLogContext'
        message:
          type: string
          description: The log message.
        level:
          $ref: '#/components/schemas/LogLevel'
    PackAuthLog:
      x-schema-name: PackAuthLog
      description: System logs of Pack authentication requests.
      type: object
      required:
        - type
        - context
        - path
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - auth
          x-tsType: PackLogType.Auth
        context:
          $ref: '#/components/schemas/PackLogContext'
        path:
          type: string
          description: The request path.
        errorMessage:
          type: string
          description: The error message.
        errorStack:
          type: string
          description: The error stacktrace (internal only).
    PackIngestionLifecycleLog:
      x-schema-name: PackIngestionLifecycleLog
      description: Pack log generated by an executing ingestion.
      type: object
      required:
        - type
        - context
        - message
        - level
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - ingestionLifecycle
          x-tsType: PackLogType.IngestionLifecycle
        context:
          $ref: '#/components/schemas/PackLogContext'
        message:
          type: string
          description: The message that's passed into context.logger.
          example: The formula is called!
        level:
          $ref: '#/components/schemas/LogLevel'
    PackIngestionDebugLog:
      x-schema-name: PackIngestionDebugLog
      description: >-
        Pack log generated by an executing ingestion. Contains metadata helpful
        for debugging
      type: object
      required:
        - type
        - context
        - message
        - level
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - ingestionDebug
          x-tsType: PackLogType.IngestionDebug
        context:
          $ref: '#/components/schemas/PackLogContext'
        message:
          type: string
          description: The message that's passed into context.logger.
          example: The formula is called!
        level:
          $ref: '#/components/schemas/LogLevel'
    PackLogRequestType:
      x-schema-name: PackLogRequestType
      description: The context request type where a Pack log is generated.
      type: string
      enum:
        - unknown
        - connectionNameMetadataRequest
        - parameterAutocompleteMetadataRequest
        - postAuthSetupMetadataRequest
        - propertyOptionsMetadataRequest
        - getSyncTableSchemaMetadataRequest
        - getDynamicSyncTableNameMetadataRequest
        - listSyncTableDynamicUrlsMetadataRequest
        - searchSyncTableDynamicUrlsMetadataRequest
        - getDynamicSyncTableDisplayUrlMetadataRequest
        - getIdentifiersForConnectionRequest
        - invokeFormulaRequest
        - invokeSyncFormulaRequest
        - invokeSyncUpdateFormulaRequest
        - invokeExecuteGetPermissionsRequest
        - validateParametersMetadataRequest
        - mcp
      x-tsEnumNames:
        - Unknown
        - ConnectionNameMetadataRequest
        - ParameterAutocompleteMetadataRequest
        - PostAuthSetupMetadataRequest
        - PropertyOptionsMetadataRequest
        - GetSyncTableSchemaMetadataRequest
        - GetDynamicSyncTableNameMetadataRequest
        - ListSyncTableDynamicUrlsMetadataRequest
        - SearchSyncTableDynamicUrlsMetadataRequest
        - GetDynamicSyncTableDisplayUrlMetadataRequest
        - ValidateParametersMetadataRequest
        - GetIdentifiersForConnectionRequest
        - InvokeFormulaRequest
        - InvokeSyncFormulaRequest
        - InvokeSyncUpdateFormulaRequest
        - InvokeExecuteGetPermissionsRequest
        - Mcp
    PackLogType:
      x-schema-name: PackLogType
      type: string
      enum:
        - custom
        - fetcher
        - invocation
        - internal
        - auth
        - ingestionLifecycle
        - ingestionDebug
        - agentRuntime
        - mcp
      x-tsEnumNames:
        - Custom
        - Fetcher
        - Invocation
        - Internal
        - Auth
        - IngestionLifecycle
        - IngestionDebug
        - AgentRuntime
        - Mcp
    LogLevel:
      x-schema-name: LogLevel
      type: string
      enum:
        - error
        - warn
        - info
        - debug
        - trace
        - unknown
      x-tsEnumNames:
        - Error
        - Warn
        - Info
        - Debug
        - Trace
        - Unknown
    FeatureSet:
      x-schema-name: FeatureSet
      deprecated: true
      description: Only relevant for original Coda packs.
      type: string
      enum:
        - Basic
        - Pro
        - Team
        - Enterprise
      x-tsEnumNames:
        - Basic
        - Pro
        - Team
        - Enterprise
    PaidFeatureSet:
      x-schema-name: PaidFeatureSet
      description: Workspace feature set excluding free.
      type: string
      enum:
        - Pro
        - Team
        - Enterprise
      x-tsEnumNames:
        - Pro
        - Team
        - Enterprise
    FeaturedDocStatus:
      x-schema-name: FeaturedDocStatus
      description: Status of featured doc in pack listing.
      type: string
      enum:
        - docInaccessibleOrDoesNotExist
        - invalidPublishedDocUrl
      x-tsEnumNames:
        - DocInaccessibleOrDoesNotExist
        - InvalidPublishedDocUrl
    PackFormulaIdentifier:
      x-schema-name: PackFormulaIdentifier
      type: object
      required:
        - name
        - type
      additionalProperties: false
      properties:
        name:
          type: string
          description: The Pack formula name.
          example: SquareRoot
        type:
          $ref: '#/components/schemas/PackFormulaType'
    PackFormulaType:
      x-schema-name: PackFormulaType
      type: string
      enum:
        - action
        - formula
        - sync
        - metadata
      x-tsEnumNames:
        - Action
        - Formula
        - Sync
        - Metadata
    PackSourceCodeVisibility:
      x-schema-name: PackSourceCodeVisibility
      description: Visibility of a pack's source code.
      type: string
      enum:
        - private
        - shared
      x-tsEnumNames:
        - Private
        - Shared
    PackPlanCurrency:
      x-schema-name: PackPlanCurrency
      description: Currency needed to subscribe to the Pack.
      type: string
      enum:
        - USD
      x-tsEnumNames:
        - Usd
    PackPlanPricingType:
      x-schema-name: PackPlanPricingType
      description: Type of pricing used to subscribe to a Pack.
      type: string
      enum:
        - Free
        - MonthlyDocMaker
        - BundledWithTier
      x-tsEnumNames:
        - Free
        - MonthlyDocMaker
        - BundledWithTier
    FreePackPlanPricing:
      x-schema-name: FreePackPlanPricing
      description: Pricing used when workspaces can subscribe to the Pack for free.
      type: object
      required:
        - type
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - Free
          x-tsType: PackPlanPricingType.Free
    MonthlyDocMakerPackPlanPricing:
      x-schema-name: MonthlyDocMakerPackPlanPricing
      description: >-
        Pricing used when workspaces can subscribe to the Pack for a monthly
        cost per Doc Maker.
      type: object
      required:
        - type
        - amount
        - currency
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - MonthlyDocMaker
          x-tsType: PackPlanPricingType.MonthlyDocMaker
        amount:
          type: number
          description: The monthly cost of the Pack per Doc Maker.
        currency:
          $ref: '#/components/schemas/PackPlanCurrency'
    BundledPackPlanPricing:
      x-schema-name: BundledPackPlanPricing
      description: >-
        Pricing used when workspaces have access to the Pack for free if their
        workspace is at least the given tier.
      type: object
      required:
        - type
        - minimumFeatureSet
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - BundledWithTier
          x-tsType: PackPlanPricingType.BundledWithTier
        minimumFeatureSet:
          $ref: '#/components/schemas/PaidFeatureSet'
    StandardPackPlan:
      x-schema-name: StandardPackPlan
      description: >-
        The Pack plan to show the Pack can be subscribed to at a monthly cost
        per Doc Maker or for free.
      type: object
      required:
        - packPlanId
        - packId
        - pricing
        - createdAt
      additionalProperties: false
      properties:
        packPlanId:
          type: string
        packId:
          type: number
        pricing:
          oneOf:
            - $ref: '#/components/schemas/FreePackPlanPricing'
            - $ref: '#/components/schemas/MonthlyDocMakerPackPlanPricing'
          description: Pricing to show how workspaces can subscribe to the Pack.
        createdAt:
          type: string
          format: date-time
          description: Timestamp for when the Pack plan was created.
          example: '2018-04-11T00:18:57.946Z'
    BundledPackPlan:
      x-schema-name: BundledPackPlan
      description: >-
        The Pack plan to show the Pack can be accessed if the workspace is at
        least the given tier.
      type: object
      required:
        - packPlanId
        - packId
        - pricing
        - createdAt
      additionalProperties: false
      properties:
        packPlanId:
          type: string
        packId:
          type: number
        pricing:
          $ref: '#/components/schemas/BundledPackPlanPricing'
        createdAt:
          type: string
          format: date-time
          description: Timestamp for when the Pack plan was created.
          example: '2018-04-11T00:18:57.946Z'
    PatchPackSystemConnectionRequest:
      x-schema-name: PatchPackSystemConnectionRequest
      description: The request to patch pack system connection credentials.
      oneOf:
        - $ref: '#/components/schemas/PackConnectionHeaderPatch'
        - $ref: '#/components/schemas/PackConnectionMultiHeaderPatch'
        - $ref: '#/components/schemas/PackConnectionUrlParamPatch'
        - $ref: '#/components/schemas/PackConnectionHttpBasicPatch'
        - $ref: '#/components/schemas/PackConnectionCustomPatch'
        - $ref: '#/components/schemas/PackConnectionOauth2ClientCredentialsPatch'
        - $ref: '#/components/schemas/PackConnectionGoogleServiceAccountPatch'
        - $ref: '#/components/schemas/PackConnectionAwsAssumeRolePatch'
        - $ref: '#/components/schemas/PackConnectionAwsAccessKeyPatch'
      discriminator:
        propertyName: type
        mapping:
          header: '#/components/schemas/PackConnectionHeaderPatch'
          multiHeader: '#/components/schemas/PackConnectionMultiHeaderPatch'
          urlParam: '#/components/schemas/PackConnectionUrlParamPatch'
          httpBasic: '#/components/schemas/PackConnectionHttpBasicPatch'
          custom: '#/components/schemas/PackConnectionCustomPatch'
          oauth2ClientCredentials: '#/components/schemas/PackConnectionOauth2ClientCredentialsPatch'
          googleServiceAccount: '#/components/schemas/PackConnectionGoogleServiceAccountPatch'
          awsAssumeRole: '#/components/schemas/PackConnectionAwsAssumeRolePatch'
          awsAccessKey: '#/components/schemas/PackConnectionAwsAccessKeyPatch'
    SetPackOauthConfigRequest:
      x-schema-name: SetPackOauthConfigRequest
      description: Request to set the Pack OAuth configuration.
      type: object
      additionalProperties: false
      properties:
        clientId:
          type: string
        clientSecret:
          type: string
        redirectUri:
          type: string
    SetPackSystemConnectionRequest:
      x-schema-name: SetPackSystemConnectionRequest
      description: The request to set pack system connection credentials.
      type: object
      additionalProperties: false
      required:
        - credentials
      properties:
        credentials:
          $ref: '#/components/schemas/PackSystemConnectionCredentials'
    RegisterPackVersionRequest:
      x-schema-name: RegisterPackVersionRequest
      description: Payload for registering a Pack version.
      type: object
      required:
        - bundleHash
      additionalProperties: false
      properties:
        bundleHash:
          type: string
          description: The SHA-256 hash of the file to be uploaded.
          example: f0e4c2f76c58916ec258f246851bea091d14d4247a2fc3e18694461b1816e13b
    UpdatePackRequest:
      x-schema-name: UpdatePackRequest
      description: Payload for updating a Pack.
      type: object
      additionalProperties: false
      properties:
        overallRateLimit:
          x-schema-name: PackRateLimit
          description: Rate limit in Pack settings.
          type: object
          additionalProperties: false
          required: *ref_151
          properties: *ref_152
          nullable: true
        perConnectionRateLimit:
          x-schema-name: PackRateLimit
          description: Rate limit in Pack settings.
          type: object
          additionalProperties: false
          required: *ref_151
          properties: *ref_152
          nullable: true
        logo:
          x-schema-name: ImageFileForUpdatePackRequest
          description: Information about an image file for an update Pack request.
          type: object
          additionalProperties: false
          required: &ref_153
            - assetId
            - filename
          properties: &ref_154
            assetId:
              type: string
              description: >-
                The asset id of the Pack's image, returned by
                [`#PackAssetUploadComplete`](#operation/packAssetUploadComplete)
                endpoint.
            filename:
              type: string
              description: The filename for the image.
            mimeType:
              type: string
              description: The media type of the image being sent.
              example: image/jpeg
          nullable: true
        cover:
          x-schema-name: ImageFileForUpdatePackRequest
          description: Information about an image file for an update Pack request.
          type: object
          additionalProperties: false
          required: *ref_153
          properties: *ref_154
          nullable: true
        exampleImages:
          type: array
          description: The example images for the Pack.
          nullable: true
          items:
            $ref: '#/components/schemas/ImageFileForUpdatePackRequest'
        agentImages:
          type: array
          description: The agent images for the Pack.
          nullable: true
          items:
            $ref: '#/components/schemas/ImageFileForUpdatePackRequest'
        sourceCodeVisibility:
          $ref: '#/components/schemas/PackSourceCodeVisibility'
          nullable: true
        packEntrypoints:
          type: array
          description: Pack entrypoints where this pack is available
          nullable: true
          minItems: 1
          items:
            $ref: '#/components/schemas/PackEntrypoint'
        name: *ref_109
        description: *ref_110
        shortDescription: *ref_111
        agentShortDescription: *ref_112
        agentDescription: *ref_113
        supportEmail: *ref_114
        termsOfServiceUrl: *ref_115
        privacyPolicyUrl: *ref_116
    ImageFileForUpdatePackRequest:
      x-schema-name: ImageFileForUpdatePackRequest
      description: Information about an image file for an update Pack request.
      type: object
      additionalProperties: false
      required: *ref_153
      properties: *ref_154
    CreatePackVersionResponse:
      x-schema-name: CreatePackVersionResponse
      description: Confirmation of successful Pack version creation.
      type: object
      additionalProperties: false
      properties:
        deprecationWarnings:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    DeletePackResponse:
      x-schema-name: DeletePackResponse
      description: Confirmation of successful Pack deletion.
      type: object
      additionalProperties: false
      properties: {}
    ListPackMakersResponse:
      x-schema-name: ListPackMakersResponse
      description: Confirmation of successfully retrieving Pack makers.
      type: object
      required:
        - makers
      additionalProperties: false
      properties:
        makers:
          type: array
          items:
            $ref: '#/components/schemas/Maker'
    AddPackMakerRequest:
      x-schema-name: AddPackMakerRequest
      description: Payload for adding a Pack maker.
      type: object
      required:
        - loginId
      additionalProperties: false
      properties:
        loginId:
          type: string
          description: The email of the Pack maker.
          example: api@coda.io
    AddPackMakerResponse:
      x-schema-name: AddPackMakerResponse
      description: Confirmation of successfully adding a Pack maker.
      type: object
      additionalProperties: false
      properties: {}
    DeletePackMakerResponse:
      x-schema-name: AddPackMakerResponse
      description: Confirmation of successfully deleting a Pack maker.
      type: object
      additionalProperties: false
      properties: {}
    ListPackCategoriesResponse:
      x-schema-name: ListPackCategoriesResponse
      description: Confirmation of successfully retrieving Pack categories.
      type: object
      required:
        - categories
      additionalProperties: false
      properties:
        categories:
          type: array
          description: The names of categories associated with a Pack.
          items:
            $ref: '#/components/schemas/PublishingCategory'
    AddPackCategoryRequest:
      x-schema-name: AddPackCategoryRequest
      description: Payload for adding a Pack Category.
      type: object
      required:
        - categoryName
      additionalProperties: false
      properties:
        categoryName:
          type: string
          description: Name of the publishing category.
          example: Project management
    AddPackCategoryResponse:
      x-schema-name: AddPackCategoryResponse
      description: Confirmation of successfully adding a Pack category.
      type: object
      additionalProperties: false
      properties: {}
    DeletePackCategoryResponse:
      x-schema-name: DeletePackCategoryResponse
      description: Confirmation of successfully deleting a Pack category.
      type: object
      additionalProperties: false
      properties: {}
    AddPackPermissionRequest:
      x-schema-name: AddPackPermissionRequest
      description: Payload for upserting a Pack permission.
      type: object
      required:
        - access
        - principal
      additionalProperties: false
      properties:
        principal:
          $ref: '#/components/schemas/PackPrincipal'
        access:
          $ref: '#/components/schemas/PackAccessType'
    AddPackPermissionResponse:
      x-schema-name: AddPackPermissionResponse
      description: Confirmation of successfully upserting a Pack permission.
      type: object
      required:
        - permissionId
      additionalProperties: false
      properties:
        permissionId:
          type: string
          description: The ID of the permission created or updated.
    DeletePackPermissionResponse:
      x-schema-name: DeletePackPermissionResponse
      description: Confirmation of successfully deleting a Pack permission.
      type: object
      additionalProperties: false
      properties: {}
    DeleteUserPackPermissionsResponse:
      x-schema-name: DeleteUserPackPermissionsResponse
      description: Confirmation of successfully deleting a user's permissions for a Pack.
      type: object
      additionalProperties: false
      properties: {}
    CreatePackInvitationRequest:
      x-schema-name: CreatePackInvitationRequest
      description: Payload for creating a Pack invitation.
      type: object
      required:
        - access
        - email
      additionalProperties: false
      properties:
        email:
          type: string
          description: Email address of the user to invite
          example: user@example.com
        access:
          $ref: '#/components/schemas/PackAccessType'
    CreatePackInvitationResponse:
      x-schema-name: CreatePackInvitationResponse
      description: Confirmation of successfully creating a Pack invitation.
      type: object
      required:
        - invitationId
      additionalProperties: false
      properties:
        invitationId:
          type: string
          description: The ID of the invitation created.
          example: 550e8400-e29b-41d4-a716-446655440000
    HandlePackInvitationRequest:
      x-schema-name: HandlePackInvitationRequest
      description: Payload for handling a Pack invitation (accept or reject).
      type: object
      required:
        - accept
      additionalProperties: false
      properties:
        accept:
          type: boolean
          description: True to accept the invitation, false to reject it
    HandlePackInvitationResponse:
      x-schema-name: HandlePackInvitationResponse
      description: Confirmation of successfully handling a Pack invitation.
      type: object
      additionalProperties: false
      properties:
        permissionId:
          type: string
          description: >-
            The ID of the permission that was created. Only returned when
            accepting the invitation.
    UpdatePackInvitationRequest:
      x-schema-name: UpdatePackInvitationRequest
      description: Payload for updating a Pack invitation.
      type: object
      required:
        - access
      additionalProperties: false
      properties:
        access:
          $ref: '#/components/schemas/PackAccessType'
    UpdatePackInvitationResponse:
      x-schema-name: UpdatePackInvitationResponse
      description: Confirmation of successfully updating a Pack invitation.
      type: object
      additionalProperties: false
      properties: {}
    DeletePackInvitationResponse:
      x-schema-name: DeletePackInvitationResponse
      description: Confirmation of successfully deleting a Pack invitation.
      type: object
      additionalProperties: false
      properties: {}
    UploadPackAssetRequest:
      x-schema-name: UploadPackAssetRequest
      description: Payload for a Pack asset upload.
      type: object
      additionalProperties: false
      required:
        - packAssetType
        - filename
        - mimeType
        - imageHash
      properties:
        packAssetType:
          $ref: '#/components/schemas/PackAssetType'
        imageHash:
          type: string
          description: The SHA-256 hash of the image to be uploaded.
          example: f0e4c2f76c58916ec258f246851bea091d14d4247a2fc3e18694461b1816e13b
        mimeType:
          type: string
          description: The media type of the image being sent.
          example: image/jpeg
        filename:
          type: string
          example: image.jpg
    PackAssetUploadCompleteRequest:
      x-schema-name: PackAssetUploadCompleteRequest
      description: Payload for noting a Pack asset upload is complete.
      type: object
      additionalProperties: false
      required:
        - packAssetType
      properties:
        packAssetType:
          $ref: '#/components/schemas/PackAssetType'
    PackAssetUploadCompleteResponse:
      x-schema-name: PackAssetUploadCompleteResponse
      description: Response for noting a Pack asset upload is complete.
      type: object
      additionalProperties: false
      required:
        - requestId
        - assetId
      properties:
        requestId:
          type: string
          description: An arbitrary unique identifier for this request.
          example: abc-123-def-456
        assetId:
          type: string
          description: An identifier of this uploaded asset.
          example: e23fcb5e564f08b71183d424c2c380c0
    PackSourceCodeUploadCompleteRequest:
      x-schema-name: PackSourceCodeUploadCompleteRequest
      description: Payload for noting a Pack source code upload is complete.
      type: object
      additionalProperties: false
      required:
        - filename
        - codeHash
      properties:
        filename:
          type: string
          example: main.ts
        codeHash:
          type: string
          example: 123456
          description: >-
            A SHA-256 hash of the source code used to identify duplicate
            uploads.
    PackSourceCodeUploadCompleteResponse:
      x-schema-name: PackSourceCodeUploadCompleteResponse
      description: Response for noting a Pack source code upload is complete.
      type: object
      additionalProperties: false
      required:
        - requestId
      properties:
        requestId:
          type: string
          description: An arbitrary unique identifier for this request.
          example: abc-123-def-456
    CreatePackVersionRequest:
      x-schema-name: CreatePackVersionRequest
      description: Payload for Pack version upload complete.
      type: object
      additionalProperties: false
      properties:
        notes:
          type: string
          description: Developer notes of the new Pack version.
          example: Adding a new formula HelloWorld.
        source:
          $ref: '#/components/schemas/PackSource'
        allowOlderSdkVersion:
          type: boolean
          description: >-
            Bypass Coda's protection against SDK version regression when
            multiple makers build versions.
    CreatePackReleaseRequest:
      x-schema-name: CreatePackReleaseRequest
      description: Payload for creating a new Pack release.
      type: object
      required:
        - packVersion
      additionalProperties: false
      properties:
        packVersion:
          type: string
          description: Which semantic pack version that the release will be created on.
          example: 1.0.0
        releaseNotes:
          type: string
          description: Developers notes.
          example: The first release.
    UpdatePackReleaseRequest:
      x-schema-name: UpdatePackReleaseRequest
      description: Payload for updating a new Pack release.
      type: object
      additionalProperties: false
      properties:
        releaseNotes:
          type: string
          description: >-
            Notes about key features or changes in this release that the Pack
            maker wants to communicate to users.
          example: The first release.
    UploadPackSourceCodeRequest:
      x-schema-name: UploadPackSourceCodeRequest
      description: Payload for a Pack asset upload.
      type: object
      additionalProperties: false
      required:
        - filename
        - payloadHash
      properties:
        payloadHash:
          type: string
          description: The SHA-256 hash of the image to be uploaded.
          example: f0e4c2f76c58916ec258f246851bea091d14d4247a2fc3e18694461b1816e13b
        filename:
          type: string
          example: main.ts
        packVersion:
          type: string
          example: 1.0.0
    NextPackVersionInfo:
      x-schema-name: NextPackVersionInfo
      description: Information indicating the next Pack version definition.
      type: object
      required:
        - nextVersion
        - findings
        - findingDetails
      additionalProperties: false
      properties:
        nextVersion:
          type: string
          description: The next valid version for the Pack.
          example: 2.1.0
        findings:
          type: array
          deprecated: true
          items:
            type: string
          description: List of changes from the previous version.
        findingDetails:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - finding
              - path
            properties:
              finding:
                type: string
              path:
                type: string
    PackVersionDiffs:
      x-schema-name: PackVersionDiffs
      description: Info about the diff between two Pack versions.
      type: object
      required:
        - findings
        - findingDetails
      additionalProperties: false
      properties:
        findings:
          type: array
          deprecated: true
          items:
            type: string
          description: List of changes from the previous version to the next version.
        findingDetails:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - finding
              - path
            properties:
              finding:
                type: string
              path:
                type: string
    PackFeaturedDoc:
      x-schema-name: PackFeaturedDoc
      description: A Pack's featured doc.
      type: object
      required:
        - doc
        - isPinned
      additionalProperties: false
      properties:
        doc:
          $ref: '#/components/schemas/DocReference'
        isPinned:
          type: boolean
          description: Whether or not this featured doc is pinned.
        docStatus:
          $ref: '#/components/schemas/FeaturedDocStatus'
        publishedUrl:
          type: string
          format: url
          description: The URL of the published doc, if available.
    PackFeaturedDocRequestItem:
      x-schema-name: PackFeaturedDocRequestItem
      description: >-
        Item representing a featured doc in the update Pack featured docs
        request.
      type: object
      required:
        - url
      additionalProperties: false
      properties:
        url:
          type: string
          description: A URL to a doc.
        isPinned:
          type: boolean
          description: Whether or not the current doc should be pinned.
    UpdatePackFeaturedDocsRequest:
      x-schema-name: UpdatePackFeaturedDocsRequest
      description: Payload for updating featured docs for a Pack.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          maxItems: 5
          uniqueItems: true
          description: A list of docs to set as the featured docs for a Pack.
          items:
            $ref: '#/components/schemas/PackFeaturedDocRequestItem'
    UpdatePackFeaturedDocsResponse:
      x-schema-name: UpdatePackFeaturedDocsResponse
      description: Confirmation of successful Pack featured docs update.
      type: object
      additionalProperties: false
      properties: {}
    PackFeaturedDocsResponse:
      x-schema-name: PackFeaturedDocsResponse
      description: List of a Pack's featured docs.
      type: object
      required:
        - items
      additionalProperties: false
      properties:
        items:
          type: array
          description: A list of featured docs for the Pack.
          items:
            $ref: '#/components/schemas/PackFeaturedDoc'
    GetPackConfigurationJsonSchemaResponse:
      x-schema-name: GetPackConfigurationJsonSchemaResponse
      description: JSON schema response.
      type: object
      additionalProperties: true
    IngestionBatchExecution:
      x-schema-name: IngestionBatchExecution
      description: An ingestion batch execution.
      type: object
      required:
        - completionTimestamp
        - creationTimestamp
        - errorMessage
        - executionType
        - fullExecutionId
        - ingestionExecutionId
        - ingestionId
        - ingestionName
        - ingestionStatuses
        - startTimestamp
      additionalProperties: false
      properties:
        completionTimestamp:
          type: number
          description: >-
            Completion time of the ingestion batch execution in seconds since
            epoch.
        creationTimestamp:
          type: number
          description: >-
            Creation time of the ingestion batch execution in seconds since
            epoch.
        dynamicLabel:
          type: string
          description: The label of the dynamic URL of the ingestion, if any.
        dynamicUrl:
          type: string
          description: The dynamic URL of the ingestion.
        executionType:
          $ref: '#/components/schemas/IngestionExecutionType'
        fullExecutionId:
          type: string
          description: The ID of the full ingestion execution.
        ingestionExecutionId:
          type: string
          description: The ID of the ingestion batch execution.
        ingestionId:
          type: string
          description: The ID of the ingestion.
        ingestionName:
          type: string
          description: The name of the ingestion.
        ingestionStatusCounts:
          type: object
          additionalProperties:
            type: integer
          description: >-
            Histogram of IngestionStatus of child executions (even if there's
            only 1, non-crawled execution) as enum values.
          example:
            COMPLETED: 12
            FAILED: 5
            STARTED: 4
        lastFinishedFullWorkflowExecutionId:
          type: string
          format: uuid
          description: The ID of the last full workflow execution that finished.
        lastFinishedIncrementalWorkflowExecutionId:
          type: string
          format: uuid
          description: The ID of the last incremental workflow execution that finished.
        latestFullWorkflowExecutionId:
          type: string
          format: uuid
          description: The ID of the latest full workflow execution.
        latestIncrementalWorkflowExecutionId:
          type: string
          format: uuid
          description: The ID of the latest incremental workflow execution.
        latestIngestionSequenceId:
          type: string
          format: uuid
          description: The ID of the latest full execution.
        liveIngestionSequenceId:
          type: string
          format: uuid
          description: The ID of the full execution that generated the currently live data.
        parentSyncTableIngestionId:
          type: string
          description: The ID of the parent sync tableingestion, if any.
        startTimestamp:
          type: number
          description: Start time of the ingestion batch execution in seconds since epoch.
        totalRowCount:
          type: number
          description: The total number of rows processed in the ingestion batch execution.
    IngestionExecutionContext:
      x-schema-name: IngestionExecutionContext
      description: Context that comes with a ingestion execution.
      type: object
      required:
        - csbIngestionId
        - csbIngestionExecutionId
        - ingestionName
        - creationTimestamp
        - parentItemId
        - startTimestamp
        - completionTimestamp
        - nextEligibleTimestamp
        - nextEligibleIncrementalTimestamp
        - attemptNumber
        - ingestionStatus
        - executionType
        - errorMessage
      additionalProperties: false
      properties:
        ingestionName:
          type: string
          nullable: true
        csbIngestionId:
          type: string
        csbIngestionExecutionId:
          type: string
        creationTimestamp:
          type: number
          description: Creation time of the ingestion execution in seconds since epoch.
        parentItemId:
          type: string
          nullable: true
        startTimestamp:
          type: number
          description: Start time of the ingestion execution in seconds since epoch.
          nullable: true
        completionTimestamp:
          type: number
          description: Completion time of the ingestion execution in seconds since epoch.
          nullable: true
        nextEligibleTimestamp:
          type: number
          description: Next eligible time for the ingestion to run in seconds since epoch.
          nullable: true
        nextEligibleIncrementalTimestamp:
          type: number
          description: >-
            Next eligible time for the ingestion to run incrementally in seconds
            since epoch.
          nullable: true
        attemptNumber:
          type: number
          description: The attempt number of the ingestion execution.
        ingestionStatus:
          $ref: '#/components/schemas/IngestionStatus'
        executionType:
          $ref: '#/components/schemas/IngestionExecutionType'
        errorMessage:
          type: string
          nullable: true
        totalRowCount:
          type: string
          description: The total number of rows processed in the ingestion execution.
        latestCheckpointTimestamp:
          type: number
          description: The timestamp of the latest checkpoint of the ingestion execution.
    IngestionExecutionAttempt:
      x-schema-name: IngestionExecutionAttempt
      description: An attempt of an ingestion execution.
      type: object
      required:
        - csbIngestionExecutionId
        - attemptNumber
        - startTimestamp
        - completionTimestamp
        - errorMessage
        - message
      additionalProperties: false
      properties:
        csbIngestionExecutionId:
          type: string
          description: The ID of the ingestion execution.
        attemptNumber:
          type: number
          description: The attempt number of the ingestion execution attempt.
        ingestionStatus:
          $ref: '#/components/schemas/IngestionStatus'
        startTimestamp:
          type: number
          description: >-
            The start time of the ingestion execution attempt in seconds since
            epoch.
          nullable: true
        completionTimestamp:
          type: number
          description: >-
            The completion time of the ingestion execution attempt in seconds
            since epoch.
          nullable: true
        errorMessage:
          type: string
          description: The error message of the ingestion execution attempt.
          nullable: true
        rowCountInAttempt:
          type: string
          description: >-
            The total number of rows processed in the ingestion execution
            attempt.
          nullable: true
        latestCheckpointTimestamp:
          type: number
          description: >-
            The timestamp of the latest checkpoint of the ingestion execution
            attempt.
          nullable: true
    IngestionParentItem:
      x-schema-name: IngestionParentItem
      description: >-
        An ingestion parent item and its execution state (either full or
        incremental).
      type: object
      required:
        - completionTimestamp
        - creationTimestamp
        - errorMessage
        - executionType
        - ingestionExecutionId
        - ingestionName
        - parentItemId
        - startTimestamp
      additionalProperties: false
      properties:
        attemptNumber:
          type: number
          description: The attempt number of the ingestion child execution.
        completionTimestamp:
          type: number
          description: >-
            Completion time of the ingestion child execution in seconds since
            epoch.
        errorMessage:
          type: string
          nullable: true
        executionType:
          $ref: '#/components/schemas/IngestionChildExecutionType'
        ingestionChildExecutionIndex:
          type: number
          description: Current execution index for this parent item's child execution.
        ingestionExecutionId:
          type: string
          description: The ID of the ingestion child execution.
        ingestionName:
          type: string
          description: The name of the ingestion child execution.
        ingestionStatus:
          $ref: '#/components/schemas/IngestionStatus'
        parentItemId:
          type: string
          description: The ID of the parent item.
        startTimestamp:
          type: number
          description: Start time of the ingestion child execution in seconds since epoch.
        rowCount:
          type: number
          description: >-
            The number of rows processed so far in the current ingestion child
            execution.
        latestCheckpointTimestamp:
          type: number
          description: >-
            The timestamp of the latest checkpoint of the ingestion child
            execution.
    IngestionStatus:
      x-schema-name: IngestionStatus
      description: Status of the ingestion execution.
      type: string
      enum:
        - QUEUED
        - STARTED
        - CANCELLED
        - UP_FOR_RETRY
        - COMPLETED
        - FAILED
      x-tsEnumNames:
        - Queued
        - Started
        - Cancelled
        - UpForRetry
        - Completed
        - Failed
    IngestionExecutionType:
      x-schema-name: IngestionExecutionType
      description: Type of an ingestion batch execution.
      type: string
      enum:
        - FULL
        - INCREMENTAL
      x-tsEnumNames:
        - Full
        - Incremental
    IngestionChildExecutionType:
      x-schema-name: IngestionChildExecutionType
      description: Type of an ingestion childexecution.
      type: string
      enum:
        - FULL
        - INCREMENTAL
        - PATCH
      x-tsEnumNames:
        - Full
        - Incremental
        - Patch
    IngestionLimitSettings:
      x-schema-name: IngestionLimitSettings
      description: Limits for a pack-driven ingestion
      type: object
      additionalProperties: false
      required:
        - maxBytesPerSyncTableDefault
        - allowedTablesCount
      properties:
        tableSettings:
          type: object
          description: >
            Map from table name to per table settings. This may not include
            every table in the pack. Each setting per table will include an
            optional maxBytesPerSyncTableOverride that will override the
            default, an optional excludeIngestionByDefault flag, and an optional
            parameterLimits dictionary of allowed parameter values.
          additionalProperties:
            $ref: '#/components/schemas/IngestionTableSetting'
        maxBytesPerSyncTableDefault:
          type: number
          description: >-
            The default bytes limit when ingesting data for a table in the pack.
            null means no limit.
          nullable: true
        allowedTablesCount:
          type: number
          description: >-
            The maximum number of tables that can be included. -1 means no
            limit.
    IngestionTableSetting:
      x-schema-name: IngestionTableSetting
      description: Ingestion settings for a specific table
      type: object
      additionalProperties: false
      properties:
        maxBytesPerSyncTableOverride:
          type: number
          description: >-
            The bytes limit when ingesting data for this table. null means no
            limit.
          nullable: true
        excludeIngestionByDefault:
          type: boolean
          description: Whether to exclude this table from ingestions by default.
        parameterLimits:
          type: object
          description: Limits for allowed parameter values.
          additionalProperties:
            $ref: '#/components/schemas/ParameterSetting'
    ParameterSetting:
      x-schema-name: ParameterSetting
      description: Setting for a specific parameter
      type: object
      additionalProperties: false
      required:
        - default
        - allowed
      properties:
        default:
          type: string
          description: Default value for the parameter
        allowed:
          type: array
          items:
            type: string
    AddGoLinkRequest:
      x-schema-name: AddGoLinkRequest
      description: Payload for creating a Go Link
      type: object
      required:
        - name
        - destinationUrl
      additionalProperties: false
      properties:
        name:
          type: string
          description: >-
            The name of the Go Link that comes after go/. Only alphanumeric
            characters, dashes, and underscores are allowed.
          maxLength: 128
          pattern: ^[a-zA-Z0-9\-_]+$
        destinationUrl:
          type: string
          description: The URL that the Go Link redirects to.
          maxLength: 2048
        description:
          type: string
          description: Optional description for the Go Link.
          maxLength: 512
        urlPattern:
          type: string
          nullable: true
          description: >-
            Optional destination URL with {*} placeholders for variables to be
            inserted. Variables are specified like go/<name>/<var1>/<var2>.
          example: https://example.com/{*}/{*}
          maxLength: 2048
        creatorEmail:
          type: string
          nullable: true
          description: >-
            Optional creator email for the Go Link. Only organization admins can
            set this field.
          example: foo@bar.com
          maxLength: 512
    AddGoLinkResult:
      x-schema-name: AddGoLinkResult
      description: The result of adding a Go Link.
      type: object
      additionalProperties: false
      properties: {}
  parameters:
    limit:
      name: limit
      description: Maximum number of results to return in this query.
      in: query
      example: 10
      schema:
        type: integer
        minimum: 1
        default: 25
    pageContentLimit:
      name: limit
      description: Maximum number of content items to return in this query.
      in: query
      example: 50
      schema:
        type: integer
        minimum: 1
        maximum: 500
        default: 50
    pageToken:
      name: pageToken
      description: An opaque token used to fetch the next page of results.
      in: query
      example: eyJsaW1pd
      schema:
        type: string
    contentFormat:
      name: contentFormat
      description: The format to return content in. Defaults to plainText.
      in: query
      example: plainText
      schema:
        type: string
        enum:
          - plainText
        default: plainText
    syncToken:
      name: syncToken
      description: >
        An opaque token returned from a previous call that can be used to return
        results that are relevant to the query since the call where the
        syncToken was generated.
      in: query
      example: eyJsaW1pd
      schema:
        type: string
    docId:
      name: docId
      description: ID of the doc.
      in: path
      required: true
      example: AbCDeFGH
      schema:
        type: string
    docIds:
      name: docIds
      description: List of docIds to fetch.
      in: query
      explode: false
      schema:
        type: array
        items:
          type: string
    query:
      name: query
      description: Search term used to filter down results.
      in: query
      example: Supercalifragilisticexpialidocious
      schema:
        type: string
    permissionId:
      name: permissionId
      description: ID of a permission on a doc.
      in: path
      required: true
      example: AbCDeFGH
      schema:
        type: string
    pageIdOrName:
      name: pageIdOrName
      description: >
        ID or name of the page. Names are discouraged because they're easily
        prone to being changed by users. If you're using a name, be sure to
        URI-encode it. If you provide a name and there are multiple pages with
        the same name, an arbitrary one will be selected.
      x-sdk-description: >
        ID or name of the page. Names are discouraged because they're easily
        prone to being changed by users. Note that if you're using a name and
        there are multiple pages with the same name, an arbitrary one will be
        returned.
      in: path
      required: true
      example: canvas-IjkLmnO
      schema:
        type: string
    tableIdOrName:
      name: tableIdOrName
      description: >-
        ID or name of the table. Names are discouraged because they're easily
        prone to being changed by users. If you're using a name, be sure to
        URI-encode it.
      x-sdk-description: >-
        ID or name of the table. Names are discouraged because they're easily
        prone to being changed by users.
      in: path
      required: true
      example: grid-pqRst-U
      schema:
        type: string
    viewIdOrName:
      name: viewIdOrName
      description: >-
        ID or name of the view. Names are discouraged because they're easily
        prone to being changed by users. If you're using a name, be sure to
        URI-encode it.
      x-sdk-description: >-
        ID or name of the view. Names are discouraged because they're easily
        prone to being changed by users.
      in: path
      required: true
      example: table-pqRst-U
      schema:
        type: string
    columnIdOrName:
      name: columnIdOrName
      description: >-
        ID or name of the column. Names are discouraged because they're easily
        prone to being changed by users. If you're using a name, be sure to
        URI-encode it.
      x-sdk-description: >-
        ID or name of the column. Names are discouraged because they're easily
        prone to being changed by users.
      in: path
      required: true
      example: c-tuVwxYz
      schema:
        type: string
    rowIdOrName:
      name: rowIdOrName
      description: >
        ID or name of the row. Names are discouraged because they're easily
        prone to being changed by users. If you're using a name, be sure to
        URI-encode it. If there are multiple rows with the same value in the
        identifying column, an arbitrary one will be selected.
      x-sdk-description: >
        ID or name of the row. Names are discouraged because they're easily
        prone to being changed by users. Note that if there are multiple rows
        with the same value in the identifying column, an arbitrary one will be
        returned.
      in: path
      required: true
      example: i-tuVwxYz
      schema:
        type: string
    formulaIdOrName:
      name: formulaIdOrName
      description: >-
        ID or name of the formula. Names are discouraged because they're easily
        prone to being changed by users. If you're using a name, be sure to
        URI-encode it.
      x-sdk-description: >-
        ID or name of the formula. Names are discouraged because they're easily
        prone to being changed by users.
      in: path
      required: true
      example: f-fgHijkLm
      schema:
        type: string
    controlIdOrName:
      name: controlIdOrName
      description: >-
        ID or name of the control. Names are discouraged because they're easily
        prone to being changed by users. If you're using a name, be sure to
        URI-encode it.
      x-sdk-description: >-
        ID or name of the control. Names are discouraged because they're easily
        prone to being changed by users.
      in: path
      required: true
      example: ctrl-cDefGhij
      schema:
        type: string
    useColumnNames:
      name: useColumnNames
      description: >
        Use column names instead of column IDs in the returned output. This is
        generally discouraged as it is fragile. If columns are renamed, code
        using original names may throw errors.
      in: query
      example: true
      schema:
        type: boolean
    sortBy:
      name: sortBy
      description: Determines how to sort the given objects.
      in: query
      example: name
      schema:
        $ref: '#/components/schemas/SortBy'
    requestId:
      name: requestId
      description: ID of the request.
      in: path
      required: true
      example: abc-123-def-456
      schema:
        type: string
    ruleId:
      name: ruleId
      description: ID of the automation rule.
      in: path
      required: true
      example: grid-auto-b3Jmey6jBS
      schema:
        type: string
    tableTypes:
      name: tableTypes
      description: >-
        Comma-separated list of table types to include in results. If omitted,
        includes both tables and views.
      in: query
      explode: false
      example: table,view
      schema:
        type: array
        items:
          $ref: '#/components/schemas/TableType'
    workspaceId:
      name: workspaceId
      description: ID of the workspace.
      in: path
      required: true
      example: ws-1Ab234
      schema: &ref_155
        type: string
    workspaceIdInQuery:
      name: workspaceId
      description: ID of the workspace.
      in: query
      required: false
      example: ws-1Ab234
      schema: *ref_155
    includedRoles:
      name: includedRoles
      description: >-
        Show only members that have the included roles specified in a
        comma-separated list.
      in: query
      explode: false
      example: Editor,DocMaker
      schema:
        type: array
        items:
          $ref: '#/components/schemas/WorkspaceUserRole'
    packId:
      name: packId
      description: ID of a Pack
      in: path
      required: true
      example: 123
      schema:
        type: integer
        minimum: 1
    invitationId:
      name: invitationId
      description: ID of a Pack invitation
      in: path
      required: true
      example: 550e8400-e29b-41d4-a716-446655440000
      schema:
        type: string
        format: uuid
    loginId:
      name: loginId
      description: Email of a Coda user.
      in: path
      required: true
      example: api@coda.io
      schema:
        type: string
    categoryName:
      name: categoryName
      description: Name of a publishing category
      in: path
      required: true
      example: Project management
      schema:
        type: string
    packVersion:
      name: packVersion
      description: Semantic version of a Pack
      in: path
      required: true
      example: 1.2.3
      schema: &ref_156
        type: string
    basePackVersion:
      name: basePackVersion
      description: Semantic version of the previous Pack version.
      in: path
      required: true
      example: 1.2.3
      schema: *ref_156
    targetPackVersion:
      name: targetPackVersion
      description: Semantic version of the new Pack version.
      in: path
      required: true
      example: 1.2.3
      schema: *ref_156
    packAssetId:
      name: packAssetId
      description: Unique identifier for a Pack asset.
      in: path
      required: true
      schema:
        type: string
    packAssetType:
      name: packAssetType
      description: Pack asset type.
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/PackAssetType'
    packAccessTypes:
      name: packAccessTypes
      description: Pack access types.
      in: query
      explode: false
      schema:
        $ref: '#/components/schemas/PackAccessTypes'
    packIds:
      name: packIds
      description: Which Pack IDs to fetch.
      in: query
      explode: false
      schema:
        type: array
        items:
          type: integer
    excludePublicPacks:
      name: excludePublicPacks
      description: Only get Packs shared with users/workspaces, not publicly.
      in: query
      schema:
        type: boolean
    excludeWorkspaceAcls:
      name: excludeWorkspaceAcls
      description: Do not include Packs that are only shared with workspaces.
      in: query
      schema:
        type: boolean
    excludeIndividualAcls:
      name: excludeIndividualAcls
      description: Do not include Packs that are only shared with the user individually.
      in: query
      schema:
        type: boolean
    packEntrypoint:
      name: packEntrypoint
      description: >-
        Entrypoint for which this pack call is being made. Used to filter non
        relevant packs
      in: query
      schema:
        $ref: '#/components/schemas/PackEntrypoint'
    certifiedAgentsOnly:
      name: certifiedAgentsOnly
      description: >
        Only include Packs that are certified for agent use. Depending on server
        configuration, may also include Packs that the user is an admin of.
      in: query
      schema:
        type: boolean
        default: false
    onlyWorkspaceId:
      name: onlyWorkspaceId
      description: >-
        Use only this workspace (not all of a user's workspaces) to check for
        Packs shared via workspace ACL.
      in: query
      schema:
        type: string
    parentWorkspaceIds:
      name: parentWorkspaceIds
      description: Filter to only Packs whose parent workspace is one of the given IDs.
      in: query
      explode: false
      schema:
        type: array
        items:
          type: string
    direction:
      name: direction
      description: Direction to sort results in.
      in: query
      schema:
        $ref: '#/components/schemas/SortDirection'
    isPublished:
      name: isPublished
      description: Limit results to only published items.
      in: query
      schema:
        type: boolean
    isOwner:
      name: isOwner
      in: query
      description: Show only docs owned by the user.
      schema:
        type: boolean
    sinceDate:
      name: sinceDate
      description: Limit results to activity on or after this date.
      in: query
      example: '2020-08-01'
      schema:
        type: string
        format: date
    untilDate:
      name: untilDate
      description: Limit results to activity on or before this date.
      in: query
      example: '2020-08-05'
      schema:
        type: string
        format: date
    scale:
      name: scale
      description: Quantization period over which to view analytics. Defaults to daily.
      in: query
      example: daily
      schema:
        $ref: '#/components/schemas/AnalyticsScale'
    docAnalyticsOrderBy:
      name: orderBy
      in: query
      description: Use this parameter to order the doc analytics returned.
      schema:
        $ref: '#/components/schemas/DocAnalyticsOrderBy'
    packAnalyticsOrderBy:
      name: orderBy
      in: query
      description: Use this parameter to order the Pack analytics returned.
      schema:
        $ref: '#/components/schemas/PackAnalyticsOrderBy'
    packFormulaAnalyticsOrderBy:
      name: orderBy
      in: query
      description: Use this parameter to order the Pack formula analytics returned.
      schema:
        $ref: '#/components/schemas/PackFormulaAnalyticsOrderBy'
    customDocDomain:
      name: customDocDomain
      description: A custom domain for a published doc.
      in: path
      required: true
      schema:
        type: string
    isPublishedNoDefault:
      name: isPublished
      description: >
        Limit results to only published items. If false or unspecified, returns
        all items including published ones.
      in: query
      schema:
        type: boolean
        x-no-default: true
    packReleaseId:
      name: packReleaseId
      description: ID of a Pack release
      in: path
      required: true
      example: 2
      schema:
        type: integer
        minimum: 1
    rootIngestionId:
      name: rootIngestionId
      description: ID of the root ingestion.
      in: path
      required: true
      example: a4e293c4-4a85-45a4-b2ba-7f305cba2703
      schema:
        type: string
        format: uuid
    ingestionExecutionId:
      name: ingestionExecutionId
      description: ID of the ingestion execution.
      in: query
      required: false
      example: a4e293c4-4a85-45a4-b2ba-7f305cba2703
      schema:
        type: string
        format: uuid
    organizationId:
      name: organizationId
      description: ID of the organization.
      in: path
      required: true
      example: org-LxmbD9y2EU
      schema:
        type: string
    tenantId:
      name: tenantId
      description: ID of the tenant.
      in: path
      required: true
      example: org-LxmbD9y2EU
      schema:
        type: string
    folderId:
      name: folderId
      description: ID of the folder.
      in: path
      required: true
      example: fl-1Ab234
      schema:
        type: string
    agentInstanceId:
      name: agentInstanceId
      description: ID of the agent instance.
      in: path
      required: true
      example: a4e293c4-4a85-45a4-b2ba-7f305cba2703
      schema:
        type: string
        format: uuid
    agentSessionId:
      name: agentSessionId
      description: ID of the agent chat session.
      in: query
      required: false
      example: a4e293c4-4a85-45a4-b2ba-7f305cba2703
      schema:
        type: string
        format: uuid
  responses:
    BadRequestError:
      description: The request parameters did not conform to expectations.
      content:
        application/json:
          schema:
            description: An HTTP error resulting from an unsuccessful request.
            required: &ref_157
              - statusCode
              - statusMessage
              - message
            additionalProperties: false
            properties:
              statusCode:
                type: number
                description: HTTP status code of the error.
                example: 400
              statusMessage:
                type: string
                description: HTTP status message of the error.
                example: Bad Request
              message:
                type: string
                description: >-
                  Any additional context on the error, or the same as
                  `statusMessage` otherwise.
                example: Bad Request
    BadRequestWithValidationErrors:
      description: The request parameters did not conform to expectations.
      content:
        application/json:
          schema:
            description: An HTTP error resulting from an unsuccessful request.
            required: *ref_157
            additionalProperties: false
            properties:
              statusCode:
                type: number
                description: HTTP status code of the error.
                example: 400
              statusMessage:
                type: string
                description: HTTP status message of the error.
                example: Bad Request
              message:
                type: string
                description: >-
                  Any additional context on the error, or the same as
                  `statusMessage` otherwise.
                example: Bad Request
              codaDetail:
                type: object
                description: Detail about why this request was rejected.
                additionalProperties: false
                properties:
                  validationErrors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ValidationError'
    UnauthorizedError:
      description: The API token is invalid or has expired.
      content:
        application/json:
          schema:
            description: An HTTP error resulting from an unsuccessful request.
            required: *ref_157
            additionalProperties: false
            properties:
              statusCode:
                type: number
                description: HTTP status code of the error.
                example: 401
              statusMessage:
                type: string
                description: HTTP status message of the error.
                example: Unauthorized
              message:
                type: string
                description: >-
                  Any additional context on the error, or the same as
                  `statusMessage` otherwise.
                example: Unauthorized
    ForbiddenError:
      description: The API token does not grant access to this resource.
      content:
        application/json:
          schema:
            description: An HTTP error resulting from an unsuccessful request.
            required: *ref_157
            additionalProperties: false
            properties:
              statusCode:
                type: number
                description: HTTP status code of the error.
                example: 403
              statusMessage:
                type: string
                description: HTTP status message of the error.
                example: Forbidden
              message:
                type: string
                description: >-
                  Any additional context on the error, or the same as
                  `statusMessage` otherwise.
                example: Forbidden
    NotFoundError:
      description: The resource could not be located with the current API token.
      content:
        application/json:
          schema:
            description: An HTTP error resulting from an unsuccessful request.
            required: *ref_157
            additionalProperties: false
            properties:
              statusCode:
                type: number
                description: HTTP status code of the error.
                example: 404
              statusMessage:
                type: string
                description: HTTP status message of the error.
                example: Not Found
              message:
                type: string
                description: >-
                  Any additional context on the error, or the same as
                  `statusMessage` otherwise.
                example: Not Found
    GoneError:
      description: The resource has been deleted.
      content:
        application/json:
          schema:
            description: An HTTP error resulting from an unsuccessful request.
            required: *ref_157
            additionalProperties: false
            properties:
              statusCode:
                type: number
                description: HTTP status code of the error.
                example: 410
              statusMessage:
                type: string
                description: HTTP status message of the error.
                example: Gone
              message:
                type: string
                description: >-
                  Any additional context on the error, or the same as
                  `statusMessage` otherwise.
                example: Gone
    UnprocessableEntityError:
      description: Unable to process the request.
      content:
        application/json:
          schema:
            description: An HTTP error resulting from an unsuccessful request.
            required: *ref_157
            additionalProperties: false
            properties:
              statusCode:
                type: number
                description: HTTP status code of the error.
                example: 422
              statusMessage:
                type: string
                description: HTTP status message of the error.
                example: Unprocessable Entity
              message:
                type: string
                description: >-
                  Any additional context on the error, or the same as
                  `statusMessage` otherwise.
                example: Unprocessable Entity
    TooManyRequestsError:
      description: The client has sent too many requests.
      content:
        application/json:
          schema:
            description: An HTTP error resulting from an unsuccessful request.
            required: *ref_157
            additionalProperties: false
            properties:
              statusCode:
                type: number
                description: HTTP status code of the error.
                example: 429
              statusMessage:
                type: string
                description: HTTP status message of the error.
                example: Too Many Requests
              message:
                type: string
                description: >-
                  Any additional context on the error, or the same as
                  `statusMessage` otherwise.
                example: Too Many Requests
  securitySchemes:
    Bearer:
      description: >
        The Coda API can be accessed using an API token, which can be obtained
        from [*My account*](https://coda.io/account)

        in Coda. This token should be specified by setting a header as follows.


        ```Authorization: Bearer <api_token>```


        Keep your token safe, as anyone who gets access to it can access your
        account. Once a token is created

        it cannot be viewed or modified, so don't lose it.


        If you're logged into Coda, you can also query the API directly using
        your browser. Note that only GET

        endpoints are supported; for anything else, you'll have to use Bearer
        authentication.


        ### Restricting token authorization


        By default, bearer tokens created for the Coda API can perform any
        action that the user who created the token

        can perform. However, Coda API bearer tokens can also be created with
        restrictions. These restrictions

        can limit what objects can be operated on and the types of operations
        that can be performed.


        #### Operation types


        The table below describes the types of authorization restrictions that
        can be placed on a Coda API token.

        <table>
          <tr><th>Restriction</th><th>Description</th><th>Allowed HTTP Methods</th></tr>
          <tr>
            <td>Read access</td>
            <td>Allows access to API methods that read the state of an object</td>
            <td>GET</td>
          </tr>
          <tr>
            <td>Write access</td>
            <td>Allows access to API methods that write the state of an object</td>
            <td>POST, PUT, DELETE</td>
          </tr>
          <tr>
            <td>Read and write access</td>
            <td>Allows access to all methods for an object</td>
            <td>All</td>
          </tr>
        </table>


        #### Object types


        Coda API tokens can be restricted to the following types of objects.


        * Documents: Restricts access to only allow API calls for
        `/docs/${DOC_ID}`

        * Tables: Restricts access to only allow API calls for
        `/docs/${DOC_ID}/tables/${TABLE_ID}`


        #### Special cases


        There are a few special case methods that violate the above
        restrictions.


        * `/whoami`: This method can be called by all Coda API tokens.

        * `/resolveBrowserLink`: This method can be called by all Coda API
        tokens, but will only return a result

        if the token has access (read or write) to the object referenced by the
        URL.


        #### Feedback


        This feature is under development and we'd love to hear your feedback
        and bug reports. Please

        visit us at the [Developers
        Central](https://community.coda.io/c/developers-central) forum within

        the Coda Community.
      type: http
      scheme: bearer
      bearerFormat: UUID
security:
  - Bearer: []