@keystrokehq/docusign 0.0.16 → 0.1.0

package/dist/actions/update-custom-tab-information-for-account.mjs

@@ -0,0 +1,195 @@
+import { action } from "../action.mjs";
+import { z } from "zod";
+//#region src/actions/update-custom-tab-information-for-account.ts
+const DocusignUpdateCustomTabInformationForAccountInput = z.object({
+	bold: z.string().describe("When **true,** the information in the tab is bold.").optional(),
+	font: z.string().describe("The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana").optional(),
+	name: z.string().optional(),
+	type: z.string().describe("The type of this tab. Values are: - `Approve` - `CheckBox` - `Company` - `Date` - `DateSigned` - `Decline` - `Email` - `EmailAddress` - `EnvelopeId` - `FirstName` - `Formula` - `FullName` - `InitialHere` - `InitialHereOptional` - `LastName` - `List` - `Note` - `Number` - `Radio` - `SignerAttachment` - `SignHere` - `SignHereOptional` - `Ssn` - `Text` - `Title` - `Zip5` - `Zip5Dash4`").optional(),
+	items: z.array(z.string()).describe("If the tab is a list, this represents the values that are possible for the tab.").optional(),
+	width: z.string().describe("The width of the tab in pixels. Must be an integer.").optional(),
+	anchor: z.string().describe("An optional string that is used to auto-match tabs to strings located in the documents of an envelope.").optional(),
+	height: z.string().describe("The height of the tab in pixels. Must be an integer.").optional(),
+	italic: z.string().describe("When **true,** the information in the tab is italic.").optional(),
+	locked: z.string().describe("When **true,** the signer cannot change the data of the custom tab.").optional(),
+	shared: z.string().describe("When **true,** this custom tab is shared.").optional(),
+	editable: z.string().describe("When **true,** the custom tab is editable. Otherwise the custom tab cannot be modified.").optional(),
+	fontSize: z.string().describe("The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72").optional(),
+	required: z.string().describe("When **true,** the signer is required to fill out this tab.").optional(),
+	selected: z.string().describe("When **true,** the radio button is selected.").optional(),
+	tabLabel: z.string().describe("The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters.").optional(),
+	accountId: z.string().describe("The unique identifier for the DocuSign account. This can be either the account number (an integer) or the account ID GUID. It is required to specify which account the custom tab belongs to. Example: \"12345\" or \"a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p\".").optional(),
+	fontColor: z.string().describe("The font color to use for the information in the tab. Possible values are:  - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White").optional(),
+	stampType: z.string().describe("The type of stamp. Valid values are: - `signature`: A signature image. This is the default value. - `stamp`: A stamp image. - null").optional(),
+	underline: z.string().describe("When **true,** the information in the tab is underlined.").optional(),
+	requireAll: z.string().describe("When **true** and shared is true, information must be entered in this field to complete the envelope.").optional(),
+	scaleValue: z.string().describe("Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size.").optional(),
+	anchorUnits: z.string().describe("Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms`").optional(),
+	customTabId: z.string().nullable(),
+	initialValue: z.string().describe("The original value of the tab.").optional(),
+	lastModified: z.string().describe("The UTC DateTime this object was last modified. This is in ISO 8601 format.").optional(),
+	anchorXOffset: z.string().describe("Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.").optional(),
+	anchorYOffset: z.string().describe("Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.").optional(),
+	collaborative: z.string().optional(),
+	maximumLength: z.string().describe("The maximum number of entry characters supported by the custom tab.").optional(),
+	numericalValue: z.string().optional(),
+	validationType: z.string().describe("Specifies how numerical data is validated. Valid values: - `number` - `currency`").optional(),
+	createdByUserId: z.string().describe("The userId of the Docusign user who created this object.").optional(),
+	disableAutoSize: z.string().describe("When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.").optional(),
+	includedInEmail: z.string().describe("When **true,** the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.").optional(),
+	mergeField__row: z.string().describe("Specifies the row number in a Salesforce table that the merge field value corresponds to.").optional(),
+	paymentItemCode: z.string().describe("If the custom tab is for a payment request, this is the external code for the item associated with the charge. For example, this might be your product id. Example: `SHAK1` Maximum Length: 100 characters.").optional(),
+	paymentItemName: z.string().describe("If the custom tab is for a payment request, this is the name of the item associated with the charge. Maximum Length: 100 characters. Example: `Hamlet`").optional(),
+	mergeField__path: z.string().describe("Sets the object associated with the custom tab. Currently this is the Salesforce Object.").optional(),
+	maxNumericalValue: z.string().optional(),
+	minNumericalValue: z.string().optional(),
+	validationMessage: z.string().describe("The message displayed if the custom tab fails input validation (either custom of embedded).").optional(),
+	validationPattern: z.string().describe("A regular expression used to validate input for the tab.").optional(),
+	anchorCaseSensitive: z.string().describe("This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:   $~><|^+=   For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words.   Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.   Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words.   Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/").optional(),
+	signatureProviderId: z.string().describe("Reserved for Docusign.").optional(),
+	anchorMatchWholeWord: z.string().describe("When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:   $~><|^+=   For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words.   Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.   Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words.   Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).  **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/").optional(),
+	createdByDisplayName: z.string().describe("The user name of the Docusign user who created this object.").optional(),
+	lastModifiedByUserId: z.string().describe("The userId of the Docusign user who last modified this object.").optional(),
+	mergeField__writeBack: z.string().describe("When **true,** data entered into the merge field during Signing will update the mapped Salesforce field.").optional(),
+	concealValueOnDocument: z.string().describe("When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.").optional(),
+	localePolicy__timeZone: z.string().describe("Specifies the time zone. Valid values: - `TZ_01_AfghanistanStandardTime` - `TZ_02_AlaskanStandardTime` - `TZ_03_ArabStandardTime` - `TZ_04_ArabianStandardTime` - `TZ_05_ArabicStandardTime` - `TZ_06_ArgentinaStandardTime` - `TZ_07_AtlanticStandardTime` - `TZ_08_AUS_CentralStandardTime` - `TZ_09_AUS_EasternStandardTime` - `TZ_10_AzerbaijanStandardTime` - `TZ_11_AzoresStandardTime` - `TZ_12_BangladeshStandardTime` - `TZ_13_CanadaCentralStandardTime` - `TZ_14_CapeVerdeStandardTime` - `TZ_15_CaucasusStandardTime` - `TZ_16_CentralAustraliaStandardTime` - `TZ_17_CentralAmericaStandardTime` - `TZ_18_CentralAsiaStandardTime` - `TZ_19_CentralBrazilianStandardTime` - `TZ_20_CentralEuropeStandardTime` - `TZ_21_CentralEuropeanStandardTime` - `TZ_22_CentralPacificStandardTime` - `TZ_23_CentralStandardTime` - `TZ_24_CentralStandardTimeMexico` - `TZ_25_ChinaStandardTime` - `TZ_26_DatelineStandardTime` - `TZ_27_E_AfricaStandardTime` - `TZ_28_E_AustraliaStandardTime` - `TZ_29_E_EuropeStandardTime` - `TZ_30_E_SouthAmericaStandardTime` - `TZ_31_EasternStandardTime` - `TZ_32_EgyptStandardTime` - `TZ_33_EkaterinburgStandardTime` - `TZ_34_FijiStandardTime` - `TZ_35_FLE_StandardTime` - `TZ_36_GeorgianStandardTime` - `TZ_37_GMT_StandardTime` - `TZ_38_GreenlandStandardTime` - `TZ_39_GreenwichStandardTime` - `TZ_40_GTB_StandardTime` - `TZ_41_HawaiianStandardTime` - `TZ_42_IndiaStandardTime` - `TZ_43_IranStandardTime` - `TZ_44_IsraelStandardTime` - `TZ_45_JordanStandardTime` - `TZ_46_KaliningradStandardTime` - `TZ_47_KamchatkaStandardTime` - `TZ_48_KoreaStandardTime` - `TZ_49_MagadanStandardTime` - `TZ_50_MauritiusStandardTime` - `TZ_51_MidAtlanticStandardTime` - `TZ_52_MiddleEastStandardTime` - `TZ_53_MontevideoStandardTime` - `TZ_54_MoroccoStandardTime` - `TZ_55_MountainStandardTime` - `TZ_56_MountainStandardTimeMMexico` - `TZ_57_MyanmarStandardTime` - `TZ_58_N_CentralAsiaStandardTime` - `TZ_59_NamibiaStandardTime` - `TZ_60_NepalStandardTime` - `TZ_61_NewZealandStandardTime` - `TZ_62_NewfoundlandStandardTime` - `TZ_63_NorthAsiaEastStandardTime` - `TZ_64_NorthAsiaStandardTime` - `TZ_65_PacificSAStandardTime` - `TZ_66_PacificStandardTime` - `TZ_67_PacificStandardTimeMexico` - `TZ_68_PakistanStandardTime` - `TZ_69_ParaguayStandardTime` - `TZ_70_RomanceStandardTime` - `TZ_71_RussianStandardTime` - `TZ_72_SAEasternStandardTime` - `TZ_73_SAPacificStandardTime` - `TZ_74_SAWesternStandardTime` - `TZ_75_SamoaStandardTime` - `TZ_76_SE_AsiaStandardTime` - `TZ_77_SingaporeStandardTime` - `TZ_78_SouthAfricaStandardTime` - `TZ_79_SriLankaStandardTime` - `TZ_80_SyriaStandardTime` - `TZ_81_TaipeiStandardTime` - `TZ_82_TasmaniaStandardTime` - `TZ_83_TokyoStandardTime` - `TZ_84_TongaStandardTime` - `TZ_85_TurkeyStandardTime` - `TZ_86_UlaanbaatarStandardTime` - `TZ_87_US_EasternStandardTime` - `TZ_88_USMountainStandardTime` - `TZ_89_VenezuelaStandardTime` - `TZ_90_VladivostokStandardTime` - `TZ_91_W_AustraliaStandardTime` - `TZ_92_W_CentralAfricaStandardTime` - `TZ_93_W_EuropeStandardTime` - `TZ_94_WestAsiaStandardTime` - `TZ_95_WestPacificStandardTime` - `TZ_96_YakutskStandardTime`").optional(),
+	paymentItemDescription: z.string().describe("If the custom tab is for a payment request, this is the description of the item associated with the charge. Example: `The Danish play by Shakespeare` Maximum Length: 100 characters.").optional(),
+	anchorIgnoreIfNotPresent: z.string().describe("When **true,** this tab is ignored if the `anchorString` is not found in the document.").optional(),
+	localePolicy__dateFormat: z.string().describe("Specifies the date format. Valid values: - `default` <br> used the UI\"s  - `longformat` <br> use the UI\"s long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d").optional(),
+	localePolicy__nameFormat: z.string().describe("Describes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->").optional(),
+	localePolicy__timeFormat: z.string().describe("Specifies the time format. Valid values: - `none`      <br>None - `hh_mm`     <br>hh:mm  - `hhmm`      <br>HH:mm - `hhmmss`    <br>HH:mm:ss - `hhmmsstt`  <br>HH:mm:ss tt - `hhmmtt`    <br> HH:mm tt - `hmm`       <br>h:mm - `hmmss`     <br>h:mm:ss - `hmmsstt`   <br>h:mm:ss tt - `hmmtt`     <br>h:mm tt - `custom`    <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->").optional(),
+	mergeField__pathExtended: z.array(z.object({
+		name: z.string().optional(),
+		type: z.string().describe("The type of this tab. Values are: - `Approve` - `CheckBox` - `Company` - `Date` - `DateSigned` - `Decline` - `Email` - `EmailAddress` - `EnvelopeId` - `FirstName` - `Formula` - `FullName` - `InitialHere` - `InitialHereOptional` - `LastName` - `List` - `Note` - `Number` - `Radio` - `SignerAttachment` - `SignHere` - `SignHereOptional` - `Ssn` - `Text` - `Title` - `Zip5` - `Zip5Dash4`").optional(),
+		typeName: z.string().optional()
+	}).describe("Request schema for `PathExtended`")).describe("Reserved for Docusign.").optional(),
+	anchorHorizontalAlignment: z.string().describe("This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/").optional(),
+	lastModifiedByDisplayName: z.string().describe("The User Name of the Docusign user who last modified this object.").optional(),
+	localePolicy__cultureName: z.string().describe("The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.").optional(),
+	stampTypeMetadata__rights: z.string().describe("Indicates whether the property is editable. Valid values are: - `editable` - `read_only`").optional(),
+	localePolicy__calendarType: z.string().describe("Specifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist`").optional(),
+	localePolicy__currencyCode: z.string().describe("The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. Supported formats: - `AED` - `AFN` - `ALL` - `AMD` - `ANG` - `AOA` - `ARS` - `AUD` - `AWG` - `AZN` - `BAM` - `BBD` - `BDT` - `BGN` - `BHD` - `BIF` - `BMD` - `BND` - `BOB` - `BOV` - `BRL` - `BSD` - `BTN` - `BWP` - `BYN` - `BYR` - `BZD` - `CAD` - `CDF` - `CHE` - `CHF` - `CHW` - `CLF` - `CLP` - `CNY` - `COP` - `COU` - `CRC` - `CUC` - `CUP` - `CVE` - `CZK` - `DJF` - `DKK` - `DOP` - `DZD` - `EGP` - `ERN` - `ETB` - `EUR` - `FJD` - `FKP` - `GBP` - `GEL` - `GHS` - `GIP` - `GMD` - `GNF` - `GTQ` - `GYD` - `HKD` - `HNL` - `HRK` - `HTG` - `HUF` - `IDR` - `ILS` - `INR` - `IQD` - `IRR` - `ISK` - `JMD` - `JOD` - `JPY` - `KES` - `KGS` - `KHR` - `KMF` - `KPW` - `KRW` - `KWD` - `KYD` - `KZT` - `LAK` - `LBP` - `LKR` - `LRD` - `LSL` - `LYD` - `MAD` - `MDL` - `MGA` - `MKD` - `MMK` - `MNT` - `MOP` - `MRO` - `MUR` - `MVR` - `MWK` - `MXN` - `MXV` - `MYR` - `MZN` - `NAD` - `NGN` - `NIO` - `NOK` - `NPR` - `NZD` - `OMR` - `PAB` - `PEN` - `PGK` - `PHP` - `PKR` - `PLN` - `PYG` - `QAR` - `RON` - `RSD` - `RUB` - `RWF` - `SAR` - `SBD` - `SCR` - `SDG` - `SEK` - `SGD` - `SHP` - `SLL` - `SOS` - `SRD` - `SSP` - `STD` - `SVC` - `SYP` - `SZL` - `THB` - `TJS` - `TMT` - `TND` - `TOP` - `TRY` - `TTD` - `TWD` - `TZS` - `UAH` - `UGX` - `USD` - `USN` - `UYI` - `UYU` - `UZS` - `VEF` - `VND` - `VUV` - `WST` - `XAF` - `XAG` - `XAU` - `XBA` - `XBB` - `XBC` - `XBD` - `XCD` - `XDR` - `XOF` - `XPD` - `XPF` - `XPT` - `XSU` - `XTS` - `XUA` - `XXX` - `YER` - `ZAR` - `ZMW` - `ZWL`").optional(),
+	stampTypeMetadata__options: z.array(z.string()).describe("An array of option strings supported by this setting.").optional(),
+	localePolicy__addressFormat: z.string().describe("Specifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw`").optional(),
+	localePolicy__initialFormat: z.string().describe("When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for \"William Henry Gates\".  - `first1last1`<br> \"WG\" - `last2`<br> \"GA\" - `first2`<br> \"WI\" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->").optional(),
+	requireInitialOnSharedChange: z.string().describe("Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.").optional(),
+	mergeField__allowSenderToEdit: z.string().describe("When **true,** the sender can modify the value of the `mergeField` tab during the sending process.").optional(),
+	mergeField__configurationType: z.string().describe("If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.").optional(),
+	localePolicy__customDateFormat: z.string().optional(),
+	localePolicy__customTimeFormat: z.string().optional(),
+	mergeField__rowMetadata__rights: z.string().describe("Indicates whether the property is editable. Valid values are: - `editable` - `read_only`").optional(),
+	mergeField__pathMetadata__rights: z.string().describe("Indicates whether the property is editable. Valid values are: - `editable` - `read_only`").optional(),
+	mergeField__rowMetadata__options: z.array(z.string()).describe("An array of option strings supported by this setting.").optional(),
+	mergeField__pathMetadata__options: z.array(z.string()).describe("An array of option strings supported by this setting.").optional(),
+	localePolicy__useLongCurrencyFormat: z.string().describe("When **true,** use the long currency format for the locale.").optional(),
+	localePolicy__currencyNegativeFormat: z.string().describe("Determines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br>   `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br>   `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br>   `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br>   `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br>   `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br>   `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br>   `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br>   `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br>   `$-1\"234\"567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br>   `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br>   `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br>   `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br>   `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br>   `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br>   `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br>   `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br>   `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br>   `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br>   `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br>   `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br>   `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br>   `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br>   `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br>   `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br>   `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br>   `($ 1\"234\"567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br>   `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br>   `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br>   `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br>   `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br>   `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br>   `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br>   `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br>   `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br>   `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br>   `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br>   `-$ 1\"234\"567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br>   `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br>   `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br>   `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br>   `$ -1\"234\"567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br>   `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br>   `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br>   `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br>   `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br>   `-123\"456\"789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br>   `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br>   `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br>   `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br>   `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br>   `-$123 456 789,00`").optional(),
+	localePolicy__currencyPositiveFormat: z.string().describe("Determines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values:  - `Default`<br>   Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br>   `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br>   `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br>   `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br>   `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br>   `$ 1\"234\"567.89` - `CSym_1_Comma_234_Comma_567`<br>   `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br>   `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br>   `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br>   `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br>   `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br>   `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br>   `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br>   `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br>   `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br>   `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br>   `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br>   `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br>   `123\"456\"789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br>   `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br>   `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br>   `$123 456 789,00` (en-ZA, es-CR)").optional(),
+	mergeField__writeBackMetadata__rights: z.string().describe("Indicates whether the property is editable. Valid values are: - `editable` - `read_only`").optional(),
+	mergeField__writeBackMetadata__options: z.array(z.string()).describe("An array of option strings supported by this setting.").optional(),
+	mergeField__pathExtendedMetadata__rights: z.string().describe("Indicates whether the property is editable. Valid values are: - `editable` - `read_only`").optional(),
+	mergeField__pathExtendedMetadata__options: z.array(z.string()).describe("An array of option strings supported by this setting.").optional(),
+	mergeField__allowSenderToEditMetadata__rights: z.string().describe("Indicates whether the property is editable. Valid values are: - `editable` - `read_only`").optional(),
+	mergeField__configurationTypeMetadata__rights: z.string().describe("Indicates whether the property is editable. Valid values are: - `editable` - `read_only`").optional(),
+	mergeField__allowSenderToEditMetadata__options: z.array(z.string()).describe("An array of option strings supported by this setting.").optional(),
+	mergeField__configurationTypeMetadata__options: z.array(z.string()).describe("An array of option strings supported by this setting.").optional()
+}).describe("Request schema for `UpdateCustomTabInformationForAccount`");
+const DocusignUpdateCustomTabInformationForAccount_PropertyMetadataSchema = z.object({
+	rights: z.string().describe("Rights associated with the property.").nullable().optional(),
+	options: z.array(z.string()).describe("Available options for the property.").nullable().optional()
+}).describe("Metadata for property editability and available options.");
+const DocusignUpdateCustomTabInformationForAccount_MergeFieldSchema = z.object({
+	row: z.string().describe("Specifies the row number in a Salesforce table that the merge field value corresponds to.").nullable().optional(),
+	path: z.string().describe("Sets the object associated with the custom tab. Currently this is the Salesforce Object.").nullable().optional(),
+	writeBack: z.string().describe("Enables automatic updates to Salesforce data upon envelope completion.").nullable().optional(),
+	rowMetadata: DocusignUpdateCustomTabInformationForAccount_PropertyMetadataSchema.nullable().optional(),
+	pathExtended: z.array(z.unknown()).describe("Extended path information for Salesforce field mapping.").nullable().optional(),
+	pathMetadata: DocusignUpdateCustomTabInformationForAccount_PropertyMetadataSchema.nullable().optional(),
+	allowSenderToEdit: z.string().describe("When set to true, the sender can modify the value of the custom tab during the sending process.").nullable().optional(),
+	configurationType: z.string().describe("If merge fields are being used, specifies the type of the merge field. The only supported value is salesforce.").nullable().optional(),
+	writeBackMetadata: DocusignUpdateCustomTabInformationForAccount_PropertyMetadataSchema.nullable().optional(),
+	pathExtendedMetadata: DocusignUpdateCustomTabInformationForAccount_PropertyMetadataSchema.nullable().optional(),
+	allowSenderToEditMetadata: DocusignUpdateCustomTabInformationForAccount_PropertyMetadataSchema.nullable().optional(),
+	configurationTypeMetadata: DocusignUpdateCustomTabInformationForAccount_PropertyMetadataSchema.nullable().optional()
+}).describe("Mapping details for Salesforce field integration. Contains information necessary to map tabs to fields in Salesforce.");
+const DocusignUpdateCustomTabInformationForAccount_LocalePolicySchema = z.object({
+	timeZone: z.string().describe("Time zone configuration.").nullable().optional(),
+	dateFormat: z.string().describe("Date format configuration.").nullable().optional(),
+	nameFormat: z.string().describe("Name format configuration.").nullable().optional(),
+	timeFormat: z.string().describe("Time format configuration.").nullable().optional(),
+	cultureName: z.string().describe("Culture name configuration.").nullable().optional(),
+	calendarType: z.string().describe("Calendar type configuration.").nullable().optional(),
+	currencyCode: z.string().describe("Currency code configuration.").nullable().optional(),
+	addressFormat: z.string().describe("Address format configuration.").nullable().optional(),
+	initialFormat: z.string().describe("Initial format configuration.").nullable().optional(),
+	customDateFormat: z.string().describe("Custom date format configuration.").nullable().optional(),
+	customTimeFormat: z.string().describe("Custom time format configuration.").nullable().optional(),
+	useLongCurrencyFormat: z.string().describe("Long currency format usage configuration.").nullable().optional(),
+	currencyNegativeFormat: z.string().describe("Currency negative format configuration.").nullable().optional(),
+	currencyPositiveFormat: z.string().describe("Currency positive format configuration.").nullable().optional()
+}).describe("Reserved for DocuSign internal use. Contains locale-specific formatting settings.");
+const docusignUpdateCustomTabInformationForAccount = action("DOCUSIGN_UPDATE_CUSTOM_TAB_INFORMATION_FOR_ACCOUNT", {
+	slug: "docusign-update-custom-tab-information-for-account",
+	name: "Update custom tab information for account",
+	description: "This endpoint updates the information for a custom tab associated with a specific DocuSign account. It allows for extensive customization of tab properties, including appearance, behavior, and positioning within documents. The endpoint is used when modifying existing custom tabs to change their characteristics or functionality. It provides granular control over tab settings but requires careful consideration of the numerous optional parameters to avoid unintended changes.",
+	input: DocusignUpdateCustomTabInformationForAccountInput,
+	output: z.object({
+		bold: z.string().describe("Applies bold formatting to tab content when enabled.").nullable().optional(),
+		font: z.string().describe("Typeface selection: Arial, Calibri, Courier, Garamond, Georgia, Helvetica, and others.").nullable().optional(),
+		name: z.string().describe("Tab identifier label.").nullable().optional(),
+		type: z.string().describe("Tab classification: Approve, CheckBox, Company, Date, DateSigned, Decline, Email, EmailAddress, EnvelopeId, FirstName, Formula, FullName, InitialHere, InitialHereOptional, LastName, List, Note, Number, Radio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4.").nullable().optional(),
+		items: z.array(z.string()).describe("Collection of possible values for list-type tabs.").nullable().optional(),
+		width: z.string().describe("Tab dimension in pixels.").nullable().optional(),
+		anchor: z.string().describe("An optional string that is used to auto-match tabs to strings located in the documents of an envelope.").nullable().optional(),
+		height: z.string().describe("Tab dimension in pixels.").nullable().optional(),
+		italic: z.string().describe("Applies italic formatting when enabled.").nullable().optional(),
+		locked: z.string().describe("Prevents signers from modifying tab data when enabled.").nullable().optional(),
+		shared: z.string().describe("Marks custom tab as available for shared use.").nullable().optional(),
+		editable: z.string().describe("Determines whether custom tabs can be modified.").nullable().optional(),
+		fontSize: z.string().describe("Available sizes: Size7 through Size72 in various increments.").nullable().optional(),
+		required: z.string().describe("Designates tab as mandatory for signer completion.").nullable().optional(),
+		selected: z.string().describe("Selection state indicator.").nullable().optional(),
+		tabLabel: z.string().describe("Display label associated with the tab.").nullable().optional(),
+		fontColor: z.string().describe("Color options: Black, BrightBlue, BrightRed, DarkGreen, Gold, NavyBlue, Purple, White, etc.").nullable().optional(),
+		stampType: z.string().describe("Classification of stamp appearance.").nullable().optional(),
+		underline: z.string().describe("Applies underline formatting when enabled.").nullable().optional(),
+		mergeField: DocusignUpdateCustomTabInformationForAccount_MergeFieldSchema.nullable().optional(),
+		requireAll: z.string().describe("Mandates input completion when combined with shared property.").nullable().optional(),
+		scaleValue: z.string().describe("Scaling adjustment value for tab display.").nullable().optional(),
+		anchorUnits: z.string().describe("Measurement units for offset values: pixels, millimeters, centimeters, or inches.").nullable().optional(),
+		customTabId: z.string().describe("DocuSign-generated identifier for applying custom tab properties.").nullable().optional(),
+		initialValue: z.string().describe("Default or starting value for the tab.").nullable().optional(),
+		lastModified: z.string().describe("ISO8601 timestamp of the most recent modification.").nullable().optional(),
+		localePolicy: DocusignUpdateCustomTabInformationForAccount_LocalePolicySchema.nullable().optional(),
+		anchorXOffset: z.string().describe("Horizontal positioning distance from the anchor string.").nullable().optional(),
+		anchorYOffset: z.string().describe("Vertical positioning distance from the anchor string.").nullable().optional(),
+		collaborative: z.string().describe("Collaborative field indicator.").nullable().optional(),
+		maximumLength: z.string().describe("Character limit for input fields.").nullable().optional(),
+		numericalValue: z.string().describe("Numeric value assigned to the tab.").nullable().optional(),
+		validationType: z.string().describe("Classification method for input validation.").nullable().optional(),
+		createdByUserId: z.string().describe("User ID of the creator.").nullable().optional(),
+		disableAutoSize: z.string().describe("Prevents single-line text box auto-expansion during data entry (default: false).").nullable().optional(),
+		includedInEmail: z.string().describe("Includes tab in envelope-related email correspondence when enabled.").nullable().optional(),
+		paymentItemCode: z.string().describe("Code identifier for payment-related tabs.").nullable().optional(),
+		paymentItemName: z.string().describe("Display name for payment-related tabs.").nullable().optional(),
+		maxNumericalValue: z.string().describe("Upper boundary for numeric entries.").nullable().optional(),
+		minNumericalValue: z.string().describe("Lower boundary for numeric entries.").nullable().optional(),
+		stampTypeMetadata: DocusignUpdateCustomTabInformationForAccount_PropertyMetadataSchema.nullable().optional(),
+		validationMessage: z.string().describe("Error message displayed upon validation failure.").nullable().optional(),
+		validationPattern: z.string().describe("Regular expression used for input validation.").nullable().optional(),
+		anchorCaseSensitive: z.string().describe("When enabled, anchor matching ignores character casing. Defaults to true.").nullable().optional(),
+		signatureProviderId: z.string().describe("External signature service identifier.").nullable().optional(),
+		anchorMatchWholeWord: z.string().describe("When enabled, only complete word matches are recognized (default: true).").nullable().optional(),
+		createdByDisplayName: z.string().describe("Username of the DocuSign user who created this object.").nullable().optional(),
+		lastModifiedByUserId: z.string().describe("User ID of the last modifier.").nullable().optional(),
+		concealValueOnDocument: z.string().describe("Hides data input using asterisks while recipient modifies, but reveals to sender post-completion.").nullable().optional(),
+		paymentItemDescription: z.string().describe("Descriptive text for payment items.").nullable().optional(),
+		anchorIgnoreIfNotPresent: z.string().describe("When true, tabs are disregarded if anchor text is not found.").nullable().optional(),
+		anchorHorizontalAlignment: z.string().describe("Alignment positioning for anchors: left or right (default: left).").nullable().optional(),
+		lastModifiedByDisplayName: z.string().describe("Username performing the last update.").nullable().optional(),
+		requireInitialOnSharedChange: z.string().describe("Requires signer initials when modifying shared fields.").nullable().optional()
+	}).describe("Response from updating custom tab information for an account. Returns a TabMetadata object containing the updated custom tab properties.")
+});
+//#endregion
+export { docusignUpdateCustomTabInformationForAccount };
+
+//# sourceMappingURL=update-custom-tab-information-for-account.mjs.map

