AgreementsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| declineUserAgreement | POST /agreements/{agreement_id}/decline | Decline an agreement for the authenticated user. |
| getUserAgreement | GET /agreements/{agreement_id} | Fetch agreement content for the authenticated user. |
| listUserAgreements | GET /agreements | List agreements for the authenticated user. |
| signUserAgreement | POST /agreements/{agreement_id}/sign | Sign an agreement for the authenticated user. |
declineUserAgreement
AgreementInstanceResponse declineUserAgreement(agreement_id, AgreementDeclineRequest)
Decline an agreement for the authenticated user.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| agreement_id | Long | [default to null] | |
| AgreementDeclineRequest | AgreementDeclineRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
getUserAgreement
AgreementInstanceContentResponse getUserAgreement(agreement_id)
Fetch agreement content for the authenticated user.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| agreement_id | Long | [default to null] |
Return type
AgreementInstanceContentResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listUserAgreements
List listUserAgreements(include_signed)
List agreements for the authenticated user.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| include_signed | Boolean | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
signUserAgreement
AgreementInstanceResponse signUserAgreement(agreement_id, AgreementSignRequest)
Sign an agreement for the authenticated user.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| agreement_id | Long | [default to null] | |
| AgreementSignRequest | AgreementSignRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8