v5.3.0 (#24)

akutsanov · web-flow · commit 1b2b5166638d · 2022-08-18T18:55:09.000+03:00
- "Sender" parameter is added to the document send endpoint
- Add a new endpoint "document update"
diff --git a/README.md b/README.md
@@ -87,6 +87,7 @@ Class | Method | HTTP request | Description
 *DocumentsApi* | [**statusDocument**](docs/DocumentsApi.md#statusdocument) | **GET** /public/v1/documents/{id} | Document status
 *DocumentsApi* | [**transferAllDocumentsOwnership**](docs/DocumentsApi.md#transferalldocumentsownership) | **PATCH** /public/v1/documents/ownership | Transfer all documents ownership
 *DocumentsApi* | [**transferDocumentOwnership**](docs/DocumentsApi.md#transferdocumentownership) | **PATCH** /public/v1/documents/{id}/ownership | Update document ownership
+*DocumentsApi* | [**updateDocument**](docs/DocumentsApi.md#updatedocument) | **PATCH** /public/v1/documents/{id} | Update Document only in the draft status
 *FoldersAPIApi* | [**createDocumentFolder**](docs/FoldersAPIApi.md#createdocumentfolder) | **POST** /public/v1/documents/folders | Create Documents Folder
 *FoldersAPIApi* | [**createTemplateFolder**](docs/FoldersAPIApi.md#createtemplatefolder) | **POST** /public/v1/templates/folders | Create Templates Folder
 *FoldersAPIApi* | [**listDocumentFolders**](docs/FoldersAPIApi.md#listdocumentfolders) | **GET** /public/v1/documents/folders | List Documents Folders
diff --git a/docs/DocumentsApi.md b/docs/DocumentsApi.md
@@ -19,6 +19,7 @@ Method | HTTP request | Description
 [**statusDocument**](DocumentsApi.md#statusDocument) | **GET** /public/v1/documents/{id} | Document status
 [**transferAllDocumentsOwnership**](DocumentsApi.md#transferAllDocumentsOwnership) | **PATCH** /public/v1/documents/ownership | Transfer all documents ownership
 [**transferDocumentOwnership**](DocumentsApi.md#transferDocumentOwnership) | **PATCH** /public/v1/documents/{id}/ownership | Update document ownership
+[**updateDocument**](DocumentsApi.md#updateDocument) | **PATCH** /public/v1/documents/{id} | Update Document only in the draft status
 
 
 # **changeDocumentStatus**
@@ -919,6 +920,9 @@ const body:pd_api.DocumentsApiSendDocumentRequest = {
     message: "Hello! This document was sent from the PandaDoc API",
     subject: "Please check this test API document from PandaDoc",
     silent: true,
+    sender: {
+      "key": "key_example",
+    },
   },
 };
 
@@ -1151,3 +1155,109 @@ Name | Type | Description  | Notes
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
+# **updateDocument**
+> void updateDocument(documentUpdateRequest)
+
+
+### Example
+
+
+```typescript
+import * as pd_api from 'pandadoc-node-client';
+
+// replace it with your API key
+const API_KEY = "YOUR_API_KEY";
+const configuration = pd_api.createConfiguration(
+    { authMethods: {apiKey: `API-Key ${API_KEY}`} }
+);
+const apiInstance = new pd_api.DocumentsApi(configuration);
+
+const body:pd_api.DocumentsApiUpdateDocumentRequest = {
+  // string | Document ID
+  id: "BhVzRcxH9Z2LgfPPGXFUBa",
+  // DocumentUpdateRequest
+  documentUpdateRequest: {
+    recipients: [
+      {
+        id: "id_example",
+        email: "josh@example.com",
+        firstName: "Josh",
+        lastName: "Ron",
+      },
+    ],
+    fields: {},
+    tokens: [
+      {
+        name: "Favorite.Pet",
+        value: "Panda",
+      },
+    ],
+    metadata: {},
+    pricingTables: [
+      {
+        name: "Pricing Table 1",
+        dataMerge: true,
+        options: {},
+        sections: [
+          {
+            title: "Sample Section",
+            _default: true,
+            multichoiceEnabled: false,
+            rows: [
+              {
+                options: {
+                  qtyEditable: true,
+                  optionalSelected: true,
+                  optional: true,
+                },
+                data: {},
+                customFields: {},
+              },
+            ],
+          },
+        ],
+      },
+    ],
+  },
+};
+
+apiInstance.updateDocument(body).then((data) => {
+  console.log('API called successfully. Returned data: %o', data);
+}).catch((error) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **documentUpdateRequest** | **DocumentUpdateRequest**|  |
+ **id** | [**string**] | Document ID | defaults to undefined
+
+
+### Return type
+
+**void**
+
+### Authorization
+
+[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | No content |  -  |
+**400** | Bad Request |  -  |
+**401** | Authentication error |  -  |
+**403** | Permission error |  -  |
+**404** | Not found |  -  |
+**429** | Too Many Requests |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pandadoc-node-client",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "description": "The Official PandaDoc Node client SDK",
   "author": "PandaDoc",
   "keywords": [
diff --git a/src/apis/DocumentsApi.ts b/src/apis/DocumentsApi.ts
@@ -24,6 +24,7 @@ import { DocumentStatusRequestEnum } from '../models/DocumentStatusRequestEnum';
 import { DocumentStatusResponse } from '../models/DocumentStatusResponse';
 import { DocumentTransferAllOwnershipRequest } from '../models/DocumentTransferAllOwnershipRequest';
 import { DocumentTransferOwnershipRequest } from '../models/DocumentTransferOwnershipRequest';
+import { DocumentUpdateRequest } from '../models/DocumentUpdateRequest';
 import { LinkedObjectCreateRequest } from '../models/LinkedObjectCreateRequest';
 import { LinkedObjectCreateResponse } from '../models/LinkedObjectCreateResponse';
 import { LinkedObjectListResponse } from '../models/LinkedObjectListResponse';
@@ -974,6 +975,66 @@ export class DocumentsApiRequestFactory extends BaseAPIRequestFactory {
         return requestContext;
     }
 
+    /**
+     * Update Document only in the draft status
+     * @param id Document ID
+     * @param documentUpdateRequest 
+     */
+    public async updateDocument(id: string, documentUpdateRequest: DocumentUpdateRequest, _options?: Configuration): Promise<RequestContext> {
+        let _config = _options || this.configuration;
+
+        // verify required parameter 'id' is not null or undefined
+        if (id === null || id === undefined) {
+            throw new RequiredError("DocumentsApi", "updateDocument", "id");
+        }
+
+
+        // verify required parameter 'documentUpdateRequest' is not null or undefined
+        if (documentUpdateRequest === null || documentUpdateRequest === undefined) {
+            throw new RequiredError("DocumentsApi", "updateDocument", "documentUpdateRequest");
+        }
+
+
+        // Path Params
+        const localVarPath = '/public/v1/documents/{id}'
+            .replace('{' + 'id' + '}', encodeURIComponent(String(id)));
+
+        // Make Request Context
+        const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.PATCH);
+        requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
+
+
+        // Body Params
+        const contentType = ObjectSerializer.getPreferredMediaType([
+            "application/json"
+        ]);
+        requestContext.setHeaderParam("Content-Type", contentType);
+        const serializedBody = ObjectSerializer.stringify(
+            ObjectSerializer.serialize(documentUpdateRequest, "DocumentUpdateRequest", ""),
+            contentType
+        );
+        requestContext.setBody(serializedBody);
+
+        let authMethod: SecurityAuthentication | undefined;
+        // Apply auth methods
+        authMethod = _config.authMethods["apiKey"]
+        if (authMethod?.applySecurityAuthentication) {
+            await authMethod?.applySecurityAuthentication(requestContext);
+        }
+        // Apply auth methods
+        authMethod = _config.authMethods["oauth2"]
+        if (authMethod?.applySecurityAuthentication) {
+            await authMethod?.applySecurityAuthentication(requestContext);
+        }
+        
+        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        if (defaultAuth?.applySecurityAuthentication) {
+            await defaultAuth?.applySecurityAuthentication(requestContext);
+        }
+
+        return requestContext;
+    }
+
 }
 
 export class DocumentsApiResponseProcessor {
@@ -1856,4 +1917,64 @@ export class DocumentsApiResponseProcessor {
         throw new ApiException<string | Buffer | undefined>(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers);
     }
 
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to updateDocument
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+     public async updateDocument(response: ResponseContext): Promise<void > {
+        const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
+        if (isCodeInRange("204", response.httpStatusCode)) {
+            return;
+        }
+        if (isCodeInRange("400", response.httpStatusCode)) {
+            const body: any = ObjectSerializer.deserialize(
+                ObjectSerializer.parse(await response.body.text(), contentType),
+                "any", ""
+            ) as any;
+            throw new ApiException<any>(400, "Bad Request", body, response.headers);
+        }
+        if (isCodeInRange("401", response.httpStatusCode)) {
+            const body: any = ObjectSerializer.deserialize(
+                ObjectSerializer.parse(await response.body.text(), contentType),
+                "any", ""
+            ) as any;
+            throw new ApiException<any>(401, "Authentication error", body, response.headers);
+        }
+        if (isCodeInRange("403", response.httpStatusCode)) {
+            const body: any = ObjectSerializer.deserialize(
+                ObjectSerializer.parse(await response.body.text(), contentType),
+                "any", ""
+            ) as any;
+            throw new ApiException<any>(403, "Permission error", body, response.headers);
+        }
+        if (isCodeInRange("404", response.httpStatusCode)) {
+            const body: any = ObjectSerializer.deserialize(
+                ObjectSerializer.parse(await response.body.text(), contentType),
+                "any", ""
+            ) as any;
+            throw new ApiException<any>(404, "Not found", body, response.headers);
+        }
+        if (isCodeInRange("429", response.httpStatusCode)) {
+            const body: any = ObjectSerializer.deserialize(
+                ObjectSerializer.parse(await response.body.text(), contentType),
+                "any", ""
+            ) as any;
+            throw new ApiException<any>(429, "Too Many Requests", body, response.headers);
+        }
+
+        // Work around for missing responses in specification, e.g. for petstore.yaml
+        if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
+            const body: void = ObjectSerializer.deserialize(
+                ObjectSerializer.parse(await response.body.text(), contentType),
+                "void", ""
+            ) as void;
+            return body;
+        }
+
+        throw new ApiException<string | Buffer | undefined>(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers);
+    }
+
 }
diff --git a/src/http/http.ts b/src/http/http.ts
@@ -50,7 +50,7 @@ export type RequestBody = undefined | string | FormData | URLSearchParams;
  */
 export class RequestContext {
     private headers: { [key: string]: string } = {
-        "User-Agent": "pandadoc_node_client/5.2.0",
+        "User-Agent": "pandadoc_node_client/5.3.0",
     };
     private body: RequestBody = undefined;
     private url: URLParse;
diff --git a/src/index.ts b/src/index.ts
@@ -7,5 +7,5 @@ export * from "./apis/exception";
 export * from "./servers";
 
 export { PromiseMiddleware as Middleware } from './middleware';
-export { APILogsApiDetailsLogRequest, APILogsApiListLogsRequest, ObjectAPILogsApi as APILogsApi,  ContactsApiCreateContactRequest, ContactsApiDeleteContactRequest, ContactsApiDetailsContactRequest, ContactsApiListContactsRequest, ContactsApiUpdateContactRequest, ObjectContactsApi as ContactsApi,  ContentLibraryItemsApiDetailsContentLibraryItemRequest, ContentLibraryItemsApiListContentLibraryItemsRequest, ObjectContentLibraryItemsApi as ContentLibraryItemsApi,  DocumentAttachmentsApiCreateDocumentAttachmentRequest, DocumentAttachmentsApiDeleteDocumentAttachmentRequest, DocumentAttachmentsApiDetailsDocumentAttachmentRequest, DocumentAttachmentsApiDownloadDocumentAttachmentRequest, DocumentAttachmentsApiListDocumentAttachmentsRequest, ObjectDocumentAttachmentsApi as DocumentAttachmentsApi,  DocumentsApiChangeDocumentStatusRequest, DocumentsApiCreateDocumentRequest, DocumentsApiCreateDocumentLinkRequest, DocumentsApiCreateLinkedObjectRequest, DocumentsApiDeleteDocumentRequest, DocumentsApiDeleteLinkedObjectRequest, DocumentsApiDetailsDocumentRequest, DocumentsApiDownloadDocumentRequest, DocumentsApiDownloadProtectedDocumentRequest, DocumentsApiListDocumentsRequest, DocumentsApiListLinkedObjectsRequest, DocumentsApiSendDocumentRequest, DocumentsApiStatusDocumentRequest, DocumentsApiTransferAllDocumentsOwnershipRequest, DocumentsApiTransferDocumentOwnershipRequest, ObjectDocumentsApi as DocumentsApi,  FoldersAPIApiCreateDocumentFolderRequest, FoldersAPIApiCreateTemplateFolderRequest, FoldersAPIApiListDocumentFoldersRequest, FoldersAPIApiListTemplateFoldersRequest, FoldersAPIApiRenameDocumentFolderRequest, FoldersAPIApiRenameTemplateFolderRequest, ObjectFoldersAPIApi as FoldersAPIApi,  FormsApiListFormRequest, ObjectFormsApi as FormsApi,  MembersApiDetailsCurrentMemberRequest, MembersApiDetailsMemberRequest, MembersApiListMembersRequest, ObjectMembersApi as MembersApi,  OAuth20AuthenticationApiAccessTokenRequest, ObjectOAuth20AuthenticationApi as OAuth20AuthenticationApi,  TemplatesApiDeleteTemplateRequest, TemplatesApiDetailsTemplateRequest, TemplatesApiListTemplatesRequest, ObjectTemplatesApi as TemplatesApi,  WebhookEventsApiDetailsWebhookEventRequest, WebhookEventsApiListWebhookEventRequest, ObjectWebhookEventsApi as WebhookEventsApi,  WebhookSubscriptionsApiCreateWebhookSubscriptionRequest, WebhookSubscriptionsApiDeleteWebhookSubscriptionRequest, WebhookSubscriptionsApiDetailsWebhookSubscriptionRequest, WebhookSubscriptionsApiListWebhookSubscriptionsRequest, WebhookSubscriptionsApiUpdateWebhookSubscriptionRequest, WebhookSubscriptionsApiUpdateWebhookSubscriptionSharedKeyRequest, ObjectWebhookSubscriptionsApi as WebhookSubscriptionsApi } from './types/ObjectParamAPI';
+export { APILogsApiDetailsLogRequest, APILogsApiListLogsRequest, ObjectAPILogsApi as APILogsApi,  ContactsApiCreateContactRequest, ContactsApiDeleteContactRequest, ContactsApiDetailsContactRequest, ContactsApiListContactsRequest, ContactsApiUpdateContactRequest, ObjectContactsApi as ContactsApi,  ContentLibraryItemsApiDetailsContentLibraryItemRequest, ContentLibraryItemsApiListContentLibraryItemsRequest, ObjectContentLibraryItemsApi as ContentLibraryItemsApi,  DocumentAttachmentsApiCreateDocumentAttachmentRequest, DocumentAttachmentsApiDeleteDocumentAttachmentRequest, DocumentAttachmentsApiDetailsDocumentAttachmentRequest, DocumentAttachmentsApiDownloadDocumentAttachmentRequest, DocumentAttachmentsApiListDocumentAttachmentsRequest, ObjectDocumentAttachmentsApi as DocumentAttachmentsApi,  DocumentsApiChangeDocumentStatusRequest, DocumentsApiCreateDocumentRequest, DocumentsApiCreateDocumentLinkRequest, DocumentsApiCreateLinkedObjectRequest, DocumentsApiDeleteDocumentRequest, DocumentsApiDeleteLinkedObjectRequest, DocumentsApiDetailsDocumentRequest, DocumentsApiDownloadDocumentRequest, DocumentsApiDownloadProtectedDocumentRequest, DocumentsApiListDocumentsRequest, DocumentsApiListLinkedObjectsRequest, DocumentsApiSendDocumentRequest, DocumentsApiStatusDocumentRequest, DocumentsApiTransferAllDocumentsOwnershipRequest, DocumentsApiTransferDocumentOwnershipRequest, DocumentsApiUpdateDocumentRequest, ObjectDocumentsApi as DocumentsApi,  FoldersAPIApiCreateDocumentFolderRequest, FoldersAPIApiCreateTemplateFolderRequest, FoldersAPIApiListDocumentFoldersRequest, FoldersAPIApiListTemplateFoldersRequest, FoldersAPIApiRenameDocumentFolderRequest, FoldersAPIApiRenameTemplateFolderRequest, ObjectFoldersAPIApi as FoldersAPIApi,  FormsApiListFormRequest, ObjectFormsApi as FormsApi,  MembersApiDetailsCurrentMemberRequest, MembersApiDetailsMemberRequest, MembersApiListMembersRequest, ObjectMembersApi as MembersApi,  OAuth20AuthenticationApiAccessTokenRequest, ObjectOAuth20AuthenticationApi as OAuth20AuthenticationApi,  TemplatesApiDeleteTemplateRequest, TemplatesApiDetailsTemplateRequest, TemplatesApiListTemplatesRequest, ObjectTemplatesApi as TemplatesApi,  WebhookEventsApiDetailsWebhookEventRequest, WebhookEventsApiListWebhookEventRequest, ObjectWebhookEventsApi as WebhookEventsApi,  WebhookSubscriptionsApiCreateWebhookSubscriptionRequest, WebhookSubscriptionsApiDeleteWebhookSubscriptionRequest, WebhookSubscriptionsApiDetailsWebhookSubscriptionRequest, WebhookSubscriptionsApiListWebhookSubscriptionsRequest, WebhookSubscriptionsApiUpdateWebhookSubscriptionRequest, WebhookSubscriptionsApiUpdateWebhookSubscriptionSharedKeyRequest, ObjectWebhookSubscriptionsApi as WebhookSubscriptionsApi } from './types/ObjectParamAPI';
 
diff --git a/src/models/DocumentSendRequest.ts b/src/models/DocumentSendRequest.ts
@@ -22,6 +22,10 @@ export class DocumentSendRequest {
     * Disables sent, viewed, comment, and completed email notifications for document recipients and the document sender. By default, notifications emails are sent for specific actions. If set as true, it won't affect the \"Approve document\" email notification sent to the Approver.
     */
     'silent'?: boolean;
+    /**
+    * You can set a sender of a document as an `email` or `membership_id`
+    */
+    'sender'?: { [key: string]: string; };
 
     static readonly discriminator: string | undefined = undefined;
 
@@ -43,6 +47,12 @@ export class DocumentSendRequest {
             "baseName": "silent",
             "type": "boolean",
             "format": ""
+        },
+        {
+            "name": "sender",
+            "baseName": "sender",
+            "type": "{ [key: string]: string; }",
+            "format": ""
         }    ];
 
     static getAttributeTypeMap() {
diff --git a/src/models/ObjectSerializer.ts b/src/models/ObjectSerializer.ts
@@ -44,6 +44,8 @@ export * from './DocumentStatusRequestEnum';
 export * from './DocumentStatusResponse';
 export * from './DocumentTransferAllOwnershipRequest';
 export * from './DocumentTransferOwnershipRequest';
+export * from './DocumentUpdateRequest';
+export * from './DocumentUpdateRequestRecipients';
 export * from './DocumentsFolderCreateRequest';
 export * from './DocumentsFolderCreateResponse';
 export * from './DocumentsFolderListResponse';
@@ -143,6 +145,8 @@ import { DocumentStatusRequestEnum } from './DocumentStatusRequestEnum';
 import { DocumentStatusResponse } from './DocumentStatusResponse';
 import { DocumentTransferAllOwnershipRequest } from './DocumentTransferAllOwnershipRequest';
 import { DocumentTransferOwnershipRequest } from './DocumentTransferOwnershipRequest';
+import { DocumentUpdateRequest } from './DocumentUpdateRequest';
+import { DocumentUpdateRequestRecipients } from './DocumentUpdateRequestRecipients';
 import { DocumentsFolderCreateRequest } from './DocumentsFolderCreateRequest';
 import { DocumentsFolderCreateResponse } from './DocumentsFolderCreateResponse';
 import { DocumentsFolderListResponse } from './DocumentsFolderListResponse';
@@ -271,6 +275,8 @@ let typeMap: {[index: string]: any} = {
     "DocumentStatusResponse": DocumentStatusResponse,
     "DocumentTransferAllOwnershipRequest": DocumentTransferAllOwnershipRequest,
     "DocumentTransferOwnershipRequest": DocumentTransferOwnershipRequest,
+    "DocumentUpdateRequest": DocumentUpdateRequest,
+    "DocumentUpdateRequestRecipients": DocumentUpdateRequestRecipients,
     "DocumentsFolderCreateRequest": DocumentsFolderCreateRequest,
     "DocumentsFolderCreateResponse": DocumentsFolderCreateResponse,
     "DocumentsFolderListResponse": DocumentsFolderListResponse,
diff --git a/src/models/all.ts b/src/models/all.ts
diff --git a/src/types/ObjectParamAPI.ts b/src/types/ObjectParamAPI.ts
diff --git a/src/types/ObservableAPI.ts b/src/types/ObservableAPI.ts
diff --git a/src/types/PromiseAPI.ts b/src/types/PromiseAPI.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "pandadoc-node-client",`
`3`		`- "version": "5.2.0",`
	`3`	`+ "version": "5.3.0",`
`4`	`4`	`"description": "The Official PandaDoc Node client SDK",`
`5`	`5`	`"author": "PandaDoc",`
`6`	`6`	`"keywords": [`