DocuSign Folder::listItems API 的输出不包括信封

Question

我正在使用 Laravel 7 并添加了 DocuSign PHP SDK 和 Laravel 包装器：

public function getFolderItems($folderId)
{
    $folderApi = new FoldersApi($this->apiClient);
    return $folderApi->listItems($this->accountId, $folderId);
}

比如我调用这个方法获取Draft文件夹中的信封。结果是：

{
    "endPosition": "0",
    "folders": [
        {
            "folderId": "...",
            "hasSubFolders": "false",
            "itemCount": "1",
            "name": "Draft",
            "owner": {
                "email": "...@gmail.com",
                "userId": "...",
                "userName": "P. K."
            },
            "subFolderCount": "0",
            "type": "draft",
            "uri": "/folders/..."
        }
    ],
    "resultSetSize": "1",
    "startPosition": "0",
    "totalSetSize": "1"
}

注：此结果中的部分数据隐藏为...。

但是正如我们在 this link (DocuSign REST API) 上看到的那样，响应应该是这样的：

{
  "resultSetSize": "sample string 1",
  "startPosition": "sample string 2",
  "endPosition": "sample string 3",
  "totalSetSize": "sample string 4",
  "previousUri": "sample string 5",
  "nextUri": "sample string 6",
  "folderItems": [
    {
      "ownerName": "sample string 1",
      "envelopeId": "sample string 2",
      "envelopeUri": "sample string 3",
      "status": "sample string 4",
      "senderName": "sample string 5",
      "senderEmail": "sample string 6",
      "createdDateTime": "sample string 7",
      "sentDateTime": "sample string 8",
      "completedDateTime": "sample string 9",
      "subject": "sample string 10",
      "templateId": "sample string 11",
      "name": "sample string 12",
      "shared": "sample string 13",
      "password": "sample string 14",
      "description": "sample string 15",
      "lastModified": "sample string 16",
      "pageCount": 17,
      "uri": "sample string 18",
      "is21CFRPart11": "sample string 19",
      "isSignatureProviderEnvelope": "sample string 20",
      "customFields": [
        {
          "fieldId": "sample string 1",
          "name": "sample string 2",
          "show": "sample string 3",
          "required": "sample string 4",
          "value": "sample string 5",
          "configurationType": "sample string 6",
          "errorDetails": {
            "errorCode": "sample string 1",
            "message": "sample string 2"
          }
        }
      ]
    }
  ]
}

Answer 1

您似乎缺少 include_items 参数。

来自您链接的参考文档：指示文件夹项目是否包含在响应中。如果省略该参数，则默认为false。

在 PHP SDK 中，我相信这意味着您需要创建一个 ListItemsOptions 对象，通过将 include_items 参数设置为 true 来填充它并将其应用于您的请求。

DocuSign Folder::listItems API 的输出不包括信封

DocuSign Folder::listItems API's output does not include envelopes

docusignapi