package/dist/actions/update-custom-tab-information-for-account.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-custom-tab-information-for-account.mjs","names":[],"sources":["../../src/actions/update-custom-tab-information-for-account.ts"],"sourcesContent":["import { z } from \"zod\";\n\nimport { action } from \"../action\";\n\nexport const DocusignUpdateCustomTabInformationForAccountInput: z.ZodTypeAny = z.object({\n  bold: z.string().describe(\"When **true,** the information in the tab is bold.\").optional(),\n  font: z.string().describe(\"The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana\").optional(),\n  name: z.string().optional(),\n  type: z.string().describe(\"The type of this tab. Values are: - `Approve` - `CheckBox` - `Company` - `Date` - `DateSigned` - `Decline` - `Email` - `EmailAddress` - `EnvelopeId` - `FirstName` - `Formula` - `FullName` - `InitialHere` - `InitialHereOptional` - `LastName` - `List` - `Note` - `Number` - `Radio` - `SignerAttachment` - `SignHere` - `SignHereOptional` - `Ssn` - `Text` - `Title` - `Zip5` - `Zip5Dash4`\").optional(),\n  items: z.array(z.string()).describe(\"If the tab is a list, this represents the values that are possible for the tab.\").optional(),\n  width: z.string().describe(\"The width of the tab in pixels. Must be an integer.\").optional(),\n  anchor: z.string().describe(\"An optional string that is used to auto-match tabs to strings located in the documents of an envelope.\").optional(),\n  height: z.string().describe(\"The height of the tab in pixels. Must be an integer.\").optional(),\n  italic: z.string().describe(\"When **true,** the information in the tab is italic.\").optional(),\n  locked: z.string().describe(\"When **true,** the signer cannot change the data of the custom tab.\").optional(),\n  shared: z.string().describe(\"When **true,** this custom tab is shared.\").optional(),\n  editable: z.string().describe(\"When **true,** the custom tab is editable. Otherwise the custom tab cannot be modified.\").optional(),\n  fontSize: z.string().describe(\"The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72\").optional(),\n  required: z.string().describe(\"When **true,** the signer is required to fill out this tab.\").optional(),\n  selected: z.string().describe(\"When **true,** the radio button is selected.\").optional(),\n  tabLabel: z.string().describe(\"The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters.\").optional(),\n  accountId: z.string().describe(\"The unique identifier for the DocuSign account. This can be either the account number (an integer) or the account ID GUID. It is required to specify which account the custom tab belongs to. Example: \\\"12345\\\" or \\\"a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p\\\".\").optional(),\n  fontColor: z.string().describe(\"The font color to use for the information in the tab. Possible values are:  - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White\").optional(),\n  stampType: z.string().describe(\"The type of stamp. Valid values are: - `signature`: A signature image. This is the default value. - `stamp`: A stamp image. - null\").optional(),\n  underline: z.string().describe(\"When **true,** the information in the tab is underlined.\").optional(),\n  requireAll: z.string().describe(\"When **true** and shared is true, information must be entered in this field to complete the envelope.\").optional(),\n  scaleValue: z.string().describe(\"Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size.\").optional(),\n  anchorUnits: z.string().describe(\"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms`\").optional(),\n  customTabId: z.string().nullable(),\n  initialValue: z.string().describe(\"The original value of the tab.\").optional(),\n  lastModified: z.string().describe(\"The UTC DateTime this object was last modified. This is in ISO 8601 format.\").optional(),\n  anchorXOffset: z.string().describe(\"Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\").optional(),\n  anchorYOffset: z.string().describe(\"Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\").optional(),\n  collaborative: z.string().optional(),\n  maximumLength: z.string().describe(\"The maximum number of entry characters supported by the custom tab.\").optional(),\n  numericalValue: z.string().optional(),\n  validationType: z.string().describe(\"Specifies how numerical data is validated. Valid values: - `number` - `currency`\").optional(),\n  createdByUserId: z.string().describe(\"The userId of the Docusign user who created this object.\").optional(),\n  disableAutoSize: z.string().describe(\"When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.\").optional(),\n  includedInEmail: z.string().describe(\"When **true,** the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.\").optional(),\n  mergeField__row: z.string().describe(\"Specifies the row number in a Salesforce table that the merge field value corresponds to.\").optional(),\n  paymentItemCode: z.string().describe(\"If the custom tab is for a payment request, this is the external code for the item associated with the charge. For example, this might be your product id. Example: `SHAK1` Maximum Length: 100 characters.\").optional(),\n  paymentItemName: z.string().describe(\"If the custom tab is for a payment request, this is the name of the item associated with the charge. Maximum Length: 100 characters. Example: `Hamlet`\").optional(),\n  mergeField__path: z.string().describe(\"Sets the object associated with the custom tab. Currently this is the Salesforce Object.\").optional(),\n  maxNumericalValue: z.string().optional(),\n  minNumericalValue: z.string().optional(),\n  validationMessage: z.string().describe(\"The message displayed if the custom tab fails input validation (either custom of embedded).\").optional(),\n  validationPattern: z.string().describe(\"A regular expression used to validate input for the tab.\").optional(),\n  anchorCaseSensitive: z.string().describe(\"This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:   $~><|^+=   For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words.   Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.   Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words.   Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\").optional(),\n  signatureProviderId: z.string().describe(\"Reserved for Docusign.\").optional(),\n  anchorMatchWholeWord: z.string().describe(\"When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:   $~><|^+=   For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words.   Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.   Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words.   Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).  **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\").optional(),\n  createdByDisplayName: z.string().describe(\"The user name of the Docusign user who created this object.\").optional(),\n  lastModifiedByUserId: z.string().describe(\"The userId of the Docusign user who last modified this object.\").optional(),\n  mergeField__writeBack: z.string().describe(\"When **true,** data entered into the merge field during Signing will update the mapped Salesforce field.\").optional(),\n  concealValueOnDocument: z.string().describe(\"When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.\").optional(),\n  localePolicy__timeZone: z.string().describe(\"Specifies the time zone. Valid values: - `TZ_01_AfghanistanStandardTime` - `TZ_02_AlaskanStandardTime` - `TZ_03_ArabStandardTime` - `TZ_04_ArabianStandardTime` - `TZ_05_ArabicStandardTime` - `TZ_06_ArgentinaStandardTime` - `TZ_07_AtlanticStandardTime` - `TZ_08_AUS_CentralStandardTime` - `TZ_09_AUS_EasternStandardTime` - `TZ_10_AzerbaijanStandardTime` - `TZ_11_AzoresStandardTime` - `TZ_12_BangladeshStandardTime` - `TZ_13_CanadaCentralStandardTime` - `TZ_14_CapeVerdeStandardTime` - `TZ_15_CaucasusStandardTime` - `TZ_16_CentralAustraliaStandardTime` - `TZ_17_CentralAmericaStandardTime` - `TZ_18_CentralAsiaStandardTime` - `TZ_19_CentralBrazilianStandardTime` - `TZ_20_CentralEuropeStandardTime` - `TZ_21_CentralEuropeanStandardTime` - `TZ_22_CentralPacificStandardTime` - `TZ_23_CentralStandardTime` - `TZ_24_CentralStandardTimeMexico` - `TZ_25_ChinaStandardTime` - `TZ_26_DatelineStandardTime` - `TZ_27_E_AfricaStandardTime` - `TZ_28_E_AustraliaStandardTime` - `TZ_29_E_EuropeStandardTime` - `TZ_30_E_SouthAmericaStandardTime` - `TZ_31_EasternStandardTime` - `TZ_32_EgyptStandardTime` - `TZ_33_EkaterinburgStandardTime` - `TZ_34_FijiStandardTime` - `TZ_35_FLE_StandardTime` - `TZ_36_GeorgianStandardTime` - `TZ_37_GMT_StandardTime` - `TZ_38_GreenlandStandardTime` - `TZ_39_GreenwichStandardTime` - `TZ_40_GTB_StandardTime` - `TZ_41_HawaiianStandardTime` - `TZ_42_IndiaStandardTime` - `TZ_43_IranStandardTime` - `TZ_44_IsraelStandardTime` - `TZ_45_JordanStandardTime` - `TZ_46_KaliningradStandardTime` - `TZ_47_KamchatkaStandardTime` - `TZ_48_KoreaStandardTime` - `TZ_49_MagadanStandardTime` - `TZ_50_MauritiusStandardTime` - `TZ_51_MidAtlanticStandardTime` - `TZ_52_MiddleEastStandardTime` - `TZ_53_MontevideoStandardTime` - `TZ_54_MoroccoStandardTime` - `TZ_55_MountainStandardTime` - `TZ_56_MountainStandardTimeMMexico` - `TZ_57_MyanmarStandardTime` - `TZ_58_N_CentralAsiaStandardTime` - `TZ_59_NamibiaStandardTime` - `TZ_60_NepalStandardTime` - `TZ_61_NewZealandStandardTime` - `TZ_62_NewfoundlandStandardTime` - `TZ_63_NorthAsiaEastStandardTime` - `TZ_64_NorthAsiaStandardTime` - `TZ_65_PacificSAStandardTime` - `TZ_66_PacificStandardTime` - `TZ_67_PacificStandardTimeMexico` - `TZ_68_PakistanStandardTime` - `TZ_69_ParaguayStandardTime` - `TZ_70_RomanceStandardTime` - `TZ_71_RussianStandardTime` - `TZ_72_SAEasternStandardTime` - `TZ_73_SAPacificStandardTime` - `TZ_74_SAWesternStandardTime` - `TZ_75_SamoaStandardTime` - `TZ_76_SE_AsiaStandardTime` - `TZ_77_SingaporeStandardTime` - `TZ_78_SouthAfricaStandardTime` - `TZ_79_SriLankaStandardTime` - `TZ_80_SyriaStandardTime` - `TZ_81_TaipeiStandardTime` - `TZ_82_TasmaniaStandardTime` - `TZ_83_TokyoStandardTime` - `TZ_84_TongaStandardTime` - `TZ_85_TurkeyStandardTime` - `TZ_86_UlaanbaatarStandardTime` - `TZ_87_US_EasternStandardTime` - `TZ_88_USMountainStandardTime` - `TZ_89_VenezuelaStandardTime` - `TZ_90_VladivostokStandardTime` - `TZ_91_W_AustraliaStandardTime` - `TZ_92_W_CentralAfricaStandardTime` - `TZ_93_W_EuropeStandardTime` - `TZ_94_WestAsiaStandardTime` - `TZ_95_WestPacificStandardTime` - `TZ_96_YakutskStandardTime`\").optional(),\n  paymentItemDescription: z.string().describe(\"If the custom tab is for a payment request, this is the description of the item associated with the charge. Example: `The Danish play by Shakespeare` Maximum Length: 100 characters.\").optional(),\n  anchorIgnoreIfNotPresent: z.string().describe(\"When **true,** this tab is ignored if the `anchorString` is not found in the document.\").optional(),\n  localePolicy__dateFormat: z.string().describe(\"Specifies the date format. Valid values: - `default` <br> used the UI\\\"s  - `longformat` <br> use the UI\\\"s long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d\").optional(),\n  localePolicy__nameFormat: z.string().describe(\"Describes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->\").optional(),\n  localePolicy__timeFormat: z.string().describe(\"Specifies the time format. Valid values: - `none`      <br>None - `hh_mm`     <br>hh:mm  - `hhmm`      <br>HH:mm - `hhmmss`    <br>HH:mm:ss - `hhmmsstt`  <br>HH:mm:ss tt - `hhmmtt`    <br> HH:mm tt - `hmm`       <br>h:mm - `hmmss`     <br>h:mm:ss - `hmmsstt`   <br>h:mm:ss tt - `hmmtt`     <br>h:mm tt - `custom`    <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->\").optional(),\n  mergeField__pathExtended: z.array(z.object({\n  name: z.string().optional(),\n  type: z.string().describe(\"The type of this tab. Values are: - `Approve` - `CheckBox` - `Company` - `Date` - `DateSigned` - `Decline` - `Email` - `EmailAddress` - `EnvelopeId` - `FirstName` - `Formula` - `FullName` - `InitialHere` - `InitialHereOptional` - `LastName` - `List` - `Note` - `Number` - `Radio` - `SignerAttachment` - `SignHere` - `SignHereOptional` - `Ssn` - `Text` - `Title` - `Zip5` - `Zip5Dash4`\").optional(),\n  typeName: z.string().optional(),\n}).describe(\"Request schema for `PathExtended`\")).describe(\"Reserved for Docusign.\").optional(),\n  anchorHorizontalAlignment: z.string().describe(\"This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\").optional(),\n  lastModifiedByDisplayName: z.string().describe(\"The User Name of the Docusign user who last modified this object.\").optional(),\n  localePolicy__cultureName: z.string().describe(\"The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.\").optional(),\n  stampTypeMetadata__rights: z.string().describe(\"Indicates whether the property is editable. Valid values are: - `editable` - `read_only`\").optional(),\n  localePolicy__calendarType: z.string().describe(\"Specifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist`\").optional(),\n  localePolicy__currencyCode: z.string().describe(\"The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. Supported formats: - `AED` - `AFN` - `ALL` - `AMD` - `ANG` - `AOA` - `ARS` - `AUD` - `AWG` - `AZN` - `BAM` - `BBD` - `BDT` - `BGN` - `BHD` - `BIF` - `BMD` - `BND` - `BOB` - `BOV` - `BRL` - `BSD` - `BTN` - `BWP` - `BYN` - `BYR` - `BZD` - `CAD` - `CDF` - `CHE` - `CHF` - `CHW` - `CLF` - `CLP` - `CNY` - `COP` - `COU` - `CRC` - `CUC` - `CUP` - `CVE` - `CZK` - `DJF` - `DKK` - `DOP` - `DZD` - `EGP` - `ERN` - `ETB` - `EUR` - `FJD` - `FKP` - `GBP` - `GEL` - `GHS` - `GIP` - `GMD` - `GNF` - `GTQ` - `GYD` - `HKD` - `HNL` - `HRK` - `HTG` - `HUF` - `IDR` - `ILS` - `INR` - `IQD` - `IRR` - `ISK` - `JMD` - `JOD` - `JPY` - `KES` - `KGS` - `KHR` - `KMF` - `KPW` - `KRW` - `KWD` - `KYD` - `KZT` - `LAK` - `LBP` - `LKR` - `LRD` - `LSL` - `LYD` - `MAD` - `MDL` - `MGA` - `MKD` - `MMK` - `MNT` - `MOP` - `MRO` - `MUR` - `MVR` - `MWK` - `MXN` - `MXV` - `MYR` - `MZN` - `NAD` - `NGN` - `NIO` - `NOK` - `NPR` - `NZD` - `OMR` - `PAB` - `PEN` - `PGK` - `PHP` - `PKR` - `PLN` - `PYG` - `QAR` - `RON` - `RSD` - `RUB` - `RWF` - `SAR` - `SBD` - `SCR` - `SDG` - `SEK` - `SGD` - `SHP` - `SLL` - `SOS` - `SRD` - `SSP` - `STD` - `SVC` - `SYP` - `SZL` - `THB` - `TJS` - `TMT` - `TND` - `TOP` - `TRY` - `TTD` - `TWD` - `TZS` - `UAH` - `UGX` - `USD` - `USN` - `UYI` - `UYU` - `UZS` - `VEF` - `VND` - `VUV` - `WST` - `XAF` - `XAG` - `XAU` - `XBA` - `XBB` - `XBC` - `XBD` - `XCD` - `XDR` - `XOF` - `XPD` - `XPF` - `XPT` - `XSU` - `XTS` - `XUA` - `XXX` - `YER` - `ZAR` - `ZMW` - `ZWL`\").optional(),\n  stampTypeMetadata__options: z.array(z.string()).describe(\"An array of option strings supported by this setting.\").optional(),\n  localePolicy__addressFormat: z.string().describe(\"Specifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw`\").optional(),\n  localePolicy__initialFormat: z.string().describe(\"When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for \\\"William Henry Gates\\\".  - `first1last1`<br> \\\"WG\\\" - `last2`<br> \\\"GA\\\" - `first2`<br> \\\"WI\\\" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->\").optional(),\n  requireInitialOnSharedChange: z.string().describe(\"Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.\").optional(),\n  mergeField__allowSenderToEdit: z.string().describe(\"When **true,** the sender can modify the value of the `mergeField` tab during the sending process.\").optional(),\n  mergeField__configurationType: z.string().describe(\"If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.\").optional(),\n  localePolicy__customDateFormat: z.string().optional(),\n  localePolicy__customTimeFormat: z.string().optional(),\n  mergeField__rowMetadata__rights: z.string().describe(\"Indicates whether the property is editable. Valid values are: - `editable` - `read_only`\").optional(),\n  mergeField__pathMetadata__rights: z.string().describe(\"Indicates whether the property is editable. Valid values are: - `editable` - `read_only`\").optional(),\n  mergeField__rowMetadata__options: z.array(z.string()).describe(\"An array of option strings supported by this setting.\").optional(),\n  mergeField__pathMetadata__options: z.array(z.string()).describe(\"An array of option strings supported by this setting.\").optional(),\n  localePolicy__useLongCurrencyFormat: z.string().describe(\"When **true,** use the long currency format for the locale.\").optional(),\n  localePolicy__currencyNegativeFormat: z.string().describe(\"Determines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br>   `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br>   `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br>   `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br>   `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br>   `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br>   `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br>   `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br>   `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br>   `$-1\\\"234\\\"567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br>   `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br>   `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br>   `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br>   `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br>   `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br>   `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br>   `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br>   `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br>   `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br>   `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br>   `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br>   `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br>   `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br>   `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br>   `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br>   `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br>   `($ 1\\\"234\\\"567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br>   `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br>   `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br>   `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br>   `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br>   `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br>   `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br>   `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br>   `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br>   `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br>   `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br>   `-$ 1\\\"234\\\"567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br>   `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br>   `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br>   `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br>   `$ -1\\\"234\\\"567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br>   `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br>   `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br>   `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br>   `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br>   `-123\\\"456\\\"789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br>   `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br>   `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br>   `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br>   `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br>   `-$123 456 789,00`\").optional(),\n  localePolicy__currencyPositiveFormat: z.string().describe(\"Determines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values:  - `Default`<br>   Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br>   `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br>   `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br>   `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br>   `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br>   `$ 1\\\"234\\\"567.89` - `CSym_1_Comma_234_Comma_567`<br>   `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br>   `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br>   `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br>   `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br>   `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br>   `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br>   `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br>   `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br>   `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br>   `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br>   `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br>   `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br>   `123\\\"456\\\"789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br>   `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br>   `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br>   `$123 456 789,00` (en-ZA, es-CR)\").optional(),\n  mergeField__writeBackMetadata__rights: z.string().describe(\"Indicates whether the property is editable. Valid values are: - `editable` - `read_only`\").optional(),\n  mergeField__writeBackMetadata__options: z.array(z.string()).describe(\"An array of option strings supported by this setting.\").optional(),\n  mergeField__pathExtendedMetadata__rights: z.string().describe(\"Indicates whether the property is editable. Valid values are: - `editable` - `read_only`\").optional(),\n  mergeField__pathExtendedMetadata__options: z.array(z.string()).describe(\"An array of option strings supported by this setting.\").optional(),\n  mergeField__allowSenderToEditMetadata__rights: z.string().describe(\"Indicates whether the property is editable. Valid values are: - `editable` - `read_only`\").optional(),\n  mergeField__configurationTypeMetadata__rights: z.string().describe(\"Indicates whether the property is editable. Valid values are: - `editable` - `read_only`\").optional(),\n  mergeField__allowSenderToEditMetadata__options: z.array(z.string()).describe(\"An array of option strings supported by this setting.\").optional(),\n  mergeField__configurationTypeMetadata__options: z.array(z.string()).describe(\"An array of option strings supported by this setting.\").optional(),\n}).describe(\"Request schema for `UpdateCustomTabInformationForAccount`\");\nconst DocusignUpdateCustomTabInformationForAccount_PropertyMetadataSchema: z.ZodTypeAny = z.object({\n  rights: z.string().describe(\"Rights associated with the property.\").nullable().optional(),\n  options: z.array(z.string()).describe(\"Available options for the property.\").nullable().optional(),\n}).describe(\"Metadata for property editability and available options.\");\nconst DocusignUpdateCustomTabInformationForAccount_MergeFieldSchema: z.ZodTypeAny = z.object({\n  row: z.string().describe(\"Specifies the row number in a Salesforce table that the merge field value corresponds to.\").nullable().optional(),\n  path: z.string().describe(\"Sets the object associated with the custom tab. Currently this is the Salesforce Object.\").nullable().optional(),\n  writeBack: z.string().describe(\"Enables automatic updates to Salesforce data upon envelope completion.\").nullable().optional(),\n  rowMetadata: DocusignUpdateCustomTabInformationForAccount_PropertyMetadataSchema.nullable().optional(),\n  pathExtended: z.array(z.unknown()).describe(\"Extended path information for Salesforce field mapping.\").nullable().optional(),\n  pathMetadata: DocusignUpdateCustomTabInformationForAccount_PropertyMetadataSchema.nullable().optional(),\n  allowSenderToEdit: z.string().describe(\"When set to true, the sender can modify the value of the custom tab during the sending process.\").nullable().optional(),\n  configurationType: z.string().describe(\"If merge fields are being used, specifies the type of the merge field. The only supported value is salesforce.\").nullable().optional(),\n  writeBackMetadata: DocusignUpdateCustomTabInformationForAccount_PropertyMetadataSchema.nullable().optional(),\n  pathExtendedMetadata: DocusignUpdateCustomTabInformationForAccount_PropertyMetadataSchema.nullable().optional(),\n  allowSenderToEditMetadata: DocusignUpdateCustomTabInformationForAccount_PropertyMetadataSchema.nullable().optional(),\n  configurationTypeMetadata: DocusignUpdateCustomTabInformationForAccount_PropertyMetadataSchema.nullable().optional(),\n}).describe(\"Mapping details for Salesforce field integration. Contains information necessary to map tabs to fields in Salesforce.\");\nconst DocusignUpdateCustomTabInformationForAccount_LocalePolicySchema: z.ZodTypeAny = z.object({\n  timeZone: z.string().describe(\"Time zone configuration.\").nullable().optional(),\n  dateFormat: z.string().describe(\"Date format configuration.\").nullable().optional(),\n  nameFormat: z.string().describe(\"Name format configuration.\").nullable().optional(),\n  timeFormat: z.string().describe(\"Time format configuration.\").nullable().optional(),\n  cultureName: z.string().describe(\"Culture name configuration.\").nullable().optional(),\n  calendarType: z.string().describe(\"Calendar type configuration.\").nullable().optional(),\n  currencyCode: z.string().describe(\"Currency code configuration.\").nullable().optional(),\n  addressFormat: z.string().describe(\"Address format configuration.\").nullable().optional(),\n  initialFormat: z.string().describe(\"Initial format configuration.\").nullable().optional(),\n  customDateFormat: z.string().describe(\"Custom date format configuration.\").nullable().optional(),\n  customTimeFormat: z.string().describe(\"Custom time format configuration.\").nullable().optional(),\n  useLongCurrencyFormat: z.string().describe(\"Long currency format usage configuration.\").nullable().optional(),\n  currencyNegativeFormat: z.string().describe(\"Currency negative format configuration.\").nullable().optional(),\n  currencyPositiveFormat: z.string().describe(\"Currency positive format configuration.\").nullable().optional(),\n}).describe(\"Reserved for DocuSign internal use. Contains locale-specific formatting settings.\");\nexport const DocusignUpdateCustomTabInformationForAccountOutput: z.ZodTypeAny = z.object({\n  bold: z.string().describe(\"Applies bold formatting to tab content when enabled.\").nullable().optional(),\n  font: z.string().describe(\"Typeface selection: Arial, Calibri, Courier, Garamond, Georgia, Helvetica, and others.\").nullable().optional(),\n  name: z.string().describe(\"Tab identifier label.\").nullable().optional(),\n  type: z.string().describe(\"Tab classification: Approve, CheckBox, Company, Date, DateSigned, Decline, Email, EmailAddress, EnvelopeId, FirstName, Formula, FullName, InitialHere, InitialHereOptional, LastName, List, Note, Number, Radio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4.\").nullable().optional(),\n  items: z.array(z.string()).describe(\"Collection of possible values for list-type tabs.\").nullable().optional(),\n  width: z.string().describe(\"Tab dimension in pixels.\").nullable().optional(),\n  anchor: z.string().describe(\"An optional string that is used to auto-match tabs to strings located in the documents of an envelope.\").nullable().optional(),\n  height: z.string().describe(\"Tab dimension in pixels.\").nullable().optional(),\n  italic: z.string().describe(\"Applies italic formatting when enabled.\").nullable().optional(),\n  locked: z.string().describe(\"Prevents signers from modifying tab data when enabled.\").nullable().optional(),\n  shared: z.string().describe(\"Marks custom tab as available for shared use.\").nullable().optional(),\n  editable: z.string().describe(\"Determines whether custom tabs can be modified.\").nullable().optional(),\n  fontSize: z.string().describe(\"Available sizes: Size7 through Size72 in various increments.\").nullable().optional(),\n  required: z.string().describe(\"Designates tab as mandatory for signer completion.\").nullable().optional(),\n  selected: z.string().describe(\"Selection state indicator.\").nullable().optional(),\n  tabLabel: z.string().describe(\"Display label associated with the tab.\").nullable().optional(),\n  fontColor: z.string().describe(\"Color options: Black, BrightBlue, BrightRed, DarkGreen, Gold, NavyBlue, Purple, White, etc.\").nullable().optional(),\n  stampType: z.string().describe(\"Classification of stamp appearance.\").nullable().optional(),\n  underline: z.string().describe(\"Applies underline formatting when enabled.\").nullable().optional(),\n  mergeField: DocusignUpdateCustomTabInformationForAccount_MergeFieldSchema.nullable().optional(),\n  requireAll: z.string().describe(\"Mandates input completion when combined with shared property.\").nullable().optional(),\n  scaleValue: z.string().describe(\"Scaling adjustment value for tab display.\").nullable().optional(),\n  anchorUnits: z.string().describe(\"Measurement units for offset values: pixels, millimeters, centimeters, or inches.\").nullable().optional(),\n  customTabId: z.string().describe(\"DocuSign-generated identifier for applying custom tab properties.\").nullable().optional(),\n  initialValue: z.string().describe(\"Default or starting value for the tab.\").nullable().optional(),\n  lastModified: z.string().describe(\"ISO8601 timestamp of the most recent modification.\").nullable().optional(),\n  localePolicy: DocusignUpdateCustomTabInformationForAccount_LocalePolicySchema.nullable().optional(),\n  anchorXOffset: z.string().describe(\"Horizontal positioning distance from the anchor string.\").nullable().optional(),\n  anchorYOffset: z.string().describe(\"Vertical positioning distance from the anchor string.\").nullable().optional(),\n  collaborative: z.string().describe(\"Collaborative field indicator.\").nullable().optional(),\n  maximumLength: z.string().describe(\"Character limit for input fields.\").nullable().optional(),\n  numericalValue: z.string().describe(\"Numeric value assigned to the tab.\").nullable().optional(),\n  validationType: z.string().describe(\"Classification method for input validation.\").nullable().optional(),\n  createdByUserId: z.string().describe(\"User ID of the creator.\").nullable().optional(),\n  disableAutoSize: z.string().describe(\"Prevents single-line text box auto-expansion during data entry (default: false).\").nullable().optional(),\n  includedInEmail: z.string().describe(\"Includes tab in envelope-related email correspondence when enabled.\").nullable().optional(),\n  paymentItemCode: z.string().describe(\"Code identifier for payment-related tabs.\").nullable().optional(),\n  paymentItemName: z.string().describe(\"Display name for payment-related tabs.\").nullable().optional(),\n  maxNumericalValue: z.string().describe(\"Upper boundary for numeric entries.\").nullable().optional(),\n  minNumericalValue: z.string().describe(\"Lower boundary for numeric entries.\").nullable().optional(),\n  stampTypeMetadata: DocusignUpdateCustomTabInformationForAccount_PropertyMetadataSchema.nullable().optional(),\n  validationMessage: z.string().describe(\"Error message displayed upon validation failure.\").nullable().optional(),\n  validationPattern: z.string().describe(\"Regular expression used for input validation.\").nullable().optional(),\n  anchorCaseSensitive: z.string().describe(\"When enabled, anchor matching ignores character casing. Defaults to true.\").nullable().optional(),\n  signatureProviderId: z.string().describe(\"External signature service identifier.\").nullable().optional(),\n  anchorMatchWholeWord: z.string().describe(\"When enabled, only complete word matches are recognized (default: true).\").nullable().optional(),\n  createdByDisplayName: z.string().describe(\"Username of the DocuSign user who created this object.\").nullable().optional(),\n  lastModifiedByUserId: z.string().describe(\"User ID of the last modifier.\").nullable().optional(),\n  concealValueOnDocument: z.string().describe(\"Hides data input using asterisks while recipient modifies, but reveals to sender post-completion.\").nullable().optional(),\n  paymentItemDescription: z.string().describe(\"Descriptive text for payment items.\").nullable().optional(),\n  anchorIgnoreIfNotPresent: z.string().describe(\"When true, tabs are disregarded if anchor text is not found.\").nullable().optional(),\n  anchorHorizontalAlignment: z.string().describe(\"Alignment positioning for anchors: left or right (default: left).\").nullable().optional(),\n  lastModifiedByDisplayName: z.string().describe(\"Username performing the last update.\").nullable().optional(),\n  requireInitialOnSharedChange: z.string().describe(\"Requires signer initials when modifying shared fields.\").nullable().optional(),\n}).describe(\"Response from updating custom tab information for an account. Returns a TabMetadata object containing the updated custom tab properties.\");\n\nexport const docusignUpdateCustomTabInformationForAccount = action(\"DOCUSIGN_UPDATE_CUSTOM_TAB_INFORMATION_FOR_ACCOUNT\", {\n  slug: \"docusign-update-custom-tab-information-for-account\",\n  name: \"Update custom tab information for account\",\n  description: \"This endpoint updates the information for a custom tab associated with a specific DocuSign account. It allows for extensive customization of tab properties, including appearance, behavior, and positioning within documents. The endpoint is used when modifying existing custom tabs to change their characteristics or functionality. It provides granular control over tab settings but requires careful consideration of the numerous optional parameters to avoid unintended changes.\",\n  input: DocusignUpdateCustomTabInformationForAccountInput,\n  output: DocusignUpdateCustomTabInformationForAccountOutput,\n});\n"],"mappings":";;;AAIA,MAAa,oDAAkE,EAAE,OAAO;CACtF,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS,oDAAoD,CAAC,CAAC,SAAS;CACzF,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS,sPAAsP,CAAC,CAAC,SAAS;CAC3R,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS;CAC1B,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS,kYAAkY,CAAC,CAAC,SAAS;CACva,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,iFAAiF,CAAC,CAAC,SAAS;CAChI,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS,qDAAqD,CAAC,CAAC,SAAS;CAC3F,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS,wGAAwG,CAAC,CAAC,SAAS;CAC/I,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS,sDAAsD,CAAC,CAAC,SAAS;CAC7F,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS,sDAAsD,CAAC,CAAC,SAAS;CAC7F,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS,qEAAqE,CAAC,CAAC,SAAS;CAC5G,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS,2CAA2C,CAAC,CAAC,SAAS;CAClF,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS,yFAAyF,CAAC,CAAC,SAAS;CAClI,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS,+NAA+N,CAAC,CAAC,SAAS;CACxQ,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS,6DAA6D,CAAC,CAAC,SAAS;CACtG,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS,8CAA8C,CAAC,CAAC,SAAS;CACvF,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS,mKAAmK,CAAC,CAAC,SAAS;CAC5M,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS,+PAA+P,CAAC,CAAC,SAAS;CACzS,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS,+KAA+K,CAAC,CAAC,SAAS;CACzN,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS,oIAAoI,CAAC,CAAC,SAAS;CAC9K,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS,0DAA0D,CAAC,CAAC,SAAS;CACpG,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS,uGAAuG,CAAC,CAAC,SAAS;CAClJ,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS,0IAA0I,CAAC,CAAC,SAAS;CACrL,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS,8HAA8H,CAAC,CAAC,SAAS;CAC1K,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS;CACjC,cAAc,EAAE,OAAO,CAAC,CAAC,SAAS,gCAAgC,CAAC,CAAC,SAAS;CAC7E,cAAc,EAAE,OAAO,CAAC,CAAC,SAAS,6EAA6E,CAAC,CAAC,SAAS;CAC1H,eAAe,EAAE,OAAO,CAAC,CAAC,SAAS,2FAA2F,CAAC,CAAC,SAAS;CACzI,eAAe,EAAE,OAAO,CAAC,CAAC,SAAS,2FAA2F,CAAC,CAAC,SAAS;CACzI,eAAe,EAAE,OAAO,CAAC,CAAC,SAAS;CACnC,eAAe,EAAE,OAAO,CAAC,CAAC,SAAS,qEAAqE,CAAC,CAAC,SAAS;CACnH,gBAAgB,EAAE,OAAO,CAAC,CAAC,SAAS;CACpC,gBAAgB,EAAE,OAAO,CAAC,CAAC,SAAS,kFAAkF,CAAC,CAAC,SAAS;CACjI,iBAAiB,EAAE,OAAO,CAAC,CAAC,SAAS,0DAA0D,CAAC,CAAC,SAAS;CAC1G,iBAAiB,EAAE,OAAO,CAAC,CAAC,SAAS,oRAAoR,CAAC,CAAC,SAAS;CACpU,iBAAiB,EAAE,OAAO,CAAC,CAAC,SAAS,+HAA+H,CAAC,CAAC,SAAS;CAC/K,iBAAiB,EAAE,OAAO,CAAC,CAAC,SAAS,2FAA2F,CAAC,CAAC,SAAS;CAC3I,iBAAiB,EAAE,OAAO,CAAC,CAAC,SAAS,6MAA6M,CAAC,CAAC,SAAS;CAC7P,iBAAiB,EAAE,OAAO,CAAC,CAAC,SAAS,wJAAwJ,CAAC,CAAC,SAAS;CACxM,kBAAkB,EAAE,OAAO,CAAC,CAAC,SAAS,0FAA0F,CAAC,CAAC,SAAS;CAC3I,mBAAmB,EAAE,OAAO,CAAC,CAAC,SAAS;CACvC,mBAAmB,EAAE,OAAO,CAAC,CAAC,SAAS;CACvC,mBAAmB,EAAE,OAAO,CAAC,CAAC,SAAS,6FAA6F,CAAC,CAAC,SAAS;CAC/I,mBAAmB,EAAE,OAAO,CAAC,CAAC,SAAS,0DAA0D,CAAC,CAAC,SAAS;CAC5G,qBAAqB,EAAE,OAAO,CAAC,CAAC,SAAS,gwDAAgwD,CAAC,CAAC,SAAS;CACpzD,qBAAqB,EAAE,OAAO,CAAC,CAAC,SAAS,wBAAwB,CAAC,CAAC,SAAS;CAC5E,sBAAsB,EAAE,OAAO,CAAC,CAAC,SAAS,wtDAAwtD,CAAC,CAAC,SAAS;CAC7wD,sBAAsB,EAAE,OAAO,CAAC,CAAC,SAAS,6DAA6D,CAAC,CAAC,SAAS;CAClH,sBAAsB,EAAE,OAAO,CAAC,CAAC,SAAS,gEAAgE,CAAC,CAAC,SAAS;CACrH,uBAAuB,EAAE,OAAO,CAAC,CAAC,SAAS,0GAA0G,CAAC,CAAC,SAAS;CAChK,wBAAwB,EAAE,OAAO,CAAC,CAAC,SAAS,6gBAA6gB,CAAC,CAAC,SAAS;CACpkB,wBAAwB,EAAE,OAAO,CAAC,CAAC,SAAS,whGAAwhG,CAAC,CAAC,SAAS;CAC/kG,wBAAwB,EAAE,OAAO,CAAC,CAAC,SAAS,uLAAuL,CAAC,CAAC,SAAS;CAC9O,0BAA0B,EAAE,OAAO,CAAC,CAAC,SAAS,wFAAwF,CAAC,CAAC,SAAS;CACjJ,0BAA0B,EAAE,OAAO,CAAC,CAAC,SAAS,gxBAAgxB,CAAC,CAAC,SAAS;CACz0B,0BAA0B,EAAE,OAAO,CAAC,CAAC,SAAS,uXAAuX,CAAC,CAAC,SAAS;CAChb,0BAA0B,EAAE,OAAO,CAAC,CAAC,SAAS,gZAAgZ,CAAC,CAAC,SAAS;CACzc,0BAA0B,EAAE,MAAM,EAAE,OAAO;EAC3C,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS;EAC1B,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS,kYAAkY,CAAC,CAAC,SAAS;EACva,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS;CAChC,CAAC,CAAC,CAAC,SAAS,mCAAmC,CAAC,CAAC,CAAC,SAAS,wBAAwB,CAAC,CAAC,SAAS;CAC5F,2BAA2B,EAAE,OAAO,CAAC,CAAC,SAAS,ifAAif,CAAC,CAAC,SAAS;CAC3iB,2BAA2B,EAAE,OAAO,CAAC,CAAC,SAAS,mEAAmE,CAAC,CAAC,SAAS;CAC7H,2BAA2B,EAAE,OAAO,CAAC,CAAC,SAAS,kGAAkG,CAAC,CAAC,SAAS;CAC5J,2BAA2B,EAAE,OAAO,CAAC,CAAC,SAAS,0FAA0F,CAAC,CAAC,SAAS;CACpJ,4BAA4B,EAAE,OAAO,CAAC,CAAC,SAAS,uFAAuF,CAAC,CAAC,SAAS;CAClJ,4BAA4B,EAAE,OAAO,CAAC,CAAC,SAAS,k/CAAk/C,CAAC,CAAC,SAAS;CAC7iD,4BAA4B,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,uDAAuD,CAAC,CAAC,SAAS;CAC3H,6BAA6B,EAAE,OAAO,CAAC,CAAC,SAAS,8EAA8E,CAAC,CAAC,SAAS;CAC1I,6BAA6B,EAAE,OAAO,CAAC,CAAC,SAAS,wYAAwY,CAAC,CAAC,SAAS;CACpc,8BAA8B,EAAE,OAAO,CAAC,CAAC,SAAS,sHAAsH,CAAC,CAAC,SAAS;CACnL,+BAA+B,EAAE,OAAO,CAAC,CAAC,SAAS,oGAAoG,CAAC,CAAC,SAAS;CAClK,+BAA+B,EAAE,OAAO,CAAC,CAAC,SAAS,+HAA+H,CAAC,CAAC,SAAS;CAC7L,gCAAgC,EAAE,OAAO,CAAC,CAAC,SAAS;CACpD,gCAAgC,EAAE,OAAO,CAAC,CAAC,SAAS;CACpD,iCAAiC,EAAE,OAAO,CAAC,CAAC,SAAS,0FAA0F,CAAC,CAAC,SAAS;CAC1J,kCAAkC,EAAE,OAAO,CAAC,CAAC,SAAS,0FAA0F,CAAC,CAAC,SAAS;CAC3J,kCAAkC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,uDAAuD,CAAC,CAAC,SAAS;CACjI,mCAAmC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,uDAAuD,CAAC,CAAC,SAAS;CAClI,qCAAqC,EAAE,OAAO,CAAC,CAAC,SAAS,6DAA6D,CAAC,CAAC,SAAS;CACjI,sCAAsC,EAAE,OAAO,CAAC,CAAC,SAAS,o5HAAo5H,CAAC,CAAC,SAAS;CACz9H,sCAAsC,EAAE,OAAO,CAAC,CAAC,SAAS,8vDAA8vD,CAAC,CAAC,SAAS;CACn0D,uCAAuC,EAAE,OAAO,CAAC,CAAC,SAAS,0FAA0F,CAAC,CAAC,SAAS;CAChK,wCAAwC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,uDAAuD,CAAC,CAAC,SAAS;CACvI,0CAA0C,EAAE,OAAO,CAAC,CAAC,SAAS,0FAA0F,CAAC,CAAC,SAAS;CACnK,2CAA2C,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,uDAAuD,CAAC,CAAC,SAAS;CAC1I,+CAA+C,EAAE,OAAO,CAAC,CAAC,SAAS,0FAA0F,CAAC,CAAC,SAAS;CACxK,+CAA+C,EAAE,OAAO,CAAC,CAAC,SAAS,0FAA0F,CAAC,CAAC,SAAS;CACxK,gDAAgD,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,uDAAuD,CAAC,CAAC,SAAS;CAC/I,gDAAgD,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,uDAAuD,CAAC,CAAC,SAAS;AACjJ,CAAC,CAAC,CAAC,SAAS,2DAA2D;AACvE,MAAM,sEAAoF,EAAE,OAAO;CACjG,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS,sCAAsC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CACxF,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,qCAAqC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;AACnG,CAAC,CAAC,CAAC,SAAS,0DAA0D;AACtE,MAAM,gEAA8E,EAAE,OAAO;CAC3F,KAAK,EAAE,OAAO,CAAC,CAAC,SAAS,2FAA2F,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC1I,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS,0FAA0F,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC1I,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS,wEAAwE,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC7H,aAAa,oEAAoE,SAAS,CAAC,CAAC,SAAS;CACrG,cAAc,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,yDAAyD,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC3H,cAAc,oEAAoE,SAAS,CAAC,CAAC,SAAS;CACtG,mBAAmB,EAAE,OAAO,CAAC,CAAC,SAAS,iGAAiG,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC9J,mBAAmB,EAAE,OAAO,CAAC,CAAC,SAAS,gHAAgH,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC7K,mBAAmB,oEAAoE,SAAS,CAAC,CAAC,SAAS;CAC3G,sBAAsB,oEAAoE,SAAS,CAAC,CAAC,SAAS;CAC9G,2BAA2B,oEAAoE,SAAS,CAAC,CAAC,SAAS;CACnH,2BAA2B,oEAAoE,SAAS,CAAC,CAAC,SAAS;AACrH,CAAC,CAAC,CAAC,SAAS,uHAAuH;AACnI,MAAM,kEAAgF,EAAE,OAAO;CAC7F,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS,0BAA0B,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC9E,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS,4BAA4B,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAClF,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS,4BAA4B,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAClF,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS,4BAA4B,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAClF,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS,6BAA6B,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CACpF,cAAc,EAAE,OAAO,CAAC,CAAC,SAAS,8BAA8B,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CACtF,cAAc,EAAE,OAAO,CAAC,CAAC,SAAS,8BAA8B,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CACtF,eAAe,EAAE,OAAO,CAAC,CAAC,SAAS,+BAA+B,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CACxF,eAAe,EAAE,OAAO,CAAC,CAAC,SAAS,+BAA+B,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CACxF,kBAAkB,EAAE,OAAO,CAAC,CAAC,SAAS,mCAAmC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC/F,kBAAkB,EAAE,OAAO,CAAC,CAAC,SAAS,mCAAmC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC/F,uBAAuB,EAAE,OAAO,CAAC,CAAC,SAAS,2CAA2C,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC5G,wBAAwB,EAAE,OAAO,CAAC,CAAC,SAAS,yCAAyC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC3G,wBAAwB,EAAE,OAAO,CAAC,CAAC,SAAS,yCAAyC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;AAC7G,CAAC,CAAC,CAAC,SAAS,mFAAmF;AA0D/F,MAAa,+CAA+C,OAAO,sDAAsD;CACvH,MAAM;CACN,MAAM;CACN,aAAa;CACb,OAAO;CACP,QA9D8E,EAAE,OAAO;EACvF,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS,sDAAsD,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACtG,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS,wFAAwF,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACxI,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS,uBAAuB,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACvE,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS,sSAAsS,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACtV,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,mDAAmD,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC7G,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS,0BAA0B,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC3E,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS,wGAAwG,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC1J,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS,0BAA0B,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC5E,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS,yCAAyC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC3F,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS,wDAAwD,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC1G,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS,+CAA+C,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACjG,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS,iDAAiD,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACrG,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS,8DAA8D,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAClH,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS,oDAAoD,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACxG,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS,4BAA4B,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAChF,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS,wCAAwC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC5F,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS,6FAA6F,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAClJ,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS,qCAAqC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC1F,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS,4CAA4C,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACjG,YAAY,8DAA8D,SAAS,CAAC,CAAC,SAAS;EAC9F,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS,+DAA+D,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACrH,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS,2CAA2C,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACjG,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS,mFAAmF,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC1I,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS,mEAAmE,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC1H,cAAc,EAAE,OAAO,CAAC,CAAC,SAAS,wCAAwC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAChG,cAAc,EAAE,OAAO,CAAC,CAAC,SAAS,oDAAoD,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC5G,cAAc,gEAAgE,SAAS,CAAC,CAAC,SAAS;EAClG,eAAe,EAAE,OAAO,CAAC,CAAC,SAAS,yDAAyD,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAClH,eAAe,EAAE,OAAO,CAAC,CAAC,SAAS,uDAAuD,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAChH,eAAe,EAAE,OAAO,CAAC,CAAC,SAAS,gCAAgC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACzF,eAAe,EAAE,OAAO,CAAC,CAAC,SAAS,mCAAmC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC5F,gBAAgB,EAAE,OAAO,CAAC,CAAC,SAAS,oCAAoC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC9F,gBAAgB,EAAE,OAAO,CAAC,CAAC,SAAS,6CAA6C,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACvG,iBAAiB,EAAE,OAAO,CAAC,CAAC,SAAS,yBAAyB,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACpF,iBAAiB,EAAE,OAAO,CAAC,CAAC,SAAS,kFAAkF,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC7I,iBAAiB,EAAE,OAAO,CAAC,CAAC,SAAS,qEAAqE,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAChI,iBAAiB,EAAE,OAAO,CAAC,CAAC,SAAS,2CAA2C,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACtG,iBAAiB,EAAE,OAAO,CAAC,CAAC,SAAS,wCAAwC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACnG,mBAAmB,EAAE,OAAO,CAAC,CAAC,SAAS,qCAAqC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAClG,mBAAmB,EAAE,OAAO,CAAC,CAAC,SAAS,qCAAqC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAClG,mBAAmB,oEAAoE,SAAS,CAAC,CAAC,SAAS;EAC3G,mBAAmB,EAAE,OAAO,CAAC,CAAC,SAAS,kDAAkD,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC/G,mBAAmB,EAAE,OAAO,CAAC,CAAC,SAAS,+CAA+C,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC5G,qBAAqB,EAAE,OAAO,CAAC,CAAC,SAAS,2EAA2E,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC1I,qBAAqB,EAAE,OAAO,CAAC,CAAC,SAAS,wCAAwC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACvG,sBAAsB,EAAE,OAAO,CAAC,CAAC,SAAS,0EAA0E,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC1I,sBAAsB,EAAE,OAAO,CAAC,CAAC,SAAS,wDAAwD,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACxH,sBAAsB,EAAE,OAAO,CAAC,CAAC,SAAS,+BAA+B,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC/F,wBAAwB,EAAE,OAAO,CAAC,CAAC,SAAS,mGAAmG,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACrK,wBAAwB,EAAE,OAAO,CAAC,CAAC,SAAS,qCAAqC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACvG,0BAA0B,EAAE,OAAO,CAAC,CAAC,SAAS,8DAA8D,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAClI,2BAA2B,EAAE,OAAO,CAAC,CAAC,SAAS,mEAAmE,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EACxI,2BAA2B,EAAE,OAAO,CAAC,CAAC,SAAS,sCAAsC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;EAC3G,8BAA8B,EAAE,OAAO,CAAC,CAAC,SAAS,wDAAwD,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAClI,CAAC,CAAC,CAAC,SAAS,0IAOF;AACV,CAAC"}

