diff --git a/README.md b/README.md index e331427..b6c57ce 100644 --- a/README.md +++ b/README.md @@ -60,22 +60,35 @@ All URIs are relative to *https://api.pandadoc.com* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*APILogsApi* | [**detailsApiLog**](docs/APILogsApi.md#detailsApiLog) | **GET** /public/v1/logs/{id} | Details API Log -*APILogsApi* | [**listApiLogs**](docs/APILogsApi.md#listApiLogs) | **GET** /public/v1/logs | List API Log +*APILogsApi* | [**detailsApiLog**](docs/APILogsApi.md#detailsapilog) | **GET** /public/v1/logs/{id} | Details API Log +*APILogsApi* | [**listApiLogs**](docs/APILogsApi.md#listapilogs) | **GET** /public/v1/logs | List API Log +*ContactsApi* | [**contactCreate**](docs/ContactsApi.md#contactcreate) | **POST** /public/v1/contacts | Create contact +*ContactsApi* | [**contactDelete**](docs/ContactsApi.md#contactdelete) | **DELETE** /public/v1/contacts/{id} | Delete contact by id +*ContactsApi* | [**contactDetails**](docs/ContactsApi.md#contactdetails) | **GET** /public/v1/contacts/{id} | Get contact details by id +*ContactsApi* | [**contactList**](docs/ContactsApi.md#contactlist) | **GET** /public/v1/contacts | List contacts +*ContactsApi* | [**contactUpdate**](docs/ContactsApi.md#contactupdate) | **PATCH** /public/v1/contacts/{id} | Update contact by id *ContentLibraryItemsApi* | [**detailsContentLibraryItem**](docs/ContentLibraryItemsApi.md#detailscontentlibraryitem) | **GET** /public/v1/content-library-items/{id}/details | Details Content Library Item *ContentLibraryItemsApi* | [**listContentLibraryItems**](docs/ContentLibraryItemsApi.md#listcontentlibraryitems) | **GET** /public/v1/content-library-items | List Content Library Item +*DocumentAttachmentsApi* | [**documentAttachmentCreate**](docs/DocumentAttachmentsApi.md#documentattachmentcreate) | **POST** /public/v1/documents/{id}/attachments | Document Attachment Create +*DocumentAttachmentsApi* | [**documentAttachmentDelete**](docs/DocumentAttachmentsApi.md#documentattachmentdelete) | **DELETE** /public/v1/documents/{id}/attachments/{attachment_id} | Document Attachment Delete +*DocumentAttachmentsApi* | [**documentAttachmentDetails**](docs/DocumentAttachmentsApi.md#documentattachmentdetails) | **GET** /public/v1/documents/{id}/attachments/{attachment_id} | Document Attachment Details +*DocumentAttachmentsApi* | [**documentAttachmentDownload**](docs/DocumentAttachmentsApi.md#documentattachmentdownload) | **GET** /public/v1/documents/{id}/attachments/{attachment_id}/download | Document Attachment Download +*DocumentAttachmentsApi* | [**documentAttachmentsList**](docs/DocumentAttachmentsApi.md#documentattachmentslist) | **GET** /public/v1/documents/{id}/attachments | Document Attachment List *DocumentsApi* | [**deleteDocument**](docs/DocumentsApi.md#deletedocument) | **DELETE** /public/v1/documents/{id} | Delete document by id *DocumentsApi* | [**documentCreate**](docs/DocumentsApi.md#documentcreate) | **POST** /public/v1/documents | Create document *DocumentsApi* | [**documentCreateLink**](docs/DocumentsApi.md#documentcreatelink) | **POST** /public/v1/documents/{id}/session | Create a Document Link *DocumentsApi* | [**documentDetails**](docs/DocumentsApi.md#documentdetails) | **GET** /public/v1/documents/{id}/details | Document details *DocumentsApi* | [**documentList**](docs/DocumentsApi.md#documentlist) | **GET** /public/v1/documents | List documents *DocumentsApi* | [**documentStatus**](docs/DocumentsApi.md#documentstatus) | **GET** /public/v1/documents/{id} | Document status +*DocumentsApi* | [**documentStatusChange**](docs/DocumentsApi.md#documentstatuschange) | **PATCH** /public/v1/documents/{id}/status | Document status change *DocumentsApi* | [**downloadDocument**](docs/DocumentsApi.md#downloaddocument) | **GET** /public/v1/documents/{id}/download | Document download *DocumentsApi* | [**downloadProtectedDocument**](docs/DocumentsApi.md#downloadprotecteddocument) | **GET** /public/v1/documents/{id}/download-protected | Download document protected *DocumentsApi* | [**linkedObjectDelete**](docs/DocumentsApi.md#linkedobjectdelete) | **DELETE** /public/v1/documents/{id}/linked-objects/{linked_object_id} | Delete Linked Object *DocumentsApi* | [**linkedObjectList**](docs/DocumentsApi.md#linkedobjectlist) | **GET** /public/v1/documents/{id}/linked-objects | List Linked Objects *DocumentsApi* | [**linkedObjectsCreate**](docs/DocumentsApi.md#linkedobjectscreate) | **POST** /public/v1/documents/{id}/linked-objects | Create Linked Object *DocumentsApi* | [**sendDocument**](docs/DocumentsApi.md#senddocument) | **POST** /public/v1/documents/{id}/send | Send Document +*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 *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 @@ -83,6 +96,9 @@ Class | Method | HTTP request | Description *FoldersAPIApi* | [**renameDocumentFolder**](docs/FoldersAPIApi.md#renamedocumentfolder) | **PUT** /public/v1/documents/folders/{id} | Rename Documents Folder *FoldersAPIApi* | [**renameTemplateFolder**](docs/FoldersAPIApi.md#renametemplatefolder) | **PUT** /public/v1/templates/folders/{id} | Rename Templates Folder *FormsApi* | [**listForm**](docs/FormsApi.md#listform) | **GET** /public/v1/forms | Forms +*MembersApi* | [**currentMemberDetails**](docs/MembersApi.md#currentmemberdetails) | **GET** /public/v1/members/current | Current member details +*MembersApi* | [**memberDetails**](docs/MembersApi.md#memberdetails) | **GET** /public/v1/members/{id} | Member details +*MembersApi* | [**memberList**](docs/MembersApi.md#memberlist) | **GET** /public/v1/members | List members *OAuth20AuthenticationApi* | [**accessToken**](docs/OAuth20AuthenticationApi.md#accesstoken) | **POST** /oauth2/access_token | Create/Refresh Access Token *TemplatesApi* | [**deleteTemplate**](docs/TemplatesApi.md#deletetemplate) | **DELETE** /public/v1/templates/{id} | Delete Template *TemplatesApi* | [**detailsTemaplate**](docs/TemplatesApi.md#detailstemaplate) | **GET** /public/v1/templates/{id}/details | Details Template diff --git a/docs/APILogsApi.md b/docs/APILogsApi.md index 8aa9cce..970aa71 100644 --- a/docs/APILogsApi.md +++ b/docs/APILogsApi.md @@ -28,7 +28,7 @@ const apiInstance = new pd_api.APILogsApi(configuration); const body:pd_api.APILogsApiDetailsApiLogRequest = { // string | Log event id. - id: "id_example", + id: "AXp2jrHMK2MKv_lRqmQ", }; apiInstance.detailsApiLog(body).then((data) => { @@ -50,7 +50,7 @@ Name | Type | Description | Notes ### Authorization -[apiKey](../README.md#apikey), [oauth2](../README.md#oauth2) +[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2) ### HTTP request headers @@ -88,23 +88,19 @@ const apiInstance = new pd_api.APILogsApi(configuration); const body:pd_api.APILogsApiListApiLogsRequest = { // string | Determines a point in time from which logs should be fetched. Either a specific ISO 8601 datetime or a relative identifier such as \"-90d\" (for past 90 days). (optional) - since: "since_example", + since: "-7d", // string | Determines a point in time from which logs should be fetched. Either a specific ISO 8601 datetime or a relative identifier such as \"-10d\" (for past 10 days) or a special \"now\" value. (optional) - to: "to_example", + to: "now", // number | The amount of items on each page. (optional) - count: 1, + count: 10, // number | Page number of the results returned. (optional) page: 1, // Array<100 | 200 | 300 | 400 | 500> | Returns only the predefined status codes. Allows 1xx, 2xx, 3xx, 4xx, and 5xx. (optional) - statuses: [ - 100, - ], + statuses: [400,500], // Array<'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'> | Returns only the predefined HTTP methods. Allows GET, POST, PUT, PATCH, and DELETE. (optional) - methods: [ - "GET", - ], + methods: ["GET","POST"], // string | Returns the results containing a string. (optional) - search: "search_example", + search: "documents/hryJY9mqYZHjQCYQuSjRQg/send", // 'PRODUCTION' | 'SANDBOX' | Returns logs for production/sandbox. (optional) environmentType: "PRODUCTION", }; diff --git a/docs/ContactsApi.md b/docs/ContactsApi.md new file mode 100644 index 0000000..5177623 --- /dev/null +++ b/docs/ContactsApi.md @@ -0,0 +1,330 @@ +# .ContactsApi + +All URIs are relative to *https://api.pandadoc.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**contactCreate**](ContactsApi.md#contactCreate) | **POST** /public/v1/contacts | Create contact +[**contactDelete**](ContactsApi.md#contactDelete) | **DELETE** /public/v1/contacts/{id} | Delete contact by id +[**contactDetails**](ContactsApi.md#contactDetails) | **GET** /public/v1/contacts/{id} | Get contact details by id +[**contactList**](ContactsApi.md#contactList) | **GET** /public/v1/contacts | List contacts +[**contactUpdate**](ContactsApi.md#contactUpdate) | **PATCH** /public/v1/contacts/{id} | Update contact by id + + +# **contactCreate** +> ContactDetailsResponse contactCreate(contactCreateRequest) + + +### 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.ContactsApi(configuration); + +const body:pd_api.ContactsApiContactCreateRequest = { + // ContactCreateRequest + contactCreateRequest: { + email: "user01@pandadoc.com", + firstName: "John", + lastName: "Doe", + company: "John Doe Inc.", + jobTitle: "CTO", + phone: "+14842634627", + state: "Texas", + streetAddress: "1313 Mockingbird Lane", + city: "Austin", + postalCode: "75001", + }, +}; + +apiInstance.contactCreate(body).then((data) => { + console.log('API called successfully. Returned data: %o', data); +}).catch((error) => console.error(error)); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **contactCreateRequest** | **ContactCreateRequest**| | + + +### Return type + +**ContactDetailsResponse** + +### 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 | +|-------------|-------------|------------------| +**201** | OK | - | +**400** | Bad Request | - | +**401** | Authentication error | - | +**429** | Too Many Requests | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **contactDelete** +> void contactDelete() + + +### 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.ContactsApi(configuration); + +const body:pd_api.ContactsApiContactDeleteRequest = { + // string | Contact id. + id: "SyoufNkJiHRn24LpuJ7RXb", +}; + +apiInstance.contactDelete(body).then((data) => { + console.log('API called successfully. Returned data: %o', data); +}).catch((error) => console.error(error)); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | Contact id. | defaults to undefined + + +### Return type + +**void** + +### Authorization + +[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | OK | - | +**400** | Bad Request | - | +**401** | Bad Request | - | +**403** | Authentication error | - | +**429** | Too Many Requests | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **contactDetails** +> ContactDetailsResponse contactDetails() + + +### 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.ContactsApi(configuration); + +const body:pd_api.ContactsApiContactDetailsRequest = { + // string | Contact id. + id: "SyoufNkJiHRn24LpuJ7RXb", +}; + +apiInstance.contactDetails(body).then((data) => { + console.log('API called successfully. Returned data: %o', data); +}).catch((error) => console.error(error)); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | Contact id. | defaults to undefined + + +### Return type + +**ContactDetailsResponse** + +### Authorization + +[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Bad Request | - | +**403** | Authentication error | - | +**429** | Too Many Requests | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **contactList** +> Array contactList() + + +### 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.ContactsApi(configuration); + +let body:any = {}; + +apiInstance.contactList(body).then((data) => { + console.log('API called successfully. Returned data: %o', data); +}).catch((error) => console.error(error)); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**Array** + +### Authorization + +[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Bad Request | - | +**403** | Authentication error | - | +**429** | Too Many Requests | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **contactUpdate** +> ContactDetailsResponse contactUpdate(contactUpdateRequest) + + +### 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.ContactsApi(configuration); + +const body:pd_api.ContactsApiContactUpdateRequest = { + // string | Contact id. + id: "SyoufNkJiHRn24LpuJ7RXb", + // ContactUpdateRequest + contactUpdateRequest: { + email: "user01@pandadoc.com", + firstName: "John", + lastName: "Doe", + company: "John Doe Inc.", + jobTitle: "CTO", + phone: "+14842634627", + state: "Texas", + streetAddress: "1313 Mockingbird Lane", + city: "Austin", + postalCode: "75001", + }, +}; + +apiInstance.contactUpdate(body).then((data) => { + console.log('API called successfully. Returned data: %o', data); +}).catch((error) => console.error(error)); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **contactUpdateRequest** | **ContactUpdateRequest**| | + **id** | [**string**] | Contact id. | defaults to undefined + + +### Return type + +**ContactDetailsResponse** + +### 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 | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Authentication error | - | +**429** | Too Many Requests | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + diff --git a/docs/ContentLibraryItemsApi.md b/docs/ContentLibraryItemsApi.md index 54ba4f2..92ebd85 100644 --- a/docs/ContentLibraryItemsApi.md +++ b/docs/ContentLibraryItemsApi.md @@ -28,7 +28,7 @@ const apiInstance = new pd_api.ContentLibraryItemsApi(configuration); const body:pd_api.ContentLibraryItemsApiDetailsContentLibraryItemRequest = { // string | Content Library Item ID - id: "id_example", + id: "UXdP7Lnbvvr4WEb2wzM2hc", }; apiInstance.detailsContentLibraryItem(body).then((data) => { @@ -89,19 +89,19 @@ const apiInstance = new pd_api.ContentLibraryItemsApi(configuration); const body:pd_api.ContentLibraryItemsApiListContentLibraryItemsRequest = { // string | Search query. Filter by content library item name. (optional) - q: "name", + q: "Sample Pricing Table", // string | Specify content library item ID. (optional) - id: "id_example", + id: "UXdP7Lnbvvr4WEb2wzM2hc", // boolean | Returns only the deleted content library items. (optional) deleted: true, // string | The UUID of the folder where the content library items are stored. (optional) - folderUuid: "folder_uuid_example", + folderUuid: "S6xX7saJfA44mtJxGWd95L", // number | Specify how many content library items to return. Default is 50 content library items, maximum is 100 content library items. (optional) - count: 1, + count: 10, // number | Specify which page of the dataset to return. (optional) page: 1, // string | Search tag. Filter by content library item tag. (optional) - tag: "tag_example", + tag: "pricing_tables", }; apiInstance.listContentLibraryItems(body).then((data) => { diff --git a/docs/DocumentAttachmentsApi.md b/docs/DocumentAttachmentsApi.md new file mode 100644 index 0000000..c94bd4e --- /dev/null +++ b/docs/DocumentAttachmentsApi.md @@ -0,0 +1,332 @@ +# .DocumentAttachmentsApi + +All URIs are relative to *https://api.pandadoc.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**documentAttachmentCreate**](DocumentAttachmentsApi.md#documentAttachmentCreate) | **POST** /public/v1/documents/{id}/attachments | Document Attachment Create +[**documentAttachmentDelete**](DocumentAttachmentsApi.md#documentAttachmentDelete) | **DELETE** /public/v1/documents/{id}/attachments/{attachment_id} | Document Attachment Delete +[**documentAttachmentDetails**](DocumentAttachmentsApi.md#documentAttachmentDetails) | **GET** /public/v1/documents/{id}/attachments/{attachment_id} | Document Attachment Details +[**documentAttachmentDownload**](DocumentAttachmentsApi.md#documentAttachmentDownload) | **GET** /public/v1/documents/{id}/attachments/{attachment_id}/download | Document Attachment Download +[**documentAttachmentsList**](DocumentAttachmentsApi.md#documentAttachmentsList) | **GET** /public/v1/documents/{id}/attachments | Document Attachment List + + +# **documentAttachmentCreate** +> DocumentAttachmentResponse documentAttachmentCreate() + +Creates an attachment for a particular document + +### 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.DocumentAttachmentsApi(configuration); + +const body:pd_api.DocumentAttachmentsApiDocumentAttachmentCreateRequest = { + // string | Document UUID + id: "BhVzRcxH9Z2LgfPPGXFUBa", + // HttpFile | Binary file to be attached to a document (optional) + file: { data: Buffer.from(fs.readFileSync('/path/to/file', 'utf-8')), name: '/path/to/file' }, + // string | URL link to the file to be attached to a document (optional) + source: "https://is3-ssl.mzstatic.com/1e7fbd74-d10c-8e3a-63c3-0beb3ea231a5/512x512bb.jpg", + // string | Optional name to set for uploaded file (optional) + name: "Additional agreement", +}; + +apiInstance.documentAttachmentCreate(body).then((data) => { + console.log('API called successfully. Returned data: %o', data); +}).catch((error) => console.error(error)); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | Document UUID | defaults to undefined + **file** | [**HttpFile**] | Binary file to be attached to a document | (optional) defaults to undefined + **source** | [**string**] | URL link to the file to be attached to a document | (optional) defaults to undefined + **name** | [**string**] | Optional name to set for uploaded file | (optional) defaults to undefined + + +### Return type + +**DocumentAttachmentResponse** + +### Authorization + +[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Authentication error | - | +**404** | Not found | - | +**429** | Too Many Requests | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **documentAttachmentDelete** +> void documentAttachmentDelete() + +Deletes specific document's attachment + +### 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.DocumentAttachmentsApi(configuration); + +const body:pd_api.DocumentAttachmentsApiDocumentAttachmentDeleteRequest = { + // string | Document UUID + id: "BhVzRcxH9Z2LgfPPGXFUBa", + // string | Attachment UUID + attachmentId: "89ce2f49-10fb-4e9b-b5f3-e28be2a5c042", +}; + +apiInstance.documentAttachmentDelete(body).then((data) => { + console.log('API called successfully. Returned data: %o', data); +}).catch((error) => console.error(error)); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | Document UUID | defaults to undefined + **attachmentId** | [**string**] | Attachment UUID | defaults to undefined + + +### Return type + +**void** + +### Authorization + +[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | +**401** | Authentication error | - | +**404** | Not found | - | +**429** | Too Many Requests | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **documentAttachmentDetails** +> DocumentAttachmentResponse documentAttachmentDetails() + +Returns details of the specific document's attachment + +### 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.DocumentAttachmentsApi(configuration); + +const body:pd_api.DocumentAttachmentsApiDocumentAttachmentDetailsRequest = { + // string | Document UUID + id: "BhVzRcxH9Z2LgfPPGXFUBa", + // string | Attachment UUID + attachmentId: "89ce2f49-10fb-4e9b-b5f3-e28be2a5c042", +}; + +apiInstance.documentAttachmentDetails(body).then((data) => { + console.log('API called successfully. Returned data: %o', data); +}).catch((error) => console.error(error)); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | Document UUID | defaults to undefined + **attachmentId** | [**string**] | Attachment UUID | defaults to undefined + + +### Return type + +**DocumentAttachmentResponse** + +### Authorization + +[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Authentication error | - | +**404** | Not found | - | +**429** | Too Many Requests | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **documentAttachmentDownload** +> HttpFile documentAttachmentDownload() + +Returns document attachment file for download + +### 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.DocumentAttachmentsApi(configuration); + +const body:pd_api.DocumentAttachmentsApiDocumentAttachmentDownloadRequest = { + // string | Document UUID + id: "BhVzRcxH9Z2LgfPPGXFUBa", + // string | Attachment UUID + attachmentId: "89ce2f49-10fb-4e9b-b5f3-e28be2a5c042", +}; + +apiInstance.documentAttachmentDownload(body).then((data) => { + console.log('API called successfully. Returned data: %o', data); +}).catch((error) => console.error(error)); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | Document UUID | defaults to undefined + **attachmentId** | [**string**] | Attachment UUID | defaults to undefined + + +### Return type + +**HttpFile** + +### Authorization + +[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/_*, application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Authentication error | - | +**404** | Not found | - | +**429** | Too Many Requests | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **documentAttachmentsList** +> Array documentAttachmentsList() + +Return list of objects attached to particular document + +### 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.DocumentAttachmentsApi(configuration); + +const body:pd_api.DocumentAttachmentsApiDocumentAttachmentsListRequest = { + // string | Document UUID + id: "BhVzRcxH9Z2LgfPPGXFUBa", +}; + +apiInstance.documentAttachmentsList(body).then((data) => { + console.log('API called successfully. Returned data: %o', data); +}).catch((error) => console.error(error)); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | Document UUID | defaults to undefined + + +### Return type + +**Array** + +### Authorization + +[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Authentication error | - | +**404** | Not found | - | +**429** | Too Many Requests | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + diff --git a/docs/DocumentsApi.md b/docs/DocumentsApi.md index f4f8be7..f904a0e 100644 --- a/docs/DocumentsApi.md +++ b/docs/DocumentsApi.md @@ -10,12 +10,15 @@ Method | HTTP request | Description [**documentDetails**](DocumentsApi.md#documentDetails) | **GET** /public/v1/documents/{id}/details | Document details [**documentList**](DocumentsApi.md#documentList) | **GET** /public/v1/documents | List documents [**documentStatus**](DocumentsApi.md#documentStatus) | **GET** /public/v1/documents/{id} | Document status +[**documentStatusChange**](DocumentsApi.md#documentStatusChange) | **PATCH** /public/v1/documents/{id}/status | Document status change [**downloadDocument**](DocumentsApi.md#downloadDocument) | **GET** /public/v1/documents/{id}/download | Document download [**downloadProtectedDocument**](DocumentsApi.md#downloadProtectedDocument) | **GET** /public/v1/documents/{id}/download-protected | Download document protected [**linkedObjectDelete**](DocumentsApi.md#linkedObjectDelete) | **DELETE** /public/v1/documents/{id}/linked-objects/{linked_object_id} | Delete Linked Object [**linkedObjectList**](DocumentsApi.md#linkedObjectList) | **GET** /public/v1/documents/{id}/linked-objects | List Linked Objects [**linkedObjectsCreate**](DocumentsApi.md#linkedObjectsCreate) | **POST** /public/v1/documents/{id}/linked-objects | Create Linked Object [**sendDocument**](DocumentsApi.md#sendDocument) | **POST** /public/v1/documents/{id}/send | Send Document +[**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 # **deleteDocument** @@ -37,7 +40,7 @@ const apiInstance = new pd_api.DocumentsApi(configuration); const body:pd_api.DocumentsApiDeleteDocumentRequest = { // string | Document ID - id: "id_example", + id: "BhVzRcxH9Z2LgfPPGXFUBa", }; apiInstance.deleteDocument(body).then((data) => { @@ -76,7 +79,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) # **documentCreate** -> DocumentCreateResponse documentCreate() +> DocumentCreateResponse documentCreate(documentCreateRequest) ### Example @@ -93,10 +96,8 @@ const configuration = pd_api.createConfiguration( const apiInstance = new pd_api.DocumentsApi(configuration); const body:pd_api.DocumentsApiDocumentCreateRequest = { - // string | Set this parameter as `ev1` if you want to create a document from PDF with Classic Editor when both editors are enabled for the workspace. (optional) - editorVer: "ev1", - // InlineObject (optional) - inlineObject: { + // DocumentCreateRequest | Use a PandaDoc template or an existing PDF to create a document. See the creation request examples [by template](#/schemas/DocumentCreateByTemplateRequest) and [by pdf](#/schemas/DocumentCreateByPdfRequest) + documentCreateRequest: { name: "API Sample Document from PandaDoc Template", templateUuid: "hryJY9mqYZHjQCYQuSjRQg", folderUuid: "QMDSzwabfFzTgjW4kUijqQ", @@ -126,7 +127,8 @@ const body:pd_api.DocumentsApiDocumentCreateRequest = { ], pricingTables: [ { - name: "Pricing Table", + name: "Pricing Table 1", + dataMerge: true, options: { currency: "USD", discount: { @@ -189,13 +191,14 @@ const body:pd_api.DocumentsApiDocumentCreateRequest = { ], contentPlaceholders: [ { - blockId: "hryJY9mqYZHjQCYQuSjRQg", + blockId: "Content Placeholder 1", contentLibraryItems: [ { id: "hryJY9mqYZHjQCYQuSjRQg", pricingTables: [ { - name: "Pricing Table", + name: "Pricing Table 1", + dataMerge: true, options: { currency: "USD", discount: { @@ -267,6 +270,8 @@ const body:pd_api.DocumentsApiDocumentCreateRequest = { url: "https://s3.amazonaws.com/pd-static-content/public-docs/pandadoc-panda-bear.png", parseFormFields: true, }, + // string | Set this parameter as `ev1` if you want to create a document from PDF with Classic Editor when both editors are enabled for the workspace. (optional) + editorVer: "ev2", }; apiInstance.documentCreate(body).then((data) => { @@ -279,7 +284,7 @@ apiInstance.documentCreate(body).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **inlineObject** | **InlineObject**| | + **documentCreateRequest** | **DocumentCreateRequest**| Use a PandaDoc template or an existing PDF to create a document. See the creation request examples [by template](#/schemas/DocumentCreateByTemplateRequest) and [by pdf](#/schemas/DocumentCreateByPdfRequest) | **editorVer** | [**string**] | Set this parameter as `ev1` if you want to create a document from PDF with Classic Editor when both editors are enabled for the workspace. | (optional) defaults to undefined @@ -326,9 +331,12 @@ const apiInstance = new pd_api.DocumentsApi(configuration); const body:pd_api.DocumentsApiDocumentCreateLinkRequest = { // string | Document ID - id: "id_example", + id: "ZPeAfcpzr9aiVs5vqUf6jg", // DocumentCreateLinkRequest - documentCreateLinkRequest: null, + documentCreateLinkRequest: { + recipient: "josh@example.com", + lifetime: 900, + }, }; apiInstance.documentCreateLink(body).then((data) => { @@ -390,7 +398,7 @@ const apiInstance = new pd_api.DocumentsApi(configuration); const body:pd_api.DocumentsApiDocumentDetailsRequest = { // string | Document ID - id: "id_example", + id: "BhVzRcxH9Z2LgfPPGXFUBa", }; apiInstance.documentDetails(body).then((data) => { @@ -453,6 +461,8 @@ const body:pd_api.DocumentsApiDocumentListRequest = { completedFrom: "2021-10-27T15:22:23.132757Z", // string | Return results where the `date_completed` field (ISO 8601) is less than or equal to this value. (optional) completedTo: "2021-10-27T15:22:23.132757Z", + // string | Returns results where 'contact_id' is present in document as recipient or approver (optional) + contactId: "9FeAY2NB3C9qDdtQRb4tTL", // number | Specify how many document results to return. Default is 50 documents, maximum is 100 documents. (optional) count: 50, // string | Return results where the `date_created` field (ISO 8601) is greater than or equal to this value. (optional) @@ -467,6 +477,8 @@ const body:pd_api.DocumentsApiDocumentListRequest = { folderUuid: "BhVzRcxH9Z2LgfPPGXFUBa", // string | Specify the form used for documents creation. This parameter can't be used with template_id. (optional) formId: "BhVzRcxH9Z2LgfPPGXFUBa", + // string | Returns results where 'membership_id' is present in document as owner (should be member uuid) (optional) + membershipId: "BhVzRcxH9Z2LgfPPGXFUBa", // string | Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. (optional) metadata: "metadata_example", // string | Return results where the `date_modified` field (iso-8601) is greater than or equal to this value. (optional) @@ -480,9 +492,9 @@ const body:pd_api.DocumentsApiDocumentListRequest = { // string | Search query. Filter by document reference number (this token is stored on the template level) or name. (optional) q: "Sample Document", // DocumentStatusEnum | Specify the status of documents to return. * 0: document.draft * 1: document.sent * 2: document.completed * 3: document.uploaded * 4: document.error * 5: document.viewed * 6: document.waiting_approval * 7: document.approved * 8: document.rejected * 9: document.waiting_pay * 10: document.paid * 11: document.voided * 12: document.declined (optional) - status: 0, + status: 12, // DocumentStatusEnum | Specify the status of documents to return (exclude). * 0: document.draft * 1: document.sent * 2: document.completed * 3: document.uploaded * 4: document.error * 5: document.viewed * 6: document.waiting_approval * 7: document.approved * 8: document.rejected * 9: document.waiting_pay * 10: document.paid * 11: document.voided * 12: document.declined (optional) - statusNe: 0, + statusNe: 12, // string | Search tag. Filter by document tag. (optional) tag: "tag_1", // string | Specify the template used for documents creation. Parameter can't be used with form_id. (optional) @@ -501,6 +513,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **completedFrom** | [**string**] | Return results where the `date_completed` field (ISO 8601) is greater than or equal to this value. | (optional) defaults to undefined **completedTo** | [**string**] | Return results where the `date_completed` field (ISO 8601) is less than or equal to this value. | (optional) defaults to undefined + **contactId** | [**string**] | Returns results where 'contact_id' is present in document as recipient or approver | (optional) defaults to undefined **count** | [**number**] | Specify how many document results to return. Default is 50 documents, maximum is 100 documents. | (optional) defaults to undefined **createdFrom** | [**string**] | Return results where the `date_created` field (ISO 8601) is greater than or equal to this value. | (optional) defaults to undefined **createdTo** | [**string**] | Return results where the `date_created` field (ISO 8601) is less than this value. | (optional) defaults to undefined @@ -508,6 +521,7 @@ Name | Type | Description | Notes **id** | [**string**] | | (optional) defaults to undefined **folderUuid** | [**string**] | The UUID of the folder where the documents are stored. | (optional) defaults to undefined **formId** | [**string**] | Specify the form used for documents creation. This parameter can't be used with template_id. | (optional) defaults to undefined + **membershipId** | [**string**] | Returns results where 'membership_id' is present in document as owner (should be member uuid) | (optional) defaults to undefined **metadata** | [**string**] | Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. | (optional) defaults to undefined **modifiedFrom** | [**string**] | Return results where the `date_modified` field (iso-8601) is greater than or equal to this value. | (optional) defaults to undefined **modifiedTo** | [**string**] | Return results where the `date_modified` field (iso-8601) is less than this value. | (optional) defaults to undefined @@ -564,7 +578,7 @@ const apiInstance = new pd_api.DocumentsApi(configuration); const body:pd_api.DocumentsApiDocumentStatusRequest = { // string | Specify document ID. - id: "id_example", + id: "BhVzRcxH9Z2LgfPPGXFUBa", }; apiInstance.documentStatus(body).then((data) => { @@ -605,6 +619,73 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) +# **documentStatusChange** +> void documentStatusChange(documentStatusChangeRequest) + + +### 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.DocumentsApiDocumentStatusChangeRequest = { + // string | Specify document ID. + id: "BhVzRcxH9Z2LgfPPGXFUBa", + // DocumentStatusChangeRequest + documentStatusChangeRequest: { + status: 12, + note: "A private note", + notifyRecipients: true, + }, +}; + +apiInstance.documentStatusChange(body).then((data) => { + console.log('API called successfully. Returned data: %o', data); +}).catch((error) => console.error(error)); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **documentStatusChangeRequest** | **DocumentStatusChangeRequest**| | + **id** | [**string**] | Specify document ID. | defaults to undefined + + +### Return type + +**void** + +### Authorization + +[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No content | - | +**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 Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + # **downloadDocument** > HttpFile downloadDocument() @@ -624,15 +705,15 @@ const apiInstance = new pd_api.DocumentsApi(configuration); const body:pd_api.DocumentsApiDownloadDocumentRequest = { // string | Specify document ID. - id: "id_example", - // string | HEX code (for example `#RRGGBB`). (optional) - watermarkColor: "watermark_color_example", + id: "BhVzRcxH9Z2LgfPPGXFUBa", + // string | HEX code (for example `#FF5733`). (optional) + watermarkColor: "#FF5733", // number | Font size of the watermark. (optional) - watermarkFontSize: 1, + watermarkFontSize: 12, // number | In range 0.0-1.0 (optional) - watermarkOpacity: 3.14, + watermarkOpacity: 0.5, // string | Specify watermark text. (optional) - watermarkText: "watermark_text_example", + watermarkText: "John Doe inc.", }; apiInstance.downloadDocument(body).then((data) => { @@ -646,7 +727,7 @@ apiInstance.downloadDocument(body).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | [**string**] | Specify document ID. | defaults to undefined - **watermarkColor** | [**string**] | HEX code (for example `#RRGGBB`). | (optional) defaults to undefined + **watermarkColor** | [**string**] | HEX code (for example `#FF5733`). | (optional) defaults to undefined **watermarkFontSize** | [**number**] | Font size of the watermark. | (optional) defaults to undefined **watermarkOpacity** | [**number**] | In range 0.0-1.0 | (optional) defaults to undefined **watermarkText** | [**string**] | Specify watermark text. | (optional) defaults to undefined @@ -758,9 +839,9 @@ const apiInstance = new pd_api.DocumentsApi(configuration); const body:pd_api.DocumentsApiLinkedObjectDeleteRequest = { // string | Specify document ID. - id: "id_example", + id: "ZPeAfcpzr9aiVs5vqUf6jg", // string | Specify linked object ID. - linkedObjectId: "linked_object_id_example", + linkedObjectId: "deb0d530-d759-4189-a422-8d2265e01b2e", }; apiInstance.linkedObjectDelete(body).then((data) => { @@ -821,7 +902,7 @@ const apiInstance = new pd_api.DocumentsApi(configuration); const body:pd_api.DocumentsApiLinkedObjectListRequest = { // string | Specify document ID. - id: "id_example", + id: "ZPeAfcpzr9aiVs5vqUf6jg", }; apiInstance.linkedObjectList(body).then((data) => { @@ -881,9 +962,13 @@ const apiInstance = new pd_api.DocumentsApi(configuration); const body:pd_api.DocumentsApiLinkedObjectsCreateRequest = { // string | Specify document ID. - id: "id_example", + id: "ZPeAfcpzr9aiVs5vqUf6jg", // LinkedObjectCreateRequest - linkedObjectCreateRequest: null, + linkedObjectCreateRequest: { + provider: "pipedrive", + entityType: "deal", + entityId: "9372", + }, }; apiInstance.linkedObjectsCreate(body).then((data) => { @@ -927,7 +1012,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) # **sendDocument** -> DocumentSendResponse sendDocument() +> DocumentSendResponse sendDocument(documentSendRequest) ### Example @@ -945,9 +1030,13 @@ const apiInstance = new pd_api.DocumentsApi(configuration); const body:pd_api.DocumentsApiSendDocumentRequest = { // string | Document ID - id: "id_example", - // DocumentSendRequest (optional) - documentSendRequest: null, + id: "ZPeAfcpzr9aiVs5vqUf6jg", + // DocumentSendRequest + documentSendRequest: { + message: "Hello! This document was sent from the PandaDoc API", + subject: "Please check this test API document from PandaDoc", + silent: true, + }, }; apiInstance.sendDocument(body).then((data) => { @@ -989,3 +1078,131 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) +# **transferAllDocumentsOwnership** +> void transferAllDocumentsOwnership(documentTransferAllOwnershipRequest) + + +### 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.DocumentsApiTransferAllDocumentsOwnershipRequest = { + // DocumentTransferAllOwnershipRequest + documentTransferAllOwnershipRequest: { + fromMembershipId: "Dqsxp4jNnFcS63tJEgLJGN", + toMembershipId: "radQBiBkU7MBk59NSgaGfd", + }, +}; + +apiInstance.transferAllDocumentsOwnership(body).then((data) => { + console.log('API called successfully. Returned data: %o', data); +}).catch((error) => console.error(error)); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **documentTransferAllOwnershipRequest** | **DocumentTransferAllOwnershipRequest**| | + + +### 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 | - | +**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 Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **transferDocumentOwnership** +> void transferDocumentOwnership(documentTransferOwnershipRequest) + + +### 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.DocumentsApiTransferDocumentOwnershipRequest = { + // string | Specify document ID. + id: "BhVzRcxH9Z2LgfPPGXFUBa", + // DocumentTransferOwnershipRequest + documentTransferOwnershipRequest: { + membershipId: "radQBiBkU7MBk59NSgaGfd", + }, +}; + +apiInstance.transferDocumentOwnership(body).then((data) => { + console.log('API called successfully. Returned data: %o', data); +}).catch((error) => console.error(error)); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **documentTransferOwnershipRequest** | **DocumentTransferOwnershipRequest**| | + **id** | [**string**] | Specify 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 | - | +**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 Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + diff --git a/docs/FoldersAPIApi.md b/docs/FoldersAPIApi.md index 5ca01df..12be839 100644 --- a/docs/FoldersAPIApi.md +++ b/docs/FoldersAPIApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description # **createDocumentFolder** -> DocumentsFolderCreateResponse createDocumentFolder() +> DocumentsFolderCreateResponse createDocumentFolder(documentsFolderCreateRequest) Create a new folder to store your documents. @@ -31,7 +31,7 @@ const configuration = pd_api.createConfiguration( const apiInstance = new pd_api.FoldersAPIApi(configuration); const body:pd_api.FoldersAPIApiCreateDocumentFolderRequest = { - // DocumentsFolderCreateRequest (optional) + // DocumentsFolderCreateRequest documentsFolderCreateRequest: { name: "A new document folder", parentUuid: "Nq8htXxFssmhRxAPSP4SBP", @@ -76,7 +76,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) # **createTemplateFolder** -> TemplatesFolderCreateResponse createTemplateFolder() +> TemplatesFolderCreateResponse createTemplateFolder(templatesFolderCreateRequest) Create a new folder to store your templates. @@ -94,7 +94,7 @@ const configuration = pd_api.createConfiguration( const apiInstance = new pd_api.FoldersAPIApi(configuration); const body:pd_api.FoldersAPIApiCreateTemplateFolderRequest = { - // TemplatesFolderCreateRequest (optional) + // TemplatesFolderCreateRequest templatesFolderCreateRequest: { name: "A new template folder", parentUuid: "Nq8htXxFssmhRxAPSP4SBP", @@ -158,9 +158,9 @@ const apiInstance = new pd_api.FoldersAPIApi(configuration); const body:pd_api.FoldersAPIApiListDocumentFoldersRequest = { // string | The UUID of the folder containing folders. To list the folders located in the root folder, remove this parameter in the request. (optional) - parentUuid: "parent_uuid_example", + parentUuid: "Nq8htXxFssmhRxAPSP4SBP", // number | Optionally, specify how many folders to return. Default is 50 folders, maximum is 100 folders. (optional) - count: 1, + count: 10, // number | Optionally, specify which page of the dataset to return. (optional) page: 1, }; @@ -224,9 +224,9 @@ const apiInstance = new pd_api.FoldersAPIApi(configuration); const body:pd_api.FoldersAPIApiListTemplateFoldersRequest = { // string | The UUID of the folder containing folders. To list the folders located in the root folder, remove this parameter in the request. (optional) - parentUuid: "parent_uuid_example", + parentUuid: "Nq8htXxFssmhRxAPSP4SBP", // number | Optionally, specify how many folders to return. Default is 50 folders, maximum is 100 folders. (optional) - count: 1, + count: 10, // number | Optionally, specify which page of the dataset to return. (optional) page: 1, }; @@ -271,7 +271,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) # **renameDocumentFolder** -> DocumentsFolderRenameResponse renameDocumentFolder() +> DocumentsFolderRenameResponse renameDocumentFolder(documentsFolderRenameRequest) Rename Documents Folder. @@ -290,8 +290,8 @@ const apiInstance = new pd_api.FoldersAPIApi(configuration); const body:pd_api.FoldersAPIApiRenameDocumentFolderRequest = { // string | The UUID of the folder that you are renaming. - id: "id_example", - // DocumentsFolderRenameRequest (optional) + id: "Nq8htXxFssmhRxAPSP4SBP", + // DocumentsFolderRenameRequest documentsFolderRenameRequest: { name: "Another document folder", }, @@ -337,7 +337,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) # **renameTemplateFolder** -> TemplatesFolderRenameResponse renameTemplateFolder() +> TemplatesFolderRenameResponse renameTemplateFolder(templatesFolderRenameRequest) Rename a templates folder. @@ -356,8 +356,8 @@ const apiInstance = new pd_api.FoldersAPIApi(configuration); const body:pd_api.FoldersAPIApiRenameTemplateFolderRequest = { // string | The UUID of the folder which you are renaming. - id: "id_example", - // TemplatesFolderRenameRequest (optional) + id: "Nq8htXxFssmhRxAPSP4SBP", + // TemplatesFolderRenameRequest templatesFolderRenameRequest: { name: "Another template folder", }, diff --git a/docs/FormsApi.md b/docs/FormsApi.md index 22d3001..19196e4 100644 --- a/docs/FormsApi.md +++ b/docs/FormsApi.md @@ -27,7 +27,7 @@ const apiInstance = new pd_api.FormsApi(configuration); const body:pd_api.FormsApiListFormRequest = { // number | Optionally, specify how many forms to return. Default is 50 forms, maximum is 100 forms. (optional) - count: 1, + count: 10, // number | Optionally, specify which page of the dataset to return. (optional) page: 1, // Array<'draft' | 'active' | 'disabled'> | Optionally, specify which status of the forms dataset to return. (optional) @@ -39,7 +39,7 @@ const body:pd_api.FormsApiListFormRequest = { // boolean | Optionally, specify sorting the result-set in ascending or descending order. (optional) asc: true, // string | Specify the form name. (optional) - name: "name_example", + name: "New Form", }; apiInstance.listForm(body).then((data) => { diff --git a/docs/MembersApi.md b/docs/MembersApi.md new file mode 100644 index 0000000..3320dd6 --- /dev/null +++ b/docs/MembersApi.md @@ -0,0 +1,182 @@ +# .MembersApi + +All URIs are relative to *https://api.pandadoc.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**currentMemberDetails**](MembersApi.md#currentMemberDetails) | **GET** /public/v1/members/current | Current member details +[**memberDetails**](MembersApi.md#memberDetails) | **GET** /public/v1/members/{id} | Member details +[**memberList**](MembersApi.md#memberList) | **GET** /public/v1/members | List members + + +# **currentMemberDetails** +> MemberDetailsResponse currentMemberDetails() + +A method to define to whom credentials belong + +### 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.MembersApi(configuration); + +let body:any = {}; + +apiInstance.currentMemberDetails(body).then((data) => { + console.log('API called successfully. Returned data: %o', data); +}).catch((error) => console.error(error)); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**MemberDetailsResponse** + +### Authorization + +[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Bad Request | - | +**403** | Authentication error | - | +**429** | Too Many Requests | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **memberDetails** +> MemberDetailsResponse memberDetails() + +A method to retrieve a member's details by id + +### 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.MembersApi(configuration); + +const body:pd_api.MembersApiMemberDetailsRequest = { + // string | Membership id + id: "radQBiBkU7MBk59NSgaGf5", +}; + +apiInstance.memberDetails(body).then((data) => { + console.log('API called successfully. Returned data: %o', data); +}).catch((error) => console.error(error)); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | [**string**] | Membership id | defaults to undefined + + +### Return type + +**MemberDetailsResponse** + +### Authorization + +[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Bad Request | - | +**403** | Authentication error | - | +**429** | Too Many Requests | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **memberList** +> Array memberList() + +Retrieve all members details of the workspace + +### 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.MembersApi(configuration); + +let body:any = {}; + +apiInstance.memberList(body).then((data) => { + console.log('API called successfully. Returned data: %o', data); +}).catch((error) => console.error(error)); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**Array** + +### Authorization + +[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Bad Request | - | +**403** | Authentication error | - | +**429** | Too Many Requests | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + diff --git a/docs/TemplatesApi.md b/docs/TemplatesApi.md index c6efaa3..2db5e67 100644 --- a/docs/TemplatesApi.md +++ b/docs/TemplatesApi.md @@ -29,7 +29,7 @@ const apiInstance = new pd_api.TemplatesApi(configuration); const body:pd_api.TemplatesApiDeleteTemplateRequest = { // string | Template ID - id: "id_example", + id: "EE8yUNg5HztqVAuH85He8V", }; apiInstance.deleteTemplate(body).then((data) => { @@ -91,7 +91,7 @@ const apiInstance = new pd_api.TemplatesApi(configuration); const body:pd_api.TemplatesApiDetailsTemaplateRequest = { // string | Template ID - id: "id_example", + id: "EE8yUNg5HztqVAuH85He8V", }; apiInstance.detailsTemaplate(body).then((data) => { @@ -152,19 +152,19 @@ const apiInstance = new pd_api.TemplatesApi(configuration); const body:pd_api.TemplatesApiListTemplatesRequest = { // string | Optional search query. Filter by template name. (optional) - q: "q_example", + q: "Sample onboarding template", // boolean | Returns only the shared templates. (optional) shared: true, // boolean | Optional. Returns only the deleted templates. (optional) deleted: true, // number | Optionally, specify how many templates to return. Default is 50 templates, maximum is 100 templates. (optional) - count: 1, + count: 10, // number | Optionally, specify which page of the dataset to return. (optional) page: 1, // string | Optionally, specify template ID. (optional) - id: "id_example", + id: "e9LxBesSL73AeZMzeYdfvV", // string | UUID of the folder where the templates are stored. (optional) - folderUuid: "folder_uuid_example", + folderUuid: "xDKHoJ8DkwhiTQSUzNveCJ", // Array | Optional search tag. Filter by template tag. (optional) tag: [ "tag_example", diff --git a/examples/createDocumentFromPandadocTemplateAndSend.ts b/examples/createDocumentFromPandadocTemplateAndSend.ts index 9ff6891..0d9492f 100644 --- a/examples/createDocumentFromPandadocTemplateAndSend.ts +++ b/examples/createDocumentFromPandadocTemplateAndSend.ts @@ -5,7 +5,7 @@ const API_KEY = "YOUR_API_KEY"; // or uncomment this if you want to setup with oauth2 // const OAUTH2_KEY = "YOUR_OAUTH_KEY"; const MAX_RETRIES_COUNT = 5; -// you should have an `API Sample Document from PandaDoc Template` +// you should have an `Full API Sample Document from PandaDoc Template` // onboarding template in your workspace just place its ID here const TEMPLATE_UUID = "YOUR_API_SAMPLE_TEMPLATE_ID"; // you should have a several onboarding CLIs in your workspace @@ -14,7 +14,7 @@ const CONTENT_LIBRARY_ITEM_ID = "YOUR_CLI_ID"; const pricingTables: Array = [ { - name: "Pricing Table", + name: "Pricing Table 1", options: { currency: "USD", discount: { @@ -76,7 +76,7 @@ const pricingTables: Array = [ }, ]; -const inlineObj: pd_api.InlineObject = { +const documentCreateRequest: pd_api.DocumentCreateRequest = { name: "API Sample Document from PandaDoc Template", templateUuid: TEMPLATE_UUID, // specify a folder uuid if you want to document to be created @@ -127,12 +127,11 @@ const inlineObj: pd_api.InlineObject = { async function documentCreateFromPandadocTemplate( apiInstance: pd_api.DocumentsApi, - inlineObj: pd_api.InlineObject + requestObj: pd_api.DocumentCreateRequest ): Promise { try { let response = await apiInstance.documentCreate({ - editorVer: "ev2", - inlineObject: inlineObj, + documentCreateRequest: requestObj, }); console.log("Document was successfully uploaded: %o", response); return response; @@ -193,7 +192,7 @@ async function documentSend( try { let response = await apiInstance.sendDocument({ - id: document.id, + id: String(document.id), documentSendRequest: { silent: false, subject: "Sent via Node SDK", @@ -224,7 +223,7 @@ async function runExample() { let createdDocument = await documentCreateFromPandadocTemplate( apiInstance, - inlineObj + documentCreateRequest ); await documentSend(apiInstance, createdDocument); } diff --git a/examples/createDocumentFromPdfUrlAndSend.ts b/examples/createDocumentFromPdfUrlAndSend.ts index 41c695d..b8f7904 100644 --- a/examples/createDocumentFromPdfUrlAndSend.ts +++ b/examples/createDocumentFromPdfUrlAndSend.ts @@ -8,7 +8,7 @@ const MAX_RETRIES_COUNT = 5; const PDF_URL = "https://cdn2.hubspot.net/hubfs/2127247/public-templates/SamplePandaDocPdf_FieldTags.pdf"; -const inlineObj: pd_api.InlineObject = { +const documentCreateRequest: pd_api.DocumentCreateRequest = { name: "Sample Document from PDF with Field Tags", url: PDF_URL, tags: ["tag_1", "tag_2"], @@ -37,12 +37,11 @@ const inlineObj: pd_api.InlineObject = { async function documentCreateFromPdfUrl( apiInstance: pd_api.DocumentsApi, - inlineObj: pd_api.InlineObject + requestObj: pd_api.DocumentCreateRequest ): Promise { try { let response = await apiInstance.documentCreate({ - editorVer: "ev2", - inlineObject: inlineObj, + documentCreateRequest: requestObj, }); console.log("Document was successfully uploaded: %o", response); return response; @@ -129,7 +128,7 @@ async function runExample() { }); const apiInstance = new pd_api.DocumentsApi(cfg); - let createdDocument = await documentCreateFromPdfUrl(apiInstance, inlineObj); + let createdDocument = await documentCreateFromPdfUrl(apiInstance, documentCreateRequest); await documentSend(apiInstance, createdDocument); } diff --git a/package.json b/package.json index 933e123..7f3da65 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "pandadoc-node-client", - "version": "1.0.0", + "version": "1.1.0", "description": "The Official PandaDoc Node client SDK", "author": "PandaDoc", "keywords": [ diff --git a/src/apis/ContactsApi.ts b/src/apis/ContactsApi.ts new file mode 100644 index 0000000..a55427d --- /dev/null +++ b/src/apis/ContactsApi.ts @@ -0,0 +1,497 @@ +// TODO: better import syntax? +import { BaseAPIRequestFactory, RequiredError } from './baseapi'; +import {Configuration} from '../configuration'; +import { RequestContext, HttpMethod, ResponseContext, HttpFile} from '../http/http'; +import * as FormData from "form-data"; +import { URLSearchParams } from 'url'; +import {ObjectSerializer} from '../models/ObjectSerializer'; +import {ApiException} from './exception'; +import {canConsumeForm, isCodeInRange} from '../util'; + + +import { ContactCreateRequest } from '../models/ContactCreateRequest'; +import { ContactDetailsResponse } from '../models/ContactDetailsResponse'; +import { ContactUpdateRequest } from '../models/ContactUpdateRequest'; + +/** + * no description + */ +export class ContactsApiRequestFactory extends BaseAPIRequestFactory { + + /** + * Create contact + * @param contactCreateRequest + */ + public async contactCreate(contactCreateRequest: ContactCreateRequest, _options?: Configuration): Promise { + let _config = _options || this.configuration; + + // verify required parameter 'contactCreateRequest' is not null or undefined + if (contactCreateRequest === null || contactCreateRequest === undefined) { + throw new RequiredError("ContactsApi", "contactCreate", "contactCreateRequest"); + } + + + // Path Params + const localVarPath = '/public/v1/contacts'; + + // Make Request Context + const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.POST); + 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(contactCreateRequest, "ContactCreateRequest", ""), + contentType + ); + requestContext.setBody(serializedBody); + + let authMethod = null; + // Apply auth methods + authMethod = _config.authMethods["apiKey"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + + /** + * Delete contact by id + * @param id Contact id. + */ + public async contactDelete(id: string, _options?: Configuration): Promise { + let _config = _options || this.configuration; + + // verify required parameter 'id' is not null or undefined + if (id === null || id === undefined) { + throw new RequiredError("ContactsApi", "contactDelete", "id"); + } + + + // Path Params + const localVarPath = '/public/v1/contacts/{id}' + .replace('{' + 'id' + '}', encodeURIComponent(String(id))); + + // Make Request Context + const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.DELETE); + requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") + + + let authMethod = null; + // Apply auth methods + authMethod = _config.authMethods["apiKey"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + + /** + * Get contact details by id + * @param id Contact id. + */ + public async contactDetails(id: string, _options?: Configuration): Promise { + let _config = _options || this.configuration; + + // verify required parameter 'id' is not null or undefined + if (id === null || id === undefined) { + throw new RequiredError("ContactsApi", "contactDetails", "id"); + } + + + // Path Params + const localVarPath = '/public/v1/contacts/{id}' + .replace('{' + 'id' + '}', encodeURIComponent(String(id))); + + // Make Request Context + const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.GET); + requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") + + + let authMethod = null; + // Apply auth methods + authMethod = _config.authMethods["apiKey"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + + /** + * List contacts + */ + public async contactList(_options?: Configuration): Promise { + let _config = _options || this.configuration; + + // Path Params + const localVarPath = '/public/v1/contacts'; + + // Make Request Context + const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.GET); + requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") + + + let authMethod = null; + // Apply auth methods + authMethod = _config.authMethods["apiKey"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + + /** + * Update contact by id + * @param id Contact id. + * @param contactUpdateRequest + */ + public async contactUpdate(id: string, contactUpdateRequest: ContactUpdateRequest, _options?: Configuration): Promise { + let _config = _options || this.configuration; + + // verify required parameter 'id' is not null or undefined + if (id === null || id === undefined) { + throw new RequiredError("ContactsApi", "contactUpdate", "id"); + } + + + // verify required parameter 'contactUpdateRequest' is not null or undefined + if (contactUpdateRequest === null || contactUpdateRequest === undefined) { + throw new RequiredError("ContactsApi", "contactUpdate", "contactUpdateRequest"); + } + + + // Path Params + const localVarPath = '/public/v1/contacts/{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(contactUpdateRequest, "ContactUpdateRequest", ""), + contentType + ); + requestContext.setBody(serializedBody); + + let authMethod = null; + // Apply auth methods + authMethod = _config.authMethods["apiKey"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + +} + +export class ContactsApiResponseProcessor { + + /** + * 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 contactCreate + * @throws ApiException if the response code was not in [200, 299] + */ + public async contactCreate(response: ResponseContext): Promise { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("201", response.httpStatusCode)) { + const body: ContactDetailsResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "ContactDetailsResponse", "" + ) as ContactDetailsResponse; + return body; + } + if (isCodeInRange("400", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "" + ) as any; + throw new ApiException(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(401, "Authentication error", 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(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: ContactDetailsResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "ContactDetailsResponse", "" + ) as ContactDetailsResponse; + return body; + } + + throw new ApiException(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 contactDelete + * @throws ApiException if the response code was not in [200, 299] + */ + public async contactDelete(response: ResponseContext): Promise { + 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(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(401, "Bad Request", 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(403, "Authentication error", 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(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(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 contactDetails + * @throws ApiException if the response code was not in [200, 299] + */ + public async contactDetails(response: ResponseContext): Promise { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("200", response.httpStatusCode)) { + const body: ContactDetailsResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "ContactDetailsResponse", "" + ) as ContactDetailsResponse; + return body; + } + if (isCodeInRange("400", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "" + ) as any; + throw new ApiException(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(401, "Bad Request", 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(403, "Authentication error", 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(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: ContactDetailsResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "ContactDetailsResponse", "" + ) as ContactDetailsResponse; + return body; + } + + throw new ApiException(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 contactList + * @throws ApiException if the response code was not in [200, 299] + */ + public async contactList(response: ResponseContext): Promise > { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("200", response.httpStatusCode)) { + const body: Array = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "Array", "" + ) as Array; + return body; + } + if (isCodeInRange("400", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "" + ) as any; + throw new ApiException(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(401, "Bad Request", 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(403, "Authentication error", 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(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: Array = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "Array", "" + ) as Array; + return body; + } + + throw new ApiException(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 contactUpdate + * @throws ApiException if the response code was not in [200, 299] + */ + public async contactUpdate(response: ResponseContext): Promise { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("200", response.httpStatusCode)) { + const body: ContactDetailsResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "ContactDetailsResponse", "" + ) as ContactDetailsResponse; + return body; + } + if (isCodeInRange("400", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "" + ) as any; + throw new ApiException(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(401, "Authentication error", 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(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: ContactDetailsResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "ContactDetailsResponse", "" + ) as ContactDetailsResponse; + return body; + } + + throw new ApiException(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers); + } + +} diff --git a/src/apis/DocumentAttachmentsApi.ts b/src/apis/DocumentAttachmentsApi.ts new file mode 100644 index 0000000..ab222cb --- /dev/null +++ b/src/apis/DocumentAttachmentsApi.ts @@ -0,0 +1,528 @@ +// TODO: better import syntax? +import { BaseAPIRequestFactory, RequiredError } from './baseapi'; +import {Configuration} from '../configuration'; +import { RequestContext, HttpMethod, ResponseContext, HttpFile} from '../http/http'; +import * as FormData from "form-data"; +import { URLSearchParams } from 'url'; +import {ObjectSerializer} from '../models/ObjectSerializer'; +import {ApiException} from './exception'; +import {canConsumeForm, isCodeInRange} from '../util'; + + +import { DocumentAttachmentResponse } from '../models/DocumentAttachmentResponse'; + +/** + * no description + */ +export class DocumentAttachmentsApiRequestFactory extends BaseAPIRequestFactory { + + /** + * Creates an attachment for a particular document + * Document Attachment Create + * @param id Document UUID + * @param file Binary file to be attached to a document + * @param source URL link to the file to be attached to a document + * @param name Optional name to set for uploaded file + */ + public async documentAttachmentCreate(id: string, file?: HttpFile, source?: string, name?: string, _options?: Configuration): Promise { + let _config = _options || this.configuration; + + // verify required parameter 'id' is not null or undefined + if (id === null || id === undefined) { + throw new RequiredError("DocumentAttachmentsApi", "documentAttachmentCreate", "id"); + } + + + + + + // Path Params + const localVarPath = '/public/v1/documents/{id}/attachments' + .replace('{' + 'id' + '}', encodeURIComponent(String(id))); + + // Make Request Context + const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.POST); + requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") + + // Form Params + const useForm = canConsumeForm([ + 'multipart/form-data', + ]); + + let localVarFormParams + if (useForm) { + localVarFormParams = new FormData(); + } else { + localVarFormParams = new URLSearchParams(); + } + + if (file !== undefined) { + // TODO: replace .append with .set + if (localVarFormParams instanceof FormData) { + localVarFormParams.append('file', file.data, file.name); + } + } + if (source !== undefined) { + // TODO: replace .append with .set + localVarFormParams.append('source', source as any); + } + if (name !== undefined) { + // TODO: replace .append with .set + localVarFormParams.append('name', name as any); + } + + requestContext.setBody(localVarFormParams); + + if(!useForm) { + const contentType = ObjectSerializer.getPreferredMediaType([ + "multipart/form-data" + ]); + requestContext.setHeaderParam("Content-Type", contentType); + } + + let authMethod = null; + // Apply auth methods + authMethod = _config.authMethods["apiKey"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + + /** + * Deletes specific document's attachment + * Document Attachment Delete + * @param id Document UUID + * @param attachmentId Attachment UUID + */ + public async documentAttachmentDelete(id: string, attachmentId: string, _options?: Configuration): Promise { + let _config = _options || this.configuration; + + // verify required parameter 'id' is not null or undefined + if (id === null || id === undefined) { + throw new RequiredError("DocumentAttachmentsApi", "documentAttachmentDelete", "id"); + } + + + // verify required parameter 'attachmentId' is not null or undefined + if (attachmentId === null || attachmentId === undefined) { + throw new RequiredError("DocumentAttachmentsApi", "documentAttachmentDelete", "attachmentId"); + } + + + // Path Params + const localVarPath = '/public/v1/documents/{id}/attachments/{attachment_id}' + .replace('{' + 'id' + '}', encodeURIComponent(String(id))) + .replace('{' + 'attachment_id' + '}', encodeURIComponent(String(attachmentId))); + + // Make Request Context + const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.DELETE); + requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") + + + let authMethod = null; + // Apply auth methods + authMethod = _config.authMethods["apiKey"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + + /** + * Returns details of the specific document's attachment + * Document Attachment Details + * @param id Document UUID + * @param attachmentId Attachment UUID + */ + public async documentAttachmentDetails(id: string, attachmentId: string, _options?: Configuration): Promise { + let _config = _options || this.configuration; + + // verify required parameter 'id' is not null or undefined + if (id === null || id === undefined) { + throw new RequiredError("DocumentAttachmentsApi", "documentAttachmentDetails", "id"); + } + + + // verify required parameter 'attachmentId' is not null or undefined + if (attachmentId === null || attachmentId === undefined) { + throw new RequiredError("DocumentAttachmentsApi", "documentAttachmentDetails", "attachmentId"); + } + + + // Path Params + const localVarPath = '/public/v1/documents/{id}/attachments/{attachment_id}' + .replace('{' + 'id' + '}', encodeURIComponent(String(id))) + .replace('{' + 'attachment_id' + '}', encodeURIComponent(String(attachmentId))); + + // Make Request Context + const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.GET); + requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") + + + let authMethod = null; + // Apply auth methods + authMethod = _config.authMethods["apiKey"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + + /** + * Returns document attachment file for download + * Document Attachment Download + * @param id Document UUID + * @param attachmentId Attachment UUID + */ + public async documentAttachmentDownload(id: string, attachmentId: string, _options?: Configuration): Promise { + let _config = _options || this.configuration; + + // verify required parameter 'id' is not null or undefined + if (id === null || id === undefined) { + throw new RequiredError("DocumentAttachmentsApi", "documentAttachmentDownload", "id"); + } + + + // verify required parameter 'attachmentId' is not null or undefined + if (attachmentId === null || attachmentId === undefined) { + throw new RequiredError("DocumentAttachmentsApi", "documentAttachmentDownload", "attachmentId"); + } + + + // Path Params + const localVarPath = '/public/v1/documents/{id}/attachments/{attachment_id}/download' + .replace('{' + 'id' + '}', encodeURIComponent(String(id))) + .replace('{' + 'attachment_id' + '}', encodeURIComponent(String(attachmentId))); + + // Make Request Context + const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.GET); + requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") + + + let authMethod = null; + // Apply auth methods + authMethod = _config.authMethods["apiKey"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + + /** + * Return list of objects attached to particular document + * Document Attachment List + * @param id Document UUID + */ + public async documentAttachmentsList(id: string, _options?: Configuration): Promise { + let _config = _options || this.configuration; + + // verify required parameter 'id' is not null or undefined + if (id === null || id === undefined) { + throw new RequiredError("DocumentAttachmentsApi", "documentAttachmentsList", "id"); + } + + + // Path Params + const localVarPath = '/public/v1/documents/{id}/attachments' + .replace('{' + 'id' + '}', encodeURIComponent(String(id))); + + // Make Request Context + const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.GET); + requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") + + + let authMethod = null; + // Apply auth methods + authMethod = _config.authMethods["apiKey"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + +} + +export class DocumentAttachmentsApiResponseProcessor { + + /** + * 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 documentAttachmentCreate + * @throws ApiException if the response code was not in [200, 299] + */ + public async documentAttachmentCreate(response: ResponseContext): Promise { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("200", response.httpStatusCode)) { + const body: DocumentAttachmentResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "DocumentAttachmentResponse", "" + ) as DocumentAttachmentResponse; + return body; + } + if (isCodeInRange("400", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "" + ) as any; + throw new ApiException(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(401, "Authentication 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(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(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: DocumentAttachmentResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "DocumentAttachmentResponse", "" + ) as DocumentAttachmentResponse; + return body; + } + + throw new ApiException(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 documentAttachmentDelete + * @throws ApiException if the response code was not in [200, 299] + */ + public async documentAttachmentDelete(response: ResponseContext): Promise { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("204", response.httpStatusCode)) { + return; + } + if (isCodeInRange("401", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "" + ) as any; + throw new ApiException(401, "Authentication 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(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(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(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 documentAttachmentDetails + * @throws ApiException if the response code was not in [200, 299] + */ + public async documentAttachmentDetails(response: ResponseContext): Promise { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("200", response.httpStatusCode)) { + const body: DocumentAttachmentResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "DocumentAttachmentResponse", "" + ) as DocumentAttachmentResponse; + return body; + } + if (isCodeInRange("401", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "" + ) as any; + throw new ApiException(401, "Authentication 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(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(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: DocumentAttachmentResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "DocumentAttachmentResponse", "" + ) as DocumentAttachmentResponse; + return body; + } + + throw new ApiException(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 documentAttachmentDownload + * @throws ApiException if the response code was not in [200, 299] + */ + public async documentAttachmentDownload(response: ResponseContext): Promise { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("200", response.httpStatusCode)) { + const body: HttpFile = await response.getBodyAsFile() as any as HttpFile; + return body; + } + if (isCodeInRange("401", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "binary" + ) as any; + throw new ApiException(401, "Authentication error", body, response.headers); + } + if (isCodeInRange("404", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "binary" + ) as any; + throw new ApiException(404, "Not found", body, response.headers); + } + if (isCodeInRange("429", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "binary" + ) as any; + throw new ApiException(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: HttpFile = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "HttpFile", "binary" + ) as HttpFile; + return body; + } + + throw new ApiException(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 documentAttachmentsList + * @throws ApiException if the response code was not in [200, 299] + */ + public async documentAttachmentsList(response: ResponseContext): Promise > { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("200", response.httpStatusCode)) { + const body: Array = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "Array", "" + ) as Array; + return body; + } + if (isCodeInRange("401", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "" + ) as any; + throw new ApiException(401, "Authentication 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(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(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: Array = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "Array", "" + ) as Array; + return body; + } + + throw new ApiException(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers); + } + +} diff --git a/src/apis/DocumentsApi.ts b/src/apis/DocumentsApi.ts index be7b6e6..6583f71 100644 --- a/src/apis/DocumentsApi.ts +++ b/src/apis/DocumentsApi.ts @@ -11,15 +11,18 @@ import {canConsumeForm, isCodeInRange} from '../util'; import { DocumentCreateLinkRequest } from '../models/DocumentCreateLinkRequest'; import { DocumentCreateLinkResponse } from '../models/DocumentCreateLinkResponse'; +import { DocumentCreateRequest } from '../models/DocumentCreateRequest'; import { DocumentCreateResponse } from '../models/DocumentCreateResponse'; import { DocumentDetailsResponse } from '../models/DocumentDetailsResponse'; import { DocumentListResponse } from '../models/DocumentListResponse'; import { DocumentOrderingFieldsEnum } from '../models/DocumentOrderingFieldsEnum'; import { DocumentSendRequest } from '../models/DocumentSendRequest'; import { DocumentSendResponse } from '../models/DocumentSendResponse'; +import { DocumentStatusChangeRequest } from '../models/DocumentStatusChangeRequest'; import { DocumentStatusEnum } from '../models/DocumentStatusEnum'; import { DocumentStatusResponse } from '../models/DocumentStatusResponse'; -import { InlineObject } from '../models/InlineObject'; +import { DocumentTransferAllOwnershipRequest } from '../models/DocumentTransferAllOwnershipRequest'; +import { DocumentTransferOwnershipRequest } from '../models/DocumentTransferOwnershipRequest'; import { LinkedObjectCreateRequest } from '../models/LinkedObjectCreateRequest'; import { LinkedObjectCreateResponse } from '../models/LinkedObjectCreateResponse'; import { LinkedObjectListResponse } from '../models/LinkedObjectListResponse'; @@ -68,12 +71,17 @@ export class DocumentsApiRequestFactory extends BaseAPIRequestFactory { /** * Create document + * @param documentCreateRequest Use a PandaDoc template or an existing PDF to create a document. See the creation request examples [by template](#/schemas/DocumentCreateByTemplateRequest) and [by pdf](#/schemas/DocumentCreateByPdfRequest) * @param editorVer Set this parameter as `ev1` if you want to create a document from PDF with Classic Editor when both editors are enabled for the workspace. - * @param inlineObject */ - public async documentCreate(editorVer?: string, inlineObject?: InlineObject, _options?: Configuration): Promise { + public async documentCreate(documentCreateRequest: DocumentCreateRequest, editorVer?: string, _options?: Configuration): Promise { let _config = _options || this.configuration; + // verify required parameter 'documentCreateRequest' is not null or undefined + if (documentCreateRequest === null || documentCreateRequest === undefined) { + throw new RequiredError("DocumentsApi", "documentCreate", "documentCreateRequest"); + } + // Path Params @@ -97,7 +105,7 @@ export class DocumentsApiRequestFactory extends BaseAPIRequestFactory { ]); requestContext.setHeaderParam("Content-Type", contentType); const serializedBody = ObjectSerializer.stringify( - ObjectSerializer.serialize(inlineObject, "InlineObject", ""), + ObjectSerializer.serialize(documentCreateRequest, "DocumentCreateRequest", ""), contentType ); requestContext.setBody(serializedBody); @@ -213,6 +221,7 @@ export class DocumentsApiRequestFactory extends BaseAPIRequestFactory { * List documents * @param completedFrom Return results where the `date_completed` field (ISO 8601) is greater than or equal to this value. * @param completedTo Return results where the `date_completed` field (ISO 8601) is less than or equal to this value. + * @param contactId Returns results where 'contact_id' is present in document as recipient or approver * @param count Specify how many document results to return. Default is 50 documents, maximum is 100 documents. * @param createdFrom Return results where the `date_created` field (ISO 8601) is greater than or equal to this value. * @param createdTo Return results where the `date_created` field (ISO 8601) is less than this value. @@ -220,6 +229,7 @@ export class DocumentsApiRequestFactory extends BaseAPIRequestFactory { * @param id * @param folderUuid The UUID of the folder where the documents are stored. * @param formId Specify the form used for documents creation. This parameter can't be used with template_id. + * @param membershipId Returns results where 'membership_id' is present in document as owner (should be member uuid) * @param metadata Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. * @param modifiedFrom Return results where the `date_modified` field (iso-8601) is greater than or equal to this value. * @param modifiedTo Return results where the `date_modified` field (iso-8601) is less than this value. @@ -231,7 +241,7 @@ export class DocumentsApiRequestFactory extends BaseAPIRequestFactory { * @param tag Search tag. Filter by document tag. * @param templateId Specify the template used for documents creation. Parameter can't be used with form_id. */ - public async documentList(completedFrom?: string, completedTo?: string, count?: number, createdFrom?: string, createdTo?: string, deleted?: boolean, id?: string, folderUuid?: string, formId?: string, metadata?: string, modifiedFrom?: string, modifiedTo?: string, orderBy?: DocumentOrderingFieldsEnum, page?: number, q?: string, status?: DocumentStatusEnum, statusNe?: DocumentStatusEnum, tag?: string, templateId?: string, _options?: Configuration): Promise { + public async documentList(completedFrom?: string, completedTo?: string, contactId?: string, count?: number, createdFrom?: string, createdTo?: string, deleted?: boolean, id?: string, folderUuid?: string, formId?: string, membershipId?: string, metadata?: string, modifiedFrom?: string, modifiedTo?: string, orderBy?: DocumentOrderingFieldsEnum, page?: number, q?: string, status?: DocumentStatusEnum, statusNe?: DocumentStatusEnum, tag?: string, templateId?: string, _options?: Configuration): Promise { let _config = _options || this.configuration; @@ -251,6 +261,8 @@ export class DocumentsApiRequestFactory extends BaseAPIRequestFactory { + + // Path Params @@ -270,6 +282,11 @@ export class DocumentsApiRequestFactory extends BaseAPIRequestFactory { requestContext.setQueryParam("completed_to", ObjectSerializer.serialize(completedTo, "string", "datetime")); } + // Query Params + if (contactId !== undefined) { + requestContext.setQueryParam("contact_id", ObjectSerializer.serialize(contactId, "string", "")); + } + // Query Params if (count !== undefined) { requestContext.setQueryParam("count", ObjectSerializer.serialize(count, "number", "")); @@ -305,6 +322,11 @@ export class DocumentsApiRequestFactory extends BaseAPIRequestFactory { requestContext.setQueryParam("form_id", ObjectSerializer.serialize(formId, "string", "")); } + // Query Params + if (membershipId !== undefined) { + requestContext.setQueryParam("membership_id", ObjectSerializer.serialize(membershipId, "string", "")); + } + // Query Params if (metadata !== undefined) { requestContext.setQueryParam("metadata", ObjectSerializer.serialize(metadata, "string", "")); @@ -408,10 +430,67 @@ export class DocumentsApiRequestFactory extends BaseAPIRequestFactory { return requestContext; } + /** + * Document status change + * @param id Specify document ID. + * @param documentStatusChangeRequest + */ + public async documentStatusChange(id: string, documentStatusChangeRequest: DocumentStatusChangeRequest, _options?: Configuration): Promise { + let _config = _options || this.configuration; + + // verify required parameter 'id' is not null or undefined + if (id === null || id === undefined) { + throw new RequiredError("DocumentsApi", "documentStatusChange", "id"); + } + + + // verify required parameter 'documentStatusChangeRequest' is not null or undefined + if (documentStatusChangeRequest === null || documentStatusChangeRequest === undefined) { + throw new RequiredError("DocumentsApi", "documentStatusChange", "documentStatusChangeRequest"); + } + + + // Path Params + const localVarPath = '/public/v1/documents/{id}/status' + .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", + + "multipart/form-data" + ]); + requestContext.setHeaderParam("Content-Type", contentType); + const serializedBody = ObjectSerializer.stringify( + ObjectSerializer.serialize(documentStatusChangeRequest, "DocumentStatusChangeRequest", ""), + contentType + ); + requestContext.setBody(serializedBody); + + let authMethod = null; + // Apply auth methods + authMethod = _config.authMethods["apiKey"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + /** * Document download * @param id Specify document ID. - * @param watermarkColor HEX code (for example `#RRGGBB`). + * @param watermarkColor HEX code (for example `#FF5733`). * @param watermarkFontSize Font size of the watermark. * @param watermarkOpacity In range 0.0-1.0 * @param watermarkText Specify watermark text. @@ -653,7 +732,7 @@ export class DocumentsApiRequestFactory extends BaseAPIRequestFactory { * @param id Document ID * @param documentSendRequest */ - public async sendDocument(id: string, documentSendRequest?: DocumentSendRequest, _options?: Configuration): Promise { + public async sendDocument(id: string, documentSendRequest: DocumentSendRequest, _options?: Configuration): Promise { let _config = _options || this.configuration; // verify required parameter 'id' is not null or undefined @@ -662,6 +741,11 @@ export class DocumentsApiRequestFactory extends BaseAPIRequestFactory { } + // verify required parameter 'documentSendRequest' is not null or undefined + if (documentSendRequest === null || documentSendRequest === undefined) { + throw new RequiredError("DocumentsApi", "sendDocument", "documentSendRequest"); + } + // Path Params const localVarPath = '/public/v1/documents/{id}/send' @@ -698,6 +782,108 @@ export class DocumentsApiRequestFactory extends BaseAPIRequestFactory { return requestContext; } + /** + * Transfer all documents ownership + * @param documentTransferAllOwnershipRequest + */ + public async transferAllDocumentsOwnership(documentTransferAllOwnershipRequest: DocumentTransferAllOwnershipRequest, _options?: Configuration): Promise { + let _config = _options || this.configuration; + + // verify required parameter 'documentTransferAllOwnershipRequest' is not null or undefined + if (documentTransferAllOwnershipRequest === null || documentTransferAllOwnershipRequest === undefined) { + throw new RequiredError("DocumentsApi", "transferAllDocumentsOwnership", "documentTransferAllOwnershipRequest"); + } + + + // Path Params + const localVarPath = '/public/v1/documents/ownership'; + + // 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(documentTransferAllOwnershipRequest, "DocumentTransferAllOwnershipRequest", ""), + contentType + ); + requestContext.setBody(serializedBody); + + let authMethod = null; + // Apply auth methods + authMethod = _config.authMethods["apiKey"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + + /** + * Update document ownership + * @param id Specify document ID. + * @param documentTransferOwnershipRequest + */ + public async transferDocumentOwnership(id: string, documentTransferOwnershipRequest: DocumentTransferOwnershipRequest, _options?: Configuration): Promise { + let _config = _options || this.configuration; + + // verify required parameter 'id' is not null or undefined + if (id === null || id === undefined) { + throw new RequiredError("DocumentsApi", "transferDocumentOwnership", "id"); + } + + + // verify required parameter 'documentTransferOwnershipRequest' is not null or undefined + if (documentTransferOwnershipRequest === null || documentTransferOwnershipRequest === undefined) { + throw new RequiredError("DocumentsApi", "transferDocumentOwnership", "documentTransferOwnershipRequest"); + } + + + // Path Params + const localVarPath = '/public/v1/documents/{id}/ownership' + .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(documentTransferOwnershipRequest, "DocumentTransferOwnershipRequest", ""), + contentType + ); + requestContext.setBody(serializedBody); + + let authMethod = null; + // Apply auth methods + authMethod = _config.authMethods["apiKey"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + } export class DocumentsApiResponseProcessor { @@ -1019,6 +1205,59 @@ export class DocumentsApiResponseProcessor { throw new ApiException(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 documentStatusChange + * @throws ApiException if the response code was not in [200, 299] + */ + public async documentStatusChange(response: ResponseContext): Promise { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("204", response.httpStatusCode)) { + return; + } + if (isCodeInRange("401", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "" + ) as any; + throw new ApiException(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(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(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(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(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 @@ -1365,4 +1604,110 @@ export class DocumentsApiResponseProcessor { throw new ApiException(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 transferAllDocumentsOwnership + * @throws ApiException if the response code was not in [200, 299] + */ + public async transferAllDocumentsOwnership(response: ResponseContext): Promise { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("204", response.httpStatusCode)) { + return; + } + if (isCodeInRange("401", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "" + ) as any; + throw new ApiException(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(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(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(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(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 transferDocumentOwnership + * @throws ApiException if the response code was not in [200, 299] + */ + public async transferDocumentOwnership(response: ResponseContext): Promise { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("204", response.httpStatusCode)) { + return; + } + if (isCodeInRange("401", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "" + ) as any; + throw new ApiException(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(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(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(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(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers); + } + } diff --git a/src/apis/FoldersAPIApi.ts b/src/apis/FoldersAPIApi.ts index a730b58..65b8f8a 100644 --- a/src/apis/FoldersAPIApi.ts +++ b/src/apis/FoldersAPIApi.ts @@ -30,9 +30,14 @@ export class FoldersAPIApiRequestFactory extends BaseAPIRequestFactory { * Create Documents Folder * @param documentsFolderCreateRequest */ - public async createDocumentFolder(documentsFolderCreateRequest?: DocumentsFolderCreateRequest, _options?: Configuration): Promise { + public async createDocumentFolder(documentsFolderCreateRequest: DocumentsFolderCreateRequest, _options?: Configuration): Promise { let _config = _options || this.configuration; + // verify required parameter 'documentsFolderCreateRequest' is not null or undefined + if (documentsFolderCreateRequest === null || documentsFolderCreateRequest === undefined) { + throw new RequiredError("FoldersAPIApi", "createDocumentFolder", "documentsFolderCreateRequest"); + } + // Path Params const localVarPath = '/public/v1/documents/folders'; @@ -73,9 +78,14 @@ export class FoldersAPIApiRequestFactory extends BaseAPIRequestFactory { * Create Templates Folder * @param templatesFolderCreateRequest */ - public async createTemplateFolder(templatesFolderCreateRequest?: TemplatesFolderCreateRequest, _options?: Configuration): Promise { + public async createTemplateFolder(templatesFolderCreateRequest: TemplatesFolderCreateRequest, _options?: Configuration): Promise { let _config = _options || this.configuration; + // verify required parameter 'templatesFolderCreateRequest' is not null or undefined + if (templatesFolderCreateRequest === null || templatesFolderCreateRequest === undefined) { + throw new RequiredError("FoldersAPIApi", "createTemplateFolder", "templatesFolderCreateRequest"); + } + // Path Params const localVarPath = '/public/v1/templates/folders'; @@ -219,7 +229,7 @@ export class FoldersAPIApiRequestFactory extends BaseAPIRequestFactory { * @param id The UUID of the folder that you are renaming. * @param documentsFolderRenameRequest */ - public async renameDocumentFolder(id: string, documentsFolderRenameRequest?: DocumentsFolderRenameRequest, _options?: Configuration): Promise { + public async renameDocumentFolder(id: string, documentsFolderRenameRequest: DocumentsFolderRenameRequest, _options?: Configuration): Promise { let _config = _options || this.configuration; // verify required parameter 'id' is not null or undefined @@ -228,6 +238,11 @@ export class FoldersAPIApiRequestFactory extends BaseAPIRequestFactory { } + // verify required parameter 'documentsFolderRenameRequest' is not null or undefined + if (documentsFolderRenameRequest === null || documentsFolderRenameRequest === undefined) { + throw new RequiredError("FoldersAPIApi", "renameDocumentFolder", "documentsFolderRenameRequest"); + } + // Path Params const localVarPath = '/public/v1/documents/folders/{id}' @@ -270,7 +285,7 @@ export class FoldersAPIApiRequestFactory extends BaseAPIRequestFactory { * @param id The UUID of the folder which you are renaming. * @param templatesFolderRenameRequest */ - public async renameTemplateFolder(id: string, templatesFolderRenameRequest?: TemplatesFolderRenameRequest, _options?: Configuration): Promise { + public async renameTemplateFolder(id: string, templatesFolderRenameRequest: TemplatesFolderRenameRequest, _options?: Configuration): Promise { let _config = _options || this.configuration; // verify required parameter 'id' is not null or undefined @@ -279,6 +294,11 @@ export class FoldersAPIApiRequestFactory extends BaseAPIRequestFactory { } + // verify required parameter 'templatesFolderRenameRequest' is not null or undefined + if (templatesFolderRenameRequest === null || templatesFolderRenameRequest === undefined) { + throw new RequiredError("FoldersAPIApi", "renameTemplateFolder", "templatesFolderRenameRequest"); + } + // Path Params const localVarPath = '/public/v1/templates/folders/{id}' diff --git a/src/apis/MembersApi.ts b/src/apis/MembersApi.ts new file mode 100644 index 0000000..eca05a5 --- /dev/null +++ b/src/apis/MembersApi.ts @@ -0,0 +1,292 @@ +// TODO: better import syntax? +import { BaseAPIRequestFactory, RequiredError } from './baseapi'; +import {Configuration} from '../configuration'; +import { RequestContext, HttpMethod, ResponseContext, HttpFile} from '../http/http'; +import * as FormData from "form-data"; +import { URLSearchParams } from 'url'; +import {ObjectSerializer} from '../models/ObjectSerializer'; +import {ApiException} from './exception'; +import {canConsumeForm, isCodeInRange} from '../util'; + + +import { MemberDetailsResponse } from '../models/MemberDetailsResponse'; + +/** + * no description + */ +export class MembersApiRequestFactory extends BaseAPIRequestFactory { + + /** + * A method to define to whom credentials belong + * Current member details + */ + public async currentMemberDetails(_options?: Configuration): Promise { + let _config = _options || this.configuration; + + // Path Params + const localVarPath = '/public/v1/members/current'; + + // Make Request Context + const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.GET); + requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") + + + let authMethod = null; + // Apply auth methods + authMethod = _config.authMethods["apiKey"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + + /** + * A method to retrieve a member's details by id + * Member details + * @param id Membership id + */ + public async memberDetails(id: string, _options?: Configuration): Promise { + let _config = _options || this.configuration; + + // verify required parameter 'id' is not null or undefined + if (id === null || id === undefined) { + throw new RequiredError("MembersApi", "memberDetails", "id"); + } + + + // Path Params + const localVarPath = '/public/v1/members/{id}' + .replace('{' + 'id' + '}', encodeURIComponent(String(id))); + + // Make Request Context + const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.GET); + requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") + + + let authMethod = null; + // Apply auth methods + authMethod = _config.authMethods["apiKey"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + + /** + * Retrieve all members details of the workspace + * List members + */ + public async memberList(_options?: Configuration): Promise { + let _config = _options || this.configuration; + + // Path Params + const localVarPath = '/public/v1/members'; + + // Make Request Context + const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.GET); + requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") + + + let authMethod = null; + // Apply auth methods + authMethod = _config.authMethods["apiKey"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod) { + await authMethod.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + +} + +export class MembersApiResponseProcessor { + + /** + * 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 currentMemberDetails + * @throws ApiException if the response code was not in [200, 299] + */ + public async currentMemberDetails(response: ResponseContext): Promise { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("200", response.httpStatusCode)) { + const body: MemberDetailsResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "MemberDetailsResponse", "" + ) as MemberDetailsResponse; + return body; + } + if (isCodeInRange("400", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "" + ) as any; + throw new ApiException(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(401, "Bad Request", 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(403, "Authentication error", 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(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: MemberDetailsResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "MemberDetailsResponse", "" + ) as MemberDetailsResponse; + return body; + } + + throw new ApiException(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 memberDetails + * @throws ApiException if the response code was not in [200, 299] + */ + public async memberDetails(response: ResponseContext): Promise { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("200", response.httpStatusCode)) { + const body: MemberDetailsResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "MemberDetailsResponse", "" + ) as MemberDetailsResponse; + return body; + } + if (isCodeInRange("400", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "" + ) as any; + throw new ApiException(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(401, "Bad Request", 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(403, "Authentication error", 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(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: MemberDetailsResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "MemberDetailsResponse", "" + ) as MemberDetailsResponse; + return body; + } + + throw new ApiException(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 memberList + * @throws ApiException if the response code was not in [200, 299] + */ + public async memberList(response: ResponseContext): Promise > { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("200", response.httpStatusCode)) { + const body: Array = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "Array", "" + ) as Array; + return body; + } + if (isCodeInRange("400", response.httpStatusCode)) { + const body: any = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "any", "" + ) as any; + throw new ApiException(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(401, "Bad Request", 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(403, "Authentication error", 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(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: Array = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "Array", "" + ) as Array; + return body; + } + + throw new ApiException(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers); + } + +} diff --git a/src/index.ts b/src/index.ts index bb7b406..77ac17d 100644 --- 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 { APILogsApiDetailsApiLogRequest, APILogsApiListApiLogsRequest, ObjectAPILogsApi as APILogsApi, ContentLibraryItemsApiDetailsContentLibraryItemRequest, ContentLibraryItemsApiListContentLibraryItemsRequest, ObjectContentLibraryItemsApi as ContentLibraryItemsApi, DocumentsApiDeleteDocumentRequest, DocumentsApiDocumentCreateRequest, DocumentsApiDocumentCreateLinkRequest, DocumentsApiDocumentDetailsRequest, DocumentsApiDocumentListRequest, DocumentsApiDocumentStatusRequest, DocumentsApiDownloadDocumentRequest, DocumentsApiDownloadProtectedDocumentRequest, DocumentsApiLinkedObjectDeleteRequest, DocumentsApiLinkedObjectListRequest, DocumentsApiLinkedObjectsCreateRequest, DocumentsApiSendDocumentRequest, ObjectDocumentsApi as DocumentsApi, FoldersAPIApiCreateDocumentFolderRequest, FoldersAPIApiCreateTemplateFolderRequest, FoldersAPIApiListDocumentFoldersRequest, FoldersAPIApiListTemplateFoldersRequest, FoldersAPIApiRenameDocumentFolderRequest, FoldersAPIApiRenameTemplateFolderRequest, ObjectFoldersAPIApi as FoldersAPIApi, FormsApiListFormRequest, ObjectFormsApi as FormsApi, OAuth20AuthenticationApiAccessTokenRequest, ObjectOAuth20AuthenticationApi as OAuth20AuthenticationApi, TemplatesApiDeleteTemplateRequest, TemplatesApiDetailsTemaplateRequest, TemplatesApiListTemplatesRequest, ObjectTemplatesApi as TemplatesApi } from './types/ObjectParamAPI'; +export { APILogsApiDetailsApiLogRequest, APILogsApiListApiLogsRequest, ObjectAPILogsApi as APILogsApi, ContactsApiContactCreateRequest, ContactsApiContactDeleteRequest, ContactsApiContactDetailsRequest, ContactsApiContactListRequest, ContactsApiContactUpdateRequest, ObjectContactsApi as ContactsApi, ContentLibraryItemsApiDetailsContentLibraryItemRequest, ContentLibraryItemsApiListContentLibraryItemsRequest, ObjectContentLibraryItemsApi as ContentLibraryItemsApi, DocumentAttachmentsApiDocumentAttachmentCreateRequest, DocumentAttachmentsApiDocumentAttachmentDeleteRequest, DocumentAttachmentsApiDocumentAttachmentDetailsRequest, DocumentAttachmentsApiDocumentAttachmentDownloadRequest, DocumentAttachmentsApiDocumentAttachmentsListRequest, ObjectDocumentAttachmentsApi as DocumentAttachmentsApi, DocumentsApiDeleteDocumentRequest, DocumentsApiDocumentCreateRequest, DocumentsApiDocumentCreateLinkRequest, DocumentsApiDocumentDetailsRequest, DocumentsApiDocumentListRequest, DocumentsApiDocumentStatusRequest, DocumentsApiDocumentStatusChangeRequest, DocumentsApiDownloadDocumentRequest, DocumentsApiDownloadProtectedDocumentRequest, DocumentsApiLinkedObjectDeleteRequest, DocumentsApiLinkedObjectListRequest, DocumentsApiLinkedObjectsCreateRequest, DocumentsApiSendDocumentRequest, DocumentsApiTransferAllDocumentsOwnershipRequest, DocumentsApiTransferDocumentOwnershipRequest, ObjectDocumentsApi as DocumentsApi, FoldersAPIApiCreateDocumentFolderRequest, FoldersAPIApiCreateTemplateFolderRequest, FoldersAPIApiListDocumentFoldersRequest, FoldersAPIApiListTemplateFoldersRequest, FoldersAPIApiRenameDocumentFolderRequest, FoldersAPIApiRenameTemplateFolderRequest, ObjectFoldersAPIApi as FoldersAPIApi, FormsApiListFormRequest, ObjectFormsApi as FormsApi, MembersApiCurrentMemberDetailsRequest, MembersApiMemberDetailsRequest, MembersApiMemberListRequest, ObjectMembersApi as MembersApi, OAuth20AuthenticationApiAccessTokenRequest, ObjectOAuth20AuthenticationApi as OAuth20AuthenticationApi, TemplatesApiDeleteTemplateRequest, TemplatesApiDetailsTemaplateRequest, TemplatesApiListTemplatesRequest, ObjectTemplatesApi as TemplatesApi } from './types/ObjectParamAPI'; diff --git a/src/models/APILogDetailsResponse.ts b/src/models/APILogDetailsResponse.ts index 6a1eca8..5146a84 100644 --- a/src/models/APILogDetailsResponse.ts +++ b/src/models/APILogDetailsResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/APILogListResponse.ts b/src/models/APILogListResponse.ts index 459b60a..50e13de 100644 --- a/src/models/APILogListResponse.ts +++ b/src/models/APILogListResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/APILogListResponseResults.ts b/src/models/APILogListResponseResults.ts index 083d520..7e7ce96 100644 --- a/src/models/APILogListResponseResults.ts +++ b/src/models/APILogListResponseResults.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/ContactCreateRequest.ts b/src/models/ContactCreateRequest.ts new file mode 100644 index 0000000..9737272 --- /dev/null +++ b/src/models/ContactCreateRequest.ts @@ -0,0 +1,95 @@ +/** + * PandaDoc Public API + * PandaDoc Public API documentation + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { HttpFile } from '../http/http'; + +export class ContactCreateRequest { + 'email': string; + 'firstName'?: string; + 'lastName'?: string; + 'company'?: string; + 'jobTitle'?: string; + 'phone'?: string; + 'state'?: string; + 'streetAddress'?: string; + 'city'?: string; + 'postalCode'?: string; + + static readonly discriminator: string | undefined = undefined; + + static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ + { + "name": "email", + "baseName": "email", + "type": "string", + "format": "" + }, + { + "name": "firstName", + "baseName": "first_name", + "type": "string", + "format": "" + }, + { + "name": "lastName", + "baseName": "last_name", + "type": "string", + "format": "" + }, + { + "name": "company", + "baseName": "company", + "type": "string", + "format": "" + }, + { + "name": "jobTitle", + "baseName": "job_title", + "type": "string", + "format": "" + }, + { + "name": "phone", + "baseName": "phone", + "type": "string", + "format": "" + }, + { + "name": "state", + "baseName": "state", + "type": "string", + "format": "" + }, + { + "name": "streetAddress", + "baseName": "street_address", + "type": "string", + "format": "" + }, + { + "name": "city", + "baseName": "city", + "type": "string", + "format": "" + }, + { + "name": "postalCode", + "baseName": "postal_code", + "type": "string", + "format": "" + } ]; + + static getAttributeTypeMap() { + return ContactCreateRequest.attributeTypeMap; + } + + public constructor() { + } +} + diff --git a/src/models/ContactDetailsResponse.ts b/src/models/ContactDetailsResponse.ts new file mode 100644 index 0000000..72fa449 --- /dev/null +++ b/src/models/ContactDetailsResponse.ts @@ -0,0 +1,102 @@ +/** + * PandaDoc Public API + * PandaDoc Public API documentation + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { HttpFile } from '../http/http'; + +export class ContactDetailsResponse { + 'id'?: string; + 'email'?: string; + 'firstName'?: string; + 'lastName'?: string; + 'company'?: string; + 'jobTitle'?: string; + 'phone'?: string; + 'state'?: string; + 'streetAddress'?: string; + 'city'?: string; + 'postalCode'?: string; + + static readonly discriminator: string | undefined = undefined; + + static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ + { + "name": "id", + "baseName": "id", + "type": "string", + "format": "" + }, + { + "name": "email", + "baseName": "email", + "type": "string", + "format": "" + }, + { + "name": "firstName", + "baseName": "first_name", + "type": "string", + "format": "" + }, + { + "name": "lastName", + "baseName": "last_name", + "type": "string", + "format": "" + }, + { + "name": "company", + "baseName": "company", + "type": "string", + "format": "" + }, + { + "name": "jobTitle", + "baseName": "job_title", + "type": "string", + "format": "" + }, + { + "name": "phone", + "baseName": "phone", + "type": "string", + "format": "" + }, + { + "name": "state", + "baseName": "state", + "type": "string", + "format": "" + }, + { + "name": "streetAddress", + "baseName": "street_address", + "type": "string", + "format": "" + }, + { + "name": "city", + "baseName": "city", + "type": "string", + "format": "" + }, + { + "name": "postalCode", + "baseName": "postal_code", + "type": "string", + "format": "" + } ]; + + static getAttributeTypeMap() { + return ContactDetailsResponse.attributeTypeMap; + } + + public constructor() { + } +} + diff --git a/src/models/ContactUpdateRequest.ts b/src/models/ContactUpdateRequest.ts new file mode 100644 index 0000000..a54d408 --- /dev/null +++ b/src/models/ContactUpdateRequest.ts @@ -0,0 +1,95 @@ +/** + * PandaDoc Public API + * PandaDoc Public API documentation + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { HttpFile } from '../http/http'; + +export class ContactUpdateRequest { + 'email'?: string; + 'firstName'?: string; + 'lastName'?: string; + 'company'?: string; + 'jobTitle'?: string; + 'phone'?: string; + 'state'?: string; + 'streetAddress'?: string; + 'city'?: string; + 'postalCode'?: string; + + static readonly discriminator: string | undefined = undefined; + + static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ + { + "name": "email", + "baseName": "email", + "type": "string", + "format": "" + }, + { + "name": "firstName", + "baseName": "first_name", + "type": "string", + "format": "" + }, + { + "name": "lastName", + "baseName": "last_name", + "type": "string", + "format": "" + }, + { + "name": "company", + "baseName": "company", + "type": "string", + "format": "" + }, + { + "name": "jobTitle", + "baseName": "job_title", + "type": "string", + "format": "" + }, + { + "name": "phone", + "baseName": "phone", + "type": "string", + "format": "" + }, + { + "name": "state", + "baseName": "state", + "type": "string", + "format": "" + }, + { + "name": "streetAddress", + "baseName": "street_address", + "type": "string", + "format": "" + }, + { + "name": "city", + "baseName": "city", + "type": "string", + "format": "" + }, + { + "name": "postalCode", + "baseName": "postal_code", + "type": "string", + "format": "" + } ]; + + static getAttributeTypeMap() { + return ContactUpdateRequest.attributeTypeMap; + } + + public constructor() { + } +} + diff --git a/src/models/ContentLibraryItemListResponse.ts b/src/models/ContentLibraryItemListResponse.ts index 5815653..eae35f5 100644 --- a/src/models/ContentLibraryItemListResponse.ts +++ b/src/models/ContentLibraryItemListResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/ContentLibraryItemListResponseResults.ts b/src/models/ContentLibraryItemListResponseResults.ts index 7a87e84..d04f7b1 100644 --- a/src/models/ContentLibraryItemListResponseResults.ts +++ b/src/models/ContentLibraryItemListResponseResults.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/ContentLibraryItemResponse.ts b/src/models/ContentLibraryItemResponse.ts index e4b81df..86caee0 100644 --- a/src/models/ContentLibraryItemResponse.ts +++ b/src/models/ContentLibraryItemResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/ContentLibraryItemResponseCreatedBy.ts b/src/models/ContentLibraryItemResponseCreatedBy.ts index d2fb44f..6713689 100644 --- a/src/models/ContentLibraryItemResponseCreatedBy.ts +++ b/src/models/ContentLibraryItemResponseCreatedBy.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentAttachmentResponse.ts b/src/models/DocumentAttachmentResponse.ts new file mode 100644 index 0000000..fc147d3 --- /dev/null +++ b/src/models/DocumentAttachmentResponse.ts @@ -0,0 +1,54 @@ +/** + * PandaDoc Public API + * PandaDoc Public API documentation + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { DocumentAttachmentResponseCreatedBy } from './DocumentAttachmentResponseCreatedBy'; +import { HttpFile } from '../http/http'; + +export class DocumentAttachmentResponse { + 'uuid'?: string; + 'dateCreated'?: string; + 'createdBy'?: DocumentAttachmentResponseCreatedBy; + 'name'?: string; + + static readonly discriminator: string | undefined = undefined; + + static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ + { + "name": "uuid", + "baseName": "uuid", + "type": "string", + "format": "" + }, + { + "name": "dateCreated", + "baseName": "date_created", + "type": "string", + "format": "" + }, + { + "name": "createdBy", + "baseName": "created_by", + "type": "DocumentAttachmentResponseCreatedBy", + "format": "" + }, + { + "name": "name", + "baseName": "name", + "type": "string", + "format": "" + } ]; + + static getAttributeTypeMap() { + return DocumentAttachmentResponse.attributeTypeMap; + } + + public constructor() { + } +} + diff --git a/src/models/DocumentAttachmentResponseCreatedBy.ts b/src/models/DocumentAttachmentResponseCreatedBy.ts new file mode 100644 index 0000000..9bab997 --- /dev/null +++ b/src/models/DocumentAttachmentResponseCreatedBy.ts @@ -0,0 +1,60 @@ +/** + * PandaDoc Public API + * PandaDoc Public API documentation + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { HttpFile } from '../http/http'; + +export class DocumentAttachmentResponseCreatedBy { + 'id'?: string; + 'email'?: string; + 'firstName'?: string; + 'lastName'?: string; + 'avatar'?: string; + + static readonly discriminator: string | undefined = undefined; + + static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ + { + "name": "id", + "baseName": "id", + "type": "string", + "format": "" + }, + { + "name": "email", + "baseName": "email", + "type": "string", + "format": "" + }, + { + "name": "firstName", + "baseName": "first_name", + "type": "string", + "format": "" + }, + { + "name": "lastName", + "baseName": "last_name", + "type": "string", + "format": "" + }, + { + "name": "avatar", + "baseName": "avatar", + "type": "string", + "format": "" + } ]; + + static getAttributeTypeMap() { + return DocumentAttachmentResponseCreatedBy.attributeTypeMap; + } + + public constructor() { + } +} + diff --git a/src/models/DocumentCreateByPdfRequest.ts b/src/models/DocumentCreateByPdfRequest.ts index e83fd72..513b654 100644 --- a/src/models/DocumentCreateByPdfRequest.ts +++ b/src/models/DocumentCreateByPdfRequest.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentCreateByPdfRequestRecipients.ts b/src/models/DocumentCreateByPdfRequestRecipients.ts index 9fc966d..4e07ebb 100644 --- a/src/models/DocumentCreateByPdfRequestRecipients.ts +++ b/src/models/DocumentCreateByPdfRequestRecipients.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentCreateByTemplateRequest.ts b/src/models/DocumentCreateByTemplateRequest.ts index a4b42b8..8b9854c 100644 --- a/src/models/DocumentCreateByTemplateRequest.ts +++ b/src/models/DocumentCreateByTemplateRequest.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. @@ -13,8 +10,8 @@ import { DocumentCreateByTemplateRequestContentPlaceholders } from './DocumentCreateByTemplateRequestContentPlaceholders'; import { DocumentCreateByTemplateRequestImages } from './DocumentCreateByTemplateRequestImages'; import { DocumentCreateByTemplateRequestRecipients } from './DocumentCreateByTemplateRequestRecipients'; +import { DocumentCreateByTemplateRequestTokens } from './DocumentCreateByTemplateRequestTokens'; import { PricingTableRequest } from './PricingTableRequest'; -import { PublicV1DocumentsTokens } from './PublicV1DocumentsTokens'; import { HttpFile } from '../http/http'; export class DocumentCreateByTemplateRequest { @@ -34,7 +31,7 @@ export class DocumentCreateByTemplateRequest { /** * You can pass a list of tokens/values to pre-fill tokens used in a template. Name is a token name in a template. Value is a real value you would like to replace a token with. */ - 'tokens'?: Array; + 'tokens'?: Array; /** * You can pass a list of fields/values to pre-fill fields used in a template. Note that the Signature field can't be pre-filled. */ @@ -90,7 +87,7 @@ export class DocumentCreateByTemplateRequest { { "name": "tokens", "baseName": "tokens", - "type": "Array", + "type": "Array", "format": "" }, { diff --git a/src/models/DocumentCreateByTemplateRequestContentLibraryItems.ts b/src/models/DocumentCreateByTemplateRequestContentLibraryItems.ts index 260cec5..5b326fd 100644 --- a/src/models/DocumentCreateByTemplateRequestContentLibraryItems.ts +++ b/src/models/DocumentCreateByTemplateRequestContentLibraryItems.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentCreateByTemplateRequestContentPlaceholders.ts b/src/models/DocumentCreateByTemplateRequestContentPlaceholders.ts index 9d06a07..29d0281 100644 --- a/src/models/DocumentCreateByTemplateRequestContentPlaceholders.ts +++ b/src/models/DocumentCreateByTemplateRequestContentPlaceholders.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentCreateByTemplateRequestImages.ts b/src/models/DocumentCreateByTemplateRequestImages.ts index c089841..98d1710 100644 --- a/src/models/DocumentCreateByTemplateRequestImages.ts +++ b/src/models/DocumentCreateByTemplateRequestImages.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentCreateByTemplateRequestRecipients.ts b/src/models/DocumentCreateByTemplateRequestRecipients.ts index 98641b0..d5e87aa 100644 --- a/src/models/DocumentCreateByTemplateRequestRecipients.ts +++ b/src/models/DocumentCreateByTemplateRequestRecipients.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/PublicV1DocumentsTokens.ts b/src/models/DocumentCreateByTemplateRequestTokens.ts similarity index 86% rename from src/models/PublicV1DocumentsTokens.ts rename to src/models/DocumentCreateByTemplateRequestTokens.ts index 76c00c7..ed05f0a 100644 --- a/src/models/PublicV1DocumentsTokens.ts +++ b/src/models/DocumentCreateByTemplateRequestTokens.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. @@ -12,7 +9,7 @@ import { HttpFile } from '../http/http'; -export class PublicV1DocumentsTokens { +export class DocumentCreateByTemplateRequestTokens { 'name'?: string; 'value'?: string; @@ -33,7 +30,7 @@ export class PublicV1DocumentsTokens { } ]; static getAttributeTypeMap() { - return PublicV1DocumentsTokens.attributeTypeMap; + return DocumentCreateByTemplateRequestTokens.attributeTypeMap; } public constructor() { diff --git a/src/models/DocumentCreateLinkRequest.ts b/src/models/DocumentCreateLinkRequest.ts index 55dce63..0a4c727 100644 --- a/src/models/DocumentCreateLinkRequest.ts +++ b/src/models/DocumentCreateLinkRequest.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentCreateLinkResponse.ts b/src/models/DocumentCreateLinkResponse.ts index 0fd1894..67db48a 100644 --- a/src/models/DocumentCreateLinkResponse.ts +++ b/src/models/DocumentCreateLinkResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/InlineObject.ts b/src/models/DocumentCreateRequest.ts similarity index 84% rename from src/models/InlineObject.ts rename to src/models/DocumentCreateRequest.ts index 7a82c97..cb9ce90 100644 --- a/src/models/InlineObject.ts +++ b/src/models/DocumentCreateRequest.ts @@ -2,22 +2,19 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ +import { DocumentCreateByTemplateRequestTokens } from './DocumentCreateByTemplateRequestTokens'; +import { DocumentCreateRequestContentPlaceholders } from './DocumentCreateRequestContentPlaceholders'; +import { DocumentCreateRequestImages } from './DocumentCreateRequestImages'; +import { DocumentCreateRequestRecipients } from './DocumentCreateRequestRecipients'; import { PricingTableRequest } from './PricingTableRequest'; -import { PublicV1DocumentsContentPlaceholders } from './PublicV1DocumentsContentPlaceholders'; -import { PublicV1DocumentsImages } from './PublicV1DocumentsImages'; -import { PublicV1DocumentsRecipients } from './PublicV1DocumentsRecipients'; -import { PublicV1DocumentsTokens } from './PublicV1DocumentsTokens'; import { HttpFile } from '../http/http'; -export class InlineObject { +export class DocumentCreateRequest { /** * Name the document you are creating. */ @@ -33,11 +30,11 @@ export class InlineObject { /** * The list of recipients you're sending the document to. Every object must contain the `email` parameter. The `role`, `first_name` and `last_name` parameters are optional. If the `role` parameter is passed, a person is assigned all fields matching their corresponding role. If a role was not passed, a person receives a read-only link to view the document. If the `first_name` and `last_name` are not passed, the system does this 1. Creates a new contact, if none exists with the given `email`; or 2. Gets the existing contact with the given `email` that already exists. */ - 'recipients'?: Array; + 'recipients'?: Array; /** * You can pass a list of tokens/values to pre-fill tokens used in a template. Name is a token name in a template. Value is a real value you would like to replace a token with. */ - 'tokens'?: Array; + 'tokens'?: Array; /** * You can pass a list of fields/values to pre-fill fields used in a template. Please note Signature field can't be pre-filled. */ @@ -53,7 +50,7 @@ export class InlineObject { /** * You can pass a list of images to image blocks (one image in one block) for replacement. */ - 'images'?: Array; + 'images'?: Array; /** * Information to construct or populate a pricing table can be passed when creating a document. All product information must be passed when creating a new document. Products stored in PandaDoc cannot be used to populate table rows at this time. Keep in mind that this is an array, so multiple table objects can be passed to a document. */ @@ -61,7 +58,7 @@ export class InlineObject { /** * You may replace Content Library Item Placeholders with a few content library items each and pre-fill fields/variables values, pricing table items, and assign recipients to roles from there. */ - 'contentPlaceholders'?: Array; + 'contentPlaceholders'?: Array; /** * Use a URL to specify the PDF. We support only URLs starting with https. */ @@ -95,13 +92,13 @@ export class InlineObject { { "name": "recipients", "baseName": "recipients", - "type": "Array", + "type": "Array", "format": "" }, { "name": "tokens", "baseName": "tokens", - "type": "Array", + "type": "Array", "format": "" }, { @@ -125,7 +122,7 @@ export class InlineObject { { "name": "images", "baseName": "images", - "type": "Array", + "type": "Array", "format": "" }, { @@ -137,7 +134,7 @@ export class InlineObject { { "name": "contentPlaceholders", "baseName": "content_placeholders", - "type": "Array", + "type": "Array", "format": "" }, { @@ -154,7 +151,7 @@ export class InlineObject { } ]; static getAttributeTypeMap() { - return InlineObject.attributeTypeMap; + return DocumentCreateRequest.attributeTypeMap; } public constructor() { diff --git a/src/models/PublicV1DocumentsContentLibraryItems.ts b/src/models/DocumentCreateRequestContentLibraryItems.ts similarity index 89% rename from src/models/PublicV1DocumentsContentLibraryItems.ts rename to src/models/DocumentCreateRequestContentLibraryItems.ts index 5841635..60de8a6 100644 --- a/src/models/PublicV1DocumentsContentLibraryItems.ts +++ b/src/models/DocumentCreateRequestContentLibraryItems.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. @@ -13,7 +10,7 @@ import { PricingTableRequest } from './PricingTableRequest'; import { HttpFile } from '../http/http'; -export class PublicV1DocumentsContentLibraryItems { +export class DocumentCreateRequestContentLibraryItems { /** * Content library item id */ @@ -51,7 +48,7 @@ export class PublicV1DocumentsContentLibraryItems { } ]; static getAttributeTypeMap() { - return PublicV1DocumentsContentLibraryItems.attributeTypeMap; + return DocumentCreateRequestContentLibraryItems.attributeTypeMap; } public constructor() { diff --git a/src/models/PublicV1DocumentsContentPlaceholders.ts b/src/models/DocumentCreateRequestContentPlaceholders.ts similarity index 69% rename from src/models/PublicV1DocumentsContentPlaceholders.ts rename to src/models/DocumentCreateRequestContentPlaceholders.ts index 2710661..9e9d16b 100644 --- a/src/models/PublicV1DocumentsContentPlaceholders.ts +++ b/src/models/DocumentCreateRequestContentPlaceholders.ts @@ -2,23 +2,20 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ -import { PublicV1DocumentsContentLibraryItems } from './PublicV1DocumentsContentLibraryItems'; +import { DocumentCreateRequestContentLibraryItems } from './DocumentCreateRequestContentLibraryItems'; import { HttpFile } from '../http/http'; -export class PublicV1DocumentsContentPlaceholders { +export class DocumentCreateRequestContentPlaceholders { /** * Content placeholder block id */ 'blockId'?: string; - 'contentLibraryItems'?: Array; + 'contentLibraryItems'?: Array; static readonly discriminator: string | undefined = undefined; @@ -32,12 +29,12 @@ export class PublicV1DocumentsContentPlaceholders { { "name": "contentLibraryItems", "baseName": "content_library_items", - "type": "Array", + "type": "Array", "format": "" } ]; static getAttributeTypeMap() { - return PublicV1DocumentsContentPlaceholders.attributeTypeMap; + return DocumentCreateRequestContentPlaceholders.attributeTypeMap; } public constructor() { diff --git a/src/models/PublicV1DocumentsImages.ts b/src/models/DocumentCreateRequestImages.ts similarity index 86% rename from src/models/PublicV1DocumentsImages.ts rename to src/models/DocumentCreateRequestImages.ts index 58ef590..bb5f95c 100644 --- a/src/models/PublicV1DocumentsImages.ts +++ b/src/models/DocumentCreateRequestImages.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. @@ -12,7 +9,7 @@ import { HttpFile } from '../http/http'; -export class PublicV1DocumentsImages { +export class DocumentCreateRequestImages { 'urls'?: Array; 'name'?: string; @@ -33,7 +30,7 @@ export class PublicV1DocumentsImages { } ]; static getAttributeTypeMap() { - return PublicV1DocumentsImages.attributeTypeMap; + return DocumentCreateRequestImages.attributeTypeMap; } public constructor() { diff --git a/src/models/PublicV1DocumentsRecipients.ts b/src/models/DocumentCreateRequestRecipients.ts similarity index 90% rename from src/models/PublicV1DocumentsRecipients.ts rename to src/models/DocumentCreateRequestRecipients.ts index 9248819..c012c4a 100644 --- a/src/models/PublicV1DocumentsRecipients.ts +++ b/src/models/DocumentCreateRequestRecipients.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. @@ -12,7 +9,7 @@ import { HttpFile } from '../http/http'; -export class PublicV1DocumentsRecipients { +export class DocumentCreateRequestRecipients { 'email'?: string; 'firstName'?: string; 'lastName'?: string; @@ -54,7 +51,7 @@ export class PublicV1DocumentsRecipients { } ]; static getAttributeTypeMap() { - return PublicV1DocumentsRecipients.attributeTypeMap; + return DocumentCreateRequestRecipients.attributeTypeMap; } public constructor() { diff --git a/src/models/DocumentCreateResponse.ts b/src/models/DocumentCreateResponse.ts index 7fcc59a..8452a61 100644 --- a/src/models/DocumentCreateResponse.ts +++ b/src/models/DocumentCreateResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentDetailsResponse.ts b/src/models/DocumentDetailsResponse.ts index ec05573..ad247e3 100644 --- a/src/models/DocumentDetailsResponse.ts +++ b/src/models/DocumentDetailsResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentDetailsResponseCreatedBy.ts b/src/models/DocumentDetailsResponseCreatedBy.ts index 6ab37be..295d1be 100644 --- a/src/models/DocumentDetailsResponseCreatedBy.ts +++ b/src/models/DocumentDetailsResponseCreatedBy.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. @@ -14,6 +11,7 @@ import { HttpFile } from '../http/http'; export class DocumentDetailsResponseCreatedBy { 'id'?: string; + 'membershipId'?: string; 'email'?: string; 'firstName'?: string; 'lastName'?: string; @@ -28,6 +26,12 @@ export class DocumentDetailsResponseCreatedBy { "type": "string", "format": "" }, + { + "name": "membershipId", + "baseName": "membership_id", + "type": "string", + "format": "" + }, { "name": "email", "baseName": "email", diff --git a/src/models/DocumentDetailsResponseGrandTotal.ts b/src/models/DocumentDetailsResponseGrandTotal.ts index 88839b7..21c314e 100644 --- a/src/models/DocumentDetailsResponseGrandTotal.ts +++ b/src/models/DocumentDetailsResponseGrandTotal.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentDetailsResponseLinkedObjects.ts b/src/models/DocumentDetailsResponseLinkedObjects.ts index e1c65cf..c393bcb 100644 --- a/src/models/DocumentDetailsResponseLinkedObjects.ts +++ b/src/models/DocumentDetailsResponseLinkedObjects.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentDetailsResponseRecipients.ts b/src/models/DocumentDetailsResponseRecipients.ts index bf3a5e3..a73b133 100644 --- a/src/models/DocumentDetailsResponseRecipients.ts +++ b/src/models/DocumentDetailsResponseRecipients.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. @@ -18,6 +15,7 @@ export class DocumentDetailsResponseRecipients { 'lastName'?: string; 'signingOrder'?: any; 'id'?: string; + 'contactId'?: string; 'firstName'?: string; 'email'?: string; 'hasCompleted'?: boolean; @@ -55,6 +53,12 @@ export class DocumentDetailsResponseRecipients { "type": "string", "format": "" }, + { + "name": "contactId", + "baseName": "contact_id", + "type": "string", + "format": "" + }, { "name": "firstName", "baseName": "first_name", diff --git a/src/models/DocumentDetailsResponseTemplate.ts b/src/models/DocumentDetailsResponseTemplate.ts index 3370567..d82ad28 100644 --- a/src/models/DocumentDetailsResponseTemplate.ts +++ b/src/models/DocumentDetailsResponseTemplate.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentListResponse.ts b/src/models/DocumentListResponse.ts index 4161dce..45ed661 100644 --- a/src/models/DocumentListResponse.ts +++ b/src/models/DocumentListResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentListResponseResults.ts b/src/models/DocumentListResponseResults.ts index 2cfdb56..126abd6 100644 --- a/src/models/DocumentListResponseResults.ts +++ b/src/models/DocumentListResponseResults.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentOrderingFieldsEnum.ts b/src/models/DocumentOrderingFieldsEnum.ts index 14a5112..2bfae8f 100644 --- a/src/models/DocumentOrderingFieldsEnum.ts +++ b/src/models/DocumentOrderingFieldsEnum.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentSendRequest.ts b/src/models/DocumentSendRequest.ts index 0fb800b..9d6e336 100644 --- a/src/models/DocumentSendRequest.ts +++ b/src/models/DocumentSendRequest.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentSendResponse.ts b/src/models/DocumentSendResponse.ts index e9464b5..a2b2a53 100644 --- a/src/models/DocumentSendResponse.ts +++ b/src/models/DocumentSendResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentStatusChangeRequest.ts b/src/models/DocumentStatusChangeRequest.ts new file mode 100644 index 0000000..9fbb1c3 --- /dev/null +++ b/src/models/DocumentStatusChangeRequest.ts @@ -0,0 +1,53 @@ +/** + * PandaDoc Public API + * PandaDoc Public API documentation + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { DocumentStatusEnum } from './DocumentStatusEnum'; +import { HttpFile } from '../http/http'; + +export class DocumentStatusChangeRequest { + 'status': DocumentStatusEnum; + /** + * Provide “private notes” regarding the manual status change. + */ + 'note'?: string; + /** + * Send a notification email about the status change to all recipients. + */ + 'notifyRecipients'?: boolean; + + static readonly discriminator: string | undefined = undefined; + + static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ + { + "name": "status", + "baseName": "status", + "type": "DocumentStatusEnum", + "format": "" + }, + { + "name": "note", + "baseName": "note", + "type": "string", + "format": "" + }, + { + "name": "notifyRecipients", + "baseName": "notify_recipients", + "type": "boolean", + "format": "" + } ]; + + static getAttributeTypeMap() { + return DocumentStatusChangeRequest.attributeTypeMap; + } + + public constructor() { + } +} + diff --git a/src/models/DocumentStatusEnum.ts b/src/models/DocumentStatusEnum.ts index f3979fe..67bb974 100644 --- a/src/models/DocumentStatusEnum.ts +++ b/src/models/DocumentStatusEnum.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentStatusResponse.ts b/src/models/DocumentStatusResponse.ts index fb2cf97..a5232d6 100644 --- a/src/models/DocumentStatusResponse.ts +++ b/src/models/DocumentStatusResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentTransferAllOwnershipRequest.ts b/src/models/DocumentTransferAllOwnershipRequest.ts new file mode 100644 index 0000000..6c6f6c5 --- /dev/null +++ b/src/models/DocumentTransferAllOwnershipRequest.ts @@ -0,0 +1,45 @@ +/** + * PandaDoc Public API + * PandaDoc Public API documentation + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { HttpFile } from '../http/http'; + +export class DocumentTransferAllOwnershipRequest { + /** + * A unique identifier of a workspace member from whom you want to transfer ownership. + */ + 'fromMembershipId'?: string; + /** + * A unique identifier of a workspace member to whom you want to transfer ownership. + */ + 'toMembershipId'?: string; + + static readonly discriminator: string | undefined = undefined; + + static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ + { + "name": "fromMembershipId", + "baseName": "from_membership_id", + "type": "string", + "format": "" + }, + { + "name": "toMembershipId", + "baseName": "to_membership_id", + "type": "string", + "format": "" + } ]; + + static getAttributeTypeMap() { + return DocumentTransferAllOwnershipRequest.attributeTypeMap; + } + + public constructor() { + } +} + diff --git a/src/models/DocumentTransferOwnershipRequest.ts b/src/models/DocumentTransferOwnershipRequest.ts new file mode 100644 index 0000000..2b13a33 --- /dev/null +++ b/src/models/DocumentTransferOwnershipRequest.ts @@ -0,0 +1,35 @@ +/** + * PandaDoc Public API + * PandaDoc Public API documentation + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { HttpFile } from '../http/http'; + +export class DocumentTransferOwnershipRequest { + /** + * A unique identifier of a workspace member. + */ + 'membershipId'?: string; + + static readonly discriminator: string | undefined = undefined; + + static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ + { + "name": "membershipId", + "baseName": "membership_id", + "type": "string", + "format": "" + } ]; + + static getAttributeTypeMap() { + return DocumentTransferOwnershipRequest.attributeTypeMap; + } + + public constructor() { + } +} + diff --git a/src/models/DocumentsFolderCreateRequest.ts b/src/models/DocumentsFolderCreateRequest.ts index eb02d79..1223dee 100644 --- a/src/models/DocumentsFolderCreateRequest.ts +++ b/src/models/DocumentsFolderCreateRequest.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentsFolderCreateResponse.ts b/src/models/DocumentsFolderCreateResponse.ts index f4c917f..91d53d2 100644 --- a/src/models/DocumentsFolderCreateResponse.ts +++ b/src/models/DocumentsFolderCreateResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentsFolderListResponse.ts b/src/models/DocumentsFolderListResponse.ts index dfc3832..8e654cc 100644 --- a/src/models/DocumentsFolderListResponse.ts +++ b/src/models/DocumentsFolderListResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentsFolderListResponseResults.ts b/src/models/DocumentsFolderListResponseResults.ts index b9c4fbd..8a18e42 100644 --- a/src/models/DocumentsFolderListResponseResults.ts +++ b/src/models/DocumentsFolderListResponseResults.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentsFolderRenameRequest.ts b/src/models/DocumentsFolderRenameRequest.ts index c2fce83..107026e 100644 --- a/src/models/DocumentsFolderRenameRequest.ts +++ b/src/models/DocumentsFolderRenameRequest.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/DocumentsFolderRenameResponse.ts b/src/models/DocumentsFolderRenameResponse.ts index 0dab60c..34b8f74 100644 --- a/src/models/DocumentsFolderRenameResponse.ts +++ b/src/models/DocumentsFolderRenameResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/FormListResponse.ts b/src/models/FormListResponse.ts index 138c406..1d86608 100644 --- a/src/models/FormListResponse.ts +++ b/src/models/FormListResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/FormListResponseResults.ts b/src/models/FormListResponseResults.ts index 63fda8b..6e15739 100644 --- a/src/models/FormListResponseResults.ts +++ b/src/models/FormListResponseResults.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/LinkedObjectCreateRequest.ts b/src/models/LinkedObjectCreateRequest.ts index a34574f..11a3af0 100644 --- a/src/models/LinkedObjectCreateRequest.ts +++ b/src/models/LinkedObjectCreateRequest.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/LinkedObjectCreateResponse.ts b/src/models/LinkedObjectCreateResponse.ts index 4cae0ab..4a6874a 100644 --- a/src/models/LinkedObjectCreateResponse.ts +++ b/src/models/LinkedObjectCreateResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/LinkedObjectListResponse.ts b/src/models/LinkedObjectListResponse.ts index 7a535e2..53fb241 100644 --- a/src/models/LinkedObjectListResponse.ts +++ b/src/models/LinkedObjectListResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/MemberDetailsResponse.ts b/src/models/MemberDetailsResponse.ts new file mode 100644 index 0000000..3b6e335 --- /dev/null +++ b/src/models/MemberDetailsResponse.ts @@ -0,0 +1,155 @@ +/** + * PandaDoc Public API + * PandaDoc Public API documentation + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { HttpFile } from '../http/http'; + +export class MemberDetailsResponse { + /** + * A unique identifier of the user in the organization. + */ + 'userId'?: string; + /** + * A unique identifier of the user in the workspace. + */ + 'membershipId'?: string; + /** + * A user's email address. + */ + 'email'?: string; + /** + * A user's first name. + */ + 'firstName'?: string; + /** + * A user's last name. + */ + 'lastName'?: string; + /** + * A boolean value that identifies if a member is active in the workspace. + */ + 'isActive'?: boolean; + /** + * A name of the user's current active workspace. + */ + 'workspace'?: string; + /** + * A unique identifier of the user's current active workspace. + */ + 'workspaceName'?: string; + /** + * A boolean value that identifies if the email is verified. + */ + 'emailsVerified'?: boolean; + /** + * A member's role in the workspace. + */ + 'role'?: string; + /** + * A user license in the organization. + */ + 'userLicense'?: string; + /** + * A date when a member was added to the workspace. + */ + 'dateCreated'?: string; + /** + * Last modified date of a member. + */ + 'dateModified'?: string; + + static readonly discriminator: string | undefined = undefined; + + static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ + { + "name": "userId", + "baseName": "user_id", + "type": "string", + "format": "" + }, + { + "name": "membershipId", + "baseName": "membership_id", + "type": "string", + "format": "" + }, + { + "name": "email", + "baseName": "email", + "type": "string", + "format": "" + }, + { + "name": "firstName", + "baseName": "first_name", + "type": "string", + "format": "" + }, + { + "name": "lastName", + "baseName": "last_name", + "type": "string", + "format": "" + }, + { + "name": "isActive", + "baseName": "is_active", + "type": "boolean", + "format": "" + }, + { + "name": "workspace", + "baseName": "workspace", + "type": "string", + "format": "" + }, + { + "name": "workspaceName", + "baseName": "workspace_name", + "type": "string", + "format": "" + }, + { + "name": "emailsVerified", + "baseName": "emails_verified", + "type": "boolean", + "format": "" + }, + { + "name": "role", + "baseName": "role", + "type": "string", + "format": "" + }, + { + "name": "userLicense", + "baseName": "user_license", + "type": "string", + "format": "" + }, + { + "name": "dateCreated", + "baseName": "date_created", + "type": "string", + "format": "" + }, + { + "name": "dateModified", + "baseName": "date_modified", + "type": "string", + "format": "" + } ]; + + static getAttributeTypeMap() { + return MemberDetailsResponse.attributeTypeMap; + } + + public constructor() { + } +} + diff --git a/src/models/OAuth2AccessTokenResponse.ts b/src/models/OAuth2AccessTokenResponse.ts index 99e52cd..8ccf38d 100644 --- a/src/models/OAuth2AccessTokenResponse.ts +++ b/src/models/OAuth2AccessTokenResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/ObjectSerializer.ts b/src/models/ObjectSerializer.ts index fd82d7f..8e9b73d 100644 --- a/src/models/ObjectSerializer.ts +++ b/src/models/ObjectSerializer.ts @@ -1,10 +1,15 @@ export * from './APILogDetailsResponse'; export * from './APILogListResponse'; export * from './APILogListResponseResults'; +export * from './ContactCreateRequest'; +export * from './ContactDetailsResponse'; +export * from './ContactUpdateRequest'; export * from './ContentLibraryItemListResponse'; export * from './ContentLibraryItemListResponseResults'; export * from './ContentLibraryItemResponse'; export * from './ContentLibraryItemResponseCreatedBy'; +export * from './DocumentAttachmentResponse'; +export * from './DocumentAttachmentResponseCreatedBy'; export * from './DocumentCreateByPdfRequest'; export * from './DocumentCreateByPdfRequestRecipients'; export * from './DocumentCreateByTemplateRequest'; @@ -12,8 +17,14 @@ export * from './DocumentCreateByTemplateRequestContentLibraryItems'; export * from './DocumentCreateByTemplateRequestContentPlaceholders'; export * from './DocumentCreateByTemplateRequestImages'; export * from './DocumentCreateByTemplateRequestRecipients'; +export * from './DocumentCreateByTemplateRequestTokens'; export * from './DocumentCreateLinkRequest'; export * from './DocumentCreateLinkResponse'; +export * from './DocumentCreateRequest'; +export * from './DocumentCreateRequestContentLibraryItems'; +export * from './DocumentCreateRequestContentPlaceholders'; +export * from './DocumentCreateRequestImages'; +export * from './DocumentCreateRequestRecipients'; export * from './DocumentCreateResponse'; export * from './DocumentDetailsResponse'; export * from './DocumentDetailsResponseCreatedBy'; @@ -26,8 +37,11 @@ export * from './DocumentListResponseResults'; export * from './DocumentOrderingFieldsEnum'; export * from './DocumentSendRequest'; export * from './DocumentSendResponse'; +export * from './DocumentStatusChangeRequest'; export * from './DocumentStatusEnum'; export * from './DocumentStatusResponse'; +export * from './DocumentTransferAllOwnershipRequest'; +export * from './DocumentTransferOwnershipRequest'; export * from './DocumentsFolderCreateRequest'; export * from './DocumentsFolderCreateResponse'; export * from './DocumentsFolderListResponse'; @@ -36,10 +50,10 @@ export * from './DocumentsFolderRenameRequest'; export * from './DocumentsFolderRenameResponse'; export * from './FormListResponse'; export * from './FormListResponseResults'; -export * from './InlineObject'; export * from './LinkedObjectCreateRequest'; export * from './LinkedObjectCreateResponse'; export * from './LinkedObjectListResponse'; +export * from './MemberDetailsResponse'; export * from './OAuth2AccessTokenResponse'; export * from './PricingTableRequest'; export * from './PricingTableRequestData'; @@ -57,11 +71,6 @@ export * from './PricingTablesResponseItems'; export * from './PricingTablesResponseOptions'; export * from './PricingTablesResponseSummary'; export * from './PricingTablesResponseTables'; -export * from './PublicV1DocumentsContentLibraryItems'; -export * from './PublicV1DocumentsContentPlaceholders'; -export * from './PublicV1DocumentsImages'; -export * from './PublicV1DocumentsRecipients'; -export * from './PublicV1DocumentsTokens'; export * from './TemplateDetailsResponse'; export * from './TemplateDetailsResponseAssignedTo'; export * from './TemplateDetailsResponseContentPlaceholders'; @@ -82,10 +91,15 @@ export * from './TemplatesFolderRenameResponse'; import { APILogDetailsResponse } from './APILogDetailsResponse'; import { APILogListResponse } from './APILogListResponse'; import { APILogListResponseResults } from './APILogListResponseResults'; +import { ContactCreateRequest } from './ContactCreateRequest'; +import { ContactDetailsResponse } from './ContactDetailsResponse'; +import { ContactUpdateRequest } from './ContactUpdateRequest'; import { ContentLibraryItemListResponse } from './ContentLibraryItemListResponse'; import { ContentLibraryItemListResponseResults } from './ContentLibraryItemListResponseResults'; import { ContentLibraryItemResponse } from './ContentLibraryItemResponse'; import { ContentLibraryItemResponseCreatedBy } from './ContentLibraryItemResponseCreatedBy'; +import { DocumentAttachmentResponse } from './DocumentAttachmentResponse'; +import { DocumentAttachmentResponseCreatedBy } from './DocumentAttachmentResponseCreatedBy'; import { DocumentCreateByPdfRequest } from './DocumentCreateByPdfRequest'; import { DocumentCreateByPdfRequestRecipients } from './DocumentCreateByPdfRequestRecipients'; import { DocumentCreateByTemplateRequest } from './DocumentCreateByTemplateRequest'; @@ -93,8 +107,14 @@ import { DocumentCreateByTemplateRequestContentLibraryItems } from './DocumentCr import { DocumentCreateByTemplateRequestContentPlaceholders } from './DocumentCreateByTemplateRequestContentPlaceholders'; import { DocumentCreateByTemplateRequestImages } from './DocumentCreateByTemplateRequestImages'; import { DocumentCreateByTemplateRequestRecipients } from './DocumentCreateByTemplateRequestRecipients'; +import { DocumentCreateByTemplateRequestTokens } from './DocumentCreateByTemplateRequestTokens'; import { DocumentCreateLinkRequest } from './DocumentCreateLinkRequest'; import { DocumentCreateLinkResponse } from './DocumentCreateLinkResponse'; +import { DocumentCreateRequest } from './DocumentCreateRequest'; +import { DocumentCreateRequestContentLibraryItems } from './DocumentCreateRequestContentLibraryItems'; +import { DocumentCreateRequestContentPlaceholders } from './DocumentCreateRequestContentPlaceholders'; +import { DocumentCreateRequestImages } from './DocumentCreateRequestImages'; +import { DocumentCreateRequestRecipients } from './DocumentCreateRequestRecipients'; import { DocumentCreateResponse } from './DocumentCreateResponse'; import { DocumentDetailsResponse } from './DocumentDetailsResponse'; import { DocumentDetailsResponseCreatedBy } from './DocumentDetailsResponseCreatedBy'; @@ -107,8 +127,11 @@ import { DocumentListResponseResults } from './DocumentListResponseResults'; import { DocumentOrderingFieldsEnum } from './DocumentOrderingFieldsEnum'; import { DocumentSendRequest } from './DocumentSendRequest'; import { DocumentSendResponse } from './DocumentSendResponse'; +import { DocumentStatusChangeRequest } from './DocumentStatusChangeRequest'; import { DocumentStatusEnum } from './DocumentStatusEnum'; import { DocumentStatusResponse } from './DocumentStatusResponse'; +import { DocumentTransferAllOwnershipRequest } from './DocumentTransferAllOwnershipRequest'; +import { DocumentTransferOwnershipRequest } from './DocumentTransferOwnershipRequest'; import { DocumentsFolderCreateRequest } from './DocumentsFolderCreateRequest'; import { DocumentsFolderCreateResponse } from './DocumentsFolderCreateResponse'; import { DocumentsFolderListResponse } from './DocumentsFolderListResponse'; @@ -117,10 +140,10 @@ import { DocumentsFolderRenameRequest } from './DocumentsFolderRenameRequest'; import { DocumentsFolderRenameResponse } from './DocumentsFolderRenameResponse'; import { FormListResponse } from './FormListResponse'; import { FormListResponseResults } from './FormListResponseResults'; -import { InlineObject } from './InlineObject'; import { LinkedObjectCreateRequest } from './LinkedObjectCreateRequest'; import { LinkedObjectCreateResponse } from './LinkedObjectCreateResponse'; import { LinkedObjectListResponse } from './LinkedObjectListResponse'; +import { MemberDetailsResponse } from './MemberDetailsResponse'; import { OAuth2AccessTokenResponse } from './OAuth2AccessTokenResponse'; import { PricingTableRequest } from './PricingTableRequest'; import { PricingTableRequestData } from './PricingTableRequestData'; @@ -138,11 +161,6 @@ import { PricingTablesResponseItems } from './PricingTablesResponseItems'; import { PricingTablesResponseOptions } from './PricingTablesResponseOptions'; import { PricingTablesResponseSummary } from './PricingTablesResponseSummary'; import { PricingTablesResponseTables } from './PricingTablesResponseTables'; -import { PublicV1DocumentsContentLibraryItems } from './PublicV1DocumentsContentLibraryItems'; -import { PublicV1DocumentsContentPlaceholders } from './PublicV1DocumentsContentPlaceholders'; -import { PublicV1DocumentsImages } from './PublicV1DocumentsImages'; -import { PublicV1DocumentsRecipients } from './PublicV1DocumentsRecipients'; -import { PublicV1DocumentsTokens } from './PublicV1DocumentsTokens'; import { TemplateDetailsResponse } from './TemplateDetailsResponse'; import { TemplateDetailsResponseAssignedTo } from './TemplateDetailsResponseAssignedTo'; import { TemplateDetailsResponseContentPlaceholders } from './TemplateDetailsResponseContentPlaceholders'; @@ -191,10 +209,15 @@ let typeMap: {[index: string]: any} = { "APILogDetailsResponse": APILogDetailsResponse, "APILogListResponse": APILogListResponse, "APILogListResponseResults": APILogListResponseResults, + "ContactCreateRequest": ContactCreateRequest, + "ContactDetailsResponse": ContactDetailsResponse, + "ContactUpdateRequest": ContactUpdateRequest, "ContentLibraryItemListResponse": ContentLibraryItemListResponse, "ContentLibraryItemListResponseResults": ContentLibraryItemListResponseResults, "ContentLibraryItemResponse": ContentLibraryItemResponse, "ContentLibraryItemResponseCreatedBy": ContentLibraryItemResponseCreatedBy, + "DocumentAttachmentResponse": DocumentAttachmentResponse, + "DocumentAttachmentResponseCreatedBy": DocumentAttachmentResponseCreatedBy, "DocumentCreateByPdfRequest": DocumentCreateByPdfRequest, "DocumentCreateByPdfRequestRecipients": DocumentCreateByPdfRequestRecipients, "DocumentCreateByTemplateRequest": DocumentCreateByTemplateRequest, @@ -202,8 +225,14 @@ let typeMap: {[index: string]: any} = { "DocumentCreateByTemplateRequestContentPlaceholders": DocumentCreateByTemplateRequestContentPlaceholders, "DocumentCreateByTemplateRequestImages": DocumentCreateByTemplateRequestImages, "DocumentCreateByTemplateRequestRecipients": DocumentCreateByTemplateRequestRecipients, + "DocumentCreateByTemplateRequestTokens": DocumentCreateByTemplateRequestTokens, "DocumentCreateLinkRequest": DocumentCreateLinkRequest, "DocumentCreateLinkResponse": DocumentCreateLinkResponse, + "DocumentCreateRequest": DocumentCreateRequest, + "DocumentCreateRequestContentLibraryItems": DocumentCreateRequestContentLibraryItems, + "DocumentCreateRequestContentPlaceholders": DocumentCreateRequestContentPlaceholders, + "DocumentCreateRequestImages": DocumentCreateRequestImages, + "DocumentCreateRequestRecipients": DocumentCreateRequestRecipients, "DocumentCreateResponse": DocumentCreateResponse, "DocumentDetailsResponse": DocumentDetailsResponse, "DocumentDetailsResponseCreatedBy": DocumentDetailsResponseCreatedBy, @@ -215,7 +244,10 @@ let typeMap: {[index: string]: any} = { "DocumentListResponseResults": DocumentListResponseResults, "DocumentSendRequest": DocumentSendRequest, "DocumentSendResponse": DocumentSendResponse, + "DocumentStatusChangeRequest": DocumentStatusChangeRequest, "DocumentStatusResponse": DocumentStatusResponse, + "DocumentTransferAllOwnershipRequest": DocumentTransferAllOwnershipRequest, + "DocumentTransferOwnershipRequest": DocumentTransferOwnershipRequest, "DocumentsFolderCreateRequest": DocumentsFolderCreateRequest, "DocumentsFolderCreateResponse": DocumentsFolderCreateResponse, "DocumentsFolderListResponse": DocumentsFolderListResponse, @@ -224,10 +256,10 @@ let typeMap: {[index: string]: any} = { "DocumentsFolderRenameResponse": DocumentsFolderRenameResponse, "FormListResponse": FormListResponse, "FormListResponseResults": FormListResponseResults, - "InlineObject": InlineObject, "LinkedObjectCreateRequest": LinkedObjectCreateRequest, "LinkedObjectCreateResponse": LinkedObjectCreateResponse, "LinkedObjectListResponse": LinkedObjectListResponse, + "MemberDetailsResponse": MemberDetailsResponse, "OAuth2AccessTokenResponse": OAuth2AccessTokenResponse, "PricingTableRequest": PricingTableRequest, "PricingTableRequestData": PricingTableRequestData, @@ -245,11 +277,6 @@ let typeMap: {[index: string]: any} = { "PricingTablesResponseOptions": PricingTablesResponseOptions, "PricingTablesResponseSummary": PricingTablesResponseSummary, "PricingTablesResponseTables": PricingTablesResponseTables, - "PublicV1DocumentsContentLibraryItems": PublicV1DocumentsContentLibraryItems, - "PublicV1DocumentsContentPlaceholders": PublicV1DocumentsContentPlaceholders, - "PublicV1DocumentsImages": PublicV1DocumentsImages, - "PublicV1DocumentsRecipients": PublicV1DocumentsRecipients, - "PublicV1DocumentsTokens": PublicV1DocumentsTokens, "TemplateDetailsResponse": TemplateDetailsResponse, "TemplateDetailsResponseAssignedTo": TemplateDetailsResponseAssignedTo, "TemplateDetailsResponseContentPlaceholders": TemplateDetailsResponseContentPlaceholders, diff --git a/src/models/PricingTableRequest.ts b/src/models/PricingTableRequest.ts index 1da1e3e..994e74a 100644 --- a/src/models/PricingTableRequest.ts +++ b/src/models/PricingTableRequest.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. @@ -16,6 +13,10 @@ import { HttpFile } from '../http/http'; export class PricingTableRequest { 'name'?: string; + /** + * When set to true all field names in data rows must be passed as external names defined in the template. + */ + 'dataMerge'?: boolean; 'options'?: PricingTableRequestOptions; 'sections'?: Array; @@ -28,6 +29,12 @@ export class PricingTableRequest { "type": "string", "format": "" }, + { + "name": "dataMerge", + "baseName": "data_merge", + "type": "boolean", + "format": "" + }, { "name": "options", "baseName": "options", diff --git a/src/models/PricingTableRequestData.ts b/src/models/PricingTableRequestData.ts index 042eba5..a35c292 100644 --- a/src/models/PricingTableRequestData.ts +++ b/src/models/PricingTableRequestData.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/PricingTableRequestDataDiscount.ts b/src/models/PricingTableRequestDataDiscount.ts index 7dc1035..90a3e6d 100644 --- a/src/models/PricingTableRequestDataDiscount.ts +++ b/src/models/PricingTableRequestDataDiscount.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/PricingTableRequestOptions.ts b/src/models/PricingTableRequestOptions.ts index 152fdbb..48197c7 100644 --- a/src/models/PricingTableRequestOptions.ts +++ b/src/models/PricingTableRequestOptions.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/PricingTableRequestOptions1.ts b/src/models/PricingTableRequestOptions1.ts index 2b836b8..2c3f727 100644 --- a/src/models/PricingTableRequestOptions1.ts +++ b/src/models/PricingTableRequestOptions1.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/PricingTableRequestOptionsDiscount.ts b/src/models/PricingTableRequestOptionsDiscount.ts index c647437..34dd4c1 100644 --- a/src/models/PricingTableRequestOptionsDiscount.ts +++ b/src/models/PricingTableRequestOptionsDiscount.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/PricingTableRequestOptionsTaxFirst.ts b/src/models/PricingTableRequestOptionsTaxFirst.ts index a18faee..55c78ea 100644 --- a/src/models/PricingTableRequestOptionsTaxFirst.ts +++ b/src/models/PricingTableRequestOptionsTaxFirst.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/PricingTableRequestOptionsTaxSecond.ts b/src/models/PricingTableRequestOptionsTaxSecond.ts index a2909dd..e9cd5c3 100644 --- a/src/models/PricingTableRequestOptionsTaxSecond.ts +++ b/src/models/PricingTableRequestOptionsTaxSecond.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/PricingTableRequestRows.ts b/src/models/PricingTableRequestRows.ts index fb9f8a4..46378b7 100644 --- a/src/models/PricingTableRequestRows.ts +++ b/src/models/PricingTableRequestRows.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/PricingTableRequestSections.ts b/src/models/PricingTableRequestSections.ts index 183457b..d01444b 100644 --- a/src/models/PricingTableRequestSections.ts +++ b/src/models/PricingTableRequestSections.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/PricingTablesResponse.ts b/src/models/PricingTablesResponse.ts index f3ca5e6..ab5f1eb 100644 --- a/src/models/PricingTablesResponse.ts +++ b/src/models/PricingTablesResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/PricingTablesResponseDiscount.ts b/src/models/PricingTablesResponseDiscount.ts index d9be780..1ded58d 100644 --- a/src/models/PricingTablesResponseDiscount.ts +++ b/src/models/PricingTablesResponseDiscount.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/PricingTablesResponseItems.ts b/src/models/PricingTablesResponseItems.ts index 5e036c6..549ca98 100644 --- a/src/models/PricingTablesResponseItems.ts +++ b/src/models/PricingTablesResponseItems.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. @@ -33,6 +30,10 @@ export class PricingTablesResponseItems { 'taxes'?: any; 'discounts'?: any; 'fees'?: any; + /** + * Will contain all the fields in flat structure with external field names defined in the template. + */ + 'mergedData'?: any; static readonly discriminator: string | undefined = undefined; @@ -144,6 +145,12 @@ export class PricingTablesResponseItems { "baseName": "fees", "type": "any", "format": "" + }, + { + "name": "mergedData", + "baseName": "merged_data", + "type": "any", + "format": "" } ]; static getAttributeTypeMap() { diff --git a/src/models/PricingTablesResponseOptions.ts b/src/models/PricingTablesResponseOptions.ts index 02620fb..c213d82 100644 --- a/src/models/PricingTablesResponseOptions.ts +++ b/src/models/PricingTablesResponseOptions.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/PricingTablesResponseSummary.ts b/src/models/PricingTablesResponseSummary.ts index 31d9d0c..43065ac 100644 --- a/src/models/PricingTablesResponseSummary.ts +++ b/src/models/PricingTablesResponseSummary.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/PricingTablesResponseTables.ts b/src/models/PricingTablesResponseTables.ts index d1d8407..d28be92 100644 --- a/src/models/PricingTablesResponseTables.ts +++ b/src/models/PricingTablesResponseTables.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/TemplateDetailsResponse.ts b/src/models/TemplateDetailsResponse.ts index 05ff981..af7b78a 100644 --- a/src/models/TemplateDetailsResponse.ts +++ b/src/models/TemplateDetailsResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/TemplateDetailsResponseAssignedTo.ts b/src/models/TemplateDetailsResponseAssignedTo.ts index 4cbd6ff..18c090b 100644 --- a/src/models/TemplateDetailsResponseAssignedTo.ts +++ b/src/models/TemplateDetailsResponseAssignedTo.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/TemplateDetailsResponseContentPlaceholders.ts b/src/models/TemplateDetailsResponseContentPlaceholders.ts index f103f57..2213bf9 100644 --- a/src/models/TemplateDetailsResponseContentPlaceholders.ts +++ b/src/models/TemplateDetailsResponseContentPlaceholders.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/TemplateDetailsResponseFields.ts b/src/models/TemplateDetailsResponseFields.ts index 440136d..3da9d86 100644 --- a/src/models/TemplateDetailsResponseFields.ts +++ b/src/models/TemplateDetailsResponseFields.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/TemplateDetailsResponseImages.ts b/src/models/TemplateDetailsResponseImages.ts index fb55b58..4a1b1b4 100644 --- a/src/models/TemplateDetailsResponseImages.ts +++ b/src/models/TemplateDetailsResponseImages.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/TemplateDetailsResponsePreassignedPerson.ts b/src/models/TemplateDetailsResponsePreassignedPerson.ts index 6bc3fda..3734a9e 100644 --- a/src/models/TemplateDetailsResponsePreassignedPerson.ts +++ b/src/models/TemplateDetailsResponsePreassignedPerson.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/TemplateDetailsResponseRoles.ts b/src/models/TemplateDetailsResponseRoles.ts index 743e564..d295ab2 100644 --- a/src/models/TemplateDetailsResponseRoles.ts +++ b/src/models/TemplateDetailsResponseRoles.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/TemplateDetailsResponseTokens.ts b/src/models/TemplateDetailsResponseTokens.ts index 0afd0bb..b09624e 100644 --- a/src/models/TemplateDetailsResponseTokens.ts +++ b/src/models/TemplateDetailsResponseTokens.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/TemplateListResponse.ts b/src/models/TemplateListResponse.ts index da2880b..78aaef9 100644 --- a/src/models/TemplateListResponse.ts +++ b/src/models/TemplateListResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/TemplateListResponseResults.ts b/src/models/TemplateListResponseResults.ts index a6ccced..a80a133 100644 --- a/src/models/TemplateListResponseResults.ts +++ b/src/models/TemplateListResponseResults.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/TemplatesFolderCreateRequest.ts b/src/models/TemplatesFolderCreateRequest.ts index b6e8ef9..df894ec 100644 --- a/src/models/TemplatesFolderCreateRequest.ts +++ b/src/models/TemplatesFolderCreateRequest.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/TemplatesFolderCreateResponse.ts b/src/models/TemplatesFolderCreateResponse.ts index 3928405..135795c 100644 --- a/src/models/TemplatesFolderCreateResponse.ts +++ b/src/models/TemplatesFolderCreateResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/TemplatesFolderListResponse.ts b/src/models/TemplatesFolderListResponse.ts index a4a9318..1c47867 100644 --- a/src/models/TemplatesFolderListResponse.ts +++ b/src/models/TemplatesFolderListResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/TemplatesFolderListResponseResults.ts b/src/models/TemplatesFolderListResponseResults.ts index 0d86564..a483a17 100644 --- a/src/models/TemplatesFolderListResponseResults.ts +++ b/src/models/TemplatesFolderListResponseResults.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/TemplatesFolderRenameRequest.ts b/src/models/TemplatesFolderRenameRequest.ts index e945a50..660f9de 100644 --- a/src/models/TemplatesFolderRenameRequest.ts +++ b/src/models/TemplatesFolderRenameRequest.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/TemplatesFolderRenameResponse.ts b/src/models/TemplatesFolderRenameResponse.ts index 2e1e140..dc0fde3 100644 --- a/src/models/TemplatesFolderRenameResponse.ts +++ b/src/models/TemplatesFolderRenameResponse.ts @@ -2,9 +2,6 @@ * PandaDoc Public API * PandaDoc Public API documentation * - * OpenAPI spec version: 1.0.1 - * - * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. diff --git a/src/models/all.ts b/src/models/all.ts index 29dba59..8106f42 100644 --- a/src/models/all.ts +++ b/src/models/all.ts @@ -1,10 +1,15 @@ export * from './APILogDetailsResponse' export * from './APILogListResponse' export * from './APILogListResponseResults' +export * from './ContactCreateRequest' +export * from './ContactDetailsResponse' +export * from './ContactUpdateRequest' export * from './ContentLibraryItemListResponse' export * from './ContentLibraryItemListResponseResults' export * from './ContentLibraryItemResponse' export * from './ContentLibraryItemResponseCreatedBy' +export * from './DocumentAttachmentResponse' +export * from './DocumentAttachmentResponseCreatedBy' export * from './DocumentCreateByPdfRequest' export * from './DocumentCreateByPdfRequestRecipients' export * from './DocumentCreateByTemplateRequest' @@ -12,8 +17,14 @@ export * from './DocumentCreateByTemplateRequestContentLibraryItems' export * from './DocumentCreateByTemplateRequestContentPlaceholders' export * from './DocumentCreateByTemplateRequestImages' export * from './DocumentCreateByTemplateRequestRecipients' +export * from './DocumentCreateByTemplateRequestTokens' export * from './DocumentCreateLinkRequest' export * from './DocumentCreateLinkResponse' +export * from './DocumentCreateRequest' +export * from './DocumentCreateRequestContentLibraryItems' +export * from './DocumentCreateRequestContentPlaceholders' +export * from './DocumentCreateRequestImages' +export * from './DocumentCreateRequestRecipients' export * from './DocumentCreateResponse' export * from './DocumentDetailsResponse' export * from './DocumentDetailsResponseCreatedBy' @@ -26,8 +37,11 @@ export * from './DocumentListResponseResults' export * from './DocumentOrderingFieldsEnum' export * from './DocumentSendRequest' export * from './DocumentSendResponse' +export * from './DocumentStatusChangeRequest' export * from './DocumentStatusEnum' export * from './DocumentStatusResponse' +export * from './DocumentTransferAllOwnershipRequest' +export * from './DocumentTransferOwnershipRequest' export * from './DocumentsFolderCreateRequest' export * from './DocumentsFolderCreateResponse' export * from './DocumentsFolderListResponse' @@ -36,10 +50,10 @@ export * from './DocumentsFolderRenameRequest' export * from './DocumentsFolderRenameResponse' export * from './FormListResponse' export * from './FormListResponseResults' -export * from './InlineObject' export * from './LinkedObjectCreateRequest' export * from './LinkedObjectCreateResponse' export * from './LinkedObjectListResponse' +export * from './MemberDetailsResponse' export * from './OAuth2AccessTokenResponse' export * from './PricingTableRequest' export * from './PricingTableRequestData' @@ -57,11 +71,6 @@ export * from './PricingTablesResponseItems' export * from './PricingTablesResponseOptions' export * from './PricingTablesResponseSummary' export * from './PricingTablesResponseTables' -export * from './PublicV1DocumentsContentLibraryItems' -export * from './PublicV1DocumentsContentPlaceholders' -export * from './PublicV1DocumentsImages' -export * from './PublicV1DocumentsRecipients' -export * from './PublicV1DocumentsTokens' export * from './TemplateDetailsResponse' export * from './TemplateDetailsResponseAssignedTo' export * from './TemplateDetailsResponseContentPlaceholders' diff --git a/src/types/ObjectParamAPI.ts b/src/types/ObjectParamAPI.ts index 557ff98..9033b0b 100644 --- a/src/types/ObjectParamAPI.ts +++ b/src/types/ObjectParamAPI.ts @@ -5,10 +5,15 @@ import { Configuration} from '../configuration' import { APILogDetailsResponse } from '../models/APILogDetailsResponse'; import { APILogListResponse } from '../models/APILogListResponse'; import { APILogListResponseResults } from '../models/APILogListResponseResults'; +import { ContactCreateRequest } from '../models/ContactCreateRequest'; +import { ContactDetailsResponse } from '../models/ContactDetailsResponse'; +import { ContactUpdateRequest } from '../models/ContactUpdateRequest'; import { ContentLibraryItemListResponse } from '../models/ContentLibraryItemListResponse'; import { ContentLibraryItemListResponseResults } from '../models/ContentLibraryItemListResponseResults'; import { ContentLibraryItemResponse } from '../models/ContentLibraryItemResponse'; import { ContentLibraryItemResponseCreatedBy } from '../models/ContentLibraryItemResponseCreatedBy'; +import { DocumentAttachmentResponse } from '../models/DocumentAttachmentResponse'; +import { DocumentAttachmentResponseCreatedBy } from '../models/DocumentAttachmentResponseCreatedBy'; import { DocumentCreateByPdfRequest } from '../models/DocumentCreateByPdfRequest'; import { DocumentCreateByPdfRequestRecipients } from '../models/DocumentCreateByPdfRequestRecipients'; import { DocumentCreateByTemplateRequest } from '../models/DocumentCreateByTemplateRequest'; @@ -16,8 +21,14 @@ import { DocumentCreateByTemplateRequestContentLibraryItems } from '../models/Do import { DocumentCreateByTemplateRequestContentPlaceholders } from '../models/DocumentCreateByTemplateRequestContentPlaceholders'; import { DocumentCreateByTemplateRequestImages } from '../models/DocumentCreateByTemplateRequestImages'; import { DocumentCreateByTemplateRequestRecipients } from '../models/DocumentCreateByTemplateRequestRecipients'; +import { DocumentCreateByTemplateRequestTokens } from '../models/DocumentCreateByTemplateRequestTokens'; import { DocumentCreateLinkRequest } from '../models/DocumentCreateLinkRequest'; import { DocumentCreateLinkResponse } from '../models/DocumentCreateLinkResponse'; +import { DocumentCreateRequest } from '../models/DocumentCreateRequest'; +import { DocumentCreateRequestContentLibraryItems } from '../models/DocumentCreateRequestContentLibraryItems'; +import { DocumentCreateRequestContentPlaceholders } from '../models/DocumentCreateRequestContentPlaceholders'; +import { DocumentCreateRequestImages } from '../models/DocumentCreateRequestImages'; +import { DocumentCreateRequestRecipients } from '../models/DocumentCreateRequestRecipients'; import { DocumentCreateResponse } from '../models/DocumentCreateResponse'; import { DocumentDetailsResponse } from '../models/DocumentDetailsResponse'; import { DocumentDetailsResponseCreatedBy } from '../models/DocumentDetailsResponseCreatedBy'; @@ -30,8 +41,11 @@ import { DocumentListResponseResults } from '../models/DocumentListResponseResul import { DocumentOrderingFieldsEnum } from '../models/DocumentOrderingFieldsEnum'; import { DocumentSendRequest } from '../models/DocumentSendRequest'; import { DocumentSendResponse } from '../models/DocumentSendResponse'; +import { DocumentStatusChangeRequest } from '../models/DocumentStatusChangeRequest'; import { DocumentStatusEnum } from '../models/DocumentStatusEnum'; import { DocumentStatusResponse } from '../models/DocumentStatusResponse'; +import { DocumentTransferAllOwnershipRequest } from '../models/DocumentTransferAllOwnershipRequest'; +import { DocumentTransferOwnershipRequest } from '../models/DocumentTransferOwnershipRequest'; import { DocumentsFolderCreateRequest } from '../models/DocumentsFolderCreateRequest'; import { DocumentsFolderCreateResponse } from '../models/DocumentsFolderCreateResponse'; import { DocumentsFolderListResponse } from '../models/DocumentsFolderListResponse'; @@ -40,10 +54,10 @@ import { DocumentsFolderRenameRequest } from '../models/DocumentsFolderRenameReq import { DocumentsFolderRenameResponse } from '../models/DocumentsFolderRenameResponse'; import { FormListResponse } from '../models/FormListResponse'; import { FormListResponseResults } from '../models/FormListResponseResults'; -import { InlineObject } from '../models/InlineObject'; import { LinkedObjectCreateRequest } from '../models/LinkedObjectCreateRequest'; import { LinkedObjectCreateResponse } from '../models/LinkedObjectCreateResponse'; import { LinkedObjectListResponse } from '../models/LinkedObjectListResponse'; +import { MemberDetailsResponse } from '../models/MemberDetailsResponse'; import { OAuth2AccessTokenResponse } from '../models/OAuth2AccessTokenResponse'; import { PricingTableRequest } from '../models/PricingTableRequest'; import { PricingTableRequestData } from '../models/PricingTableRequestData'; @@ -61,11 +75,6 @@ import { PricingTablesResponseItems } from '../models/PricingTablesResponseItems import { PricingTablesResponseOptions } from '../models/PricingTablesResponseOptions'; import { PricingTablesResponseSummary } from '../models/PricingTablesResponseSummary'; import { PricingTablesResponseTables } from '../models/PricingTablesResponseTables'; -import { PublicV1DocumentsContentLibraryItems } from '../models/PublicV1DocumentsContentLibraryItems'; -import { PublicV1DocumentsContentPlaceholders } from '../models/PublicV1DocumentsContentPlaceholders'; -import { PublicV1DocumentsImages } from '../models/PublicV1DocumentsImages'; -import { PublicV1DocumentsRecipients } from '../models/PublicV1DocumentsRecipients'; -import { PublicV1DocumentsTokens } from '../models/PublicV1DocumentsTokens'; import { TemplateDetailsResponse } from '../models/TemplateDetailsResponse'; import { TemplateDetailsResponseAssignedTo } from '../models/TemplateDetailsResponseAssignedTo'; import { TemplateDetailsResponseContentPlaceholders } from '../models/TemplateDetailsResponseContentPlaceholders'; @@ -173,6 +182,103 @@ export class ObjectAPILogsApi { } +import { ObservableContactsApi } from "./ObservableAPI"; +import { ContactsApiRequestFactory, ContactsApiResponseProcessor} from "../apis/ContactsApi"; + +export interface ContactsApiContactCreateRequest { + /** + * + * @type ContactCreateRequest + * @memberof ContactsApicontactCreate + */ + contactCreateRequest: ContactCreateRequest +} + +export interface ContactsApiContactDeleteRequest { + /** + * Contact id. + * @type string + * @memberof ContactsApicontactDelete + */ + id: string +} + +export interface ContactsApiContactDetailsRequest { + /** + * Contact id. + * @type string + * @memberof ContactsApicontactDetails + */ + id: string +} + +export interface ContactsApiContactListRequest { +} + +export interface ContactsApiContactUpdateRequest { + /** + * Contact id. + * @type string + * @memberof ContactsApicontactUpdate + */ + id: string + /** + * + * @type ContactUpdateRequest + * @memberof ContactsApicontactUpdate + */ + contactUpdateRequest: ContactUpdateRequest +} + +export class ObjectContactsApi { + private api: ObservableContactsApi + + public constructor(configuration: Configuration, requestFactory?: ContactsApiRequestFactory, responseProcessor?: ContactsApiResponseProcessor) { + this.api = new ObservableContactsApi(configuration, requestFactory, responseProcessor); + } + + /** + * Create contact + * @param param the request object + */ + public contactCreate(param: ContactsApiContactCreateRequest, options?: Configuration): Promise { + return this.api.contactCreate(param.contactCreateRequest, options).toPromise(); + } + + /** + * Delete contact by id + * @param param the request object + */ + public contactDelete(param: ContactsApiContactDeleteRequest, options?: Configuration): Promise { + return this.api.contactDelete(param.id, options).toPromise(); + } + + /** + * Get contact details by id + * @param param the request object + */ + public contactDetails(param: ContactsApiContactDetailsRequest, options?: Configuration): Promise { + return this.api.contactDetails(param.id, options).toPromise(); + } + + /** + * List contacts + * @param param the request object + */ + public contactList(param: ContactsApiContactListRequest, options?: Configuration): Promise> { + return this.api.contactList( options).toPromise(); + } + + /** + * Update contact by id + * @param param the request object + */ + public contactUpdate(param: ContactsApiContactUpdateRequest, options?: Configuration): Promise { + return this.api.contactUpdate(param.id, param.contactUpdateRequest, options).toPromise(); + } + +} + import { ObservableContentLibraryItemsApi } from "./ObservableAPI"; import { ContentLibraryItemsApiRequestFactory, ContentLibraryItemsApiResponseProcessor} from "../apis/ContentLibraryItemsApi"; @@ -257,6 +363,144 @@ export class ObjectContentLibraryItemsApi { } +import { ObservableDocumentAttachmentsApi } from "./ObservableAPI"; +import { DocumentAttachmentsApiRequestFactory, DocumentAttachmentsApiResponseProcessor} from "../apis/DocumentAttachmentsApi"; + +export interface DocumentAttachmentsApiDocumentAttachmentCreateRequest { + /** + * Document UUID + * @type string + * @memberof DocumentAttachmentsApidocumentAttachmentCreate + */ + id: string + /** + * Binary file to be attached to a document + * @type HttpFile + * @memberof DocumentAttachmentsApidocumentAttachmentCreate + */ + file?: HttpFile + /** + * URL link to the file to be attached to a document + * @type string + * @memberof DocumentAttachmentsApidocumentAttachmentCreate + */ + source?: string + /** + * Optional name to set for uploaded file + * @type string + * @memberof DocumentAttachmentsApidocumentAttachmentCreate + */ + name?: string +} + +export interface DocumentAttachmentsApiDocumentAttachmentDeleteRequest { + /** + * Document UUID + * @type string + * @memberof DocumentAttachmentsApidocumentAttachmentDelete + */ + id: string + /** + * Attachment UUID + * @type string + * @memberof DocumentAttachmentsApidocumentAttachmentDelete + */ + attachmentId: string +} + +export interface DocumentAttachmentsApiDocumentAttachmentDetailsRequest { + /** + * Document UUID + * @type string + * @memberof DocumentAttachmentsApidocumentAttachmentDetails + */ + id: string + /** + * Attachment UUID + * @type string + * @memberof DocumentAttachmentsApidocumentAttachmentDetails + */ + attachmentId: string +} + +export interface DocumentAttachmentsApiDocumentAttachmentDownloadRequest { + /** + * Document UUID + * @type string + * @memberof DocumentAttachmentsApidocumentAttachmentDownload + */ + id: string + /** + * Attachment UUID + * @type string + * @memberof DocumentAttachmentsApidocumentAttachmentDownload + */ + attachmentId: string +} + +export interface DocumentAttachmentsApiDocumentAttachmentsListRequest { + /** + * Document UUID + * @type string + * @memberof DocumentAttachmentsApidocumentAttachmentsList + */ + id: string +} + +export class ObjectDocumentAttachmentsApi { + private api: ObservableDocumentAttachmentsApi + + public constructor(configuration: Configuration, requestFactory?: DocumentAttachmentsApiRequestFactory, responseProcessor?: DocumentAttachmentsApiResponseProcessor) { + this.api = new ObservableDocumentAttachmentsApi(configuration, requestFactory, responseProcessor); + } + + /** + * Creates an attachment for a particular document + * Document Attachment Create + * @param param the request object + */ + public documentAttachmentCreate(param: DocumentAttachmentsApiDocumentAttachmentCreateRequest, options?: Configuration): Promise { + return this.api.documentAttachmentCreate(param.id, param.file, param.source, param.name, options).toPromise(); + } + + /** + * Deletes specific document's attachment + * Document Attachment Delete + * @param param the request object + */ + public documentAttachmentDelete(param: DocumentAttachmentsApiDocumentAttachmentDeleteRequest, options?: Configuration): Promise { + return this.api.documentAttachmentDelete(param.id, param.attachmentId, options).toPromise(); + } + + /** + * Returns details of the specific document's attachment + * Document Attachment Details + * @param param the request object + */ + public documentAttachmentDetails(param: DocumentAttachmentsApiDocumentAttachmentDetailsRequest, options?: Configuration): Promise { + return this.api.documentAttachmentDetails(param.id, param.attachmentId, options).toPromise(); + } + + /** + * Returns document attachment file for download + * Document Attachment Download + * @param param the request object + */ + public documentAttachmentDownload(param: DocumentAttachmentsApiDocumentAttachmentDownloadRequest, options?: Configuration): Promise { + return this.api.documentAttachmentDownload(param.id, param.attachmentId, options).toPromise(); + } + + /** + * Return list of objects attached to particular document + * Document Attachment List + * @param param the request object + */ + public documentAttachmentsList(param: DocumentAttachmentsApiDocumentAttachmentsListRequest, options?: Configuration): Promise> { + return this.api.documentAttachmentsList(param.id, options).toPromise(); + } + +} + import { ObservableDocumentsApi } from "./ObservableAPI"; import { DocumentsApiRequestFactory, DocumentsApiResponseProcessor} from "../apis/DocumentsApi"; @@ -271,17 +515,17 @@ export interface DocumentsApiDeleteDocumentRequest { export interface DocumentsApiDocumentCreateRequest { /** - * Set this parameter as `ev1` if you want to create a document from PDF with Classic Editor when both editors are enabled for the workspace. - * @type string + * Use a PandaDoc template or an existing PDF to create a document. See the creation request examples [by template](#/schemas/DocumentCreateByTemplateRequest) and [by pdf](#/schemas/DocumentCreateByPdfRequest) + * @type DocumentCreateRequest * @memberof DocumentsApidocumentCreate */ - editorVer?: string + documentCreateRequest: DocumentCreateRequest /** - * - * @type InlineObject + * Set this parameter as `ev1` if you want to create a document from PDF with Classic Editor when both editors are enabled for the workspace. + * @type string * @memberof DocumentsApidocumentCreate */ - inlineObject?: InlineObject + editorVer?: string } export interface DocumentsApiDocumentCreateLinkRequest { @@ -321,6 +565,12 @@ export interface DocumentsApiDocumentListRequest { * @memberof DocumentsApidocumentList */ completedTo?: string + /** + * Returns results where 'contact_id' is present in document as recipient or approver + * @type string + * @memberof DocumentsApidocumentList + */ + contactId?: string /** * Specify how many document results to return. Default is 50 documents, maximum is 100 documents. * @type number @@ -363,6 +613,12 @@ export interface DocumentsApiDocumentListRequest { * @memberof DocumentsApidocumentList */ formId?: string + /** + * Returns results where 'membership_id' is present in document as owner (should be member uuid) + * @type string + * @memberof DocumentsApidocumentList + */ + membershipId?: string /** * Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. * @type string @@ -434,6 +690,21 @@ export interface DocumentsApiDocumentStatusRequest { id: string } +export interface DocumentsApiDocumentStatusChangeRequest { + /** + * Specify document ID. + * @type string + * @memberof DocumentsApidocumentStatusChange + */ + id: string + /** + * + * @type DocumentStatusChangeRequest + * @memberof DocumentsApidocumentStatusChange + */ + documentStatusChangeRequest: DocumentStatusChangeRequest +} + export interface DocumentsApiDownloadDocumentRequest { /** * Specify document ID. @@ -442,7 +713,7 @@ export interface DocumentsApiDownloadDocumentRequest { */ id: string /** - * HEX code (for example `#RRGGBB`). + * HEX code (for example `#FF5733`). * @type string * @memberof DocumentsApidownloadDocument */ @@ -527,7 +798,31 @@ export interface DocumentsApiSendDocumentRequest { * @type DocumentSendRequest * @memberof DocumentsApisendDocument */ - documentSendRequest?: DocumentSendRequest + documentSendRequest: DocumentSendRequest +} + +export interface DocumentsApiTransferAllDocumentsOwnershipRequest { + /** + * + * @type DocumentTransferAllOwnershipRequest + * @memberof DocumentsApitransferAllDocumentsOwnership + */ + documentTransferAllOwnershipRequest: DocumentTransferAllOwnershipRequest +} + +export interface DocumentsApiTransferDocumentOwnershipRequest { + /** + * Specify document ID. + * @type string + * @memberof DocumentsApitransferDocumentOwnership + */ + id: string + /** + * + * @type DocumentTransferOwnershipRequest + * @memberof DocumentsApitransferDocumentOwnership + */ + documentTransferOwnershipRequest: DocumentTransferOwnershipRequest } export class ObjectDocumentsApi { @@ -550,7 +845,7 @@ export class ObjectDocumentsApi { * @param param the request object */ public documentCreate(param: DocumentsApiDocumentCreateRequest, options?: Configuration): Promise { - return this.api.documentCreate(param.editorVer, param.inlineObject, options).toPromise(); + return this.api.documentCreate(param.documentCreateRequest, param.editorVer, options).toPromise(); } /** @@ -574,7 +869,7 @@ export class ObjectDocumentsApi { * @param param the request object */ public documentList(param: DocumentsApiDocumentListRequest, options?: Configuration): Promise { - return this.api.documentList(param.completedFrom, param.completedTo, param.count, param.createdFrom, param.createdTo, param.deleted, param.id, param.folderUuid, param.formId, param.metadata, param.modifiedFrom, param.modifiedTo, param.orderBy, param.page, param.q, param.status, param.statusNe, param.tag, param.templateId, options).toPromise(); + return this.api.documentList(param.completedFrom, param.completedTo, param.contactId, param.count, param.createdFrom, param.createdTo, param.deleted, param.id, param.folderUuid, param.formId, param.membershipId, param.metadata, param.modifiedFrom, param.modifiedTo, param.orderBy, param.page, param.q, param.status, param.statusNe, param.tag, param.templateId, options).toPromise(); } /** @@ -585,6 +880,14 @@ export class ObjectDocumentsApi { return this.api.documentStatus(param.id, options).toPromise(); } + /** + * Document status change + * @param param the request object + */ + public documentStatusChange(param: DocumentsApiDocumentStatusChangeRequest, options?: Configuration): Promise { + return this.api.documentStatusChange(param.id, param.documentStatusChangeRequest, options).toPromise(); + } + /** * Document download * @param param the request object @@ -634,6 +937,22 @@ export class ObjectDocumentsApi { return this.api.sendDocument(param.id, param.documentSendRequest, options).toPromise(); } + /** + * Transfer all documents ownership + * @param param the request object + */ + public transferAllDocumentsOwnership(param: DocumentsApiTransferAllDocumentsOwnershipRequest, options?: Configuration): Promise { + return this.api.transferAllDocumentsOwnership(param.documentTransferAllOwnershipRequest, options).toPromise(); + } + + /** + * Update document ownership + * @param param the request object + */ + public transferDocumentOwnership(param: DocumentsApiTransferDocumentOwnershipRequest, options?: Configuration): Promise { + return this.api.transferDocumentOwnership(param.id, param.documentTransferOwnershipRequest, options).toPromise(); + } + } import { ObservableFoldersAPIApi } from "./ObservableAPI"; @@ -645,7 +964,7 @@ export interface FoldersAPIApiCreateDocumentFolderRequest { * @type DocumentsFolderCreateRequest * @memberof FoldersAPIApicreateDocumentFolder */ - documentsFolderCreateRequest?: DocumentsFolderCreateRequest + documentsFolderCreateRequest: DocumentsFolderCreateRequest } export interface FoldersAPIApiCreateTemplateFolderRequest { @@ -654,7 +973,7 @@ export interface FoldersAPIApiCreateTemplateFolderRequest { * @type TemplatesFolderCreateRequest * @memberof FoldersAPIApicreateTemplateFolder */ - templatesFolderCreateRequest?: TemplatesFolderCreateRequest + templatesFolderCreateRequest: TemplatesFolderCreateRequest } export interface FoldersAPIApiListDocumentFoldersRequest { @@ -711,7 +1030,7 @@ export interface FoldersAPIApiRenameDocumentFolderRequest { * @type DocumentsFolderRenameRequest * @memberof FoldersAPIApirenameDocumentFolder */ - documentsFolderRenameRequest?: DocumentsFolderRenameRequest + documentsFolderRenameRequest: DocumentsFolderRenameRequest } export interface FoldersAPIApiRenameTemplateFolderRequest { @@ -726,7 +1045,7 @@ export interface FoldersAPIApiRenameTemplateFolderRequest { * @type TemplatesFolderRenameRequest * @memberof FoldersAPIApirenameTemplateFolder */ - templatesFolderRenameRequest?: TemplatesFolderRenameRequest + templatesFolderRenameRequest: TemplatesFolderRenameRequest } export class ObjectFoldersAPIApi { @@ -852,6 +1171,60 @@ export class ObjectFormsApi { } +import { ObservableMembersApi } from "./ObservableAPI"; +import { MembersApiRequestFactory, MembersApiResponseProcessor} from "../apis/MembersApi"; + +export interface MembersApiCurrentMemberDetailsRequest { +} + +export interface MembersApiMemberDetailsRequest { + /** + * Membership id + * @type string + * @memberof MembersApimemberDetails + */ + id: string +} + +export interface MembersApiMemberListRequest { +} + +export class ObjectMembersApi { + private api: ObservableMembersApi + + public constructor(configuration: Configuration, requestFactory?: MembersApiRequestFactory, responseProcessor?: MembersApiResponseProcessor) { + this.api = new ObservableMembersApi(configuration, requestFactory, responseProcessor); + } + + /** + * A method to define to whom credentials belong + * Current member details + * @param param the request object + */ + public currentMemberDetails(param: MembersApiCurrentMemberDetailsRequest, options?: Configuration): Promise { + return this.api.currentMemberDetails( options).toPromise(); + } + + /** + * A method to retrieve a member's details by id + * Member details + * @param param the request object + */ + public memberDetails(param: MembersApiMemberDetailsRequest, options?: Configuration): Promise { + return this.api.memberDetails(param.id, options).toPromise(); + } + + /** + * Retrieve all members details of the workspace + * List members + * @param param the request object + */ + public memberList(param: MembersApiMemberListRequest, options?: Configuration): Promise> { + return this.api.memberList( options).toPromise(); + } + +} + import { ObservableOAuth20AuthenticationApi } from "./ObservableAPI"; import { OAuth20AuthenticationApiRequestFactory, OAuth20AuthenticationApiResponseProcessor} from "../apis/OAuth20AuthenticationApi"; diff --git a/src/types/ObservableAPI.ts b/src/types/ObservableAPI.ts index 0b7a18a..e0865fb 100644 --- a/src/types/ObservableAPI.ts +++ b/src/types/ObservableAPI.ts @@ -6,10 +6,15 @@ import {mergeMap, map} from '../rxjsStub'; import { APILogDetailsResponse } from '../models/APILogDetailsResponse'; import { APILogListResponse } from '../models/APILogListResponse'; import { APILogListResponseResults } from '../models/APILogListResponseResults'; +import { ContactCreateRequest } from '../models/ContactCreateRequest'; +import { ContactDetailsResponse } from '../models/ContactDetailsResponse'; +import { ContactUpdateRequest } from '../models/ContactUpdateRequest'; import { ContentLibraryItemListResponse } from '../models/ContentLibraryItemListResponse'; import { ContentLibraryItemListResponseResults } from '../models/ContentLibraryItemListResponseResults'; import { ContentLibraryItemResponse } from '../models/ContentLibraryItemResponse'; import { ContentLibraryItemResponseCreatedBy } from '../models/ContentLibraryItemResponseCreatedBy'; +import { DocumentAttachmentResponse } from '../models/DocumentAttachmentResponse'; +import { DocumentAttachmentResponseCreatedBy } from '../models/DocumentAttachmentResponseCreatedBy'; import { DocumentCreateByPdfRequest } from '../models/DocumentCreateByPdfRequest'; import { DocumentCreateByPdfRequestRecipients } from '../models/DocumentCreateByPdfRequestRecipients'; import { DocumentCreateByTemplateRequest } from '../models/DocumentCreateByTemplateRequest'; @@ -17,8 +22,14 @@ import { DocumentCreateByTemplateRequestContentLibraryItems } from '../models/Do import { DocumentCreateByTemplateRequestContentPlaceholders } from '../models/DocumentCreateByTemplateRequestContentPlaceholders'; import { DocumentCreateByTemplateRequestImages } from '../models/DocumentCreateByTemplateRequestImages'; import { DocumentCreateByTemplateRequestRecipients } from '../models/DocumentCreateByTemplateRequestRecipients'; +import { DocumentCreateByTemplateRequestTokens } from '../models/DocumentCreateByTemplateRequestTokens'; import { DocumentCreateLinkRequest } from '../models/DocumentCreateLinkRequest'; import { DocumentCreateLinkResponse } from '../models/DocumentCreateLinkResponse'; +import { DocumentCreateRequest } from '../models/DocumentCreateRequest'; +import { DocumentCreateRequestContentLibraryItems } from '../models/DocumentCreateRequestContentLibraryItems'; +import { DocumentCreateRequestContentPlaceholders } from '../models/DocumentCreateRequestContentPlaceholders'; +import { DocumentCreateRequestImages } from '../models/DocumentCreateRequestImages'; +import { DocumentCreateRequestRecipients } from '../models/DocumentCreateRequestRecipients'; import { DocumentCreateResponse } from '../models/DocumentCreateResponse'; import { DocumentDetailsResponse } from '../models/DocumentDetailsResponse'; import { DocumentDetailsResponseCreatedBy } from '../models/DocumentDetailsResponseCreatedBy'; @@ -31,8 +42,11 @@ import { DocumentListResponseResults } from '../models/DocumentListResponseResul import { DocumentOrderingFieldsEnum } from '../models/DocumentOrderingFieldsEnum'; import { DocumentSendRequest } from '../models/DocumentSendRequest'; import { DocumentSendResponse } from '../models/DocumentSendResponse'; +import { DocumentStatusChangeRequest } from '../models/DocumentStatusChangeRequest'; import { DocumentStatusEnum } from '../models/DocumentStatusEnum'; import { DocumentStatusResponse } from '../models/DocumentStatusResponse'; +import { DocumentTransferAllOwnershipRequest } from '../models/DocumentTransferAllOwnershipRequest'; +import { DocumentTransferOwnershipRequest } from '../models/DocumentTransferOwnershipRequest'; import { DocumentsFolderCreateRequest } from '../models/DocumentsFolderCreateRequest'; import { DocumentsFolderCreateResponse } from '../models/DocumentsFolderCreateResponse'; import { DocumentsFolderListResponse } from '../models/DocumentsFolderListResponse'; @@ -41,10 +55,10 @@ import { DocumentsFolderRenameRequest } from '../models/DocumentsFolderRenameReq import { DocumentsFolderRenameResponse } from '../models/DocumentsFolderRenameResponse'; import { FormListResponse } from '../models/FormListResponse'; import { FormListResponseResults } from '../models/FormListResponseResults'; -import { InlineObject } from '../models/InlineObject'; import { LinkedObjectCreateRequest } from '../models/LinkedObjectCreateRequest'; import { LinkedObjectCreateResponse } from '../models/LinkedObjectCreateResponse'; import { LinkedObjectListResponse } from '../models/LinkedObjectListResponse'; +import { MemberDetailsResponse } from '../models/MemberDetailsResponse'; import { OAuth2AccessTokenResponse } from '../models/OAuth2AccessTokenResponse'; import { PricingTableRequest } from '../models/PricingTableRequest'; import { PricingTableRequestData } from '../models/PricingTableRequestData'; @@ -62,11 +76,6 @@ import { PricingTablesResponseItems } from '../models/PricingTablesResponseItems import { PricingTablesResponseOptions } from '../models/PricingTablesResponseOptions'; import { PricingTablesResponseSummary } from '../models/PricingTablesResponseSummary'; import { PricingTablesResponseTables } from '../models/PricingTablesResponseTables'; -import { PublicV1DocumentsContentLibraryItems } from '../models/PublicV1DocumentsContentLibraryItems'; -import { PublicV1DocumentsContentPlaceholders } from '../models/PublicV1DocumentsContentPlaceholders'; -import { PublicV1DocumentsImages } from '../models/PublicV1DocumentsImages'; -import { PublicV1DocumentsRecipients } from '../models/PublicV1DocumentsRecipients'; -import { PublicV1DocumentsTokens } from '../models/PublicV1DocumentsTokens'; import { TemplateDetailsResponse } from '../models/TemplateDetailsResponse'; import { TemplateDetailsResponseAssignedTo } from '../models/TemplateDetailsResponseAssignedTo'; import { TemplateDetailsResponseContentPlaceholders } from '../models/TemplateDetailsResponseContentPlaceholders'; @@ -157,6 +166,139 @@ export class ObservableAPILogsApi { } +import { ContactsApiRequestFactory, ContactsApiResponseProcessor} from "../apis/ContactsApi"; +export class ObservableContactsApi { + private requestFactory: ContactsApiRequestFactory; + private responseProcessor: ContactsApiResponseProcessor; + private configuration: Configuration; + + public constructor( + configuration: Configuration, + requestFactory?: ContactsApiRequestFactory, + responseProcessor?: ContactsApiResponseProcessor + ) { + this.configuration = configuration; + this.requestFactory = requestFactory || new ContactsApiRequestFactory(configuration); + this.responseProcessor = responseProcessor || new ContactsApiResponseProcessor(); + } + + /** + * Create contact + * @param contactCreateRequest + */ + public contactCreate(contactCreateRequest: ContactCreateRequest, _options?: Configuration): Observable { + const requestContextPromise = this.requestFactory.contactCreate(contactCreateRequest, _options); + + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (let middleware of this.configuration.middleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (let middleware of this.configuration.middleware) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.contactCreate(rsp))); + })); + } + + /** + * Delete contact by id + * @param id Contact id. + */ + public contactDelete(id: string, _options?: Configuration): Observable { + const requestContextPromise = this.requestFactory.contactDelete(id, _options); + + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (let middleware of this.configuration.middleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (let middleware of this.configuration.middleware) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.contactDelete(rsp))); + })); + } + + /** + * Get contact details by id + * @param id Contact id. + */ + public contactDetails(id: string, _options?: Configuration): Observable { + const requestContextPromise = this.requestFactory.contactDetails(id, _options); + + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (let middleware of this.configuration.middleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (let middleware of this.configuration.middleware) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.contactDetails(rsp))); + })); + } + + /** + * List contacts + */ + public contactList(_options?: Configuration): Observable> { + const requestContextPromise = this.requestFactory.contactList(_options); + + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (let middleware of this.configuration.middleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (let middleware of this.configuration.middleware) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.contactList(rsp))); + })); + } + + /** + * Update contact by id + * @param id Contact id. + * @param contactUpdateRequest + */ + public contactUpdate(id: string, contactUpdateRequest: ContactUpdateRequest, _options?: Configuration): Observable { + const requestContextPromise = this.requestFactory.contactUpdate(id, contactUpdateRequest, _options); + + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (let middleware of this.configuration.middleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (let middleware of this.configuration.middleware) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.contactUpdate(rsp))); + })); + } + +} + import { ContentLibraryItemsApiRequestFactory, ContentLibraryItemsApiResponseProcessor} from "../apis/ContentLibraryItemsApi"; export class ObservableContentLibraryItemsApi { private requestFactory: ContentLibraryItemsApiRequestFactory; @@ -229,6 +371,150 @@ export class ObservableContentLibraryItemsApi { } +import { DocumentAttachmentsApiRequestFactory, DocumentAttachmentsApiResponseProcessor} from "../apis/DocumentAttachmentsApi"; +export class ObservableDocumentAttachmentsApi { + private requestFactory: DocumentAttachmentsApiRequestFactory; + private responseProcessor: DocumentAttachmentsApiResponseProcessor; + private configuration: Configuration; + + public constructor( + configuration: Configuration, + requestFactory?: DocumentAttachmentsApiRequestFactory, + responseProcessor?: DocumentAttachmentsApiResponseProcessor + ) { + this.configuration = configuration; + this.requestFactory = requestFactory || new DocumentAttachmentsApiRequestFactory(configuration); + this.responseProcessor = responseProcessor || new DocumentAttachmentsApiResponseProcessor(); + } + + /** + * Creates an attachment for a particular document + * Document Attachment Create + * @param id Document UUID + * @param file Binary file to be attached to a document + * @param source URL link to the file to be attached to a document + * @param name Optional name to set for uploaded file + */ + public documentAttachmentCreate(id: string, file?: HttpFile, source?: string, name?: string, _options?: Configuration): Observable { + const requestContextPromise = this.requestFactory.documentAttachmentCreate(id, file, source, name, _options); + + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (let middleware of this.configuration.middleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (let middleware of this.configuration.middleware) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.documentAttachmentCreate(rsp))); + })); + } + + /** + * Deletes specific document's attachment + * Document Attachment Delete + * @param id Document UUID + * @param attachmentId Attachment UUID + */ + public documentAttachmentDelete(id: string, attachmentId: string, _options?: Configuration): Observable { + const requestContextPromise = this.requestFactory.documentAttachmentDelete(id, attachmentId, _options); + + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (let middleware of this.configuration.middleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (let middleware of this.configuration.middleware) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.documentAttachmentDelete(rsp))); + })); + } + + /** + * Returns details of the specific document's attachment + * Document Attachment Details + * @param id Document UUID + * @param attachmentId Attachment UUID + */ + public documentAttachmentDetails(id: string, attachmentId: string, _options?: Configuration): Observable { + const requestContextPromise = this.requestFactory.documentAttachmentDetails(id, attachmentId, _options); + + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (let middleware of this.configuration.middleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (let middleware of this.configuration.middleware) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.documentAttachmentDetails(rsp))); + })); + } + + /** + * Returns document attachment file for download + * Document Attachment Download + * @param id Document UUID + * @param attachmentId Attachment UUID + */ + public documentAttachmentDownload(id: string, attachmentId: string, _options?: Configuration): Observable { + const requestContextPromise = this.requestFactory.documentAttachmentDownload(id, attachmentId, _options); + + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (let middleware of this.configuration.middleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (let middleware of this.configuration.middleware) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.documentAttachmentDownload(rsp))); + })); + } + + /** + * Return list of objects attached to particular document + * Document Attachment List + * @param id Document UUID + */ + public documentAttachmentsList(id: string, _options?: Configuration): Observable> { + const requestContextPromise = this.requestFactory.documentAttachmentsList(id, _options); + + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (let middleware of this.configuration.middleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (let middleware of this.configuration.middleware) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.documentAttachmentsList(rsp))); + })); + } + +} + import { DocumentsApiRequestFactory, DocumentsApiResponseProcessor} from "../apis/DocumentsApi"; export class ObservableDocumentsApi { private requestFactory: DocumentsApiRequestFactory; @@ -270,11 +556,11 @@ export class ObservableDocumentsApi { /** * Create document + * @param documentCreateRequest Use a PandaDoc template or an existing PDF to create a document. See the creation request examples [by template](#/schemas/DocumentCreateByTemplateRequest) and [by pdf](#/schemas/DocumentCreateByPdfRequest) * @param editorVer Set this parameter as `ev1` if you want to create a document from PDF with Classic Editor when both editors are enabled for the workspace. - * @param inlineObject */ - public documentCreate(editorVer?: string, inlineObject?: InlineObject, _options?: Configuration): Observable { - const requestContextPromise = this.requestFactory.documentCreate(editorVer, inlineObject, _options); + public documentCreate(documentCreateRequest: DocumentCreateRequest, editorVer?: string, _options?: Configuration): Observable { + const requestContextPromise = this.requestFactory.documentCreate(documentCreateRequest, editorVer, _options); // build promise chain let middlewarePreObservable = from(requestContextPromise); @@ -343,6 +629,7 @@ export class ObservableDocumentsApi { * List documents * @param completedFrom Return results where the `date_completed` field (ISO 8601) is greater than or equal to this value. * @param completedTo Return results where the `date_completed` field (ISO 8601) is less than or equal to this value. + * @param contactId Returns results where 'contact_id' is present in document as recipient or approver * @param count Specify how many document results to return. Default is 50 documents, maximum is 100 documents. * @param createdFrom Return results where the `date_created` field (ISO 8601) is greater than or equal to this value. * @param createdTo Return results where the `date_created` field (ISO 8601) is less than this value. @@ -350,6 +637,7 @@ export class ObservableDocumentsApi { * @param id * @param folderUuid The UUID of the folder where the documents are stored. * @param formId Specify the form used for documents creation. This parameter can't be used with template_id. + * @param membershipId Returns results where 'membership_id' is present in document as owner (should be member uuid) * @param metadata Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. * @param modifiedFrom Return results where the `date_modified` field (iso-8601) is greater than or equal to this value. * @param modifiedTo Return results where the `date_modified` field (iso-8601) is less than this value. @@ -361,8 +649,8 @@ export class ObservableDocumentsApi { * @param tag Search tag. Filter by document tag. * @param templateId Specify the template used for documents creation. Parameter can't be used with form_id. */ - public documentList(completedFrom?: string, completedTo?: string, count?: number, createdFrom?: string, createdTo?: string, deleted?: boolean, id?: string, folderUuid?: string, formId?: string, metadata?: string, modifiedFrom?: string, modifiedTo?: string, orderBy?: DocumentOrderingFieldsEnum, page?: number, q?: string, status?: DocumentStatusEnum, statusNe?: DocumentStatusEnum, tag?: string, templateId?: string, _options?: Configuration): Observable { - const requestContextPromise = this.requestFactory.documentList(completedFrom, completedTo, count, createdFrom, createdTo, deleted, id, folderUuid, formId, metadata, modifiedFrom, modifiedTo, orderBy, page, q, status, statusNe, tag, templateId, _options); + public documentList(completedFrom?: string, completedTo?: string, contactId?: string, count?: number, createdFrom?: string, createdTo?: string, deleted?: boolean, id?: string, folderUuid?: string, formId?: string, membershipId?: string, metadata?: string, modifiedFrom?: string, modifiedTo?: string, orderBy?: DocumentOrderingFieldsEnum, page?: number, q?: string, status?: DocumentStatusEnum, statusNe?: DocumentStatusEnum, tag?: string, templateId?: string, _options?: Configuration): Observable { + const requestContextPromise = this.requestFactory.documentList(completedFrom, completedTo, contactId, count, createdFrom, createdTo, deleted, id, folderUuid, formId, membershipId, metadata, modifiedFrom, modifiedTo, orderBy, page, q, status, statusNe, tag, templateId, _options); // build promise chain let middlewarePreObservable = from(requestContextPromise); @@ -403,10 +691,34 @@ export class ObservableDocumentsApi { })); } + /** + * Document status change + * @param id Specify document ID. + * @param documentStatusChangeRequest + */ + public documentStatusChange(id: string, documentStatusChangeRequest: DocumentStatusChangeRequest, _options?: Configuration): Observable { + const requestContextPromise = this.requestFactory.documentStatusChange(id, documentStatusChangeRequest, _options); + + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (let middleware of this.configuration.middleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (let middleware of this.configuration.middleware) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.documentStatusChange(rsp))); + })); + } + /** * Document download * @param id Specify document ID. - * @param watermarkColor HEX code (for example `#RRGGBB`). + * @param watermarkColor HEX code (for example `#FF5733`). * @param watermarkFontSize Font size of the watermark. * @param watermarkOpacity In range 0.0-1.0 * @param watermarkText Specify watermark text. @@ -530,7 +842,7 @@ export class ObservableDocumentsApi { * @param id Document ID * @param documentSendRequest */ - public sendDocument(id: string, documentSendRequest?: DocumentSendRequest, _options?: Configuration): Observable { + public sendDocument(id: string, documentSendRequest: DocumentSendRequest, _options?: Configuration): Observable { const requestContextPromise = this.requestFactory.sendDocument(id, documentSendRequest, _options); // build promise chain @@ -549,6 +861,53 @@ export class ObservableDocumentsApi { })); } + /** + * Transfer all documents ownership + * @param documentTransferAllOwnershipRequest + */ + public transferAllDocumentsOwnership(documentTransferAllOwnershipRequest: DocumentTransferAllOwnershipRequest, _options?: Configuration): Observable { + const requestContextPromise = this.requestFactory.transferAllDocumentsOwnership(documentTransferAllOwnershipRequest, _options); + + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (let middleware of this.configuration.middleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (let middleware of this.configuration.middleware) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.transferAllDocumentsOwnership(rsp))); + })); + } + + /** + * Update document ownership + * @param id Specify document ID. + * @param documentTransferOwnershipRequest + */ + public transferDocumentOwnership(id: string, documentTransferOwnershipRequest: DocumentTransferOwnershipRequest, _options?: Configuration): Observable { + const requestContextPromise = this.requestFactory.transferDocumentOwnership(id, documentTransferOwnershipRequest, _options); + + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (let middleware of this.configuration.middleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (let middleware of this.configuration.middleware) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.transferDocumentOwnership(rsp))); + })); + } + } import { FoldersAPIApiRequestFactory, FoldersAPIApiResponseProcessor} from "../apis/FoldersAPIApi"; @@ -572,7 +931,7 @@ export class ObservableFoldersAPIApi { * Create Documents Folder * @param documentsFolderCreateRequest */ - public createDocumentFolder(documentsFolderCreateRequest?: DocumentsFolderCreateRequest, _options?: Configuration): Observable { + public createDocumentFolder(documentsFolderCreateRequest: DocumentsFolderCreateRequest, _options?: Configuration): Observable { const requestContextPromise = this.requestFactory.createDocumentFolder(documentsFolderCreateRequest, _options); // build promise chain @@ -596,7 +955,7 @@ export class ObservableFoldersAPIApi { * Create Templates Folder * @param templatesFolderCreateRequest */ - public createTemplateFolder(templatesFolderCreateRequest?: TemplatesFolderCreateRequest, _options?: Configuration): Observable { + public createTemplateFolder(templatesFolderCreateRequest: TemplatesFolderCreateRequest, _options?: Configuration): Observable { const requestContextPromise = this.requestFactory.createTemplateFolder(templatesFolderCreateRequest, _options); // build promise chain @@ -673,7 +1032,7 @@ export class ObservableFoldersAPIApi { * @param id The UUID of the folder that you are renaming. * @param documentsFolderRenameRequest */ - public renameDocumentFolder(id: string, documentsFolderRenameRequest?: DocumentsFolderRenameRequest, _options?: Configuration): Observable { + public renameDocumentFolder(id: string, documentsFolderRenameRequest: DocumentsFolderRenameRequest, _options?: Configuration): Observable { const requestContextPromise = this.requestFactory.renameDocumentFolder(id, documentsFolderRenameRequest, _options); // build promise chain @@ -698,7 +1057,7 @@ export class ObservableFoldersAPIApi { * @param id The UUID of the folder which you are renaming. * @param templatesFolderRenameRequest */ - public renameTemplateFolder(id: string, templatesFolderRenameRequest?: TemplatesFolderRenameRequest, _options?: Configuration): Observable { + public renameTemplateFolder(id: string, templatesFolderRenameRequest: TemplatesFolderRenameRequest, _options?: Configuration): Observable { const requestContextPromise = this.requestFactory.renameTemplateFolder(id, templatesFolderRenameRequest, _options); // build promise chain @@ -766,6 +1125,94 @@ export class ObservableFormsApi { } +import { MembersApiRequestFactory, MembersApiResponseProcessor} from "../apis/MembersApi"; +export class ObservableMembersApi { + private requestFactory: MembersApiRequestFactory; + private responseProcessor: MembersApiResponseProcessor; + private configuration: Configuration; + + public constructor( + configuration: Configuration, + requestFactory?: MembersApiRequestFactory, + responseProcessor?: MembersApiResponseProcessor + ) { + this.configuration = configuration; + this.requestFactory = requestFactory || new MembersApiRequestFactory(configuration); + this.responseProcessor = responseProcessor || new MembersApiResponseProcessor(); + } + + /** + * A method to define to whom credentials belong + * Current member details + */ + public currentMemberDetails(_options?: Configuration): Observable { + const requestContextPromise = this.requestFactory.currentMemberDetails(_options); + + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (let middleware of this.configuration.middleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (let middleware of this.configuration.middleware) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.currentMemberDetails(rsp))); + })); + } + + /** + * A method to retrieve a member's details by id + * Member details + * @param id Membership id + */ + public memberDetails(id: string, _options?: Configuration): Observable { + const requestContextPromise = this.requestFactory.memberDetails(id, _options); + + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (let middleware of this.configuration.middleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (let middleware of this.configuration.middleware) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.memberDetails(rsp))); + })); + } + + /** + * Retrieve all members details of the workspace + * List members + */ + public memberList(_options?: Configuration): Observable> { + const requestContextPromise = this.requestFactory.memberList(_options); + + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (let middleware of this.configuration.middleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (let middleware of this.configuration.middleware) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.memberList(rsp))); + })); + } + +} + import { OAuth20AuthenticationApiRequestFactory, OAuth20AuthenticationApiResponseProcessor} from "../apis/OAuth20AuthenticationApi"; export class ObservableOAuth20AuthenticationApi { private requestFactory: OAuth20AuthenticationApiRequestFactory; diff --git a/src/types/PromiseAPI.ts b/src/types/PromiseAPI.ts index 7c8f81d..c610566 100644 --- a/src/types/PromiseAPI.ts +++ b/src/types/PromiseAPI.ts @@ -5,10 +5,15 @@ import { Configuration} from '../configuration' import { APILogDetailsResponse } from '../models/APILogDetailsResponse'; import { APILogListResponse } from '../models/APILogListResponse'; import { APILogListResponseResults } from '../models/APILogListResponseResults'; +import { ContactCreateRequest } from '../models/ContactCreateRequest'; +import { ContactDetailsResponse } from '../models/ContactDetailsResponse'; +import { ContactUpdateRequest } from '../models/ContactUpdateRequest'; import { ContentLibraryItemListResponse } from '../models/ContentLibraryItemListResponse'; import { ContentLibraryItemListResponseResults } from '../models/ContentLibraryItemListResponseResults'; import { ContentLibraryItemResponse } from '../models/ContentLibraryItemResponse'; import { ContentLibraryItemResponseCreatedBy } from '../models/ContentLibraryItemResponseCreatedBy'; +import { DocumentAttachmentResponse } from '../models/DocumentAttachmentResponse'; +import { DocumentAttachmentResponseCreatedBy } from '../models/DocumentAttachmentResponseCreatedBy'; import { DocumentCreateByPdfRequest } from '../models/DocumentCreateByPdfRequest'; import { DocumentCreateByPdfRequestRecipients } from '../models/DocumentCreateByPdfRequestRecipients'; import { DocumentCreateByTemplateRequest } from '../models/DocumentCreateByTemplateRequest'; @@ -16,8 +21,14 @@ import { DocumentCreateByTemplateRequestContentLibraryItems } from '../models/Do import { DocumentCreateByTemplateRequestContentPlaceholders } from '../models/DocumentCreateByTemplateRequestContentPlaceholders'; import { DocumentCreateByTemplateRequestImages } from '../models/DocumentCreateByTemplateRequestImages'; import { DocumentCreateByTemplateRequestRecipients } from '../models/DocumentCreateByTemplateRequestRecipients'; +import { DocumentCreateByTemplateRequestTokens } from '../models/DocumentCreateByTemplateRequestTokens'; import { DocumentCreateLinkRequest } from '../models/DocumentCreateLinkRequest'; import { DocumentCreateLinkResponse } from '../models/DocumentCreateLinkResponse'; +import { DocumentCreateRequest } from '../models/DocumentCreateRequest'; +import { DocumentCreateRequestContentLibraryItems } from '../models/DocumentCreateRequestContentLibraryItems'; +import { DocumentCreateRequestContentPlaceholders } from '../models/DocumentCreateRequestContentPlaceholders'; +import { DocumentCreateRequestImages } from '../models/DocumentCreateRequestImages'; +import { DocumentCreateRequestRecipients } from '../models/DocumentCreateRequestRecipients'; import { DocumentCreateResponse } from '../models/DocumentCreateResponse'; import { DocumentDetailsResponse } from '../models/DocumentDetailsResponse'; import { DocumentDetailsResponseCreatedBy } from '../models/DocumentDetailsResponseCreatedBy'; @@ -30,8 +41,11 @@ import { DocumentListResponseResults } from '../models/DocumentListResponseResul import { DocumentOrderingFieldsEnum } from '../models/DocumentOrderingFieldsEnum'; import { DocumentSendRequest } from '../models/DocumentSendRequest'; import { DocumentSendResponse } from '../models/DocumentSendResponse'; +import { DocumentStatusChangeRequest } from '../models/DocumentStatusChangeRequest'; import { DocumentStatusEnum } from '../models/DocumentStatusEnum'; import { DocumentStatusResponse } from '../models/DocumentStatusResponse'; +import { DocumentTransferAllOwnershipRequest } from '../models/DocumentTransferAllOwnershipRequest'; +import { DocumentTransferOwnershipRequest } from '../models/DocumentTransferOwnershipRequest'; import { DocumentsFolderCreateRequest } from '../models/DocumentsFolderCreateRequest'; import { DocumentsFolderCreateResponse } from '../models/DocumentsFolderCreateResponse'; import { DocumentsFolderListResponse } from '../models/DocumentsFolderListResponse'; @@ -40,10 +54,10 @@ import { DocumentsFolderRenameRequest } from '../models/DocumentsFolderRenameReq import { DocumentsFolderRenameResponse } from '../models/DocumentsFolderRenameResponse'; import { FormListResponse } from '../models/FormListResponse'; import { FormListResponseResults } from '../models/FormListResponseResults'; -import { InlineObject } from '../models/InlineObject'; import { LinkedObjectCreateRequest } from '../models/LinkedObjectCreateRequest'; import { LinkedObjectCreateResponse } from '../models/LinkedObjectCreateResponse'; import { LinkedObjectListResponse } from '../models/LinkedObjectListResponse'; +import { MemberDetailsResponse } from '../models/MemberDetailsResponse'; import { OAuth2AccessTokenResponse } from '../models/OAuth2AccessTokenResponse'; import { PricingTableRequest } from '../models/PricingTableRequest'; import { PricingTableRequestData } from '../models/PricingTableRequestData'; @@ -61,11 +75,6 @@ import { PricingTablesResponseItems } from '../models/PricingTablesResponseItems import { PricingTablesResponseOptions } from '../models/PricingTablesResponseOptions'; import { PricingTablesResponseSummary } from '../models/PricingTablesResponseSummary'; import { PricingTablesResponseTables } from '../models/PricingTablesResponseTables'; -import { PublicV1DocumentsContentLibraryItems } from '../models/PublicV1DocumentsContentLibraryItems'; -import { PublicV1DocumentsContentPlaceholders } from '../models/PublicV1DocumentsContentPlaceholders'; -import { PublicV1DocumentsImages } from '../models/PublicV1DocumentsImages'; -import { PublicV1DocumentsRecipients } from '../models/PublicV1DocumentsRecipients'; -import { PublicV1DocumentsTokens } from '../models/PublicV1DocumentsTokens'; import { TemplateDetailsResponse } from '../models/TemplateDetailsResponse'; import { TemplateDetailsResponseAssignedTo } from '../models/TemplateDetailsResponseAssignedTo'; import { TemplateDetailsResponseContentPlaceholders } from '../models/TemplateDetailsResponseContentPlaceholders'; @@ -128,6 +137,70 @@ export class PromiseAPILogsApi { +import { ObservableContactsApi } from './ObservableAPI'; + +import { ContactsApiRequestFactory, ContactsApiResponseProcessor} from "../apis/ContactsApi"; +export class PromiseContactsApi { + private api: ObservableContactsApi + + public constructor( + configuration: Configuration, + requestFactory?: ContactsApiRequestFactory, + responseProcessor?: ContactsApiResponseProcessor + ) { + this.api = new ObservableContactsApi(configuration, requestFactory, responseProcessor); + } + + /** + * Create contact + * @param contactCreateRequest + */ + public contactCreate(contactCreateRequest: ContactCreateRequest, _options?: Configuration): Promise { + const result = this.api.contactCreate(contactCreateRequest, _options); + return result.toPromise(); + } + + /** + * Delete contact by id + * @param id Contact id. + */ + public contactDelete(id: string, _options?: Configuration): Promise { + const result = this.api.contactDelete(id, _options); + return result.toPromise(); + } + + /** + * Get contact details by id + * @param id Contact id. + */ + public contactDetails(id: string, _options?: Configuration): Promise { + const result = this.api.contactDetails(id, _options); + return result.toPromise(); + } + + /** + * List contacts + */ + public contactList(_options?: Configuration): Promise> { + const result = this.api.contactList(_options); + return result.toPromise(); + } + + /** + * Update contact by id + * @param id Contact id. + * @param contactUpdateRequest + */ + public contactUpdate(id: string, contactUpdateRequest: ContactUpdateRequest, _options?: Configuration): Promise { + const result = this.api.contactUpdate(id, contactUpdateRequest, _options); + return result.toPromise(); + } + + +} + + + import { ObservableContentLibraryItemsApi } from './ObservableAPI'; import { ContentLibraryItemsApiRequestFactory, ContentLibraryItemsApiResponseProcessor} from "../apis/ContentLibraryItemsApi"; @@ -173,6 +246,81 @@ export class PromiseContentLibraryItemsApi { +import { ObservableDocumentAttachmentsApi } from './ObservableAPI'; + +import { DocumentAttachmentsApiRequestFactory, DocumentAttachmentsApiResponseProcessor} from "../apis/DocumentAttachmentsApi"; +export class PromiseDocumentAttachmentsApi { + private api: ObservableDocumentAttachmentsApi + + public constructor( + configuration: Configuration, + requestFactory?: DocumentAttachmentsApiRequestFactory, + responseProcessor?: DocumentAttachmentsApiResponseProcessor + ) { + this.api = new ObservableDocumentAttachmentsApi(configuration, requestFactory, responseProcessor); + } + + /** + * Creates an attachment for a particular document + * Document Attachment Create + * @param id Document UUID + * @param file Binary file to be attached to a document + * @param source URL link to the file to be attached to a document + * @param name Optional name to set for uploaded file + */ + public documentAttachmentCreate(id: string, file?: HttpFile, source?: string, name?: string, _options?: Configuration): Promise { + const result = this.api.documentAttachmentCreate(id, file, source, name, _options); + return result.toPromise(); + } + + /** + * Deletes specific document's attachment + * Document Attachment Delete + * @param id Document UUID + * @param attachmentId Attachment UUID + */ + public documentAttachmentDelete(id: string, attachmentId: string, _options?: Configuration): Promise { + const result = this.api.documentAttachmentDelete(id, attachmentId, _options); + return result.toPromise(); + } + + /** + * Returns details of the specific document's attachment + * Document Attachment Details + * @param id Document UUID + * @param attachmentId Attachment UUID + */ + public documentAttachmentDetails(id: string, attachmentId: string, _options?: Configuration): Promise { + const result = this.api.documentAttachmentDetails(id, attachmentId, _options); + return result.toPromise(); + } + + /** + * Returns document attachment file for download + * Document Attachment Download + * @param id Document UUID + * @param attachmentId Attachment UUID + */ + public documentAttachmentDownload(id: string, attachmentId: string, _options?: Configuration): Promise { + const result = this.api.documentAttachmentDownload(id, attachmentId, _options); + return result.toPromise(); + } + + /** + * Return list of objects attached to particular document + * Document Attachment List + * @param id Document UUID + */ + public documentAttachmentsList(id: string, _options?: Configuration): Promise> { + const result = this.api.documentAttachmentsList(id, _options); + return result.toPromise(); + } + + +} + + + import { ObservableDocumentsApi } from './ObservableAPI'; import { DocumentsApiRequestFactory, DocumentsApiResponseProcessor} from "../apis/DocumentsApi"; @@ -198,11 +346,11 @@ export class PromiseDocumentsApi { /** * Create document + * @param documentCreateRequest Use a PandaDoc template or an existing PDF to create a document. See the creation request examples [by template](#/schemas/DocumentCreateByTemplateRequest) and [by pdf](#/schemas/DocumentCreateByPdfRequest) * @param editorVer Set this parameter as `ev1` if you want to create a document from PDF with Classic Editor when both editors are enabled for the workspace. - * @param inlineObject */ - public documentCreate(editorVer?: string, inlineObject?: InlineObject, _options?: Configuration): Promise { - const result = this.api.documentCreate(editorVer, inlineObject, _options); + public documentCreate(documentCreateRequest: DocumentCreateRequest, editorVer?: string, _options?: Configuration): Promise { + const result = this.api.documentCreate(documentCreateRequest, editorVer, _options); return result.toPromise(); } @@ -229,6 +377,7 @@ export class PromiseDocumentsApi { * List documents * @param completedFrom Return results where the `date_completed` field (ISO 8601) is greater than or equal to this value. * @param completedTo Return results where the `date_completed` field (ISO 8601) is less than or equal to this value. + * @param contactId Returns results where 'contact_id' is present in document as recipient or approver * @param count Specify how many document results to return. Default is 50 documents, maximum is 100 documents. * @param createdFrom Return results where the `date_created` field (ISO 8601) is greater than or equal to this value. * @param createdTo Return results where the `date_created` field (ISO 8601) is less than this value. @@ -236,6 +385,7 @@ export class PromiseDocumentsApi { * @param id * @param folderUuid The UUID of the folder where the documents are stored. * @param formId Specify the form used for documents creation. This parameter can't be used with template_id. + * @param membershipId Returns results where 'membership_id' is present in document as owner (should be member uuid) * @param metadata Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. * @param modifiedFrom Return results where the `date_modified` field (iso-8601) is greater than or equal to this value. * @param modifiedTo Return results where the `date_modified` field (iso-8601) is less than this value. @@ -247,8 +397,8 @@ export class PromiseDocumentsApi { * @param tag Search tag. Filter by document tag. * @param templateId Specify the template used for documents creation. Parameter can't be used with form_id. */ - public documentList(completedFrom?: string, completedTo?: string, count?: number, createdFrom?: string, createdTo?: string, deleted?: boolean, id?: string, folderUuid?: string, formId?: string, metadata?: string, modifiedFrom?: string, modifiedTo?: string, orderBy?: DocumentOrderingFieldsEnum, page?: number, q?: string, status?: DocumentStatusEnum, statusNe?: DocumentStatusEnum, tag?: string, templateId?: string, _options?: Configuration): Promise { - const result = this.api.documentList(completedFrom, completedTo, count, createdFrom, createdTo, deleted, id, folderUuid, formId, metadata, modifiedFrom, modifiedTo, orderBy, page, q, status, statusNe, tag, templateId, _options); + public documentList(completedFrom?: string, completedTo?: string, contactId?: string, count?: number, createdFrom?: string, createdTo?: string, deleted?: boolean, id?: string, folderUuid?: string, formId?: string, membershipId?: string, metadata?: string, modifiedFrom?: string, modifiedTo?: string, orderBy?: DocumentOrderingFieldsEnum, page?: number, q?: string, status?: DocumentStatusEnum, statusNe?: DocumentStatusEnum, tag?: string, templateId?: string, _options?: Configuration): Promise { + const result = this.api.documentList(completedFrom, completedTo, contactId, count, createdFrom, createdTo, deleted, id, folderUuid, formId, membershipId, metadata, modifiedFrom, modifiedTo, orderBy, page, q, status, statusNe, tag, templateId, _options); return result.toPromise(); } @@ -261,10 +411,20 @@ export class PromiseDocumentsApi { return result.toPromise(); } + /** + * Document status change + * @param id Specify document ID. + * @param documentStatusChangeRequest + */ + public documentStatusChange(id: string, documentStatusChangeRequest: DocumentStatusChangeRequest, _options?: Configuration): Promise { + const result = this.api.documentStatusChange(id, documentStatusChangeRequest, _options); + return result.toPromise(); + } + /** * Document download * @param id Specify document ID. - * @param watermarkColor HEX code (for example `#RRGGBB`). + * @param watermarkColor HEX code (for example `#FF5733`). * @param watermarkFontSize Font size of the watermark. * @param watermarkOpacity In range 0.0-1.0 * @param watermarkText Specify watermark text. @@ -318,11 +478,30 @@ export class PromiseDocumentsApi { * @param id Document ID * @param documentSendRequest */ - public sendDocument(id: string, documentSendRequest?: DocumentSendRequest, _options?: Configuration): Promise { + public sendDocument(id: string, documentSendRequest: DocumentSendRequest, _options?: Configuration): Promise { const result = this.api.sendDocument(id, documentSendRequest, _options); return result.toPromise(); } + /** + * Transfer all documents ownership + * @param documentTransferAllOwnershipRequest + */ + public transferAllDocumentsOwnership(documentTransferAllOwnershipRequest: DocumentTransferAllOwnershipRequest, _options?: Configuration): Promise { + const result = this.api.transferAllDocumentsOwnership(documentTransferAllOwnershipRequest, _options); + return result.toPromise(); + } + + /** + * Update document ownership + * @param id Specify document ID. + * @param documentTransferOwnershipRequest + */ + public transferDocumentOwnership(id: string, documentTransferOwnershipRequest: DocumentTransferOwnershipRequest, _options?: Configuration): Promise { + const result = this.api.transferDocumentOwnership(id, documentTransferOwnershipRequest, _options); + return result.toPromise(); + } + } @@ -347,7 +526,7 @@ export class PromiseFoldersAPIApi { * Create Documents Folder * @param documentsFolderCreateRequest */ - public createDocumentFolder(documentsFolderCreateRequest?: DocumentsFolderCreateRequest, _options?: Configuration): Promise { + public createDocumentFolder(documentsFolderCreateRequest: DocumentsFolderCreateRequest, _options?: Configuration): Promise { const result = this.api.createDocumentFolder(documentsFolderCreateRequest, _options); return result.toPromise(); } @@ -357,7 +536,7 @@ export class PromiseFoldersAPIApi { * Create Templates Folder * @param templatesFolderCreateRequest */ - public createTemplateFolder(templatesFolderCreateRequest?: TemplatesFolderCreateRequest, _options?: Configuration): Promise { + public createTemplateFolder(templatesFolderCreateRequest: TemplatesFolderCreateRequest, _options?: Configuration): Promise { const result = this.api.createTemplateFolder(templatesFolderCreateRequest, _options); return result.toPromise(); } @@ -392,7 +571,7 @@ export class PromiseFoldersAPIApi { * @param id The UUID of the folder that you are renaming. * @param documentsFolderRenameRequest */ - public renameDocumentFolder(id: string, documentsFolderRenameRequest?: DocumentsFolderRenameRequest, _options?: Configuration): Promise { + public renameDocumentFolder(id: string, documentsFolderRenameRequest: DocumentsFolderRenameRequest, _options?: Configuration): Promise { const result = this.api.renameDocumentFolder(id, documentsFolderRenameRequest, _options); return result.toPromise(); } @@ -403,7 +582,7 @@ export class PromiseFoldersAPIApi { * @param id The UUID of the folder which you are renaming. * @param templatesFolderRenameRequest */ - public renameTemplateFolder(id: string, templatesFolderRenameRequest?: TemplatesFolderRenameRequest, _options?: Configuration): Promise { + public renameTemplateFolder(id: string, templatesFolderRenameRequest: TemplatesFolderRenameRequest, _options?: Configuration): Promise { const result = this.api.renameTemplateFolder(id, templatesFolderRenameRequest, _options); return result.toPromise(); } @@ -447,6 +626,53 @@ export class PromiseFormsApi { +import { ObservableMembersApi } from './ObservableAPI'; + +import { MembersApiRequestFactory, MembersApiResponseProcessor} from "../apis/MembersApi"; +export class PromiseMembersApi { + private api: ObservableMembersApi + + public constructor( + configuration: Configuration, + requestFactory?: MembersApiRequestFactory, + responseProcessor?: MembersApiResponseProcessor + ) { + this.api = new ObservableMembersApi(configuration, requestFactory, responseProcessor); + } + + /** + * A method to define to whom credentials belong + * Current member details + */ + public currentMemberDetails(_options?: Configuration): Promise { + const result = this.api.currentMemberDetails(_options); + return result.toPromise(); + } + + /** + * A method to retrieve a member's details by id + * Member details + * @param id Membership id + */ + public memberDetails(id: string, _options?: Configuration): Promise { + const result = this.api.memberDetails(id, _options); + return result.toPromise(); + } + + /** + * Retrieve all members details of the workspace + * List members + */ + public memberList(_options?: Configuration): Promise> { + const result = this.api.memberList(_options); + return result.toPromise(); + } + + +} + + + import { ObservableOAuth20AuthenticationApi } from './ObservableAPI'; import { OAuth20AuthenticationApiRequestFactory, OAuth20AuthenticationApiResponseProcessor} from "../apis/OAuth20AuthenticationApi";