use anyhow::Result;
use crate::Client;
pub struct EnvelopeRecipientTabs {
pub client: Client,
}
impl EnvelopeRecipientTabs {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
EnvelopeRecipientTabs { client }
}
/**
* Gets the tabs information for a signer or sign-in-person recipient in an envelope.
*
* This function performs a `GET` to the `/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs` endpoint.
*
* Retrieves information about the tabs associated
* with a recipient. You can make a single API call
* to get all the tab values and information from a
* given, completed envelope in addition to draft
* ones. Tab values can be retrieved by using the
* [EnvelopeRecipients:list method](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipients/list/)
* with query parameter `include_tabs` set to **true**.
*
* **Parameters:**
*
* * `account_id: &str` -- The brand that envelope recipients see when a brand is not explicitly set.
* * `envelope_id: &str` -- The brand that envelope recipients see when a brand is not explicitly set.
* * `recipient_id: &str` -- A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
* * `include_anchor_tab_locations: &str` -- When set to **true**, all tabs with anchor tab properties are included in the response. The default value is **false**.
* * `include_metadata: &str` -- When set to **true**, the response includes metadata indicating which properties are editable.
*/
pub async fn recipients_get_recipient_tab(
&self,
account_id: &str,
envelope_id: &str,
recipient_id: &str,
include_anchor_tab_locations: &str,
include_metadata: &str,
) -> Result<crate::types::EnvelopeRecipientTabs> {
let mut query_args: Vec<(String, String)> = Default::default();
if !include_anchor_tab_locations.is_empty() {
query_args.push((
"include_anchor_tab_locations".to_string(),
include_anchor_tab_locations.to_string(),
));
}
if !include_metadata.is_empty() {
query_args.push(("include_metadata".to_string(), include_metadata.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/v2.1/accounts/{}/envelopes/{}/recipients/{}/tabs?{}",
crate::progenitor_support::encode_path(account_id),
crate::progenitor_support::encode_path(envelope_id),
crate::progenitor_support::encode_path(recipient_id),
query_
);
self.client.get(&url, None).await
}
/**
* Updates the tabs for a recipient.
.
*
* This function performs a `PUT` to the `/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs` endpoint.
*
* Updates one or more tabs for a recipient in a draft envelope.
* **Note**: The Update method can be used if the envelope is not yet complete. To update an existing tab, the request body must include the `tabId`.
*
* **Parameters:**
*
* * `account_id: &str` -- The brand that envelope recipients see when a brand is not explicitly set.
* * `envelope_id: &str` -- The brand that envelope recipients see when a brand is not explicitly set.
* * `recipient_id: &str` -- A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
*/
pub async fn recipients_put_recipient_tabs(
&self,
account_id: &str,
envelope_id: &str,
recipient_id: &str,
body: &crate::types::EnvelopeRecipientTabs,
) -> Result<crate::types::EnvelopeRecipientTabs> {
let url = format!(
"/v2.1/accounts/{}/envelopes/{}/recipients/{}/tabs",
crate::progenitor_support::encode_path(account_id),
crate::progenitor_support::encode_path(envelope_id),
crate::progenitor_support::encode_path(recipient_id),
);
self.client
.put(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Adds tabs for a recipient.
*
* This function performs a `POST` to the `/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs` endpoint.
*
* Adds one or more tabs for a recipient.
*
* **Parameters:**
*
* * `account_id: &str` -- The brand that envelope recipients see when a brand is not explicitly set.
* * `envelope_id: &str` -- The brand that envelope recipients see when a brand is not explicitly set.
* * `recipient_id: &str` -- A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
*/
pub async fn recipients_post_recipient_tabs(
&self,
account_id: &str,
envelope_id: &str,
recipient_id: &str,
body: &crate::types::EnvelopeRecipientTabs,
) -> Result<crate::types::EnvelopeRecipientTabs> {
let url = format!(
"/v2.1/accounts/{}/envelopes/{}/recipients/{}/tabs",
crate::progenitor_support::encode_path(account_id),
crate::progenitor_support::encode_path(envelope_id),
crate::progenitor_support::encode_path(recipient_id),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Deletes the tabs associated with a recipient.
*
* This function performs a `DELETE` to the `/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs` endpoint.
*
* Deletes one or more tabs associated with a recipient in a draft envelope.
*
* **Parameters:**
*
* * `account_id: &str` -- The brand that envelope recipients see when a brand is not explicitly set.
* * `envelope_id: &str` -- The brand that envelope recipients see when a brand is not explicitly set.
* * `recipient_id: &str` -- A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
*/
pub async fn recipients_delete_recipient_tabs(
&self,
account_id: &str,
envelope_id: &str,
recipient_id: &str,
body: &crate::types::EnvelopeRecipientTabs,
) -> Result<crate::types::EnvelopeRecipientTabs> {
let url = format!(
"/v2.1/accounts/{}/envelopes/{}/recipients/{}/tabs",
crate::progenitor_support::encode_path(account_id),
crate::progenitor_support::encode_path(envelope_id),
crate::progenitor_support::encode_path(recipient_id),
);
self.client
.delete(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
}