package/dist/actions/update-document-visibility-recipients.cjs

@@ -0,0 +1,32 @@
+const require_action = require("../action.cjs");
+let zod = require("zod");
+//#region src/actions/update-document-visibility-recipients.ts
+const DocusignUpdateDocumentVisibilityRecipientsInput = zod.z.object({
+	accountId: zod.z.string().describe("The DocuSign account ID (GUID format). This is automatically populated from your authentication credentials. Example: '46c80402-3d34-43eb-b8d1-aed79c622310'").optional(),
+	envelopeId: zod.z.string().describe("The unique identifier (GUID) of the envelope whose document visibility settings you want to update. The envelope must exist in the specified account. Example: '93be49ab-1234-5678-9abc-f752070d71ec'"),
+	documentVisibility: zod.z.array(zod.z.object({
+		rights: zod.z.string().default("read").describe("Specifies the access rights for this document. Valid values: 'editable' (recipient can modify), 'read' or 'read_only' (view only). Defaults to 'read' if not specified.").optional(),
+		visible: zod.z.string().default("true").describe("Controls whether the document is visible to the recipient. Valid values: 'true' (visible) or 'false' (hidden). Defaults to 'true' if not specified. Note: Documents with tabs assigned to a recipient cannot be hidden from that recipient.").optional(),
+		documentId: zod.z.string().describe("The unique identifier of the document within the envelope. This must refer to an existing document's ID. Example: '1' for the first document."),
+		recipientId: zod.z.string().describe("The unique identifier of the recipient to whom this visibility setting applies. This value must match a recipientId defined in the envelope. Example: '1' for the first recipient.")
+	}).describe("Request schema for individual document visibility settings")).describe("Array of document visibility configurations, specifying which documents each recipient can see. Each item must include documentId, recipientId, and optionally visible and rights settings. You can control visibility for multiple document-recipient pairs in a single request.")
+}).describe("Request schema for `UpdateDocumentVisibilityRecipients`");
+const DocusignUpdateDocumentVisibilityRecipients_DocumentVisibilityResponseItemSchema = zod.z.object({
+	rights: zod.z.string().describe("Access rights for the document: 'editable' or 'read_only'").nullable().optional(),
+	visible: zod.z.string().describe("Whether the document is visible to the recipient: 'true' or 'false'").nullable().optional(),
+	documentId: zod.z.string().describe("The unique identifier of the document").nullable().optional(),
+	recipientId: zod.z.string().describe("The unique identifier of the recipient").nullable().optional(),
+	errorDetails: zod.z.object({}).describe("Error details if the update failed for this item").nullable().optional()
+}).describe("Response schema for individual document visibility items");
+const DocusignUpdateDocumentVisibilityRecipientsOutput = zod.z.object({ documentVisibility: zod.z.array(DocusignUpdateDocumentVisibilityRecipients_DocumentVisibilityResponseItemSchema).describe("Array of document visibility objects with updated settings").nullable().optional() }).describe("Response schema for `UpdateDocumentVisibilityRecipients`");
+const docusignUpdateDocumentVisibilityRecipients = require_action.action("DOCUSIGN_UPDATE_DOCUMENT_VISIBILITY_RECIPIENTS", {
+	slug: "docusign-update-document-visibility-recipients",
+	name: "Updatedocumentvisibilityrecipients",
+	description: "Updates document visibility settings for multiple recipients in a DocuSign envelope. Use this action to control which documents each recipient can see and their access level (read-only or editable). This is essential for managing multi-document envelopes where different recipients should only access specific documents. Key features: - Set visibility for multiple document-recipient pairs in one request - Control access rights: read-only or editable - Hide documents from specific recipients (if no tabs assigned) Important limitations: - Documents with tabs assigned to a recipient cannot be hidden from that recipient - Some recipient types (Carbon Copy, Certified Delivery, Editor, Agent) always see all documents - The envelope must be in a state that allows modifications (typically 'created' status) Example use case: In a purchase agreement with financial disclosures, you might want the buyer to see the main agreement and their financial documents, while hiding the seller's confidential financial information.",
+	input: DocusignUpdateDocumentVisibilityRecipientsInput,
+	output: DocusignUpdateDocumentVisibilityRecipientsOutput
+});
+//#endregion
+exports.docusignUpdateDocumentVisibilityRecipients = docusignUpdateDocumentVisibilityRecipients;
+
+//# sourceMappingURL=update-document-visibility-recipients.cjs.map

