boldsign
Version:
NodeJS client for boldsign
178 lines (109 loc) • 10.2 kB
Markdown
# GroupContactsApi
All URIs are relative to https://api.boldsign.com.
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**createGroupContact()**](GroupContactsApi.md#createGroupContact) | **POST** /v1/contactGroups/create | Create a new Group Contact. |
| [**deleteGroupContact()**](GroupContactsApi.md#deleteGroupContact) | **DELETE** /v1/contactGroups/delete | Deletes a Group Contact. |
| [**getGroupContact()**](GroupContactsApi.md#getGroupContact) | **GET** /v1/contactGroups/get | Get Summary of the Group Contact. |
| [**groupContactList()**](GroupContactsApi.md#groupContactList) | **GET** /v1/contactGroups/list | List Group Contacts. |
| [**updateGroupContact()**](GroupContactsApi.md#updateGroupContact) | **PUT** /v1/contactGroups/update | Update the Group Contact. |
## `createGroupContact()`
```typescript
createGroupContact(groupContactDetails: GroupContactDetails): CreateGroupContactResponse
```
Create a new Group Contact.
### Parameters
|Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **groupContactDetails** | [**GroupContactDetails**](../docs/GroupContactDetails.md)| The group contact details. | [optional] |
### Return type
[**CreateGroupContactResponse**](../docs/CreateGroupContactResponse.md)
### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
[[Back to Model list]](../README.md#models)
[[Back to README]](../README.md)
## `deleteGroupContact()`
```typescript
deleteGroupContact(groupId: string)
```
Deletes a Group Contact.
### Parameters
|Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **groupId** | **string**| The group contact id. | |
### Return type
void (empty response body)
### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
[[Back to Model list]](../README.md#models)
[[Back to README]](../README.md)
## `getGroupContact()`
```typescript
getGroupContact(groupId: string): GetGroupContactDetails
```
Get Summary of the Group Contact.
### Parameters
|Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **groupId** | **string**| Group Contact Id. | |
### Return type
[**GetGroupContactDetails**](../docs/GetGroupContactDetails.md)
### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
[[Back to Model list]](../README.md#models)
[[Back to README]](../README.md)
## `groupContactList()`
```typescript
groupContactList(page: number, pageSize: number, searchKey: string, contactType: 'MyContacts' | 'AllContacts', directories: Array<string>): GroupContactsList
```
List Group Contacts.
### Parameters
|Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **page** | **number**| Page index specified in get user group contact list request. Default value is 1. | [default to 1] |
| **pageSize** | **number**| Page size specified in get user group contact list request. Default value is 10. | [optional] [default to 10] |
| **searchKey** | **string**| Group Contacts can be listed by the search based on the Name or Email | [optional] |
| **contactType** | **'MyContacts' | 'AllContacts'**| Group Contact type whether the contact is my contacts or all contacts. Default value is AllContacts. | [optional] |
| **directories** | [**Array<string>**](../docs/string.md)| Group Contacts can be listed by the search based on the directories | [optional] |
### Return type
[**GroupContactsList**](../docs/GroupContactsList.md)
### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
[[Back to Model list]](../README.md#models)
[[Back to README]](../README.md)
## `updateGroupContact()`
```typescript
updateGroupContact(groupId: string, updateGroupContact: UpdateGroupContact)
```
Update the Group Contact.
### Parameters
|Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **groupId** | **string**| The group contact ID. | |
| **updateGroupContact** | [**UpdateGroupContact**](../docs/UpdateGroupContact.md)| The group contact details. | |
### Return type
void (empty response body)
### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
[[Back to Model list]](../README.md#models)
[[Back to README]](../README.md)