@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
163 lines • 8.02 kB
JavaScript
;
/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.agreementManagerAgreementsPatchAgreement = agreementManagerAgreementsPatchAgreement;
const z = __importStar(require("zod/v3"));
const encodings_js_1 = require("../lib/encodings.js");
const http_js_1 = require("../lib/http.js");
const M = __importStar(require("../lib/matchers.js"));
const primitives_js_1 = require("../lib/primitives.js");
const schemas_js_1 = require("../lib/schemas.js");
const security_js_1 = require("../lib/security.js");
const url_js_1 = require("../lib/url.js");
const errors = __importStar(require("../models/errors/index.js"));
const operations = __importStar(require("../models/operations/index.js"));
const async_js_1 = require("../types/async.js");
/**
* Update specific fields of an agreement
*
* @remarks
* This operation updates one or more fields of a specific agreement identified by its `agreementId`.
* The operation supports partial updates, allowing clients to modify only the fields they need without affecting the rest of the agreement data.
*
* The request body should contain a JSON payload with the fields to be updated. Only the fields provided in the request body will be modified; all other fields remain unchanged. The operation returns a `204 No Content` response on success.
*
* This operation is essential for maintaining and evolving agreement data throughout the agreement's lifecycle, such as updating status, provisions, custom fields, or metadata based on business events or reviews.
*
* ### Use Cases:
* - **Updating agreement status or review completion**: Mark agreements as reviewed, completed, or pending further action based on internal workflows.
* - **Modifying provision details**: Update agreement terms, effective dates, expiration dates, or renewal conditions as circumstances change.
* - **Managing custom attributes**: Add or modify user-defined fields and custom metadata to capture additional business context for the agreement.
* - **Recording business events**: Update agreements to reflect changes such as amendments, renewals, or termination notices.
* - **Synchronizing agreements across systems**: Update agreements in response to changes detected in external systems (e.g., ERP, CRM) to maintain data integrity.
*
* ### Key Features:
* - **Partial Updates**: Modify only the fields you need; other agreement data remains intact.
* - **Flexible Payload**: Accept JSON objects with any combination of updateable agreement fields, including provisions, metadata, and custom attributes.
* - **Data Integrity**: Validates all input data to ensure compliance with agreement structure and data constraints.
*
* If set, this operation will use {@link Security.accessToken} from the global security.
*/
function agreementManagerAgreementsPatchAgreement(client, request, options) {
return new async_js_1.APIPromise($do(client, request, options));
}
async function $do(client, request, options) {
const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.PatchAgreementRequest$outboundSchema.parse(value), "Input validation failed");
if (!parsed.ok) {
return [parsed, { status: "invalid" }];
}
const payload = parsed.value;
const body = (0, encodings_js_1.encodeJSON)("body", payload.Agreement, { explode: true });
const pathParams = {
accountId: (0, encodings_js_1.encodeSimple)("accountId", payload.accountId, {
explode: false,
charEncoding: "percent",
}),
agreementId: (0, encodings_js_1.encodeSimple)("agreementId", payload.agreementId, {
explode: false,
charEncoding: "percent",
}),
};
const path = (0, url_js_1.pathToFunc)("/v1/accounts/{accountId}/agreements/{agreementId}")(pathParams);
const headers = new Headers((0, primitives_js_1.compactMap)({
"Content-Type": "application/json",
Accept: "application/problem+json",
}));
const secConfig = await (0, security_js_1.extractSecurity)(client._options.accessToken);
const securityInput = secConfig == null ? {} : { accessToken: secConfig };
const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput, [0]);
const context = {
options: client._options,
baseURL: options?.serverURL ?? client._baseURL ?? "",
operationID: "PatchAgreement",
oAuth2Scopes: null,
resolvedSecurity: requestSecurity,
securitySource: client._options.accessToken,
retryConfig: options?.retries
|| client._options.retryConfig
|| {
strategy: "backoff",
backoff: {
initialInterval: 500,
maxInterval: 5000,
exponent: 1.5,
maxElapsedTime: 30000,
},
retryConnectionErrors: true,
}
|| { strategy: "none" },
retryCodes: options?.retryCodes || ["5XX", "429"],
};
const requestRes = client._createRequest(context, {
security: requestSecurity,
method: "PATCH",
baseURL: options?.serverURL,
path: path,
headers: headers,
body: body,
userAgent: client._options.userAgent,
timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
}, options);
if (!requestRes.ok) {
return [requestRes, { status: "invalid" }];
}
const req = requestRes.value;
const doResult = await client._do(req, {
context,
isErrorStatusCode: (statusCode) => (0, http_js_1.matchStatusCode)({ status: statusCode }, ["4XX", "5XX"]),
retryConfig: context.retryConfig,
retryCodes: context.retryCodes,
});
if (!doResult.ok) {
return [doResult, { status: "request-error", request: req }];
}
const response = doResult.value;
const responseFields = {
HttpMeta: { Response: response, Request: req },
};
const [result] = await M.match(M.nil(204, z.void()), M.jsonErr([400, 403, 404], errors.ErrDetails$inboundSchema, {
ctype: "application/problem+json",
}), M.jsonErr(500, errors.ErrDetails$inboundSchema, {
ctype: "application/problem+json",
}), M.fail([401, "4XX"]), M.fail("5XX"))(response, req, { extraFields: responseFields });
if (!result.ok) {
return [result, { status: "complete", request: req, response }];
}
return [result, { status: "complete", request: req, response }];
}
//# sourceMappingURL=agreementManagerAgreementsPatchAgreement.js.map