package/dist/actions/update-document-visibility-recipients.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-document-visibility-recipients.cjs","names":["z","action"],"sources":["../../src/actions/update-document-visibility-recipients.ts"],"sourcesContent":["import { z } from \"zod\";\n\nimport { action } from \"../action\";\n\nexport const DocusignUpdateDocumentVisibilityRecipientsInput: z.ZodTypeAny = z.object({\n  accountId: z.string().describe(\"The DocuSign account ID (GUID format). This is automatically populated from your authentication credentials. Example: '46c80402-3d34-43eb-b8d1-aed79c622310'\").optional(),\n  envelopeId: z.string().describe(\"The unique identifier (GUID) of the envelope whose document visibility settings you want to update. The envelope must exist in the specified account. Example: '93be49ab-1234-5678-9abc-f752070d71ec'\"),\n  documentVisibility: z.array(z.object({\n  rights: z.string().default(\"read\").describe(\"Specifies the access rights for this document. Valid values: 'editable' (recipient can modify), 'read' or 'read_only' (view only). Defaults to 'read' if not specified.\").optional(),\n  visible: z.string().default(\"true\").describe(\"Controls whether the document is visible to the recipient. Valid values: 'true' (visible) or 'false' (hidden). Defaults to 'true' if not specified. Note: Documents with tabs assigned to a recipient cannot be hidden from that recipient.\").optional(),\n  documentId: z.string().describe(\"The unique identifier of the document within the envelope. This must refer to an existing document's ID. Example: '1' for the first document.\"),\n  recipientId: z.string().describe(\"The unique identifier of the recipient to whom this visibility setting applies. This value must match a recipientId defined in the envelope. Example: '1' for the first recipient.\"),\n}).describe(\"Request schema for individual document visibility settings\")).describe(\"Array of document visibility configurations, specifying which documents each recipient can see. Each item must include documentId, recipientId, and optionally visible and rights settings. You can control visibility for multiple document-recipient pairs in a single request.\"),\n}).describe(\"Request schema for `UpdateDocumentVisibilityRecipients`\");\nconst DocusignUpdateDocumentVisibilityRecipients_DocumentVisibilityResponseItemSchema: z.ZodTypeAny = z.object({\n  rights: z.string().describe(\"Access rights for the document: 'editable' or 'read_only'\").nullable().optional(),\n  visible: z.string().describe(\"Whether the document is visible to the recipient: 'true' or 'false'\").nullable().optional(),\n  documentId: z.string().describe(\"The unique identifier of the document\").nullable().optional(),\n  recipientId: z.string().describe(\"The unique identifier of the recipient\").nullable().optional(),\n  errorDetails: z.object({}).describe(\"Error details if the update failed for this item\").nullable().optional(),\n}).describe(\"Response schema for individual document visibility items\");\nexport const DocusignUpdateDocumentVisibilityRecipientsOutput: z.ZodTypeAny = z.object({\n  documentVisibility: z.array(DocusignUpdateDocumentVisibilityRecipients_DocumentVisibilityResponseItemSchema).describe(\"Array of document visibility objects with updated settings\").nullable().optional(),\n}).describe(\"Response schema for `UpdateDocumentVisibilityRecipients`\");\n\nexport const docusignUpdateDocumentVisibilityRecipients = action(\"DOCUSIGN_UPDATE_DOCUMENT_VISIBILITY_RECIPIENTS\", {\n  slug: \"docusign-update-document-visibility-recipients\",\n  name: \"Updatedocumentvisibilityrecipients\",\n  description: \"Updates document visibility settings for multiple recipients in a DocuSign envelope. Use this action to control which documents each recipient can see and their access level (read-only or editable). This is essential for managing multi-document envelopes where different recipients should only access specific documents. Key features: - Set visibility for multiple document-recipient pairs in one request - Control access rights: read-only or editable - Hide documents from specific recipients (if no tabs assigned) Important limitations: - Documents with tabs assigned to a recipient cannot be hidden from that recipient - Some recipient types (Carbon Copy, Certified Delivery, Editor, Agent) always see all documents - The envelope must be in a state that allows modifications (typically 'created' status) Example use case: In a purchase agreement with financial disclosures, you might want the buyer to see the main agreement and their financial documents, while hiding the seller's confidential financial information.\",\n  input: DocusignUpdateDocumentVisibilityRecipientsInput,\n  output: DocusignUpdateDocumentVisibilityRecipientsOutput,\n});\n"],"mappings":";;;AAIA,MAAa,kDAAgEA,IAAAA,EAAE,OAAO;CACpF,WAAWA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,8JAA8J,CAAC,CAAC,SAAS;CACxM,YAAYA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,uMAAuM;CACvO,oBAAoBA,IAAAA,EAAE,MAAMA,IAAAA,EAAE,OAAO;EACrC,QAAQA,IAAAA,EAAE,OAAO,CAAC,CAAC,QAAQ,MAAM,CAAC,CAAC,SAAS,yKAAyK,CAAC,CAAC,SAAS;EAChO,SAASA,IAAAA,EAAE,OAAO,CAAC,CAAC,QAAQ,MAAM,CAAC,CAAC,SAAS,6OAA6O,CAAC,CAAC,SAAS;EACrS,YAAYA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,+IAA+I;EAC/K,aAAaA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,oLAAoL;CACvN,CAAC,CAAC,CAAC,SAAS,4DAA4D,CAAC,CAAC,CAAC,SAAS,mRAAmR;AACvW,CAAC,CAAC,CAAC,SAAS,yDAAyD;AACrE,MAAM,kFAAgGA,IAAAA,EAAE,OAAO;CAC7G,QAAQA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,2DAA2D,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC7G,SAASA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,qEAAqE,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CACxH,YAAYA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,uCAAuC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC7F,aAAaA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,wCAAwC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC/F,cAAcA,IAAAA,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,kDAAkD,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;AAC9G,CAAC,CAAC,CAAC,SAAS,0DAA0D;AACtE,MAAa,mDAAiEA,IAAAA,EAAE,OAAO,EACrF,oBAAoBA,IAAAA,EAAE,MAAM,+EAA+E,CAAC,CAAC,SAAS,4DAA4D,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,EAC1M,CAAC,CAAC,CAAC,SAAS,0DAA0D;AAEtE,MAAa,6CAA6CC,eAAAA,OAAO,kDAAkD;CACjH,MAAM;CACN,MAAM;CACN,aAAa;CACb,OAAO;CACP,QAAQ;AACV,CAAC"}

