Skip to content

Commit 5fe9aef

Browse files
ddumenkoddumenko
authored
Update required params and methods naming
1 parent fbdb9fd commit 5fe9aef

40 files changed

+1224
-1296
lines changed

‎README.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -58,33 +58,33 @@ All URIs are relative to *https://api.pandadoc.com*
5858

5959
Class | Method | HTTP request | Description
6060
------------ | ------------- | ------------- | -------------
61-
*APILogsApi* | [**detailsApiLog**](docs/APILogsApi.md#detailsapilog) | **GET** /public/v1/logs/{id} | Details API Log
62-
*APILogsApi* | [**listApiLogs**](docs/APILogsApi.md#listapilogs) | **GET** /public/v1/logs | List API Log
63-
*ContactsApi* | [**contactCreate**](docs/ContactsApi.md#contactcreate) | **POST** /public/v1/contacts | Create contact
64-
*ContactsApi* | [**contactDelete**](docs/ContactsApi.md#contactdelete) | **DELETE** /public/v1/contacts/{id} | Delete contact by id
65-
*ContactsApi* | [**contactDetails**](docs/ContactsApi.md#contactdetails) | **GET** /public/v1/contacts/{id} | Get contact details by id
66-
*ContactsApi* | [**contactList**](docs/ContactsApi.md#contactlist) | **GET** /public/v1/contacts | List contacts
67-
*ContactsApi* | [**contactUpdate**](docs/ContactsApi.md#contactupdate) | **PATCH** /public/v1/contacts/{id} | Update contact by id
61+
*APILogsApi* | [**detailsLog**](docs/APILogsApi.md#detailslog) | **GET** /public/v1/logs/{id} | Details API Log
62+
*APILogsApi* | [**listLogs**](docs/APILogsApi.md#listlogs) | **GET** /public/v1/logs | List API Log
63+
*ContactsApi* | [**createContact**](docs/ContactsApi.md#createcontact) | **POST** /public/v1/contacts | Create contact
64+
*ContactsApi* | [**deleteContact**](docs/ContactsApi.md#deletecontact) | **DELETE** /public/v1/contacts/{id} | Delete contact by id
65+
*ContactsApi* | [**detailsContact**](docs/ContactsApi.md#detailscontact) | **GET** /public/v1/contacts/{id} | Get contact details by id
66+
*ContactsApi* | [**listContacts**](docs/ContactsApi.md#listcontacts) | **GET** /public/v1/contacts | List contacts
67+
*ContactsApi* | [**updateContact**](docs/ContactsApi.md#updatecontact) | **PATCH** /public/v1/contacts/{id} | Update contact by id
6868
*ContentLibraryItemsApi* | [**detailsContentLibraryItem**](docs/ContentLibraryItemsApi.md#detailscontentlibraryitem) | **GET** /public/v1/content-library-items/{id}/details | Details Content Library Item
6969
*ContentLibraryItemsApi* | [**listContentLibraryItems**](docs/ContentLibraryItemsApi.md#listcontentlibraryitems) | **GET** /public/v1/content-library-items | List Content Library Item
70-
*DocumentAttachmentsApi* | [**documentAttachmentCreate**](docs/DocumentAttachmentsApi.md#documentattachmentcreate) | **POST** /public/v1/documents/{id}/attachments | Document Attachment Create
71-
*DocumentAttachmentsApi* | [**documentAttachmentDelete**](docs/DocumentAttachmentsApi.md#documentattachmentdelete) | **DELETE** /public/v1/documents/{id}/attachments/{attachment_id} | Document Attachment Delete
72-
*DocumentAttachmentsApi* | [**documentAttachmentDetails**](docs/DocumentAttachmentsApi.md#documentattachmentdetails) | **GET** /public/v1/documents/{id}/attachments/{attachment_id} | Document Attachment Details
73-
*DocumentAttachmentsApi* | [**documentAttachmentDownload**](docs/DocumentAttachmentsApi.md#documentattachmentdownload) | **GET** /public/v1/documents/{id}/attachments/{attachment_id}/download | Document Attachment Download
74-
*DocumentAttachmentsApi* | [**documentAttachmentsList**](docs/DocumentAttachmentsApi.md#documentattachmentslist) | **GET** /public/v1/documents/{id}/attachments | Document Attachment List
70+
*DocumentAttachmentsApi* | [**createDocumentAttachment**](docs/DocumentAttachmentsApi.md#createdocumentattachment) | **POST** /public/v1/documents/{id}/attachments | Document Attachment Create
71+
*DocumentAttachmentsApi* | [**deleteDocumentAttachment**](docs/DocumentAttachmentsApi.md#deletedocumentattachment) | **DELETE** /public/v1/documents/{id}/attachments/{attachment_id} | Document Attachment Delete
72+
*DocumentAttachmentsApi* | [**detailsDocumentAttachment**](docs/DocumentAttachmentsApi.md#detailsdocumentattachment) | **GET** /public/v1/documents/{id}/attachments/{attachment_id} | Document Attachment Details
73+
*DocumentAttachmentsApi* | [**downloadDocumentAttachment**](docs/DocumentAttachmentsApi.md#downloaddocumentattachment) | **GET** /public/v1/documents/{id}/attachments/{attachment_id}/download | Document Attachment Download
74+
*DocumentAttachmentsApi* | [**listDocumentAttachments**](docs/DocumentAttachmentsApi.md#listdocumentattachments) | **GET** /public/v1/documents/{id}/attachments | Document Attachment List
75+
*DocumentsApi* | [**changeDocumentStatus**](docs/DocumentsApi.md#changedocumentstatus) | **PATCH** /public/v1/documents/{id}/status | Document status change
76+
*DocumentsApi* | [**createDocument**](docs/DocumentsApi.md#createdocument) | **POST** /public/v1/documents | Create document
77+
*DocumentsApi* | [**createDocumentLink**](docs/DocumentsApi.md#createdocumentlink) | **POST** /public/v1/documents/{id}/session | Create a Document Link
78+
*DocumentsApi* | [**createLinkedObject**](docs/DocumentsApi.md#createlinkedobject) | **POST** /public/v1/documents/{id}/linked-objects | Create Linked Object
7579
*DocumentsApi* | [**deleteDocument**](docs/DocumentsApi.md#deletedocument) | **DELETE** /public/v1/documents/{id} | Delete document by id
76-
*DocumentsApi* | [**documentCreate**](docs/DocumentsApi.md#documentcreate) | **POST** /public/v1/documents | Create document
77-
*DocumentsApi* | [**documentCreateLink**](docs/DocumentsApi.md#documentcreatelink) | **POST** /public/v1/documents/{id}/session | Create a Document Link
78-
*DocumentsApi* | [**documentDetails**](docs/DocumentsApi.md#documentdetails) | **GET** /public/v1/documents/{id}/details | Document details
79-
*DocumentsApi* | [**documentList**](docs/DocumentsApi.md#documentlist) | **GET** /public/v1/documents | List documents
80-
*DocumentsApi* | [**documentStatus**](docs/DocumentsApi.md#documentstatus) | **GET** /public/v1/documents/{id} | Document status
81-
*DocumentsApi* | [**documentStatusChange**](docs/DocumentsApi.md#documentstatuschange) | **PATCH** /public/v1/documents/{id}/status | Document status change
80+
*DocumentsApi* | [**deleteLinkedObject**](docs/DocumentsApi.md#deletelinkedobject) | **DELETE** /public/v1/documents/{id}/linked-objects/{linked_object_id} | Delete Linked Object
81+
*DocumentsApi* | [**detailsDocument**](docs/DocumentsApi.md#detailsdocument) | **GET** /public/v1/documents/{id}/details | Document details
8282
*DocumentsApi* | [**downloadDocument**](docs/DocumentsApi.md#downloaddocument) | **GET** /public/v1/documents/{id}/download | Document download
8383
*DocumentsApi* | [**downloadProtectedDocument**](docs/DocumentsApi.md#downloadprotecteddocument) | **GET** /public/v1/documents/{id}/download-protected | Download document protected
84-
*DocumentsApi* | [**linkedObjectDelete**](docs/DocumentsApi.md#linkedobjectdelete) | **DELETE** /public/v1/documents/{id}/linked-objects/{linked_object_id} | Delete Linked Object
85-
*DocumentsApi* | [**linkedObjectList**](docs/DocumentsApi.md#linkedobjectlist) | **GET** /public/v1/documents/{id}/linked-objects | List Linked Objects
86-
*DocumentsApi* | [**linkedObjectsCreate**](docs/DocumentsApi.md#linkedobjectscreate) | **POST** /public/v1/documents/{id}/linked-objects | Create Linked Object
84+
*DocumentsApi* | [**listDocuments**](docs/DocumentsApi.md#listdocuments) | **GET** /public/v1/documents | List documents
85+
*DocumentsApi* | [**listLinkedObjects**](docs/DocumentsApi.md#listlinkedobjects) | **GET** /public/v1/documents/{id}/linked-objects | List Linked Objects
8786
*DocumentsApi* | [**sendDocument**](docs/DocumentsApi.md#senddocument) | **POST** /public/v1/documents/{id}/send | Send Document
87+
*DocumentsApi* | [**statusDocument**](docs/DocumentsApi.md#statusdocument) | **GET** /public/v1/documents/{id} | Document status
8888
*DocumentsApi* | [**transferAllDocumentsOwnership**](docs/DocumentsApi.md#transferalldocumentsownership) | **PATCH** /public/v1/documents/ownership | Transfer all documents ownership
8989
*DocumentsApi* | [**transferDocumentOwnership**](docs/DocumentsApi.md#transferdocumentownership) | **PATCH** /public/v1/documents/{id}/ownership | Update document ownership
9090
*FoldersAPIApi* | [**createDocumentFolder**](docs/FoldersAPIApi.md#createdocumentfolder) | **POST** /public/v1/documents/folders | Create Documents Folder
@@ -94,12 +94,12 @@ Class | Method | HTTP request | Description
9494
*FoldersAPIApi* | [**renameDocumentFolder**](docs/FoldersAPIApi.md#renamedocumentfolder) | **PUT** /public/v1/documents/folders/{id} | Rename Documents Folder
9595
*FoldersAPIApi* | [**renameTemplateFolder**](docs/FoldersAPIApi.md#renametemplatefolder) | **PUT** /public/v1/templates/folders/{id} | Rename Templates Folder
9696
*FormsApi* | [**listForm**](docs/FormsApi.md#listform) | **GET** /public/v1/forms | Forms
97-
*MembersApi* | [**currentMemberDetails**](docs/MembersApi.md#currentmemberdetails) | **GET** /public/v1/members/current | Current member details
98-
*MembersApi* | [**memberDetails**](docs/MembersApi.md#memberdetails) | **GET** /public/v1/members/{id} | Member details
99-
*MembersApi* | [**memberList**](docs/MembersApi.md#memberlist) | **GET** /public/v1/members | List members
97+
*MembersApi* | [**detailsCurrentMember**](docs/MembersApi.md#detailscurrentmember) | **GET** /public/v1/members/current | Current member details
98+
*MembersApi* | [**detailsMember**](docs/MembersApi.md#detailsmember) | **GET** /public/v1/members/{id} | Member details
99+
*MembersApi* | [**listMembers**](docs/MembersApi.md#listmembers) | **GET** /public/v1/members | List members
100100
*OAuth20AuthenticationApi* | [**accessToken**](docs/OAuth20AuthenticationApi.md#accesstoken) | **POST** /oauth2/access_token | Create/Refresh Access Token
101101
*TemplatesApi* | [**deleteTemplate**](docs/TemplatesApi.md#deletetemplate) | **DELETE** /public/v1/templates/{id} | Delete Template
102-
*TemplatesApi* | [**detailsTemaplate**](docs/TemplatesApi.md#detailstemaplate) | **GET** /public/v1/templates/{id}/details | Details Template
102+
*TemplatesApi* | [**detailsTemplate**](docs/TemplatesApi.md#detailstemplate) | **GET** /public/v1/templates/{id}/details | Details Template
103103
*TemplatesApi* | [**listTemplates**](docs/TemplatesApi.md#listtemplates) | **GET** /public/v1/templates | List Templates
104104

105105

‎docs/APILogsApi.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ All URIs are relative to *https://api.pandadoc.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**detailsApiLog**](APILogsApi.md#detailsApiLog) | **GET** /public/v1/logs/{id} | Details API Log
8-
[**listApiLogs**](APILogsApi.md#listApiLogs) | **GET** /public/v1/logs | List API Log
7+
[**detailsLog**](APILogsApi.md#detailsLog) | **GET** /public/v1/logs/{id} | Details API Log
8+
[**listLogs**](APILogsApi.md#listLogs) | **GET** /public/v1/logs | List API Log
99

1010

11-
# **detailsApiLog**
12-
> APILogDetailsResponse detailsApiLog()
11+
# **detailsLog**
12+
> APILogDetailsResponse detailsLog()
1313
1414
Returns details of the specific API log event.
1515

@@ -26,12 +26,12 @@ const configuration = pd_api.createConfiguration(
2626
);
2727
const apiInstance = new pd_api.APILogsApi(configuration);
2828

29-
const body:pd_api.APILogsApiDetailsApiLogRequest = {
29+
const body:pd_api.APILogsApiDetailsLogRequest = {
3030
// string | Log event id.
3131
id: "AXp2jrHMK2MKv_lRqmQ",
3232
};
3333

34-
apiInstance.detailsApiLog(body).then((data) => {
34+
apiInstance.detailsLog(body).then((data) => {
3535
console.log('API called successfully. Returned data: %o', data);
3636
}).catch((error) => console.error(error));
3737
```
@@ -68,8 +68,8 @@ Name | Type | Description | Notes
6868

6969
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
7070

71-
# **listApiLogs**
72-
> APILogListResponse listApiLogs()
71+
# **listLogs**
72+
> APILogListResponse listLogs()
7373
7474
Get the list of all logs within the selected workspace. Optionally filter by date, page, and `#` of items per page.
7575

@@ -86,7 +86,7 @@ const configuration = pd_api.createConfiguration(
8686
);
8787
const apiInstance = new pd_api.APILogsApi(configuration);
8888

89-
const body:pd_api.APILogsApiListApiLogsRequest = {
89+
const body:pd_api.APILogsApiListLogsRequest = {
9090
// 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)
9191
since: "-7d",
9292
// 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)
@@ -105,7 +105,7 @@ const body:pd_api.APILogsApiListApiLogsRequest = {
105105
environmentType: "PRODUCTION",
106106
};
107107

108-
apiInstance.listApiLogs(body).then((data) => {
108+
apiInstance.listLogs(body).then((data) => {
109109
console.log('API called successfully. Returned data: %o', data);
110110
}).catch((error) => console.error(error));
111111
```

‎docs/ContactsApi.md‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ All URIs are relative to *https://api.pandadoc.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**contactCreate**](ContactsApi.md#contactCreate) | **POST** /public/v1/contacts | Create contact
8-
[**contactDelete**](ContactsApi.md#contactDelete) | **DELETE** /public/v1/contacts/{id} | Delete contact by id
9-
[**contactDetails**](ContactsApi.md#contactDetails) | **GET** /public/v1/contacts/{id} | Get contact details by id
10-
[**contactList**](ContactsApi.md#contactList) | **GET** /public/v1/contacts | List contacts
11-
[**contactUpdate**](ContactsApi.md#contactUpdate) | **PATCH** /public/v1/contacts/{id} | Update contact by id
7+
[**createContact**](ContactsApi.md#createContact) | **POST** /public/v1/contacts | Create contact
8+
[**deleteContact**](ContactsApi.md#deleteContact) | **DELETE** /public/v1/contacts/{id} | Delete contact by id
9+
[**detailsContact**](ContactsApi.md#detailsContact) | **GET** /public/v1/contacts/{id} | Get contact details by id
10+
[**listContacts**](ContactsApi.md#listContacts) | **GET** /public/v1/contacts | List contacts
11+
[**updateContact**](ContactsApi.md#updateContact) | **PATCH** /public/v1/contacts/{id} | Update contact by id
1212

1313

14-
# **contactCreate**
15-
> ContactDetailsResponse contactCreate(contactCreateRequest)
14+
# **createContact**
15+
> ContactDetailsResponse createContact(contactCreateRequest)
1616
1717

1818
### Example
@@ -28,7 +28,7 @@ const configuration = pd_api.createConfiguration(
2828
);
2929
const apiInstance = new pd_api.ContactsApi(configuration);
3030

31-
const body:pd_api.ContactsApiContactCreateRequest = {
31+
const body:pd_api.ContactsApiCreateContactRequest = {
3232
// ContactCreateRequest
3333
contactCreateRequest: {
3434
email: "[email protected]",
@@ -44,7 +44,7 @@ const body:pd_api.ContactsApiContactCreateRequest = {
4444
},
4545
};
4646

47-
apiInstance.contactCreate(body).then((data) => {
47+
apiInstance.createContact(body).then((data) => {
4848
console.log('API called successfully. Returned data: %o', data);
4949
}).catch((error) => console.error(error));
5050
```
@@ -81,8 +81,8 @@ Name | Type | Description | Notes
8181

8282
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
8383

84-
# **contactDelete**
85-
> void contactDelete()
84+
# **deleteContact**
85+
> void deleteContact()
8686
8787

8888
### Example
@@ -98,12 +98,12 @@ const configuration = pd_api.createConfiguration(
9898
);
9999
const apiInstance = new pd_api.ContactsApi(configuration);
100100

101-
const body:pd_api.ContactsApiContactDeleteRequest = {
101+
const body:pd_api.ContactsApiDeleteContactRequest = {
102102
// string | Contact id.
103103
id: "SyoufNkJiHRn24LpuJ7RXb",
104104
};
105105

106-
apiInstance.contactDelete(body).then((data) => {
106+
apiInstance.deleteContact(body).then((data) => {
107107
console.log('API called successfully. Returned data: %o', data);
108108
}).catch((error) => console.error(error));
109109
```
@@ -141,8 +141,8 @@ Name | Type | Description | Notes
141141

142142
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
143143

144-
# **contactDetails**
145-
> ContactDetailsResponse contactDetails()
144+
# **detailsContact**
145+
> ContactDetailsResponse detailsContact()
146146
147147

148148
### Example
@@ -158,12 +158,12 @@ const configuration = pd_api.createConfiguration(
158158
);
159159
const apiInstance = new pd_api.ContactsApi(configuration);
160160

161-
const body:pd_api.ContactsApiContactDetailsRequest = {
161+
const body:pd_api.ContactsApiDetailsContactRequest = {
162162
// string | Contact id.
163163
id: "SyoufNkJiHRn24LpuJ7RXb",
164164
};
165165

166-
apiInstance.contactDetails(body).then((data) => {
166+
apiInstance.detailsContact(body).then((data) => {
167167
console.log('API called successfully. Returned data: %o', data);
168168
}).catch((error) => console.error(error));
169169
```
@@ -201,8 +201,8 @@ Name | Type | Description | Notes
201201

202202
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
203203

204-
# **contactList**
205-
> Array<ContactDetailsResponse> contactList()
204+
# **listContacts**
205+
> Array<ContactDetailsResponse> listContacts()
206206
207207

208208
### Example
@@ -220,7 +220,7 @@ const apiInstance = new pd_api.ContactsApi(configuration);
220220

221221
let body:any = {};
222222

223-
apiInstance.contactList(body).then((data) => {
223+
apiInstance.listContacts(body).then((data) => {
224224
console.log('API called successfully. Returned data: %o', data);
225225
}).catch((error) => console.error(error));
226226
```
@@ -255,8 +255,8 @@ This endpoint does not need any parameter.
255255

256256
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
257257

258-
# **contactUpdate**
259-
> ContactDetailsResponse contactUpdate(contactUpdateRequest)
258+
# **updateContact**
259+
> ContactDetailsResponse updateContact(contactUpdateRequest)
260260
261261

262262
### Example
@@ -272,7 +272,7 @@ const configuration = pd_api.createConfiguration(
272272
);
273273
const apiInstance = new pd_api.ContactsApi(configuration);
274274

275-
const body:pd_api.ContactsApiContactUpdateRequest = {
275+
const body:pd_api.ContactsApiUpdateContactRequest = {
276276
// string | Contact id.
277277
id: "SyoufNkJiHRn24LpuJ7RXb",
278278
// ContactUpdateRequest
@@ -290,7 +290,7 @@ const body:pd_api.ContactsApiContactUpdateRequest = {
290290
},
291291
};
292292

293-
apiInstance.contactUpdate(body).then((data) => {
293+
apiInstance.updateContact(body).then((data) => {
294294
console.log('API called successfully. Returned data: %o', data);
295295
}).catch((error) => console.error(error));
296296
```

0 commit comments

Comments
 (0)