{
  "opencollection": "1.0.0",
  "info": {
    "name": "Telnyx Access Tokens Documents API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all document links",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/document_links",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Consolidated filter parameter for document links (deepObject style). Originally: filter[linked_record_type], filter[linked_resource_id]"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]"
              }
            ]
          },
          "docs": "List all documents links ordered by created_at descending."
        },
        {
          "info": {
            "name": "List all documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/documents",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Consolidated filter parameter for documents (deepObject style). Originally: filter[filename][contains], filter[customer_reference][eq], filter[customer_reference][in][], filter[created_at][gt], filter[created_at][lt]"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Consolidated sort parameter for documents (deepObject style). Originally: sort[]"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]"
              }
            ]
          },
          "docs": "List all documents ordered by created_at descending."
        },
        {
          "info": {
            "name": "Upload a document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/documents",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Upload a document.<br /><br />Uploaded files must be linked to a service within 30 minutes or they will be automatically deleted."
        },
        {
          "info": {
            "name": "Retrieve a document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/documents/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ]
          },
          "docs": "Retrieve a document."
        },
        {
          "info": {
            "name": "Update a document",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/documents/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a document."
        },
        {
          "info": {
            "name": "Delete a document",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/documents/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ]
          },
          "docs": "Delete a document.<br /><br />A document can only be deleted if it's not linked to a service. If it is linked to a service, it must be unlinked prior to deleting."
        },
        {
          "info": {
            "name": "Download a document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/documents/:id/download",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ]
          },
          "docs": "Download a document."
        },
        {
          "info": {
            "name": "Generate a temporary download link for a document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/documents/:id/download_link",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the document"
              }
            ]
          },
          "docs": "Generates a temporary pre-signed URL that can be used to download the document directly from the storage backend without authentication."
        }
      ]
    }
  ],
  "bundled": true
}