package/dist/actions/update-document-visibility-recipients.d.cts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+
+//#region src/actions/update-document-visibility-recipients.d.ts
+declare const DocusignUpdateDocumentVisibilityRecipientsInput: z.ZodTypeAny;
+declare const DocusignUpdateDocumentVisibilityRecipientsOutput: z.ZodTypeAny;
+declare const docusignUpdateDocumentVisibilityRecipients: import("@keystrokehq/action").WorkflowActionDefinition<unknown, unknown, import("@keystrokehq/shared").ResolvedCredentials<readonly [import("@keystrokehq/shared").Credential]>, readonly [import("@keystrokehq/shared").Credential]>;
+//#endregion
+export { docusignUpdateDocumentVisibilityRecipients };
+//# sourceMappingURL=update-document-visibility-recipients.d.cts.map

package/dist/actions/update-document-visibility-recipients.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-document-visibility-recipients.d.cts","names":[],"sources":["../../src/actions/update-document-visibility-recipients.ts"],"mappings":";;;cAIa,+CAAA,EAAiD,CAAA,CAAE,UASM;AAAA,cAQzD,gDAAA,EAAkD,CAAA,CAAE,UAEM;AAAA,cAE1D,0CAAA,gCAA0C,wBAAA,iDAAA,mBAAA,yCAAA,UAAA,4CAAA,UAAA"}

