deploy
This commit is contained in:
a2a-platform
11
README.md
Normal file
11
README.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# docusign-esignature-openapi-agent
|
||||
|
||||
Generated A2APack agent for Docusign eSignature REST API.
|
||||
|
||||
- Source OpenAPI: https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json
|
||||
- Generated operations: 414
|
||||
- Main skill: `auto`
|
||||
- Routing mode: DeepAgents subagents across 10 route groups
|
||||
|
||||
The generated code is intentionally editable. Tune prompts, operation
|
||||
grouping, auth names, and safety policy before publishing serious agents.
|
||||
13
a2a.yaml
Normal file
13
a2a.yaml
Normal file
@@ -0,0 +1,13 @@
|
||||
name: docusign-esignature-openapi-agent
|
||||
version: v2.1
|
||||
entrypoint: agent:DocusignEsignatureOpenapiAgent
|
||||
description: Electronic signature and agreement workflow API for envelopes, recipients,
|
||||
documents, and tabs.
|
||||
runtime:
|
||||
resources:
|
||||
cpu: 200m
|
||||
memory: 512Mi
|
||||
egress:
|
||||
allow_hosts:
|
||||
- www.docusign.net
|
||||
deny_internet_by_default: true
|
||||
76646
openapi.json
Normal file
76646
openapi.json
Normal file
File diff suppressed because one or more lines are too long
7
requirements.txt
Normal file
7
requirements.txt
Normal file
@@ -0,0 +1,7 @@
|
||||
# a2a-pack is installed by the platform base image.
|
||||
deepagents>=0.5.0
|
||||
langchain>=0.3
|
||||
langchain-openai>=0.2
|
||||
langchain-core>=0.3
|
||||
langgraph>=0.6
|
||||
httpx>=0.27
|
||||
868
skills/accounts-1/SKILL.md
Normal file
868
skills/accounts-1/SKILL.md
Normal file
@@ -0,0 +1,868 @@
|
||||
---
|
||||
name: accounts-1-routes
|
||||
description: Handle 80 OpenAPI operation(s) under /v2.1/accounts for the accounts 1 route group.
|
||||
---
|
||||
|
||||
# accounts 1 API Routes
|
||||
|
||||
Handle 80 OpenAPI operation(s) under /v2.1/accounts for the accounts 1 route group.
|
||||
|
||||
Use the generated operation tools to make real API calls. Do not invent API responses.
|
||||
If a tool reports missing setup, return the exact setup field name to the caller.
|
||||
For write, update, or delete operations, state the intended action before calling the tool.
|
||||
|
||||
## Operations
|
||||
|
||||
### accounts_post_accounts
|
||||
|
||||
- Operation ID: `accounts_post_accounts`
|
||||
- Route: `POST /v2.1/accounts`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates new accounts.
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### accounts_get_account
|
||||
|
||||
- Operation ID: `accounts_get_account`
|
||||
- Route: `GET /v2.1/accounts/{accountId}`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves the account information for the specified account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `include_account_settings` in `query`
|
||||
- `include_trial_eligibility` in `query`
|
||||
|
||||
### accounts_delete_account
|
||||
|
||||
- Operation ID: `accounts_delete_account`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the specified account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `redact_user_data` in `query`
|
||||
|
||||
### billing_charges_get_account_billing_charges
|
||||
|
||||
- Operation ID: `billing_charges_get_account_billing_charges`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/billing_charges`
|
||||
- Mode: READ
|
||||
- Summary: Gets list of recurring and usage charges for the account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `include_charges` in `query`
|
||||
|
||||
### billing_invoices_get_billing_invoices
|
||||
|
||||
- Operation ID: `billing_invoices_get_billing_invoices`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/billing_invoices`
|
||||
- Mode: READ
|
||||
- Summary: Get a List of Billing Invoices
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `from_date` in `query`
|
||||
- `to_date` in `query`
|
||||
|
||||
### billing_invoices_get_billing_invoice
|
||||
|
||||
- Operation ID: `billing_invoices_get_billing_invoice`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/billing_invoices/{invoiceId}`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves a billing invoice.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `invoiceId` in `path` required
|
||||
|
||||
### billing_invoices_get_billing_invoices_past_due
|
||||
|
||||
- Operation ID: `billing_invoices_get_billing_invoices_past_due`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/billing_invoices_past_due`
|
||||
- Mode: READ
|
||||
- Summary: Get a list of past due invoices.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### billing_payments_get_payment_list
|
||||
|
||||
- Operation ID: `billing_payments_get_payment_list`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/billing_payments`
|
||||
- Mode: READ
|
||||
- Summary: Gets payment information for one or more payments.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `from_date` in `query`
|
||||
- `to_date` in `query`
|
||||
|
||||
### billing_payments_post_payment
|
||||
|
||||
- Operation ID: `billing_payments_post_payment`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/billing_payments`
|
||||
- Mode: WRITE
|
||||
- Summary: Posts a payment to a past due invoice.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### billing_payments_get_payment
|
||||
|
||||
- Operation ID: `billing_payments_get_payment`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/billing_payments/{paymentId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets billing payment information for a specific payment.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `paymentId` in `path` required
|
||||
|
||||
### billing_plan_get_billing_plan
|
||||
|
||||
- Operation ID: `billing_plan_get_billing_plan`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/billing_plan`
|
||||
- Mode: READ
|
||||
- Summary: Get Account Billing Plan
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `include_credit_card_information` in `query`
|
||||
- `include_downgrade_information` in `query`
|
||||
- `include_metadata` in `query`
|
||||
- `include_successor_plans` in `query`
|
||||
- `include_tax_exempt_id` in `query`
|
||||
|
||||
### billing_plan_put_billing_plan
|
||||
|
||||
- Operation ID: `billing_plan_put_billing_plan`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/billing_plan`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates an account billing plan.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `preview_billing_plan` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### billing_plan_get_credit_card_info
|
||||
|
||||
- Operation ID: `billing_plan_get_credit_card_info`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/billing_plan/credit_card`
|
||||
- Mode: READ
|
||||
- Summary: Get credit card information
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### billing_plan_get_downgrade_request_billing_info
|
||||
|
||||
- Operation ID: `billing_plan_get_downgrade_request_billing_info`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/billing_plan/downgrade`
|
||||
- Mode: READ
|
||||
- Summary: Returns downgrade plan information for the specified account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### billing_plan_put_downgrade_account_billing_plan
|
||||
|
||||
- Operation ID: `billing_plan_put_downgrade_account_billing_plan`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/billing_plan/downgrade`
|
||||
- Mode: WRITE
|
||||
- Summary: Queues downgrade billing plan request for an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### purchased_envelopes_put_purchased_envelopes
|
||||
|
||||
- Operation ID: `purchased_envelopes_put_purchased_envelopes`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/billing_plan/purchased_envelopes`
|
||||
- Mode: WRITE
|
||||
- Summary: Reserved: Purchase additional envelopes.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### brands_get_brands
|
||||
|
||||
- Operation ID: `brands_get_brands`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/brands`
|
||||
- Mode: READ
|
||||
- Summary: Gets a list of brands.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `exclude_distributor_brand` in `query`
|
||||
- `include_logos` in `query`
|
||||
|
||||
### brands_post_brands
|
||||
|
||||
- Operation ID: `brands_post_brands`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/brands`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates one or more brand profiles for an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### brands_delete_brands
|
||||
|
||||
- Operation ID: `brands_delete_brands`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/brands`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes one or more brand profiles.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### brand_get_brand
|
||||
|
||||
- Operation ID: `brand_get_brand`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/brands/{brandId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets information about a brand.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `brandId` in `path` required
|
||||
- `include_external_references` in `query`
|
||||
- `include_logos` in `query`
|
||||
|
||||
### brand_put_brand
|
||||
|
||||
- Operation ID: `brand_put_brand`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/brands/{brandId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates an existing brand.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `brandId` in `path` required
|
||||
- `replace_brand` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### brand_delete_brand
|
||||
|
||||
- Operation ID: `brand_delete_brand`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/brands/{brandId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a brand.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `brandId` in `path` required
|
||||
|
||||
### brand_export_get_brand_export_file
|
||||
|
||||
- Operation ID: `brand_export_get_brand_export_file`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/brands/{brandId}/file`
|
||||
- Mode: READ
|
||||
- Summary: Exports a brand.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `brandId` in `path` required
|
||||
|
||||
### brand_logo_get_brand_logo
|
||||
|
||||
- Operation ID: `brand_logo_get_brand_logo`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}`
|
||||
- Mode: READ
|
||||
- Summary: Gets a brand logo.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `brandId` in `path` required
|
||||
- `logoType` in `path` required
|
||||
|
||||
### brand_logo_put_brand_logo
|
||||
|
||||
- Operation ID: `brand_logo_put_brand_logo`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates a brand logo.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `brandId` in `path` required
|
||||
- `logoType` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### brand_logo_delete_brand_logo
|
||||
|
||||
- Operation ID: `brand_logo_delete_brand_logo`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a brand logo.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `brandId` in `path` required
|
||||
- `logoType` in `path` required
|
||||
|
||||
### brand_resources_get_brand_resources_list
|
||||
|
||||
- Operation ID: `brand_resources_get_brand_resources_list`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/brands/{brandId}/resources`
|
||||
- Mode: READ
|
||||
- Summary: Returns metadata about the branding resources for an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `brandId` in `path` required
|
||||
|
||||
### brand_resources_get_brand_resources
|
||||
|
||||
- Operation ID: `brand_resources_get_brand_resources`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}`
|
||||
- Mode: READ
|
||||
- Summary: Returns a branding resource file.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `brandId` in `path` required
|
||||
- `resourceContentType` in `path` required
|
||||
- `langcode` in `query`
|
||||
- `return_master` in `query`
|
||||
|
||||
### brand_resources_put_brand_resources
|
||||
|
||||
- Operation ID: `brand_resources_put_brand_resources`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates a branding resource file.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `brandId` in `path` required
|
||||
- `resourceContentType` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### bulk_send_v2_batch_get_bulk_send_batches
|
||||
|
||||
- Operation ID: `bulk_send_v2_batch_get_bulk_send_batches`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/bulk_send_batch`
|
||||
- Mode: READ
|
||||
- Summary: Returns a list of bulk send batch summaries.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `batch_ids` in `query`
|
||||
- `count` in `query`
|
||||
- `from_date` in `query`
|
||||
- `search_text` in `query`
|
||||
- `start_position` in `query`
|
||||
- `status` in `query`
|
||||
- `to_date` in `query`
|
||||
- `user_id` in `query`
|
||||
|
||||
### bulk_send_v2_batch_get_bulk_send_batch_status
|
||||
|
||||
- Operation ID: `bulk_send_v2_batch_get_bulk_send_batch_status`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets the status of a specific bulk send batch.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `bulkSendBatchId` in `path` required
|
||||
|
||||
### bulk_send_v2_batch_put_bulk_send_batch_status
|
||||
|
||||
- Operation ID: `bulk_send_v2_batch_put_bulk_send_batch_status`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the name of a bulk send batch.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `bulkSendBatchId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### bulk_send_v2_batch_put_bulk_send_batch_action
|
||||
|
||||
- Operation ID: `bulk_send_v2_batch_put_bulk_send_batch_action`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction}`
|
||||
- Mode: WRITE
|
||||
- Summary: Applies a bulk action to all envelopes from a specified bulk send.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `bulkAction` in `path` required
|
||||
- `bulkSendBatchId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### bulk_send_v2_envelopes_get_bulk_send_batch_envelopes
|
||||
|
||||
- Operation ID: `bulk_send_v2_envelopes_get_bulk_send_batch_envelopes`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes`
|
||||
- Mode: READ
|
||||
- Summary: Gets envelopes from a specific bulk send batch.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `bulkSendBatchId` in `path` required
|
||||
- `count` in `query`
|
||||
- `include` in `query`
|
||||
- `order` in `query`
|
||||
- `order_by` in `query`
|
||||
- `search_text` in `query`
|
||||
- `start_position` in `query`
|
||||
- `status` in `query`
|
||||
|
||||
### bulk_send_v2_crud_get_bulk_send_lists
|
||||
|
||||
- Operation ID: `bulk_send_v2_crud_get_bulk_send_lists`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/bulk_send_lists`
|
||||
- Mode: READ
|
||||
- Summary: Gets bulk send lists.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### bulk_send_v2_crud_post_bulk_send_list
|
||||
|
||||
- Operation ID: `bulk_send_v2_crud_post_bulk_send_list`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/bulk_send_lists`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a bulk send list.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### bulk_send_v2_crud_get_bulk_send_list
|
||||
|
||||
- Operation ID: `bulk_send_v2_crud_get_bulk_send_list`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets a specific bulk send list.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `bulkSendListId` in `path` required
|
||||
|
||||
### bulk_send_v2_crud_put_bulk_send_list
|
||||
|
||||
- Operation ID: `bulk_send_v2_crud_put_bulk_send_list`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates a bulk send list.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `bulkSendListId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### bulk_send_v2_crud_delete_bulk_send_list
|
||||
|
||||
- Operation ID: `bulk_send_v2_crud_delete_bulk_send_list`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a bulk send list.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `bulkSendListId` in `path` required
|
||||
|
||||
### bulk_send_v2_send_post_bulk_send_request
|
||||
|
||||
- Operation ID: `bulk_send_v2_send_post_bulk_send_request`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a bulk send request.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `bulkSendListId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### bulk_send_v2_test_post_bulk_send_test_request
|
||||
|
||||
- Operation ID: `bulk_send_v2_test_post_bulk_send_test_request`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a bulk send test.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `bulkSendListId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### captive_recipients_delete_captive_recipients_part
|
||||
|
||||
- Operation ID: `captive_recipients_delete_captive_recipients_part`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/captive_recipients/{recipientPart}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the signature for one or more captive recipient records.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `recipientPart` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### chunked_uploads_post_chunked_uploads
|
||||
|
||||
- Operation ID: `chunked_uploads_post_chunked_uploads`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/chunked_uploads`
|
||||
- Mode: WRITE
|
||||
- Summary: Initiate a new chunked upload.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### chunked_uploads_get_chunked_upload
|
||||
|
||||
- Operation ID: `chunked_uploads_get_chunked_upload`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves metadata about a chunked upload.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `chunkedUploadId` in `path` required
|
||||
- `include` in `query`
|
||||
|
||||
### chunked_uploads_put_chunked_uploads
|
||||
|
||||
- Operation ID: `chunked_uploads_put_chunked_uploads`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Commit a chunked upload.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `chunkedUploadId` in `path` required
|
||||
- `action` in `query`
|
||||
|
||||
### chunked_uploads_delete_chunked_upload
|
||||
|
||||
- Operation ID: `chunked_uploads_delete_chunked_upload`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a chunked upload.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `chunkedUploadId` in `path` required
|
||||
|
||||
### chunked_uploads_put_chunked_upload_part
|
||||
|
||||
- Operation ID: `chunked_uploads_put_chunked_upload_part`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}`
|
||||
- Mode: WRITE
|
||||
- Summary: Add a chunk to an existing chunked upload.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `chunkedUploadId` in `path` required
|
||||
- `chunkedUploadPartSeq` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### connect_get_connect_configs
|
||||
|
||||
- Operation ID: `connect_get_connect_configs`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/connect`
|
||||
- Mode: READ
|
||||
- Summary: Get Connect configuration information.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### connect_put_connect_configuration
|
||||
|
||||
- Operation ID: `connect_put_connect_configuration`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/connect`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates a specified Connect configuration.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### connect_post_connect_configuration
|
||||
|
||||
- Operation ID: `connect_post_connect_configuration`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/connect`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a Connect configuration.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### connect_get_connect_config
|
||||
|
||||
- Operation ID: `connect_get_connect_config`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/connect/{connectId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets the details about a Connect configuration.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `connectId` in `path` required
|
||||
|
||||
### connect_delete_connect_config
|
||||
|
||||
- Operation ID: `connect_delete_connect_config`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/connect/{connectId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the specified Connect configuration.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `connectId` in `path` required
|
||||
|
||||
### connect_get_connect_all_users
|
||||
|
||||
- Operation ID: `connect_get_connect_all_users`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/connect/{connectId}/all/users`
|
||||
- Mode: READ
|
||||
- Summary: Returns all users from the configured Connect service.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `connectId` in `path` required
|
||||
- `count` in `query`
|
||||
- `domain_users_only` in `query`
|
||||
- `email_substring` in `query`
|
||||
- `start_position` in `query`
|
||||
- `status` in `query`
|
||||
- `user_name_substring` in `query`
|
||||
|
||||
### connect_get_connect_users
|
||||
|
||||
- Operation ID: `connect_get_connect_users`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/connect/{connectId}/users`
|
||||
- Mode: READ
|
||||
- Summary: Returns users from the configured Connect service.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `connectId` in `path` required
|
||||
- `count` in `query`
|
||||
- `email_substring` in `query`
|
||||
- `list_included_users` in `query`
|
||||
- `start_position` in `query`
|
||||
- `status` in `query`
|
||||
- `user_name_substring` in `query`
|
||||
|
||||
### connect_publish_put_connect_retry_by_envelope
|
||||
|
||||
- Operation ID: `connect_publish_put_connect_retry_by_envelope`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue`
|
||||
- Mode: WRITE
|
||||
- Summary: Republishes Connect information for the specified envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### historical_envelope_publish_post_historical_envelope_publish_transaction
|
||||
|
||||
- Operation ID: `historical_envelope_publish_post_historical_envelope_publish_transaction`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/connect/envelopes/publish/historical`
|
||||
- Mode: WRITE
|
||||
- Summary: Submits a batch of historical envelopes for republish to a webhook.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### connect_publish_put_connect_retry
|
||||
|
||||
- Operation ID: `connect_publish_put_connect_retry`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/connect/envelopes/retry_queue`
|
||||
- Mode: WRITE
|
||||
- Summary: Republishes Connect information for multiple envelopes.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### connect_failures_get_connect_logs
|
||||
|
||||
- Operation ID: `connect_failures_get_connect_logs`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/connect/failures`
|
||||
- Mode: READ
|
||||
- Summary: Gets the Connect failure log information.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `from_date` in `query`
|
||||
- `to_date` in `query`
|
||||
|
||||
### connect_failures_delete_connect_failure_log
|
||||
|
||||
- Operation ID: `connect_failures_delete_connect_failure_log`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/connect/failures/{failureId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a Connect failure log entry.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `failureId` in `path` required
|
||||
|
||||
### connect_log_get_connect_logs
|
||||
|
||||
- Operation ID: `connect_log_get_connect_logs`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/connect/logs`
|
||||
- Mode: READ
|
||||
- Summary: Gets the Connect log.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `from_date` in `query`
|
||||
- `to_date` in `query`
|
||||
|
||||
### connect_log_delete_connect_logs
|
||||
|
||||
- Operation ID: `connect_log_delete_connect_logs`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/connect/logs`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a list of Connect log entries.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### connect_log_get_connect_log
|
||||
|
||||
- Operation ID: `connect_log_get_connect_log`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/connect/logs/{logId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets a Connect log entry.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `logId` in `path` required
|
||||
- `additional_info` in `query`
|
||||
|
||||
### connect_log_delete_connect_log
|
||||
|
||||
- Operation ID: `connect_log_delete_connect_log`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/connect/logs/{logId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a specified Connect log entry.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `logId` in `path` required
|
||||
|
||||
### connect_o_auth_config_get_connect_o_auth_config
|
||||
|
||||
- Operation ID: `connect_o_auth_config_get_connect_o_auth_config`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/connect/oauth`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves the Connect OAuth information for the account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### connect_o_auth_config_put_connect_o_auth_config
|
||||
|
||||
- Operation ID: `connect_o_auth_config_put_connect_o_auth_config`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/connect/oauth`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the existing Connect OAuth configuration for the account.
|
||||
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### connect_o_auth_config_post_connect_o_auth_config
|
||||
|
||||
- Operation ID: `connect_o_auth_config_post_connect_o_auth_config`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/connect/oauth`
|
||||
- Mode: WRITE
|
||||
- Summary: Set up Connect OAuth for the specified account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### connect_o_auth_config_delete_connect_o_auth_config
|
||||
|
||||
- Operation ID: `connect_o_auth_config_delete_connect_o_auth_config`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/connect/oauth`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete the Connect OAuth configuration.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### connect_hmac_get_connect_secret
|
||||
|
||||
- Operation ID: `connect_hmac_get_connect_secret`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/connect/secret`
|
||||
- Mode: READ
|
||||
- Summary: ConnectHMAC_GetConnectSecret
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### connect_hmac_create_connect_secret
|
||||
|
||||
- Operation ID: `connect_hmac_create_connect_secret`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/connect/secret`
|
||||
- Mode: WRITE
|
||||
- Summary: Generates a new connect HMAC Secret.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### connect_hmac_delete_connect_secret
|
||||
|
||||
- Operation ID: `connect_hmac_delete_connect_secret`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/connect/secret/{keyId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the connect HMAC Secret for specified account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `keyId` in `path` required
|
||||
|
||||
### consumer_disclosure_get_consumer_disclosure
|
||||
|
||||
- Operation ID: `consumer_disclosure_get_consumer_disclosure`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/consumer_disclosure`
|
||||
- Mode: READ
|
||||
- Summary: Gets the default Electronic Record and Signature Disclosure for an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `langCode` in `query`
|
||||
|
||||
### consumer_disclosure_get_consumer_disclosure_lang_code
|
||||
|
||||
- Operation ID: `consumer_disclosure_get_consumer_disclosure_lang_code`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/consumer_disclosure/{langCode}`
|
||||
- Mode: READ
|
||||
- Summary: Gets the Electronic Record and Signature Disclosure for an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `langCode` in `path` required
|
||||
|
||||
### consumer_disclosure_put_consumer_disclosure
|
||||
|
||||
- Operation ID: `consumer_disclosure_put_consumer_disclosure`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/consumer_disclosure/{langCode}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the Electronic Record and Signature Disclosure for an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `langCode` in `path` required
|
||||
- `include_metadata` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### contacts_put_contacts
|
||||
|
||||
- Operation ID: `contacts_put_contacts`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/contacts`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates one or more contacts.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### contacts_post_contacts
|
||||
|
||||
- Operation ID: `contacts_post_contacts`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/contacts`
|
||||
- Mode: WRITE
|
||||
- Summary: Add contacts to a contacts list.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### contacts_delete_contacts
|
||||
|
||||
- Operation ID: `contacts_delete_contacts`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/contacts`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes multiple contacts from an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### contacts_get_contact_by_id
|
||||
|
||||
- Operation ID: `contacts_get_contact_by_id`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/contacts/{contactId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets one or more contacts.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `contactId` in `path` required
|
||||
- `cloud_provider` in `query`
|
||||
|
||||
### contacts_delete_contact_with_id
|
||||
|
||||
- Operation ID: `contacts_delete_contact_with_id`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/contacts/{contactId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a contact.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `contactId` in `path` required
|
||||
|
||||
### account_custom_fields_get_account_custom_fields
|
||||
|
||||
- Operation ID: `account_custom_fields_get_account_custom_fields`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/custom_fields`
|
||||
- Mode: READ
|
||||
- Summary: Gets a list of custom fields.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### account_custom_fields_post_account_custom_fields
|
||||
|
||||
- Operation ID: `account_custom_fields_post_account_custom_fields`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/custom_fields`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates an account custom field.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `apply_to_templates` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
997
skills/accounts-2/SKILL.md
Normal file
997
skills/accounts-2/SKILL.md
Normal file
@@ -0,0 +1,997 @@
|
||||
---
|
||||
name: accounts-2-routes
|
||||
description: Handle 80 OpenAPI operation(s) under /v2.1/accounts/{accountId} for the accounts 2 route group.
|
||||
---
|
||||
|
||||
# accounts 2 API Routes
|
||||
|
||||
Handle 80 OpenAPI operation(s) under /v2.1/accounts/{accountId} for the accounts 2 route group.
|
||||
|
||||
Use the generated operation tools to make real API calls. Do not invent API responses.
|
||||
If a tool reports missing setup, return the exact setup field name to the caller.
|
||||
For write, update, or delete operations, state the intended action before calling the tool.
|
||||
|
||||
## Operations
|
||||
|
||||
### account_custom_fields_put_account_custom_fields
|
||||
|
||||
- Operation ID: `account_custom_fields_put_account_custom_fields`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/custom_fields/{customFieldId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates an account custom field.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `customFieldId` in `path` required
|
||||
- `apply_to_templates` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### account_custom_fields_delete_account_custom_fields
|
||||
|
||||
- Operation ID: `account_custom_fields_delete_account_custom_fields`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/custom_fields/{customFieldId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes an account custom field.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `customFieldId` in `path` required
|
||||
- `apply_to_templates` in `query`
|
||||
|
||||
### envelopes_get_envelopes
|
||||
|
||||
- Operation ID: `envelopes_get_envelopes`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes`
|
||||
- Mode: READ
|
||||
- Summary: Search for specific sets of envelopes by using search filters.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `ac_status` in `query`
|
||||
- `block` in `query`
|
||||
- `cdse_mode` in `query`
|
||||
- `continuation_token` in `query`
|
||||
- `count` in `query`
|
||||
- `custom_field` in `query`
|
||||
- `email` in `query`
|
||||
- `envelope_ids` in `query`
|
||||
- `exclude` in `query`
|
||||
- `folder_ids` in `query`
|
||||
- `folder_types` in `query`
|
||||
- `from_date` in `query`
|
||||
- `from_to_status` in `query`
|
||||
- `include` in `query`
|
||||
- `include_purge_information` in `query`
|
||||
- `intersecting_folder_ids` in `query`
|
||||
- `last_queried_date` in `query`
|
||||
- `order` in `query`
|
||||
- `order_by` in `query`
|
||||
- `powerformids` in `query`
|
||||
- `query_budget` in `query`
|
||||
- `requester_date_format` in `query`
|
||||
- `search_mode` in `query`
|
||||
- `search_text` in `query`
|
||||
- `start_position` in `query`
|
||||
- `status` in `query`
|
||||
- `to_date` in `query`
|
||||
- `transaction_ids` in `query`
|
||||
- `user_filter` in `query`
|
||||
- `user_id` in `query`
|
||||
- `user_name` in `query`
|
||||
|
||||
### envelopes_post_envelopes
|
||||
|
||||
- Operation ID: `envelopes_post_envelopes`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `cdse_mode` in `query`
|
||||
- `change_routing_order` in `query`
|
||||
- `completed_documents_only` in `query`
|
||||
- `merge_roles_on_draft` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### envelopes_get_envelope
|
||||
|
||||
- Operation ID: `envelopes_get_envelope`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets the status of a single envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `advanced_update` in `query`
|
||||
- `include` in `query`
|
||||
- `include_anchor_tab_locations` in `query`
|
||||
- `user_id` in `query`
|
||||
|
||||
### envelopes_put_envelope
|
||||
|
||||
- Operation ID: `envelopes_put_envelope`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Send, void, or modify a draft envelope. Purge documents from a completed envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `advanced_update` in `query`
|
||||
- `recycle_on_void` in `query`
|
||||
- `resend_envelope` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### attachments_get_attachments
|
||||
|
||||
- Operation ID: `attachments_get_attachments`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments`
|
||||
- Mode: READ
|
||||
- Summary: Returns a list of envelope attachments associated with a specified envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### attachments_put_attachments
|
||||
|
||||
- Operation ID: `attachments_put_attachments`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds one or more envelope attachments to a draft or in-process envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### attachments_delete_attachments
|
||||
|
||||
- Operation ID: `attachments_delete_attachments`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes one or more envelope attachments from a draft envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### attachments_get_attachment
|
||||
|
||||
- Operation ID: `attachments_get_attachment`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves an envelope attachment from an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `attachmentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### attachments_put_attachment
|
||||
|
||||
- Operation ID: `attachments_put_attachment`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates an envelope attachment in a draft or in-process envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `attachmentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### audit_events_get_audit_events
|
||||
|
||||
- Operation ID: `audit_events_get_audit_events`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events`
|
||||
- Mode: READ
|
||||
- Summary: Gets the envelope audit events for an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `locale` in `query`
|
||||
|
||||
### comments_get_comments_transcript
|
||||
|
||||
- Operation ID: `comments_get_comments_transcript`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript`
|
||||
- Mode: READ
|
||||
- Summary: Gets a PDF transcript of all of the comments in an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `encoding` in `query`
|
||||
|
||||
### custom_fields_get_custom_fields
|
||||
|
||||
- Operation ID: `custom_fields_get_custom_fields`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields`
|
||||
- Mode: READ
|
||||
- Summary: Gets the custom field information for the specified envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### custom_fields_put_custom_fields
|
||||
|
||||
- Operation ID: `custom_fields_put_custom_fields`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates envelope custom fields in an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### custom_fields_post_custom_fields
|
||||
|
||||
- Operation ID: `custom_fields_post_custom_fields`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates envelope custom fields for an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### custom_fields_delete_custom_fields
|
||||
|
||||
- Operation ID: `custom_fields_delete_custom_fields`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes envelope custom fields for draft and in-process envelopes.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### doc_gen_form_fields_get_envelope_doc_gen_form_fields
|
||||
|
||||
- Operation ID: `doc_gen_form_fields_get_envelope_doc_gen_form_fields`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields`
|
||||
- Mode: READ
|
||||
- Summary: Returns sender fields for an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### doc_gen_form_fields_put_envelope_doc_gen_form_fields
|
||||
|
||||
- Operation ID: `doc_gen_form_fields_put_envelope_doc_gen_form_fields`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates sender fields for an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `update_docgen_formfields_only` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### documents_get_documents
|
||||
|
||||
- Operation ID: `documents_get_documents`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents`
|
||||
- Mode: READ
|
||||
- Summary: Gets a list of documents in an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `documents_by_userid` in `query`
|
||||
- `include_agreement_type` in `query`
|
||||
- `include_docgen_formfields` in `query`
|
||||
- `include_is_edited` in `query`
|
||||
- `include_metadata` in `query`
|
||||
- `include_tabs` in `query`
|
||||
- `recipient_id` in `query`
|
||||
- `shared_user_id` in `query`
|
||||
|
||||
### documents_put_documents
|
||||
|
||||
- Operation ID: `documents_put_documents`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds one or more documents to an existing envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### documents_delete_documents
|
||||
|
||||
- Operation ID: `documents_delete_documents`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes documents from a draft envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### documents_get_document
|
||||
|
||||
- Operation ID: `documents_get_document`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves a single document or all documents from an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `certificate` in `query`
|
||||
- `documents_by_userid` in `query`
|
||||
- `encoding` in `query`
|
||||
- `encrypt` in `query`
|
||||
- `language` in `query`
|
||||
- `recipient_id` in `query`
|
||||
- `shared_user_id` in `query`
|
||||
- `show_changes` in `query`
|
||||
- `watermark` in `query`
|
||||
|
||||
### documents_put_document
|
||||
|
||||
- Operation ID: `documents_put_document`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds or replaces a document in an existing envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### document_fields_get_document_fields
|
||||
|
||||
- Operation ID: `document_fields_get_document_fields`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields`
|
||||
- Mode: READ
|
||||
- Summary: Gets the custom document fields from an existing envelope document.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### document_fields_put_document_fields
|
||||
|
||||
- Operation ID: `document_fields_put_document_fields`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates existing custom document fields in an existing envelope document.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### document_fields_post_document_fields
|
||||
|
||||
- Operation ID: `document_fields_post_document_fields`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates custom document fields in an existing envelope document.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### document_fields_delete_document_fields
|
||||
|
||||
- Operation ID: `document_fields_delete_document_fields`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes custom document fields from an existing envelope document.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### responsive_html_get_envelope_document_html_definitions
|
||||
|
||||
- Operation ID: `responsive_html_get_envelope_document_html_definitions`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves the HTML definition used to generate a dynamically sized responsive document.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### pages_get_page_images
|
||||
|
||||
- Operation ID: `pages_get_page_images`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages`
|
||||
- Mode: READ
|
||||
- Summary: Returns document page images based on input.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `count` in `query`
|
||||
- `dpi` in `query`
|
||||
- `max_height` in `query`
|
||||
- `max_width` in `query`
|
||||
- `nocache` in `query`
|
||||
- `show_changes` in `query`
|
||||
- `start_position` in `query`
|
||||
|
||||
### pages_delete_page
|
||||
|
||||
- Operation ID: `pages_delete_page`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a page from a document in an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `pageNumber` in `path` required
|
||||
|
||||
### pages_get_page_image
|
||||
|
||||
- Operation ID: `pages_get_page_image`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image`
|
||||
- Mode: READ
|
||||
- Summary: Gets a page image from an envelope for display.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `pageNumber` in `path` required
|
||||
- `dpi` in `query`
|
||||
- `max_height` in `query`
|
||||
- `max_width` in `query`
|
||||
- `show_changes` in `query`
|
||||
|
||||
### pages_put_page_image
|
||||
|
||||
- Operation ID: `pages_put_page_image`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image`
|
||||
- Mode: WRITE
|
||||
- Summary: Rotates page image from an envelope for display.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `pageNumber` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### tabs_get_page_tabs
|
||||
|
||||
- Operation ID: `tabs_get_page_tabs`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs`
|
||||
- Mode: READ
|
||||
- Summary: Returns tabs on the specified page.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `pageNumber` in `path` required
|
||||
|
||||
### responsive_html_post_document_responsive_html_preview
|
||||
|
||||
- Operation ID: `responsive_html_post_document_responsive_html_preview`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a preview of the responsive version of a document.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### tabs_get_document_tabs
|
||||
|
||||
- Operation ID: `tabs_get_document_tabs`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs`
|
||||
- Mode: READ
|
||||
- Summary: Returns the tabs on a document.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `include_metadata` in `query`
|
||||
- `page_numbers` in `query`
|
||||
|
||||
### tabs_put_document_tabs
|
||||
|
||||
- Operation ID: `tabs_put_document_tabs`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the tabs for document.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### tabs_post_document_tabs
|
||||
|
||||
- Operation ID: `tabs_post_document_tabs`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds tabs to a document in an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### tabs_delete_document_tabs
|
||||
|
||||
- Operation ID: `tabs_delete_document_tabs`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes tabs from a document in an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### templates_get_document_templates
|
||||
|
||||
- Operation ID: `templates_get_document_templates`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates`
|
||||
- Mode: READ
|
||||
- Summary: Gets the templates associated with a document in an existing envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `include` in `query`
|
||||
|
||||
### templates_post_document_templates
|
||||
|
||||
- Operation ID: `templates_post_document_templates`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds templates to a document in an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `preserve_template_recipient` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### templates_delete_document_templates
|
||||
|
||||
- Operation ID: `templates_delete_document_templates`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a template from a document in an existing envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
|
||||
### email_settings_get_email_settings
|
||||
|
||||
- Operation ID: `email_settings_get_email_settings`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings`
|
||||
- Mode: READ
|
||||
- Summary: Gets the email setting overrides for an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### email_settings_put_email_settings
|
||||
|
||||
- Operation ID: `email_settings_put_email_settings`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the email setting overrides for an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### email_settings_post_email_settings
|
||||
|
||||
- Operation ID: `email_settings_post_email_settings`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds email setting overrides to an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### email_settings_delete_email_settings
|
||||
|
||||
- Operation ID: `email_settings_delete_email_settings`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the email setting overrides for an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### form_data_get_form_data
|
||||
|
||||
- Operation ID: `form_data_get_form_data`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data`
|
||||
- Mode: READ
|
||||
- Summary: Returns envelope tab data for an existing envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### responsive_html_get_envelope_html_definitions
|
||||
|
||||
- Operation ID: `responsive_html_get_envelope_html_definitions`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions`
|
||||
- Mode: READ
|
||||
- Summary: Gets the Original HTML Definition used to generate the Responsive HTML for the envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### lock_get_envelope_lock
|
||||
|
||||
- Operation ID: `lock_get_envelope_lock`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock`
|
||||
- Mode: READ
|
||||
- Summary: Gets envelope lock information.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### lock_put_envelope_lock
|
||||
|
||||
- Operation ID: `lock_put_envelope_lock`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates an envelope lock.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### lock_post_envelope_lock
|
||||
|
||||
- Operation ID: `lock_post_envelope_lock`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock`
|
||||
- Mode: WRITE
|
||||
- Summary: Locks an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### lock_delete_envelope_lock
|
||||
|
||||
- Operation ID: `lock_delete_envelope_lock`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes an envelope lock.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### notification_get_envelopes_envelope_id_notification
|
||||
|
||||
- Operation ID: `notification_get_envelopes_envelope_id_notification`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification`
|
||||
- Mode: READ
|
||||
- Summary: Gets envelope notification information.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### notification_put_envelopes_envelope_id_notification
|
||||
|
||||
- Operation ID: `notification_put_envelopes_envelope_id_notification`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification`
|
||||
- Mode: WRITE
|
||||
- Summary: Sets envelope notifications for an existing envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### recipients_get_recipients
|
||||
|
||||
- Operation ID: `recipients_get_recipients`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients`
|
||||
- Mode: READ
|
||||
- Summary: Gets the status of recipients for an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `include_anchor_tab_locations` in `query`
|
||||
- `include_extended` in `query`
|
||||
- `include_metadata` in `query`
|
||||
- `include_tabs` in `query`
|
||||
|
||||
### recipients_put_recipients
|
||||
|
||||
- Operation ID: `recipients_put_recipients`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates recipients in a draft envelope or corrects recipient information for an in-process envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `combine_same_order_recipients` in `query`
|
||||
- `offline_signing` in `query`
|
||||
- `resend_envelope` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### recipients_post_recipients
|
||||
|
||||
- Operation ID: `recipients_post_recipients`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds one or more recipients to an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `resend_envelope` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### recipients_delete_recipients
|
||||
|
||||
- Operation ID: `recipients_delete_recipients`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes recipients from an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### recipients_delete_recipient
|
||||
|
||||
- Operation ID: `recipients_delete_recipient`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a recipient from an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
|
||||
### consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id
|
||||
|
||||
- Operation ID: `consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure`
|
||||
- Mode: READ
|
||||
- Summary: Gets the default Electronic Record and Signature Disclosure for an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- `langCode` in `query`
|
||||
|
||||
### consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id_lang_code
|
||||
|
||||
- Operation ID: `consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id_lang_code`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}`
|
||||
- Mode: READ
|
||||
- Summary: Gets the Electronic Record and Signature Disclosure for a specific envelope recipient.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `langCode` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- `langCode` in `query`
|
||||
|
||||
### recipients_get_recipient_document_visibility
|
||||
|
||||
- Operation ID: `recipients_get_recipient_document_visibility`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility`
|
||||
- Mode: READ
|
||||
- Summary: Returns document visibility for a recipient
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
|
||||
### recipients_put_recipient_document_visibility
|
||||
|
||||
- Operation ID: `recipients_put_recipient_document_visibility`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates document visibility for a recipient
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### recipients_post_recipient_proof_file_resource_token
|
||||
|
||||
- Operation ID: `recipients_post_recipient_proof_file_resource_token`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a resource token for a sender to request ID Evidence data.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- `token_scopes` in `query`
|
||||
|
||||
### recipients_get_recipient_initials_image
|
||||
|
||||
- Operation ID: `recipients_get_recipient_initials_image`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image`
|
||||
- Mode: READ
|
||||
- Summary: Gets the initials image for a user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- `include_chrome` in `query`
|
||||
|
||||
### recipients_put_recipient_initials_image
|
||||
|
||||
- Operation ID: `recipients_put_recipient_initials_image`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image`
|
||||
- Mode: WRITE
|
||||
- Summary: Sets the initials image for an accountless signer.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
|
||||
### recipients_get_recipient_signature
|
||||
|
||||
- Operation ID: `recipients_get_recipient_signature`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature`
|
||||
- Mode: READ
|
||||
- Summary: Gets signature information for a signer or sign-in-person recipient.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
|
||||
### recipients_get_recipient_signature_image
|
||||
|
||||
- Operation ID: `recipients_get_recipient_signature_image`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image`
|
||||
- Mode: READ
|
||||
- Summary: Retrieve signature image information for a signer/sign-in-person recipient.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- `include_chrome` in `query`
|
||||
|
||||
### recipients_put_recipient_signature_image
|
||||
|
||||
- Operation ID: `recipients_put_recipient_signature_image`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image`
|
||||
- Mode: WRITE
|
||||
- Summary: Sets the signature image for an accountless signer.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
|
||||
### recipients_get_recipient_tabs
|
||||
|
||||
- Operation ID: `recipients_get_recipient_tabs`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs`
|
||||
- Mode: READ
|
||||
- Summary: Gets the tabs information for a signer or sign-in-person recipient in an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- `include_anchor_tab_locations` in `query`
|
||||
- `include_metadata` in `query`
|
||||
|
||||
### recipients_put_recipient_tabs
|
||||
|
||||
- Operation ID: `recipients_put_recipient_tabs`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the tabs for a recipient.
|
||||
|
||||
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### recipients_post_recipient_tabs
|
||||
|
||||
- Operation ID: `recipients_post_recipient_tabs`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds tabs for a recipient.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### recipients_delete_recipient_tabs
|
||||
|
||||
- Operation ID: `recipients_delete_recipient_tabs`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the tabs associated with a recipient.
|
||||
|
||||
**Note:** It is an error to delete a tab that has the
|
||||
`templateLocked` property set to true.
|
||||
This property corresponds to the **Restrict changes** option in the web app.
|
||||
|
||||
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### views_post_recipient_manual_review_view
|
||||
|
||||
- Operation ID: `views_post_recipient_manual_review_view`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/views/identity_manual_review`
|
||||
- Mode: WRITE
|
||||
- Summary: Create the link to the page for manually reviewing IDs.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
|
||||
### recipients_put_recipients_document_visibility
|
||||
|
||||
- Operation ID: `recipients_put_recipients_document_visibility`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates document visibility for recipients
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### responsive_html_post_responsive_html_preview
|
||||
|
||||
- Operation ID: `responsive_html_post_responsive_html_preview`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a preview of the responsive versions of all of the documents in an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### envelopes_shares_get_envelopes_shares
|
||||
|
||||
- Operation ID: `envelopes_shares_get_envelopes_shares`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares`
|
||||
- Mode: READ
|
||||
- Summary: EnvelopesShares_GetEnvelopesShares
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### envelopes_shares_put_envelopes_shares
|
||||
|
||||
- Operation ID: `envelopes_shares_put_envelopes_shares`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares`
|
||||
- Mode: WRITE
|
||||
- Summary: EnvelopesShares_PutEnvelopesShares
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### envelopes_shares_post_envelopes_shares
|
||||
|
||||
- Operation ID: `envelopes_shares_post_envelopes_shares`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares`
|
||||
- Mode: WRITE
|
||||
- Summary: EnvelopesShares_PostEnvelopesShares
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### envelopes_shares_delete_envelopes_shares
|
||||
|
||||
- Operation ID: `envelopes_shares_delete_envelopes_shares`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares`
|
||||
- Mode: WRITE
|
||||
- Summary: EnvelopesShares_DeleteEnvelopesShares
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
905
skills/accounts-3/SKILL.md
Normal file
905
skills/accounts-3/SKILL.md
Normal file
@@ -0,0 +1,905 @@
|
||||
---
|
||||
name: accounts-3-routes
|
||||
description: Handle 80 OpenAPI operation(s) under /v2.1/accounts/{accountId} for the accounts 3 route group.
|
||||
---
|
||||
|
||||
# accounts 3 API Routes
|
||||
|
||||
Handle 80 OpenAPI operation(s) under /v2.1/accounts/{accountId} for the accounts 3 route group.
|
||||
|
||||
Use the generated operation tools to make real API calls. Do not invent API responses.
|
||||
If a tool reports missing setup, return the exact setup field name to the caller.
|
||||
For write, update, or delete operations, state the intended action before calling the tool.
|
||||
|
||||
## Operations
|
||||
|
||||
### envelopes_shares_get_envelopes_share
|
||||
|
||||
- Operation ID: `envelopes_shares_get_envelopes_share`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}`
|
||||
- Mode: READ
|
||||
- Summary: EnvelopesShares_GetEnvelopesShare
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `shareId` in `path` required
|
||||
|
||||
### envelopes_shares_put_envelopes_share
|
||||
|
||||
- Operation ID: `envelopes_shares_put_envelopes_share`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}`
|
||||
- Mode: WRITE
|
||||
- Summary: EnvelopesShares_PutEnvelopesShare
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `shareId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### envelopes_shares_delete_envelopes_share
|
||||
|
||||
- Operation ID: `envelopes_shares_delete_envelopes_share`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}`
|
||||
- Mode: WRITE
|
||||
- Summary: EnvelopesShares_DeleteEnvelopesShare
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `shareId` in `path` required
|
||||
|
||||
### tabs_blob_get_tabs_blob
|
||||
|
||||
- Operation ID: `tabs_blob_get_tabs_blob`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob`
|
||||
- Mode: READ
|
||||
- Summary: Reserved for Docusign.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### tabs_blob_put_tabs_blob
|
||||
|
||||
- Operation ID: `tabs_blob_put_tabs_blob`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob`
|
||||
- Mode: WRITE
|
||||
- Summary: Reserved for Docusign.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### templates_get_envelope_templates
|
||||
|
||||
- Operation ID: `templates_get_envelope_templates`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates`
|
||||
- Mode: READ
|
||||
- Summary: Gets templates used in an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `include` in `query`
|
||||
|
||||
### templates_post_envelope_templates
|
||||
|
||||
- Operation ID: `templates_post_envelope_templates`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds templates to an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `preserve_template_recipient` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### views_post_envelope_correct_view
|
||||
|
||||
- Operation ID: `views_post_envelope_correct_view`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct`
|
||||
- Mode: WRITE
|
||||
- Summary: Returns a URL to the envelope correction UI. Use after an envelope has been sent.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### views_delete_envelope_correct_view
|
||||
|
||||
- Operation ID: `views_delete_envelope_correct_view`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct`
|
||||
- Mode: WRITE
|
||||
- Summary: Revokes the correction view URL to the Envelope UI.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### views_post_envelope_edit_view
|
||||
|
||||
- Operation ID: `views_post_envelope_edit_view`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit`
|
||||
- Mode: WRITE
|
||||
- Summary: Returns a URL to the edit view UI. Use before an envelope has been sent.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### views_post_envelope_recipient_view
|
||||
|
||||
- Operation ID: `views_post_envelope_recipient_view`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient`
|
||||
- Mode: WRITE
|
||||
- Summary: Returns a URL to the recipient view UI. For signer recipients, returns the embedded signing view. Can also be used for other recipient types.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### views_post_envelope_recipient_preview
|
||||
|
||||
- Operation ID: `views_post_envelope_recipient_preview`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates an envelope recipient preview.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### views_post_envelope_sender_view
|
||||
|
||||
- Operation ID: `views_post_envelope_sender_view`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender`
|
||||
- Mode: WRITE
|
||||
- Summary: Returns a URL to the sender view UI. Used before an envelope has been sent.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### views_post_envelope_recipient_shared_view
|
||||
|
||||
- Operation ID: `views_post_envelope_recipient_shared_view`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared`
|
||||
- Mode: WRITE
|
||||
- Summary: Returns a URL to the shared recipient view UI for an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### envelope_workflow_definition_v2_get_envelope_workflow_definition
|
||||
|
||||
- Operation ID: `envelope_workflow_definition_v2_get_envelope_workflow_definition`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow`
|
||||
- Mode: READ
|
||||
- Summary: Returns the workflow definition for an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### envelope_workflow_definition_v2_put_envelope_workflow_definition
|
||||
|
||||
- Operation ID: `envelope_workflow_definition_v2_put_envelope_workflow_definition`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the workflow definition for an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### envelope_workflow_definition_v2_delete_envelope_workflow_definition
|
||||
|
||||
- Operation ID: `envelope_workflow_definition_v2_delete_envelope_workflow_definition`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete the workflow definition for an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### envelope_workflow_scheduled_sending_get_envelope_scheduled_sending_definition
|
||||
|
||||
- Operation ID: `envelope_workflow_scheduled_sending_get_envelope_scheduled_sending_definition`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending`
|
||||
- Mode: READ
|
||||
- Summary: Returns the scheduled sending rules for an envelope's workflow definition.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### envelope_workflow_scheduled_sending_put_envelope_scheduled_sending_definition
|
||||
|
||||
- Operation ID: `envelope_workflow_scheduled_sending_put_envelope_scheduled_sending_definition`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the scheduled sending rules for an envelope's workflow.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### envelope_workflow_scheduled_sending_delete_envelope_scheduled_sending_definition
|
||||
|
||||
- Operation ID: `envelope_workflow_scheduled_sending_delete_envelope_scheduled_sending_definition`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the scheduled sending rules for the envelope's workflow.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
|
||||
### envelope_workflow_step_post_envelope_workflow_step_definition
|
||||
|
||||
- Operation ID: `envelope_workflow_step_post_envelope_workflow_step_definition`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds a new step to an envelope's workflow.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### envelope_workflow_step_get_envelope_workflow_step_definition
|
||||
|
||||
- Operation ID: `envelope_workflow_step_get_envelope_workflow_step_definition`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}`
|
||||
- Mode: READ
|
||||
- Summary: Returns a specified workflow step for a specified template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `workflowStepId` in `path` required
|
||||
|
||||
### envelope_workflow_step_put_envelope_workflow_step_definition
|
||||
|
||||
- Operation ID: `envelope_workflow_step_put_envelope_workflow_step_definition`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the specified workflow step for an envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `workflowStepId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### envelope_workflow_step_delete_envelope_workflow_step_definition
|
||||
|
||||
- Operation ID: `envelope_workflow_step_delete_envelope_workflow_step_definition`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a workflow step from an envelope's workflow definition.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `workflowStepId` in `path` required
|
||||
|
||||
### envelope_workflow_delayed_routing_get_envelope_delayed_routing_definition
|
||||
|
||||
- Operation ID: `envelope_workflow_delayed_routing_get_envelope_delayed_routing_definition`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting`
|
||||
- Mode: READ
|
||||
- Summary: Returns the delayed routing rules for an envelope's workflow step definition.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `workflowStepId` in `path` required
|
||||
|
||||
### envelope_workflow_delayed_routing_put_envelope_delayed_routing_definition
|
||||
|
||||
- Operation ID: `envelope_workflow_delayed_routing_put_envelope_delayed_routing_definition`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the delayed routing rules for an envelope's workflow step definition.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `workflowStepId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### envelope_workflow_delayed_routing_delete_envelope_delayed_routing_definition
|
||||
|
||||
- Operation ID: `envelope_workflow_delayed_routing_delete_envelope_delayed_routing_definition`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the delayed routing rules for the specified envelope workflow step.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeId` in `path` required
|
||||
- `workflowStepId` in `path` required
|
||||
|
||||
### shared_envelopes_list_get_shared_envelopes
|
||||
|
||||
- Operation ID: `shared_envelopes_list_get_shared_envelopes`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/shared`
|
||||
- Mode: READ
|
||||
- Summary: SharedEnvelopesList_GetSharedEnvelopes
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `count` in `query`
|
||||
- `from_date` in `query`
|
||||
- `include` in `query`
|
||||
- `order` in `query`
|
||||
- `order_by` in `query`
|
||||
- `search_text` in `query`
|
||||
- `start_position` in `query`
|
||||
- `status` in `query`
|
||||
- `to_date` in `query`
|
||||
|
||||
### envelopes_put_status
|
||||
|
||||
- Operation ID: `envelopes_put_status`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/status`
|
||||
- Mode: WRITE
|
||||
- Summary: Gets envelope statuses for a set of envelopes.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `ac_status` in `query`
|
||||
- `block` in `query`
|
||||
- `count` in `query`
|
||||
- `email` in `query`
|
||||
- `envelope_ids` in `query`
|
||||
- `from_date` in `query`
|
||||
- `from_to_status` in `query`
|
||||
- `start_position` in `query`
|
||||
- `status` in `query`
|
||||
- `to_date` in `query`
|
||||
- `transaction_ids` in `query`
|
||||
- `user_name` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### envelope_transfer_rules_get_envelope_transfer_rules
|
||||
|
||||
- Operation ID: `envelope_transfer_rules_get_envelope_transfer_rules`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/envelopes/transfer_rules`
|
||||
- Mode: READ
|
||||
- Summary: Gets envelope transfer rules.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `count` in `query`
|
||||
- `start_position` in `query`
|
||||
|
||||
### envelope_transfer_rules_put_envelope_transfer_rules
|
||||
|
||||
- Operation ID: `envelope_transfer_rules_put_envelope_transfer_rules`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/transfer_rules`
|
||||
- Mode: WRITE
|
||||
- Summary: Changes the status of multiple envelope transfer rules.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### envelope_transfer_rules_post_envelope_transfer_rules
|
||||
|
||||
- Operation ID: `envelope_transfer_rules_post_envelope_transfer_rules`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/envelopes/transfer_rules`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates an envelope transfer rule.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### envelope_transfer_rules_put_envelope_transfer_rule
|
||||
|
||||
- Operation ID: `envelope_transfer_rules_put_envelope_transfer_rule`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Changes the status of an envelope transfer rule.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeTransferRuleId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### envelope_transfer_rules_delete_envelope_transfer_rules
|
||||
|
||||
- Operation ID: `envelope_transfer_rules_delete_envelope_transfer_rules`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes an envelope transfer rule.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `envelopeTransferRuleId` in `path` required
|
||||
|
||||
### favorite_templates_get_favorite_templates
|
||||
|
||||
- Operation ID: `favorite_templates_get_favorite_templates`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/favorite_templates`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves the list of favorite templates for the account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### favorite_templates_put_favorite_template
|
||||
|
||||
- Operation ID: `favorite_templates_put_favorite_template`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/favorite_templates`
|
||||
- Mode: WRITE
|
||||
- Summary: Set one or more templates as account favorites.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### favorite_templates_un_favorite_template
|
||||
|
||||
- Operation ID: `favorite_templates_un_favorite_template`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/favorite_templates`
|
||||
- Mode: WRITE
|
||||
- Summary: Remove one or more templates from the account favorites.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### folders_get_folders
|
||||
|
||||
- Operation ID: `folders_get_folders`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/folders`
|
||||
- Mode: READ
|
||||
- Summary: Returns a list of the account's folders.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `count` in `query`
|
||||
- `include` in `query`
|
||||
- `include_items` in `query`
|
||||
- `start_position` in `query`
|
||||
- `sub_folder_depth` in `query`
|
||||
- `template` in `query`
|
||||
- `user_filter` in `query`
|
||||
|
||||
### folders_get_folder_items
|
||||
|
||||
- Operation ID: `folders_get_folder_items`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/folders/{folderId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets information about items in a specified folder.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `folderId` in `path` required
|
||||
- `from_date` in `query`
|
||||
- `include_items` in `query`
|
||||
- `owner_email` in `query`
|
||||
- `owner_name` in `query`
|
||||
- `search_text` in `query`
|
||||
- `start_position` in `query`
|
||||
- `status` in `query`
|
||||
- `to_date` in `query`
|
||||
|
||||
### folders_put_folder_by_id
|
||||
|
||||
- Operation ID: `folders_put_folder_by_id`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/folders/{folderId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Moves a set of envelopes from their current folder to another folder.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `folderId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### groups_get_groups
|
||||
|
||||
- Operation ID: `groups_get_groups`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/groups`
|
||||
- Mode: READ
|
||||
- Summary: Gets information about groups associated with the account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `count` in `query`
|
||||
- `group_type` in `query`
|
||||
- `include_usercount` in `query`
|
||||
- `search_text` in `query`
|
||||
- `start_position` in `query`
|
||||
|
||||
### groups_put_groups
|
||||
|
||||
- Operation ID: `groups_put_groups`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/groups`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the group information for a group.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### groups_post_groups
|
||||
|
||||
- Operation ID: `groups_post_groups`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/groups`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates one or more groups for the account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### groups_delete_groups
|
||||
|
||||
- Operation ID: `groups_delete_groups`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/groups`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes an existing user group.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### brands_get_group_brands
|
||||
|
||||
- Operation ID: `brands_get_group_brands`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/groups/{groupId}/brands`
|
||||
- Mode: READ
|
||||
- Summary: Gets the brand information for a group.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `groupId` in `path` required
|
||||
|
||||
### brands_put_group_brands
|
||||
|
||||
- Operation ID: `brands_put_group_brands`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/groups/{groupId}/brands`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds an existing brand to a group.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `groupId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### brands_delete_group_brands
|
||||
|
||||
- Operation ID: `brands_delete_group_brands`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/groups/{groupId}/brands`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes brand information from a group.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `groupId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### groups_get_group_users
|
||||
|
||||
- Operation ID: `groups_get_group_users`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/groups/{groupId}/users`
|
||||
- Mode: READ
|
||||
- Summary: Gets a list of users in a group.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `groupId` in `path` required
|
||||
- `count` in `query`
|
||||
- `start_position` in `query`
|
||||
|
||||
### groups_put_group_users
|
||||
|
||||
- Operation ID: `groups_put_group_users`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/groups/{groupId}/users`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds one or more users to an existing group.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `groupId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### groups_delete_group_users
|
||||
|
||||
- Operation ID: `groups_delete_group_users`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/groups/{groupId}/users`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes one or more users from a group
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `groupId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### account_identity_verification_get_account_identity_verification
|
||||
|
||||
- Operation ID: `account_identity_verification_get_account_identity_verification`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/identity_verification`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves the Identity Verification workflows available to an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `identity_verification_workflow_status` in `query`
|
||||
|
||||
### payment_gateway_accounts_get_all_payment_gateway_accounts
|
||||
|
||||
- Operation ID: `payment_gateway_accounts_get_all_payment_gateway_accounts`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/payment_gateway_accounts`
|
||||
- Mode: READ
|
||||
- Summary: List payment gateway accounts
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### permission_profiles_get_permission_profiles
|
||||
|
||||
- Operation ID: `permission_profiles_get_permission_profiles`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/permission_profiles`
|
||||
- Mode: READ
|
||||
- Summary: Gets a list of permission profiles.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `include` in `query`
|
||||
|
||||
### permission_profiles_post_permission_profiles
|
||||
|
||||
- Operation ID: `permission_profiles_post_permission_profiles`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/permission_profiles`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a new permission profile for an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `include` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### permission_profiles_get_permission_profile
|
||||
|
||||
- Operation ID: `permission_profiles_get_permission_profile`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}`
|
||||
- Mode: READ
|
||||
- Summary: Returns a permission profile for an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `permissionProfileId` in `path` required
|
||||
- `include` in `query`
|
||||
|
||||
### permission_profiles_put_permission_profiles
|
||||
|
||||
- Operation ID: `permission_profiles_put_permission_profiles`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates a permission profile.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `permissionProfileId` in `path` required
|
||||
- `include` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### permission_profiles_delete_permission_profiles
|
||||
|
||||
- Operation ID: `permission_profiles_delete_permission_profiles`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a permission profile from an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `permissionProfileId` in `path` required
|
||||
- `move_users_to` in `query`
|
||||
|
||||
### power_forms_get_power_forms_list
|
||||
|
||||
- Operation ID: `power_forms_get_power_forms_list`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/powerforms`
|
||||
- Mode: READ
|
||||
- Summary: Returns a list of PowerForms.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `count` in `query`
|
||||
- `from_date` in `query`
|
||||
- `order` in `query`
|
||||
- `order_by` in `query`
|
||||
- `search_fields` in `query`
|
||||
- `search_text` in `query`
|
||||
- `start_position` in `query`
|
||||
- `to_date` in `query`
|
||||
|
||||
### power_forms_post_power_form
|
||||
|
||||
- Operation ID: `power_forms_post_power_form`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/powerforms`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a new PowerForm
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### power_forms_delete_power_forms_list
|
||||
|
||||
- Operation ID: `power_forms_delete_power_forms_list`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/powerforms`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes one or more PowerForms.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### power_forms_get_power_form
|
||||
|
||||
- Operation ID: `power_forms_get_power_form`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/powerforms/{powerFormId}`
|
||||
- Mode: READ
|
||||
- Summary: Returns a single PowerForm.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `powerFormId` in `path` required
|
||||
|
||||
### power_forms_put_power_form
|
||||
|
||||
- Operation ID: `power_forms_put_power_form`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/powerforms/{powerFormId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates an existing PowerForm.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `powerFormId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### power_forms_delete_power_form
|
||||
|
||||
- Operation ID: `power_forms_delete_power_form`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/powerforms/{powerFormId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a PowerForm.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `powerFormId` in `path` required
|
||||
|
||||
### power_forms_get_power_form_form_data
|
||||
|
||||
- Operation ID: `power_forms_get_power_form_form_data`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data`
|
||||
- Mode: READ
|
||||
- Summary: Returns the data that users entered in a PowerForm.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `powerFormId` in `path` required
|
||||
- `data_layout` in `query`
|
||||
- `from_date` in `query`
|
||||
- `to_date` in `query`
|
||||
|
||||
### power_forms_get_power_forms_senders
|
||||
|
||||
- Operation ID: `power_forms_get_power_forms_senders`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/powerforms/senders`
|
||||
- Mode: READ
|
||||
- Summary: Gets PowerForm senders.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `start_position` in `query`
|
||||
|
||||
### account_signature_providers_get_seal_providers
|
||||
|
||||
- Operation ID: `account_signature_providers_get_seal_providers`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/seals`
|
||||
- Mode: READ
|
||||
- Summary: Returns available seals for specified account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### search_folders_get_search_folder_contents
|
||||
|
||||
- Operation ID: `search_folders_get_search_folder_contents`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/search_folders/{searchFolderId}`
|
||||
- Mode: READ
|
||||
- Summary: Deprecated. Use Envelopes: listStatusChanges.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `searchFolderId` in `path` required
|
||||
- `all` in `query`
|
||||
- `count` in `query`
|
||||
- `from_date` in `query`
|
||||
- `include_recipients` in `query`
|
||||
- `order` in `query`
|
||||
- `order_by` in `query`
|
||||
- `start_position` in `query`
|
||||
- `to_date` in `query`
|
||||
|
||||
### settings_get_settings
|
||||
|
||||
- Operation ID: `settings_get_settings`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/settings`
|
||||
- Mode: READ
|
||||
- Summary: Gets account settings information.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### settings_put_settings
|
||||
|
||||
- Operation ID: `settings_put_settings`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/settings`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the account settings for an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### bcc_email_archive_get_bcc_email_archive_list
|
||||
|
||||
- Operation ID: `bcc_email_archive_get_bcc_email_archive_list`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/settings/bcc_email_archives`
|
||||
- Mode: READ
|
||||
- Summary: Gets the BCC email archive configurations for an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `count` in `query`
|
||||
- `start_position` in `query`
|
||||
|
||||
### bcc_email_archive_post_bcc_email_archive
|
||||
|
||||
- Operation ID: `bcc_email_archive_post_bcc_email_archive`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/settings/bcc_email_archives`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a BCC email archive configuration.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### bcc_email_archive_get_bcc_email_archive_history_list
|
||||
|
||||
- Operation ID: `bcc_email_archive_get_bcc_email_archive_history_list`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets a BCC email archive configuration and its history.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `bccEmailArchiveId` in `path` required
|
||||
- `count` in `query`
|
||||
- `start_position` in `query`
|
||||
|
||||
### bcc_email_archive_delete_bcc_email_archive
|
||||
|
||||
- Operation ID: `bcc_email_archive_delete_bcc_email_archive`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a BCC email archive configuration.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `bccEmailArchiveId` in `path` required
|
||||
|
||||
### e_note_configuration_get_e_note_configuration
|
||||
|
||||
- Operation ID: `e_note_configuration_get_e_note_configuration`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/settings/enote_configuration`
|
||||
- Mode: READ
|
||||
- Summary: Returns the configuration information for the eNote eOriginal integration.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### e_note_configuration_put_e_note_configuration
|
||||
|
||||
- Operation ID: `e_note_configuration_put_e_note_configuration`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/settings/enote_configuration`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates configuration information for the eNote eOriginal integration.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### e_note_configuration_delete_e_note_configuration
|
||||
|
||||
- Operation ID: `e_note_configuration_delete_e_note_configuration`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/settings/enote_configuration`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes configuration information for the eNote eOriginal integration.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### envelope_purge_configuration_get_envelope_purge_configuration
|
||||
|
||||
- Operation ID: `envelope_purge_configuration_get_envelope_purge_configuration`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/settings/envelope_purge_configuration`
|
||||
- Mode: READ
|
||||
- Summary: Gets the envelope purge configuration for an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### envelope_purge_configuration_put_envelope_purge_configuration
|
||||
|
||||
- Operation ID: `envelope_purge_configuration_put_envelope_purge_configuration`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/settings/envelope_purge_configuration`
|
||||
- Mode: WRITE
|
||||
- Summary: Sets the envelope purge configuration for an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### notification_defaults_get_notification_defaults
|
||||
|
||||
- Operation ID: `notification_defaults_get_notification_defaults`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/settings/notification_defaults`
|
||||
- Mode: READ
|
||||
- Summary: Gets envelope notification defaults.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### notification_defaults_put_notification_defaults
|
||||
|
||||
- Operation ID: `notification_defaults_put_notification_defaults`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/settings/notification_defaults`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates envelope notification default settings.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
947
skills/accounts-4/SKILL.md
Normal file
947
skills/accounts-4/SKILL.md
Normal file
@@ -0,0 +1,947 @@
|
||||
---
|
||||
name: accounts-4-routes
|
||||
description: Handle 80 OpenAPI operation(s) under /v2.1/accounts/{accountId} for the accounts 4 route group.
|
||||
---
|
||||
|
||||
# accounts 4 API Routes
|
||||
|
||||
Handle 80 OpenAPI operation(s) under /v2.1/accounts/{accountId} for the accounts 4 route group.
|
||||
|
||||
Use the generated operation tools to make real API calls. Do not invent API responses.
|
||||
If a tool reports missing setup, return the exact setup field name to the caller.
|
||||
For write, update, or delete operations, state the intended action before calling the tool.
|
||||
|
||||
## Operations
|
||||
|
||||
### account_password_rules_get_account_password_rules
|
||||
|
||||
- Operation ID: `account_password_rules_get_account_password_rules`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/settings/password_rules`
|
||||
- Mode: READ
|
||||
- Summary: Gets the password rules for an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### account_password_rules_put_account_password_rules
|
||||
|
||||
- Operation ID: `account_password_rules_put_account_password_rules`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/settings/password_rules`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the password rules for an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### tab_settings_get_tab_settings
|
||||
|
||||
- Operation ID: `tab_settings_get_tab_settings`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/settings/tabs`
|
||||
- Mode: READ
|
||||
- Summary: Returns tab settings list for specified account
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### tab_settings_put_settings
|
||||
|
||||
- Operation ID: `tab_settings_put_settings`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/settings/tabs`
|
||||
- Mode: WRITE
|
||||
- Summary: Modifies tab settings for specified account
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### shared_access_get_shared_access
|
||||
|
||||
- Operation ID: `shared_access_get_shared_access`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/shared_access`
|
||||
- Mode: READ
|
||||
- Summary: Reserved: Gets the shared item status for one or more users.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `count` in `query`
|
||||
- `envelopes_not_shared_user_status` in `query`
|
||||
- `folder_ids` in `query`
|
||||
- `item_type` in `query`
|
||||
- `search_text` in `query`
|
||||
- `shared` in `query`
|
||||
- `start_position` in `query`
|
||||
- `user_ids` in `query`
|
||||
|
||||
### shared_access_put_shared_access
|
||||
|
||||
- Operation ID: `shared_access_put_shared_access`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/shared_access`
|
||||
- Mode: WRITE
|
||||
- Summary: Reserved: Sets the shared access information for users.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `item_type` in `query`
|
||||
- `preserve_existing_shared_access` in `query`
|
||||
- `user_ids` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### account_signature_providers_get_signature_providers
|
||||
|
||||
- Operation ID: `account_signature_providers_get_signature_providers`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/signatureProviders`
|
||||
- Mode: READ
|
||||
- Summary: Gets the available signature providers for an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### account_signatures_get_account_signatures
|
||||
|
||||
- Operation ID: `account_signatures_get_account_signatures`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/signatures`
|
||||
- Mode: READ
|
||||
- Summary: Returns a list of stamps available in the account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `stamp_format` in `query`
|
||||
- `stamp_name` in `query`
|
||||
- `stamp_type` in `query`
|
||||
|
||||
### account_signatures_put_account_signature
|
||||
|
||||
- Operation ID: `account_signatures_put_account_signature`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/signatures`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates an account stamp.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### account_signatures_post_account_signatures
|
||||
|
||||
- Operation ID: `account_signatures_post_account_signatures`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/signatures`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds or updates one or more account stamps.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `decode_only` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### account_signatures_get_account_signature
|
||||
|
||||
- Operation ID: `account_signatures_get_account_signature`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/signatures/{signatureId}`
|
||||
- Mode: READ
|
||||
- Summary: Returns information about the specified stamp.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `signatureId` in `path` required
|
||||
|
||||
### account_signatures_put_account_signature_by_id
|
||||
|
||||
- Operation ID: `account_signatures_put_account_signature_by_id`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/signatures/{signatureId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates an account stamp by ID.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `signatureId` in `path` required
|
||||
- `close_existing_signature` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### account_signatures_delete_account_signature
|
||||
|
||||
- Operation ID: `account_signatures_delete_account_signature`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/signatures/{signatureId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes an account stamp.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `signatureId` in `path` required
|
||||
|
||||
### account_signatures_get_account_signature_image
|
||||
|
||||
- Operation ID: `account_signatures_get_account_signature_image`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}`
|
||||
- Mode: READ
|
||||
- Summary: Returns the image for an account stamp.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `imageType` in `path` required
|
||||
- `signatureId` in `path` required
|
||||
- `include_chrome` in `query`
|
||||
|
||||
### account_signatures_put_account_signature_image
|
||||
|
||||
- Operation ID: `account_signatures_put_account_signature_image`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}`
|
||||
- Mode: WRITE
|
||||
- Summary: Sets a signature image, initials, or stamp.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `imageType` in `path` required
|
||||
- `signatureId` in `path` required
|
||||
- `transparent_png` in `query`
|
||||
|
||||
### account_signatures_delete_account_signature_image
|
||||
|
||||
- Operation ID: `account_signatures_delete_account_signature_image`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the image for a stamp.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `imageType` in `path` required
|
||||
- `signatureId` in `path` required
|
||||
|
||||
### signing_groups_get_signing_groups
|
||||
|
||||
- Operation ID: `signing_groups_get_signing_groups`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/signing_groups`
|
||||
- Mode: READ
|
||||
- Summary: Gets a list of the Signing Groups in an account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `group_type` in `query`
|
||||
- `include_users` in `query`
|
||||
|
||||
### signing_groups_put_signing_groups
|
||||
|
||||
- Operation ID: `signing_groups_put_signing_groups`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/signing_groups`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates signing group names.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### signing_groups_post_signing_groups
|
||||
|
||||
- Operation ID: `signing_groups_post_signing_groups`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/signing_groups`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a signing group.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### signing_groups_delete_signing_groups
|
||||
|
||||
- Operation ID: `signing_groups_delete_signing_groups`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/signing_groups`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes one or more signing groups.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### signing_groups_get_signing_group
|
||||
|
||||
- Operation ID: `signing_groups_get_signing_group`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets information about a signing group.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `signingGroupId` in `path` required
|
||||
|
||||
### signing_groups_put_signing_group
|
||||
|
||||
- Operation ID: `signing_groups_put_signing_group`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates a signing group.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `signingGroupId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### signing_groups_get_signing_group_users
|
||||
|
||||
- Operation ID: `signing_groups_get_signing_group_users`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users`
|
||||
- Mode: READ
|
||||
- Summary: Gets a list of members in a Signing Group.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `signingGroupId` in `path` required
|
||||
|
||||
### signing_groups_put_signing_group_users
|
||||
|
||||
- Operation ID: `signing_groups_put_signing_group_users`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds members to a signing group.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `signingGroupId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### signing_groups_delete_signing_group_users
|
||||
|
||||
- Operation ID: `signing_groups_delete_signing_group_users`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes one or more members from a signing group.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `signingGroupId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### supported_languages_get_supported_languages
|
||||
|
||||
- Operation ID: `supported_languages_get_supported_languages`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/supported_languages`
|
||||
- Mode: READ
|
||||
- Summary: Gets the supported languages for envelope recipients.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### tabs_get_tab_definitions
|
||||
|
||||
- Operation ID: `tabs_get_tab_definitions`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/tab_definitions`
|
||||
- Mode: READ
|
||||
- Summary: Gets a list of all account tabs.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `custom_tab_only` in `query`
|
||||
|
||||
### tabs_post_tab_definitions
|
||||
|
||||
- Operation ID: `tabs_post_tab_definitions`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/tab_definitions`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a custom tab.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### tab_get_custom_tab
|
||||
|
||||
- Operation ID: `tab_get_custom_tab`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/tab_definitions/{customTabId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets custom tab information.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `customTabId` in `path` required
|
||||
|
||||
### tab_put_custom_tab
|
||||
|
||||
- Operation ID: `tab_put_custom_tab`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/tab_definitions/{customTabId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates custom tab information.
|
||||
|
||||
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `customTabId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### tab_delete_custom_tab
|
||||
|
||||
- Operation ID: `tab_delete_custom_tab`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/tab_definitions/{customTabId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes custom tab information.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `customTabId` in `path` required
|
||||
|
||||
### templates_get_templates
|
||||
|
||||
- Operation ID: `templates_get_templates`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates`
|
||||
- Mode: READ
|
||||
- Summary: Gets the list of templates.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `count` in `query`
|
||||
- `created_from_date` in `query`
|
||||
- `created_to_date` in `query`
|
||||
- `folder_ids` in `query`
|
||||
- `folder_types` in `query`
|
||||
- `from_date` in `query`
|
||||
- `include` in `query`
|
||||
- `is_deleted_template_only` in `query`
|
||||
- `is_download` in `query`
|
||||
- `link_configuration_id` in `query`
|
||||
- `modified_from_date` in `query`
|
||||
- `modified_to_date` in `query`
|
||||
- `order` in `query`
|
||||
- `order_by` in `query`
|
||||
- `search_fields` in `query`
|
||||
- `search_text` in `query`
|
||||
- `shared_by_me` in `query`
|
||||
- `start_position` in `query`
|
||||
- `template_ids` in `query`
|
||||
- `to_date` in `query`
|
||||
- `used_from_date` in `query`
|
||||
- `used_to_date` in `query`
|
||||
- `user_filter` in `query`
|
||||
- `user_id` in `query`
|
||||
|
||||
### templates_put_templates
|
||||
|
||||
- Operation ID: `templates_put_templates`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates`
|
||||
- Mode: WRITE
|
||||
- Summary: Templates_PutTemplates
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### templates_post_templates
|
||||
|
||||
- Operation ID: `templates_post_templates`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/templates`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates one or more templates.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### templates_get_template
|
||||
|
||||
- Operation ID: `templates_get_template`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets a specific template associated with a specified account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `include` in `query`
|
||||
|
||||
### templates_put_template
|
||||
|
||||
- Operation ID: `templates_put_template`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates an existing template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### templates_put_template_part
|
||||
|
||||
- Operation ID: `templates_put_template_part`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}`
|
||||
- Mode: WRITE
|
||||
- Summary: Shares a template with a group.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `templatePart` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### templates_delete_template_part
|
||||
|
||||
- Operation ID: `templates_delete_template_part`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}`
|
||||
- Mode: WRITE
|
||||
- Summary: Removes a member group's sharing permissions for a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `templatePart` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### custom_fields_get_template_custom_fields
|
||||
|
||||
- Operation ID: `custom_fields_get_template_custom_fields`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields`
|
||||
- Mode: READ
|
||||
- Summary: Gets the custom document fields from a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
|
||||
### custom_fields_put_template_custom_fields
|
||||
|
||||
- Operation ID: `custom_fields_put_template_custom_fields`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates envelope custom fields in a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### custom_fields_post_template_custom_fields
|
||||
|
||||
- Operation ID: `custom_fields_post_template_custom_fields`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates custom document fields in an existing template document.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### custom_fields_delete_template_custom_fields
|
||||
|
||||
- Operation ID: `custom_fields_delete_template_custom_fields`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes envelope custom fields in a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### documents_get_template_documents
|
||||
|
||||
- Operation ID: `documents_get_template_documents`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/documents`
|
||||
- Mode: READ
|
||||
- Summary: Gets a list of documents associated with a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `include_agreement_type` in `query`
|
||||
- `include_is_edited` in `query`
|
||||
- `include_tabs` in `query`
|
||||
|
||||
### documents_put_template_documents
|
||||
|
||||
- Operation ID: `documents_put_template_documents`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds documents to a template document.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### documents_delete_template_documents
|
||||
|
||||
- Operation ID: `documents_delete_template_documents`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes documents from a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### documents_get_template_document
|
||||
|
||||
- Operation ID: `documents_get_template_document`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets PDF documents from a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `encrypt` in `query`
|
||||
- `file_type` in `query`
|
||||
- `show_changes` in `query`
|
||||
|
||||
### documents_put_template_document
|
||||
|
||||
- Operation ID: `documents_put_template_document`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates a template document.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `is_envelope_definition` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### document_fields_get_template_document_fields
|
||||
|
||||
- Operation ID: `document_fields_get_template_document_fields`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields`
|
||||
- Mode: READ
|
||||
- Summary: Gets the custom document fields for a an existing template document.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
|
||||
### document_fields_put_template_document_fields
|
||||
|
||||
- Operation ID: `document_fields_put_template_document_fields`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates existing custom document fields in an existing template document.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### document_fields_post_template_document_fields
|
||||
|
||||
- Operation ID: `document_fields_post_template_document_fields`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates custom document fields in an existing template document.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### document_fields_delete_template_document_fields
|
||||
|
||||
- Operation ID: `document_fields_delete_template_document_fields`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes custom document fields from an existing template document.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### responsive_html_get_template_document_html_definitions
|
||||
|
||||
- Operation ID: `responsive_html_get_template_document_html_definitions`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions`
|
||||
- Mode: READ
|
||||
- Summary: Gets the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
|
||||
### pages_get_template_page_images
|
||||
|
||||
- Operation ID: `pages_get_template_page_images`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages`
|
||||
- Mode: READ
|
||||
- Summary: Returns document page images based on input.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `count` in `query`
|
||||
- `dpi` in `query`
|
||||
- `max_height` in `query`
|
||||
- `max_width` in `query`
|
||||
- `nocache` in `query`
|
||||
- `show_changes` in `query`
|
||||
- `start_position` in `query`
|
||||
|
||||
### pages_delete_template_page
|
||||
|
||||
- Operation ID: `pages_delete_template_page`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a page from a document in an template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `pageNumber` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### pages_get_template_page_image
|
||||
|
||||
- Operation ID: `pages_get_template_page_image`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image`
|
||||
- Mode: READ
|
||||
- Summary: Gets a page image from a template for display.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `pageNumber` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `dpi` in `query`
|
||||
- `max_height` in `query`
|
||||
- `max_width` in `query`
|
||||
- `show_changes` in `query`
|
||||
|
||||
### pages_put_template_page_image
|
||||
|
||||
- Operation ID: `pages_put_template_page_image`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image`
|
||||
- Mode: WRITE
|
||||
- Summary: Rotates page image from a template for display.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `pageNumber` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### tabs_get_template_page_tabs
|
||||
|
||||
- Operation ID: `tabs_get_template_page_tabs`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs`
|
||||
- Mode: READ
|
||||
- Summary: Returns tabs on the specified page.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `pageNumber` in `path` required
|
||||
- `templateId` in `path` required
|
||||
|
||||
### responsive_html_post_template_document_responsive_html_preview
|
||||
|
||||
- Operation ID: `responsive_html_post_template_document_responsive_html_preview`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a preview of the responsive version of a template document.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### tabs_get_template_document_tabs
|
||||
|
||||
- Operation ID: `tabs_get_template_document_tabs`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs`
|
||||
- Mode: READ
|
||||
- Summary: Returns tabs on a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `page_numbers` in `query`
|
||||
|
||||
### tabs_put_template_document_tabs
|
||||
|
||||
- Operation ID: `tabs_put_template_document_tabs`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the tabs for a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### tabs_post_template_document_tabs
|
||||
|
||||
- Operation ID: `tabs_post_template_document_tabs`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds tabs to a document in a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### tabs_delete_template_document_tabs
|
||||
|
||||
- Operation ID: `tabs_delete_template_document_tabs`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes tabs from a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `documentId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### responsive_html_get_template_html_definitions
|
||||
|
||||
- Operation ID: `responsive_html_get_template_html_definitions`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/html_definitions`
|
||||
- Mode: READ
|
||||
- Summary: Gets the Original HTML Definition used to generate the Responsive HTML for the template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
|
||||
### lock_get_template_lock
|
||||
|
||||
- Operation ID: `lock_get_template_lock`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/lock`
|
||||
- Mode: READ
|
||||
- Summary: Gets template lock information.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
|
||||
### lock_put_template_lock
|
||||
|
||||
- Operation ID: `lock_put_template_lock`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/lock`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates a template lock.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### lock_post_template_lock
|
||||
|
||||
- Operation ID: `lock_post_template_lock`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/templates/{templateId}/lock`
|
||||
- Mode: WRITE
|
||||
- Summary: Locks a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### lock_delete_template_lock
|
||||
|
||||
- Operation ID: `lock_delete_template_lock`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/templates/{templateId}/lock`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a template lock.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### notification_get_templates_template_id_notification
|
||||
|
||||
- Operation ID: `notification_get_templates_template_id_notification`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/notification`
|
||||
- Mode: READ
|
||||
- Summary: Gets template notification information.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
|
||||
### notification_put_templates_template_id_notification
|
||||
|
||||
- Operation ID: `notification_put_templates_template_id_notification`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/notification`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the notification structure for an existing template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### recipients_get_template_recipients
|
||||
|
||||
- Operation ID: `recipients_get_template_recipients`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients`
|
||||
- Mode: READ
|
||||
- Summary: Gets recipient information from a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `include_anchor_tab_locations` in `query`
|
||||
- `include_extended` in `query`
|
||||
- `include_tabs` in `query`
|
||||
|
||||
### recipients_put_template_recipients
|
||||
|
||||
- Operation ID: `recipients_put_template_recipients`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates recipients in a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `resend_envelope` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### recipients_post_template_recipients
|
||||
|
||||
- Operation ID: `recipients_post_template_recipients`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/templates/{templateId}/recipients`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds tabs for a recipient.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `resend_envelope` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### recipients_delete_template_recipients
|
||||
|
||||
- Operation ID: `recipients_delete_template_recipients`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes recipients from a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### recipients_delete_template_recipient
|
||||
|
||||
- Operation ID: `recipients_delete_template_recipient`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the specified recipient file from a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### recipients_get_template_recipient_document_visibility
|
||||
|
||||
- Operation ID: `recipients_get_template_recipient_document_visibility`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility`
|
||||
- Mode: READ
|
||||
- Summary: Returns document visibility for a template recipient
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
|
||||
### recipients_put_template_recipient_document_visibility
|
||||
|
||||
- Operation ID: `recipients_put_template_recipient_document_visibility`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates document visibility for a template recipient
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### recipients_get_template_recipient_tabs
|
||||
|
||||
- Operation ID: `recipients_get_template_recipient_tabs`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs`
|
||||
- Mode: READ
|
||||
- Summary: Gets the tabs information for a signer or sign-in-person recipient in a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `include_anchor_tab_locations` in `query`
|
||||
- `include_metadata` in `query`
|
||||
|
||||
### recipients_put_template_recipient_tabs
|
||||
|
||||
- Operation ID: `recipients_put_template_recipient_tabs`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the tabs for a recipient.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### recipients_post_template_recipient_tabs
|
||||
|
||||
- Operation ID: `recipients_post_template_recipient_tabs`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds tabs for a recipient.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### recipients_delete_template_recipient_tabs
|
||||
|
||||
- Operation ID: `recipients_delete_template_recipient_tabs`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the tabs associated with a recipient in a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `recipientId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
891
skills/accounts-5/SKILL.md
Normal file
891
skills/accounts-5/SKILL.md
Normal file
@@ -0,0 +1,891 @@
|
||||
---
|
||||
name: accounts-5-routes
|
||||
description: Handle 75 OpenAPI operation(s) under /v2.1/accounts for the accounts 5 route group.
|
||||
---
|
||||
|
||||
# accounts 5 API Routes
|
||||
|
||||
Handle 75 OpenAPI operation(s) under /v2.1/accounts for the accounts 5 route group.
|
||||
|
||||
Use the generated operation tools to make real API calls. Do not invent API responses.
|
||||
If a tool reports missing setup, return the exact setup field name to the caller.
|
||||
For write, update, or delete operations, state the intended action before calling the tool.
|
||||
|
||||
## Operations
|
||||
|
||||
### recipients_put_template_recipients_document_visibility
|
||||
|
||||
- Operation ID: `recipients_put_template_recipients_document_visibility`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients/document_visibility`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates document visibility for template recipients
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### responsive_html_post_template_responsive_html_preview
|
||||
|
||||
- Operation ID: `responsive_html_post_template_responsive_html_preview`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/templates/{templateId}/responsive_html_preview`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a preview of the responsive versions of all of the documents associated with a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### views_post_template_edit_view
|
||||
|
||||
- Operation ID: `views_post_template_edit_view`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/templates/{templateId}/views/edit`
|
||||
- Mode: WRITE
|
||||
- Summary: Gets a URL for a template edit view.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### views_post_template_recipient_preview
|
||||
|
||||
- Operation ID: `views_post_template_recipient_preview`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a template recipient preview.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### template_workflow_definition_get_template_workflow_definition
|
||||
|
||||
- Operation ID: `template_workflow_definition_get_template_workflow_definition`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow`
|
||||
- Mode: READ
|
||||
- Summary: Returns the workflow definition for a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
|
||||
### template_workflow_definition_put_template_workflow_definition
|
||||
|
||||
- Operation ID: `template_workflow_definition_put_template_workflow_definition`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the workflow definition for a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### template_workflow_definition_delete_template_workflow_definition
|
||||
|
||||
- Operation ID: `template_workflow_definition_delete_template_workflow_definition`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete the workflow definition for a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
|
||||
### template_workflow_scheduled_sending_get_template_scheduled_sending_definition
|
||||
|
||||
- Operation ID: `template_workflow_scheduled_sending_get_template_scheduled_sending_definition`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending`
|
||||
- Mode: READ
|
||||
- Summary: Returns the scheduled sending rules for a template's workflow definition.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
|
||||
### template_workflow_scheduled_sending_put_template_scheduled_sending_definition
|
||||
|
||||
- Operation ID: `template_workflow_scheduled_sending_put_template_scheduled_sending_definition`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the scheduled sending rules for a template's workflow definition.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### template_workflow_scheduled_sending_delete_template_scheduled_sending_definition
|
||||
|
||||
- Operation ID: `template_workflow_scheduled_sending_delete_template_scheduled_sending_definition`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the scheduled sending rules for the template's workflow.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
|
||||
### template_workflow_step_post_template_workflow_step_definition
|
||||
|
||||
- Operation ID: `template_workflow_step_post_template_workflow_step_definition`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds a new step to a template's workflow.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### template_workflow_step_get_template_workflow_step_definition
|
||||
|
||||
- Operation ID: `template_workflow_step_get_template_workflow_step_definition`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}`
|
||||
- Mode: READ
|
||||
- Summary: Returns a specified workflow step for a specified envelope.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `workflowStepId` in `path` required
|
||||
|
||||
### template_workflow_step_put_template_workflow_step_definition
|
||||
|
||||
- Operation ID: `template_workflow_step_put_template_workflow_step_definition`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates a specified workflow step for a template.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `workflowStepId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### template_workflow_step_delete_template_workflow_step_definition
|
||||
|
||||
- Operation ID: `template_workflow_step_delete_template_workflow_step_definition`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes a workflow step from an template's workflow definition.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `workflowStepId` in `path` required
|
||||
|
||||
### template_workflow_delayed_routing_get_template_delayed_routing_definition
|
||||
|
||||
- Operation ID: `template_workflow_delayed_routing_get_template_delayed_routing_definition`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting`
|
||||
- Mode: READ
|
||||
- Summary: Returns the delayed routing rules for a template's workflow step definition.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `workflowStepId` in `path` required
|
||||
|
||||
### template_workflow_delayed_routing_put_template_delayed_routing_definition
|
||||
|
||||
- Operation ID: `template_workflow_delayed_routing_put_template_delayed_routing_definition`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the delayed routing rules for a template's workflow step.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `workflowStepId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### template_workflow_delayed_routing_delete_template_delayed_routing_definition
|
||||
|
||||
- Operation ID: `template_workflow_delayed_routing_delete_template_delayed_routing_definition`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the delayed routing rules for the specified template workflow step.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `templateId` in `path` required
|
||||
- `workflowStepId` in `path` required
|
||||
|
||||
### templates_auto_match_put_templates
|
||||
|
||||
- Operation ID: `templates_auto_match_put_templates`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/templates/auto_match`
|
||||
- Mode: WRITE
|
||||
- Summary: TemplatesAutoMatch_PutTemplates
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### unsupported_file_types_get_unsupported_file_types
|
||||
|
||||
- Operation ID: `unsupported_file_types_get_unsupported_file_types`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/unsupported_file_types`
|
||||
- Mode: READ
|
||||
- Summary: Gets a list of unsupported file types.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### users_get_users
|
||||
|
||||
- Operation ID: `users_get_users`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/users`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves the list of users for the specified account. You can filter the users list to get specific users.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `additional_info` in `query`
|
||||
- `alternate_admins_only` in `query`
|
||||
- `count` in `query`
|
||||
- `domain_users_only` in `query`
|
||||
- `email` in `query`
|
||||
- `email_substring` in `query`
|
||||
- `group_id` in `query`
|
||||
- `include_license` in `query`
|
||||
- `include_usersettings_for_csv` in `query`
|
||||
- `login_status` in `query`
|
||||
- `not_group_id` in `query`
|
||||
- `start_position` in `query`
|
||||
- `status` in `query`
|
||||
- `user_name_substring` in `query`
|
||||
|
||||
### users_put_users
|
||||
|
||||
- Operation ID: `users_put_users`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/users`
|
||||
- Mode: WRITE
|
||||
- Summary: Changes one or more users in the specified account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `allow_all_languages` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### users_post_users
|
||||
|
||||
- Operation ID: `users_post_users`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/users`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds new users to the specified account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### users_delete_users
|
||||
|
||||
- Operation ID: `users_delete_users`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/users`
|
||||
- Mode: WRITE
|
||||
- Summary: Closes one or more users in the account.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `delete` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### user_get_user
|
||||
|
||||
- Operation ID: `user_get_user`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/users/{userId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets the user information for a specified user using a userId (GUID). To find a user based on their email address, use the list endpoint.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- `additional_info` in `query`
|
||||
- `email` in `query`
|
||||
- `include_license` in `query`
|
||||
|
||||
### user_put_user
|
||||
|
||||
- Operation ID: `user_put_user`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/users/{userId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates user information for the specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- `allow_all_languages` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### user_authorization_create_user_authorization
|
||||
|
||||
- Operation ID: `user_authorization_create_user_authorization`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/users/{userId}/authorization`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a user authorization.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### user_authorization_get_user_authorization
|
||||
|
||||
- Operation ID: `user_authorization_get_user_authorization`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}`
|
||||
- Mode: READ
|
||||
- Summary: Returns the user authorization for a given authorization ID.
|
||||
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `authorizationId` in `path` required
|
||||
- `userId` in `path` required
|
||||
|
||||
### user_authorization_update_user_authorization
|
||||
|
||||
- Operation ID: `user_authorization_update_user_authorization`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the start or end date for a user authorization.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `authorizationId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### user_authorization_delete_user_authorization
|
||||
|
||||
- Operation ID: `user_authorization_delete_user_authorization`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the user authorization.
|
||||
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `authorizationId` in `path` required
|
||||
- `userId` in `path` required
|
||||
|
||||
### user_authorizations_get_principal_user_authorizations
|
||||
|
||||
- Operation ID: `user_authorizations_get_principal_user_authorizations`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/users/{userId}/authorizations`
|
||||
- Mode: READ
|
||||
- Summary: Returns the authorizations for which the specified user is the principal user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- `active_only` in `query`
|
||||
- `count` in `query`
|
||||
- `email_substring` in `query`
|
||||
- `include_closed_users` in `query`
|
||||
- `permissions` in `query`
|
||||
- `start_position` in `query`
|
||||
- `task_source` in `query`
|
||||
- `task_type` in `query`
|
||||
- `user_name_substring` in `query`
|
||||
|
||||
### user_authorizations_post_user_authorizations
|
||||
|
||||
- Operation ID: `user_authorizations_post_user_authorizations`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/users/{userId}/authorizations`
|
||||
- Mode: WRITE
|
||||
- Summary: Create or update multiple user authorizations.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### user_authorizations_delete_user_authorizations
|
||||
|
||||
- Operation ID: `user_authorizations_delete_user_authorizations`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/users/{userId}/authorizations`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete multiple user authorizations.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### user_agent_authorizations_get_agent_user_authorizations
|
||||
|
||||
- Operation ID: `user_agent_authorizations_get_agent_user_authorizations`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/users/{userId}/authorizations/agent`
|
||||
- Mode: READ
|
||||
- Summary: Returns the authorizations for which the specified user is the agent user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- `active_only` in `query`
|
||||
- `count` in `query`
|
||||
- `email_substring` in `query`
|
||||
- `include_closed_users` in `query`
|
||||
- `permissions` in `query`
|
||||
- `start_position` in `query`
|
||||
- `task_source` in `query`
|
||||
- `task_type` in `query`
|
||||
- `user_name_substring` in `query`
|
||||
|
||||
### cloud_storage_get_cloud_storage_providers
|
||||
|
||||
- Operation ID: `cloud_storage_get_cloud_storage_providers`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage`
|
||||
- Mode: READ
|
||||
- Summary: Get the Cloud Storage Provider configuration for the specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- `redirectUrl` in `query`
|
||||
|
||||
### cloud_storage_post_cloud_storage
|
||||
|
||||
- Operation ID: `cloud_storage_post_cloud_storage`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/users/{userId}/cloud_storage`
|
||||
- Mode: WRITE
|
||||
- Summary: Configures the redirect URL information for one or more cloud storage providers for the specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### cloud_storage_delete_cloud_storage_providers
|
||||
|
||||
- Operation ID: `cloud_storage_delete_cloud_storage_providers`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/users/{userId}/cloud_storage`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the user authentication information for one or more cloud storage providers.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### cloud_storage_get_cloud_storage
|
||||
|
||||
- Operation ID: `cloud_storage_get_cloud_storage`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets the specified Cloud Storage Provider configuration for the User.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `serviceId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- `redirectUrl` in `query`
|
||||
|
||||
### cloud_storage_delete_cloud_storage
|
||||
|
||||
- Operation ID: `cloud_storage_delete_cloud_storage`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the user authentication information for the specified cloud storage provider.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `serviceId` in `path` required
|
||||
- `userId` in `path` required
|
||||
|
||||
### cloud_storage_folder_get_cloud_storage_folder_all
|
||||
|
||||
- Operation ID: `cloud_storage_folder_get_cloud_storage_folder_all`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `serviceId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- `cloud_storage_folder_path` in `query`
|
||||
- `count` in `query`
|
||||
- `order` in `query`
|
||||
- `order_by` in `query`
|
||||
- `search_text` in `query`
|
||||
- `start_position` in `query`
|
||||
|
||||
### cloud_storage_folder_get_cloud_storage_folder
|
||||
|
||||
- Operation ID: `cloud_storage_folder_get_cloud_storage_folder`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets a list of items from a cloud storage provider.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `folderId` in `path` required
|
||||
- `serviceId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- `cloud_storage_folder_path` in `query`
|
||||
- `cloud_storage_folderid_plain` in `query`
|
||||
- `count` in `query`
|
||||
- `order` in `query`
|
||||
- `order_by` in `query`
|
||||
- `search_text` in `query`
|
||||
- `sky_drive_skip_token` in `query`
|
||||
- `start_position` in `query`
|
||||
|
||||
### user_custom_settings_get_custom_settings
|
||||
|
||||
- Operation ID: `user_custom_settings_get_custom_settings`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/users/{userId}/custom_settings`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves the custom user settings for a specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
|
||||
### user_custom_settings_put_custom_settings
|
||||
|
||||
- Operation ID: `user_custom_settings_put_custom_settings`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/users/{userId}/custom_settings`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds or updates custom user settings for the specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### user_custom_settings_delete_custom_settings
|
||||
|
||||
- Operation ID: `user_custom_settings_delete_custom_settings`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/users/{userId}/custom_settings`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes custom user settings for a specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### user_profile_get_profile
|
||||
|
||||
- Operation ID: `user_profile_get_profile`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/users/{userId}/profile`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves the user profile for a specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
|
||||
### user_profile_put_profile
|
||||
|
||||
- Operation ID: `user_profile_put_profile`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/users/{userId}/profile`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the user profile information for the specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### user_profile_image_get_user_profile_image
|
||||
|
||||
- Operation ID: `user_profile_image_get_user_profile_image`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/users/{userId}/profile/image`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves the user profile image for the specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- `encoding` in `query`
|
||||
|
||||
### user_profile_image_put_user_profile_image
|
||||
|
||||
- Operation ID: `user_profile_image_put_user_profile_image`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/users/{userId}/profile/image`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the user profile image for a specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
|
||||
### user_profile_image_delete_user_profile_image
|
||||
|
||||
- Operation ID: `user_profile_image_delete_user_profile_image`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/users/{userId}/profile/image`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the user profile image for the specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
|
||||
### user_settings_get_user_settings
|
||||
|
||||
- Operation ID: `user_settings_get_user_settings`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/users/{userId}/settings`
|
||||
- Mode: READ
|
||||
- Summary: Gets the user account settings for a specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
|
||||
### user_settings_put_user_settings
|
||||
|
||||
- Operation ID: `user_settings_put_user_settings`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/users/{userId}/settings`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the user account settings for a specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- `allow_all_languages` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### user_signatures_get_user_signatures
|
||||
|
||||
- Operation ID: `user_signatures_get_user_signatures`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/users/{userId}/signatures`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves a list of signature definitions for a user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- `stamp_type` in `query`
|
||||
|
||||
### user_signatures_put_user_signature
|
||||
|
||||
- Operation ID: `user_signatures_put_user_signature`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/users/{userId}/signatures`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds/updates a user signature.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### user_signatures_post_user_signatures
|
||||
|
||||
- Operation ID: `user_signatures_post_user_signatures`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/users/{userId}/signatures`
|
||||
- Mode: WRITE
|
||||
- Summary: Adds user Signature and initials images to a Signature.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### user_signatures_get_user_signature
|
||||
|
||||
- Operation ID: `user_signatures_get_user_signature`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets the user signature information for the specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `signatureId` in `path` required
|
||||
- `userId` in `path` required
|
||||
|
||||
### user_signatures_put_user_signature_by_id
|
||||
|
||||
- Operation ID: `user_signatures_put_user_signature_by_id`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the user signature for a specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `signatureId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- `close_existing_signature` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### user_signatures_delete_user_signature
|
||||
|
||||
- Operation ID: `user_signatures_delete_user_signature`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Removes removes signature information for the specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `signatureId` in `path` required
|
||||
- `userId` in `path` required
|
||||
|
||||
### user_signatures_get_user_signature_image
|
||||
|
||||
- Operation ID: `user_signatures_get_user_signature_image`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves the user initials image or the user signature image for the specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `imageType` in `path` required
|
||||
- `signatureId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- `include_chrome` in `query`
|
||||
|
||||
### user_signatures_put_user_signature_image
|
||||
|
||||
- Operation ID: `user_signatures_put_user_signature_image`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the user signature image or user initials image for the specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `imageType` in `path` required
|
||||
- `signatureId` in `path` required
|
||||
- `userId` in `path` required
|
||||
- `transparent_png` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### user_signatures_delete_user_signature_image
|
||||
|
||||
- Operation ID: `user_signatures_delete_user_signature_image`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the user initials image or the user signature image for the specified user.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `imageType` in `path` required
|
||||
- `signatureId` in `path` required
|
||||
- `userId` in `path` required
|
||||
|
||||
### views_post_account_console_view
|
||||
|
||||
- Operation ID: `views_post_account_console_view`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/views/console`
|
||||
- Mode: WRITE
|
||||
- Summary: Returns a URL to the Docusign eSignature web application.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### watermark_get_watermark
|
||||
|
||||
- Operation ID: `watermark_get_watermark`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/watermark`
|
||||
- Mode: READ
|
||||
- Summary: Get watermark information.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### watermark_put_watermark
|
||||
|
||||
- Operation ID: `watermark_put_watermark`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/watermark`
|
||||
- Mode: WRITE
|
||||
- Summary: Update watermark information.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### watermark_preview_put_watermark_preview
|
||||
|
||||
- Operation ID: `watermark_preview_put_watermark_preview`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/watermark/preview`
|
||||
- Mode: WRITE
|
||||
- Summary: Get watermark preview.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### workspace_get_workspaces
|
||||
|
||||
- Operation ID: `workspace_get_workspaces`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/workspaces`
|
||||
- Mode: READ
|
||||
- Summary: List Workspaces
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
|
||||
### workspace_post_workspace
|
||||
|
||||
- Operation ID: `workspace_post_workspace`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/workspaces`
|
||||
- Mode: WRITE
|
||||
- Summary: Create a Workspace
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### workspace_get_workspace
|
||||
|
||||
- Operation ID: `workspace_get_workspace`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}`
|
||||
- Mode: READ
|
||||
- Summary: Get Workspace
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `workspaceId` in `path` required
|
||||
|
||||
### workspace_put_workspace
|
||||
|
||||
- Operation ID: `workspace_put_workspace`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/workspaces/{workspaceId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update Workspace
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `workspaceId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### workspace_delete_workspace
|
||||
|
||||
- Operation ID: `workspace_delete_workspace`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/workspaces/{workspaceId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete Workspace
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `workspaceId` in `path` required
|
||||
|
||||
### workspace_folder_get_workspace_folder
|
||||
|
||||
- Operation ID: `workspace_folder_get_workspace_folder`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}`
|
||||
- Mode: READ
|
||||
- Summary: List workspace folder contents
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `folderId` in `path` required
|
||||
- `workspaceId` in `path` required
|
||||
- `count` in `query`
|
||||
- `include_files` in `query`
|
||||
- `include_sub_folders` in `query`
|
||||
- `include_thumbnails` in `query`
|
||||
- `include_user_detail` in `query`
|
||||
- `start_position` in `query`
|
||||
- `workspace_user_id` in `query`
|
||||
|
||||
### workspace_folder_delete_workspace_items
|
||||
|
||||
- Operation ID: `workspace_folder_delete_workspace_items`
|
||||
- Route: `DELETE /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes files or sub-folders from a workspace.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `folderId` in `path` required
|
||||
- `workspaceId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### workspace_file_post_workspace_files
|
||||
|
||||
- Operation ID: `workspace_file_post_workspace_files`
|
||||
- Route: `POST /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a workspace file.
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `folderId` in `path` required
|
||||
- `workspaceId` in `path` required
|
||||
|
||||
### workspace_file_get_workspace_file
|
||||
|
||||
- Operation ID: `workspace_file_get_workspace_file`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets a workspace file
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `fileId` in `path` required
|
||||
- `folderId` in `path` required
|
||||
- `workspaceId` in `path` required
|
||||
- `is_download` in `query`
|
||||
- `pdf_version` in `query`
|
||||
|
||||
### workspace_file_put_workspace_file
|
||||
|
||||
- Operation ID: `workspace_file_put_workspace_file`
|
||||
- Route: `PUT /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update workspace file or folder metadata
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `fileId` in `path` required
|
||||
- `folderId` in `path` required
|
||||
- `workspaceId` in `path` required
|
||||
|
||||
### workspace_file_pages_get_workspace_file_pages
|
||||
|
||||
- Operation ID: `workspace_file_pages_get_workspace_file_pages`
|
||||
- Route: `GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages`
|
||||
- Mode: READ
|
||||
- Summary: List File Pages
|
||||
- Parameters:
|
||||
- `accountId` in `path` required
|
||||
- `fileId` in `path` required
|
||||
- `folderId` in `path` required
|
||||
- `workspaceId` in `path` required
|
||||
- `count` in `query`
|
||||
- `dpi` in `query`
|
||||
- `max_height` in `query`
|
||||
- `max_width` in `query`
|
||||
- `start_position` in `query`
|
||||
|
||||
### accounts_get_provisioning
|
||||
|
||||
- Operation ID: `accounts_get_provisioning`
|
||||
- Route: `GET /v2.1/accounts/provisioning`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves the account provisioning information for the account.
|
||||
30
skills/billing-plans/SKILL.md
Normal file
30
skills/billing-plans/SKILL.md
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
name: billing-plans-routes
|
||||
description: Handle 2 OpenAPI operation(s) under /v2.1/billing_plans for the billing plans route group.
|
||||
---
|
||||
|
||||
# billing plans API Routes
|
||||
|
||||
Handle 2 OpenAPI operation(s) under /v2.1/billing_plans for the billing plans route group.
|
||||
|
||||
Use the generated operation tools to make real API calls. Do not invent API responses.
|
||||
If a tool reports missing setup, return the exact setup field name to the caller.
|
||||
For write, update, or delete operations, state the intended action before calling the tool.
|
||||
|
||||
## Operations
|
||||
|
||||
### billing_plans_get_billing_plans
|
||||
|
||||
- Operation ID: `billing_plans_get_billing_plans`
|
||||
- Route: `GET /v2.1/billing_plans`
|
||||
- Mode: READ
|
||||
- Summary: Gets a list of available billing plans.
|
||||
|
||||
### billing_plans_get_billing_plan
|
||||
|
||||
- Operation ID: `billing_plans_get_billing_plan`
|
||||
- Route: `GET /v2.1/billing_plans/{billingPlanId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets billing plan details.
|
||||
- Parameters:
|
||||
- `billingPlanId` in `path` required
|
||||
100
skills/current-user/SKILL.md
Normal file
100
skills/current-user/SKILL.md
Normal file
@@ -0,0 +1,100 @@
|
||||
---
|
||||
name: current-user-routes
|
||||
description: Handle 10 OpenAPI operation(s) under /v2.1/current_user for the current user route group.
|
||||
---
|
||||
|
||||
# current user API Routes
|
||||
|
||||
Handle 10 OpenAPI operation(s) under /v2.1/current_user for the current user route group.
|
||||
|
||||
Use the generated operation tools to make real API calls. Do not invent API responses.
|
||||
If a tool reports missing setup, return the exact setup field name to the caller.
|
||||
For write, update, or delete operations, state the intended action before calling the tool.
|
||||
|
||||
## Operations
|
||||
|
||||
### notary_get_notary
|
||||
|
||||
- Operation ID: `notary_get_notary`
|
||||
- Route: `GET /v2.1/current_user/notary`
|
||||
- Mode: READ
|
||||
- Summary: Gets settings for a notary user.
|
||||
- Parameters:
|
||||
- `include_jurisdictions` in `query`
|
||||
|
||||
### notary_put_notary
|
||||
|
||||
- Operation ID: `notary_put_notary`
|
||||
- Route: `PUT /v2.1/current_user/notary`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates notary information for the current user.
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### notary_post_notary
|
||||
|
||||
- Operation ID: `notary_post_notary`
|
||||
- Route: `POST /v2.1/current_user/notary`
|
||||
- Mode: WRITE
|
||||
- Summary: Registers the current user as a notary.
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### notary_journals_get_notary_journals
|
||||
|
||||
- Operation ID: `notary_journals_get_notary_journals`
|
||||
- Route: `GET /v2.1/current_user/notary/journals`
|
||||
- Mode: READ
|
||||
- Summary: Gets notary jurisdictions for a user.
|
||||
- Parameters:
|
||||
- `count` in `query`
|
||||
- `search_text` in `query`
|
||||
- `start_position` in `query`
|
||||
|
||||
### notary_jurisdictions_get_notary_jurisdictions
|
||||
|
||||
- Operation ID: `notary_jurisdictions_get_notary_jurisdictions`
|
||||
- Route: `GET /v2.1/current_user/notary/jurisdictions`
|
||||
- Mode: READ
|
||||
- Summary: Returns a list of jurisdictions that the notary is registered in.
|
||||
|
||||
### notary_jurisdictions_post_notary_jurisdictions
|
||||
|
||||
- Operation ID: `notary_jurisdictions_post_notary_jurisdictions`
|
||||
- Route: `POST /v2.1/current_user/notary/jurisdictions`
|
||||
- Mode: WRITE
|
||||
- Summary: Creates a jurisdiction object.
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### notary_jurisdictions_get_notary_jurisdiction
|
||||
|
||||
- Operation ID: `notary_jurisdictions_get_notary_jurisdiction`
|
||||
- Route: `GET /v2.1/current_user/notary/jurisdictions/{jurisdictionId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets a jurisdiction object for the current user. The user must be a notary.
|
||||
- Parameters:
|
||||
- `jurisdictionId` in `path` required
|
||||
|
||||
### notary_jurisdictions_put_notary_jurisdiction
|
||||
|
||||
- Operation ID: `notary_jurisdictions_put_notary_jurisdiction`
|
||||
- Route: `PUT /v2.1/current_user/notary/jurisdictions/{jurisdictionId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Updates the jurisdiction information about a notary.
|
||||
- Parameters:
|
||||
- `jurisdictionId` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### notary_jurisdictions_delete_notary_jurisdiction
|
||||
|
||||
- Operation ID: `notary_jurisdictions_delete_notary_jurisdiction`
|
||||
- Route: `DELETE /v2.1/current_user/notary/jurisdictions/{jurisdictionId}`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the specified jurisdiction.
|
||||
- Parameters:
|
||||
- `jurisdictionId` in `path` required
|
||||
|
||||
### password_rules_get_password_rules
|
||||
|
||||
- Operation ID: `password_rules_get_password_rules`
|
||||
- Route: `GET /v2.1/current_user/password_rules`
|
||||
- Mode: READ
|
||||
- Summary: Gets membership account password rules.
|
||||
54
skills/diagnostics/SKILL.md
Normal file
54
skills/diagnostics/SKILL.md
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
name: diagnostics-routes
|
||||
description: Handle 5 OpenAPI operation(s) under /v2.1/diagnostics for the diagnostics route group.
|
||||
---
|
||||
|
||||
# diagnostics API Routes
|
||||
|
||||
Handle 5 OpenAPI operation(s) under /v2.1/diagnostics for the diagnostics route group.
|
||||
|
||||
Use the generated operation tools to make real API calls. Do not invent API responses.
|
||||
If a tool reports missing setup, return the exact setup field name to the caller.
|
||||
For write, update, or delete operations, state the intended action before calling the tool.
|
||||
|
||||
## Operations
|
||||
|
||||
### api_request_log_get_request_logs
|
||||
|
||||
- Operation ID: `api_request_log_get_request_logs`
|
||||
- Route: `GET /v2.1/diagnostics/request_logs`
|
||||
- Mode: READ
|
||||
- Summary: Gets the API request logging log files.
|
||||
- Parameters:
|
||||
- `encoding` in `query`
|
||||
|
||||
### api_request_log_delete_request_logs
|
||||
|
||||
- Operation ID: `api_request_log_delete_request_logs`
|
||||
- Route: `DELETE /v2.1/diagnostics/request_logs`
|
||||
- Mode: WRITE
|
||||
- Summary: Deletes the request log files.
|
||||
|
||||
### api_request_log_get_request_log
|
||||
|
||||
- Operation ID: `api_request_log_get_request_log`
|
||||
- Route: `GET /v2.1/diagnostics/request_logs/{requestLogId}`
|
||||
- Mode: READ
|
||||
- Summary: Gets a request logging log file.
|
||||
- Parameters:
|
||||
- `requestLogId` in `path` required
|
||||
|
||||
### api_request_log_get_request_log_settings
|
||||
|
||||
- Operation ID: `api_request_log_get_request_log_settings`
|
||||
- Route: `GET /v2.1/diagnostics/settings`
|
||||
- Mode: READ
|
||||
- Summary: Gets the API request logging settings.
|
||||
|
||||
### api_request_log_put_request_log_settings
|
||||
|
||||
- Operation ID: `api_request_log_put_request_log_settings`
|
||||
- Route: `PUT /v2.1/diagnostics/settings`
|
||||
- Mode: WRITE
|
||||
- Summary: Enables or disables API request logging for troubleshooting.
|
||||
- Body: JSON request body accepted.
|
||||
21
skills/resources/SKILL.md
Normal file
21
skills/resources/SKILL.md
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
name: resources-routes
|
||||
description: Handle 1 OpenAPI operation(s) under /v2.1 for the Resources route group.
|
||||
---
|
||||
|
||||
# Resources API Routes
|
||||
|
||||
Handle 1 OpenAPI operation(s) under /v2.1 for the Resources route group.
|
||||
|
||||
Use the generated operation tools to make real API calls. Do not invent API responses.
|
||||
If a tool reports missing setup, return the exact setup field name to the caller.
|
||||
For write, update, or delete operations, state the intended action before calling the tool.
|
||||
|
||||
## Operations
|
||||
|
||||
### service_information_get_resource_information
|
||||
|
||||
- Operation ID: `service_information_get_resource_information`
|
||||
- Route: `GET /v2.1`
|
||||
- Mode: READ
|
||||
- Summary: Lists resources for REST version specified
|
||||
21
skills/service-information/SKILL.md
Normal file
21
skills/service-information/SKILL.md
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
name: service-information-routes
|
||||
description: Handle 1 OpenAPI operation(s) under /service_information for the service information route group.
|
||||
---
|
||||
|
||||
# service information API Routes
|
||||
|
||||
Handle 1 OpenAPI operation(s) under /service_information for the service information route group.
|
||||
|
||||
Use the generated operation tools to make real API calls. Do not invent API responses.
|
||||
If a tool reports missing setup, return the exact setup field name to the caller.
|
||||
For write, update, or delete operations, state the intended action before calling the tool.
|
||||
|
||||
## Operations
|
||||
|
||||
### service_information_get_service_information
|
||||
|
||||
- Operation ID: `service_information_get_service_information`
|
||||
- Route: `GET /service_information`
|
||||
- Mode: READ
|
||||
- Summary: Retrieves the available REST API versions.
|
||||
Reference in New Issue
Block a user