package/dist/actions/update-document-visibility-recipients.d.mts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+
+//#region src/actions/update-document-visibility-recipients.d.ts
+declare const DocusignUpdateDocumentVisibilityRecipientsInput: z.ZodTypeAny;
+declare const DocusignUpdateDocumentVisibilityRecipientsOutput: z.ZodTypeAny;
+declare const docusignUpdateDocumentVisibilityRecipients: import("@keystrokehq/action").WorkflowActionDefinition<unknown, unknown, import("@keystrokehq/shared").ResolvedCredentials<readonly [import("@keystrokehq/shared").Credential]>, readonly [import("@keystrokehq/shared").Credential]>;
+//#endregion
+export { docusignUpdateDocumentVisibilityRecipients };
+//# sourceMappingURL=update-document-visibility-recipients.d.mts.map

package/dist/actions/update-document-visibility-recipients.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-document-visibility-recipients.d.mts","names":[],"sources":["../../src/actions/update-document-visibility-recipients.ts"],"mappings":";;;cAIa,+CAAA,EAAiD,CAAA,CAAE,UASM;AAAA,cAQzD,gDAAA,EAAkD,CAAA,CAAE,UAEM;AAAA,cAE1D,0CAAA,gCAA0C,wBAAA,iDAAA,mBAAA,yCAAA,UAAA,4CAAA,UAAA"}

package/dist/actions/update-document-visibility-recipients.mjs

@@ -0,0 +1,31 @@
+import { action } from "../action.mjs";
+import { z } from "zod";
+//#region src/actions/update-document-visibility-recipients.ts
+const DocusignUpdateDocumentVisibilityRecipientsInput = z.object({
+	accountId: z.string().describe("The DocuSign account ID (GUID format). This is automatically populated from your authentication credentials. Example: '46c80402-3d34-43eb-b8d1-aed79c622310'").optional(),
+	envelopeId: z.string().describe("The unique identifier (GUID) of the envelope whose document visibility settings you want to update. The envelope must exist in the specified account. Example: '93be49ab-1234-5678-9abc-f752070d71ec'"),
+	documentVisibility: z.array(z.object({
+		rights: z.string().default("read").describe("Specifies the access rights for this document. Valid values: 'editable' (recipient can modify), 'read' or 'read_only' (view only). Defaults to 'read' if not specified.").optional(),
+		visible: z.string().default("true").describe("Controls whether the document is visible to the recipient. Valid values: 'true' (visible) or 'false' (hidden). Defaults to 'true' if not specified. Note: Documents with tabs assigned to a recipient cannot be hidden from that recipient.").optional(),
+		documentId: z.string().describe("The unique identifier of the document within the envelope. This must refer to an existing document's ID. Example: '1' for the first document."),
+		recipientId: z.string().describe("The unique identifier of the recipient to whom this visibility setting applies. This value must match a recipientId defined in the envelope. Example: '1' for the first recipient.")
+	}).describe("Request schema for individual document visibility settings")).describe("Array of document visibility configurations, specifying which documents each recipient can see. Each item must include documentId, recipientId, and optionally visible and rights settings. You can control visibility for multiple document-recipient pairs in a single request.")
+}).describe("Request schema for `UpdateDocumentVisibilityRecipients`");
+const DocusignUpdateDocumentVisibilityRecipients_DocumentVisibilityResponseItemSchema = z.object({
+	rights: z.string().describe("Access rights for the document: 'editable' or 'read_only'").nullable().optional(),
+	visible: z.string().describe("Whether the document is visible to the recipient: 'true' or 'false'").nullable().optional(),
+	documentId: z.string().describe("The unique identifier of the document").nullable().optional(),
+	recipientId: z.string().describe("The unique identifier of the recipient").nullable().optional(),
+	errorDetails: z.object({}).describe("Error details if the update failed for this item").nullable().optional()
+}).describe("Response schema for individual document visibility items");
+const docusignUpdateDocumentVisibilityRecipients = action("DOCUSIGN_UPDATE_DOCUMENT_VISIBILITY_RECIPIENTS", {
+	slug: "docusign-update-document-visibility-recipients",
+	name: "Updatedocumentvisibilityrecipients",
+	description: "Updates document visibility settings for multiple recipients in a DocuSign envelope. Use this action to control which documents each recipient can see and their access level (read-only or editable). This is essential for managing multi-document envelopes where different recipients should only access specific documents. Key features: - Set visibility for multiple document-recipient pairs in one request - Control access rights: read-only or editable - Hide documents from specific recipients (if no tabs assigned) Important limitations: - Documents with tabs assigned to a recipient cannot be hidden from that recipient - Some recipient types (Carbon Copy, Certified Delivery, Editor, Agent) always see all documents - The envelope must be in a state that allows modifications (typically 'created' status) Example use case: In a purchase agreement with financial disclosures, you might want the buyer to see the main agreement and their financial documents, while hiding the seller's confidential financial information.",
+	input: DocusignUpdateDocumentVisibilityRecipientsInput,
+	output: z.object({ documentVisibility: z.array(DocusignUpdateDocumentVisibilityRecipients_DocumentVisibilityResponseItemSchema).describe("Array of document visibility objects with updated settings").nullable().optional() }).describe("Response schema for `UpdateDocumentVisibilityRecipients`")
+});
+//#endregion
+export { docusignUpdateDocumentVisibilityRecipients };
+
+//# sourceMappingURL=update-document-visibility-recipients.mjs.map

package/dist/actions/update-document-visibility-recipients.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-document-visibility-recipients.mjs","names":[],"sources":["../../src/actions/update-document-visibility-recipients.ts"],"sourcesContent":["import { z } from \"zod\";\n\nimport { action } from \"../action\";\n\nexport const DocusignUpdateDocumentVisibilityRecipientsInput: z.ZodTypeAny = z.object({\n  accountId: z.string().describe(\"The DocuSign account ID (GUID format). This is automatically populated from your authentication credentials. Example: '46c80402-3d34-43eb-b8d1-aed79c622310'\").optional(),\n  envelopeId: z.string().describe(\"The unique identifier (GUID) of the envelope whose document visibility settings you want to update. The envelope must exist in the specified account. Example: '93be49ab-1234-5678-9abc-f752070d71ec'\"),\n  documentVisibility: z.array(z.object({\n  rights: z.string().default(\"read\").describe(\"Specifies the access rights for this document. Valid values: 'editable' (recipient can modify), 'read' or 'read_only' (view only). Defaults to 'read' if not specified.\").optional(),\n  visible: z.string().default(\"true\").describe(\"Controls whether the document is visible to the recipient. Valid values: 'true' (visible) or 'false' (hidden). Defaults to 'true' if not specified. Note: Documents with tabs assigned to a recipient cannot be hidden from that recipient.\").optional(),\n  documentId: z.string().describe(\"The unique identifier of the document within the envelope. This must refer to an existing document's ID. Example: '1' for the first document.\"),\n  recipientId: z.string().describe(\"The unique identifier of the recipient to whom this visibility setting applies. This value must match a recipientId defined in the envelope. Example: '1' for the first recipient.\"),\n}).describe(\"Request schema for individual document visibility settings\")).describe(\"Array of document visibility configurations, specifying which documents each recipient can see. Each item must include documentId, recipientId, and optionally visible and rights settings. You can control visibility for multiple document-recipient pairs in a single request.\"),\n}).describe(\"Request schema for `UpdateDocumentVisibilityRecipients`\");\nconst DocusignUpdateDocumentVisibilityRecipients_DocumentVisibilityResponseItemSchema: z.ZodTypeAny = z.object({\n  rights: z.string().describe(\"Access rights for the document: 'editable' or 'read_only'\").nullable().optional(),\n  visible: z.string().describe(\"Whether the document is visible to the recipient: 'true' or 'false'\").nullable().optional(),\n  documentId: z.string().describe(\"The unique identifier of the document\").nullable().optional(),\n  recipientId: z.string().describe(\"The unique identifier of the recipient\").nullable().optional(),\n  errorDetails: z.object({}).describe(\"Error details if the update failed for this item\").nullable().optional(),\n}).describe(\"Response schema for individual document visibility items\");\nexport const DocusignUpdateDocumentVisibilityRecipientsOutput: z.ZodTypeAny = z.object({\n  documentVisibility: z.array(DocusignUpdateDocumentVisibilityRecipients_DocumentVisibilityResponseItemSchema).describe(\"Array of document visibility objects with updated settings\").nullable().optional(),\n}).describe(\"Response schema for `UpdateDocumentVisibilityRecipients`\");\n\nexport const docusignUpdateDocumentVisibilityRecipients = action(\"DOCUSIGN_UPDATE_DOCUMENT_VISIBILITY_RECIPIENTS\", {\n  slug: \"docusign-update-document-visibility-recipients\",\n  name: \"Updatedocumentvisibilityrecipients\",\n  description: \"Updates document visibility settings for multiple recipients in a DocuSign envelope. Use this action to control which documents each recipient can see and their access level (read-only or editable). This is essential for managing multi-document envelopes where different recipients should only access specific documents. Key features: - Set visibility for multiple document-recipient pairs in one request - Control access rights: read-only or editable - Hide documents from specific recipients (if no tabs assigned) Important limitations: - Documents with tabs assigned to a recipient cannot be hidden from that recipient - Some recipient types (Carbon Copy, Certified Delivery, Editor, Agent) always see all documents - The envelope must be in a state that allows modifications (typically 'created' status) Example use case: In a purchase agreement with financial disclosures, you might want the buyer to see the main agreement and their financial documents, while hiding the seller's confidential financial information.\",\n  input: DocusignUpdateDocumentVisibilityRecipientsInput,\n  output: DocusignUpdateDocumentVisibilityRecipientsOutput,\n});\n"],"mappings":";;;AAIA,MAAa,kDAAgE,EAAE,OAAO;CACpF,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS,8JAA8J,CAAC,CAAC,SAAS;CACxM,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS,uMAAuM;CACvO,oBAAoB,EAAE,MAAM,EAAE,OAAO;EACrC,QAAQ,EAAE,OAAO,CAAC,CAAC,QAAQ,MAAM,CAAC,CAAC,SAAS,yKAAyK,CAAC,CAAC,SAAS;EAChO,SAAS,EAAE,OAAO,CAAC,CAAC,QAAQ,MAAM,CAAC,CAAC,SAAS,6OAA6O,CAAC,CAAC,SAAS;EACrS,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS,+IAA+I;EAC/K,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS,oLAAoL;CACvN,CAAC,CAAC,CAAC,SAAS,4DAA4D,CAAC,CAAC,CAAC,SAAS,mRAAmR;AACvW,CAAC,CAAC,CAAC,SAAS,yDAAyD;AACrE,MAAM,kFAAgG,EAAE,OAAO;CAC7G,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS,2DAA2D,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC7G,SAAS,EAAE,OAAO,CAAC,CAAC,SAAS,qEAAqE,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CACxH,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS,uCAAuC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC7F,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS,wCAAwC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;CAC/F,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,kDAAkD,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;AAC9G,CAAC,CAAC,CAAC,SAAS,0DAA0D;AAKtE,MAAa,6CAA6C,OAAO,kDAAkD;CACjH,MAAM;CACN,MAAM;CACN,aAAa;CACb,OAAO;CACP,QAT4E,EAAE,OAAO,EACrF,oBAAoB,EAAE,MAAM,+EAA+E,CAAC,CAAC,SAAS,4DAA4D,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,EAC1M,CAAC,CAAC,CAAC,SAAS,0DAOF;AACV,CAAC"}