@formkiq/client-sdk-typescript
v1.18.2
Published
Official FormKiQ client for TypeScript
Downloads
279
Readme
FormKiQ Client SDK - TypeScript
The FormKiQ TypeScript client utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
How to Run Example
- Install and build the generated client (one-time):
npm install axios @formkiq/client-sdk-typescript - Set your environment for the API call (replace with your values):
export FORMKIQ_API_URL="https://<your-formkiq-api-url>" export JWT="<your-oauth-access-token>" export SITE_ID="default" # optional; defaults to "default" - Run the example from the repo root (forcing CommonJS output for ts-node):
The script will add a sample document and log the result. Ensure the JWT has access tonpx ts-node --transpile-only --compiler-options '{"module":"CommonJS"}' example.tsSITE_ID.
Building
To build and compile the typescript sources to javascript use:
npm install
npm run buildPublishing
First build the package then run npm publish
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AccessControlApi | deleteOpaAccessPolicyItems | DELETE /sites/{siteId}/opa/accessPolicy/policyItems | Delete OPA Access Policy Items AccessControlApi | getOpaAccessPolicies | GET /sites/opa/accessPolicies | Get OPAs Access Policies AccessControlApi | getOpaAccessPolicy | GET /sites/{siteId}/opa/accessPolicy | Get OPA Access Policy AccessControlApi | getOpaAccessPolicyItems | GET /sites/{siteId}/opa/accessPolicy/policyItems | Get OPA Access Policy Items AccessControlApi | setOpaAccessPolicyItems | PUT /sites/{siteId}/opa/accessPolicy/policyItems | Set opa access policy items, can only be requested with ADMIN privileges AdvancedDocumentSearchApi | addDocumentFulltext | POST /documents/{documentId}/fulltext | Add document's full-text AdvancedDocumentSearchApi | deleteDocumentFulltext | DELETE /documents/{documentId}/fulltext | Delete document full-text AdvancedDocumentSearchApi | deleteDocumentFulltextTag | DELETE /documents/{documentId}/fulltext/tags/{tagKey} | Delete document full-text tag AdvancedDocumentSearchApi | deleteDocumentFulltextTagAndValue | DELETE /documents/{documentId}/fulltext/tags/{tagKey}/{tagValue} | Delete document full-text tag/value AdvancedDocumentSearchApi | getDocumentFulltext | GET /documents/{documentId}/fulltext | Get document's full-text AdvancedDocumentSearchApi | queryFulltext | POST /queryFulltext | Direct opensearch search API AdvancedDocumentSearchApi | searchFulltext | POST /searchFulltext | Document full-text search AdvancedDocumentSearchApi | setDocumentFulltext | PUT /documents/{documentId}/fulltext | Set document's full-text AdvancedDocumentSearchApi | updateDocumentFulltext | PATCH /documents/{documentId}/fulltext | Update document's full-text AttributesApi | addAttribute | POST /attributes | Add new attribute AttributesApi | deleteAttribute | DELETE /attributes/{key} | Delete attribute AttributesApi | getAttribute | GET /attributes/{key} | Get Attribute AttributesApi | getAttributeAllowedValues | GET /attributes/{key}/allowedValues | Get Attribute Allowed Values AttributesApi | getAttributes | GET /attributes | Get Attributes listing AttributesApi | updateAttribute | PATCH /attributes/{key} | Update existing attribute CaseManagementApi | addCase | POST /cases | Add New Case CaseManagementApi | addNigo | POST /cases/{caseId}/nigos | Add New Nigo CaseManagementApi | addTask | POST /cases/{caseId}/tasks | Add New Task CaseManagementApi | deleteCase | DELETE /cases/{caseId} | Delete Case CaseManagementApi | deleteCaseDocument | DELETE /cases/{caseId}/documents/{documentId} | Delete Document from Case CaseManagementApi | deleteNigo | DELETE /cases/{caseId}/nigos/{nigoId} | Delete Nigo CaseManagementApi | deleteNigoDocument | DELETE /cases/{caseId}/nigos/{nigoId}/documents/{documentId} | Delete Document from Nigo CaseManagementApi | deleteTask | DELETE /cases/{caseId}/tasks/{taskId} | Delete Task CaseManagementApi | deleteTaskDocument | DELETE /cases/{caseId}/tasks/{taskId}/documents/{documentId} | Delete Document from Task CaseManagementApi | getCase | GET /cases/{caseId} | Get Case details CaseManagementApi | getCaseDocuments | GET /cases/{caseId}/documents | Get list of document in a case CaseManagementApi | getCaseNigo | GET /cases/{caseId}/nigos/{nigoId} | Get nigo in a case CaseManagementApi | getCaseNigos | GET /cases/{caseId}/nigos | Get list of Nigos in a case CaseManagementApi | getCaseTask | GET /cases/{caseId}/tasks/{taskId} | Get task in a case CaseManagementApi | getCaseTasks | GET /cases/{caseId}/tasks | Get list of tasks in a case CaseManagementApi | getCases | GET /cases | Get Case listing CaseManagementApi | getNigoDocuments | GET /cases/{caseId}/nigos/{nigoId}/documents | Get list of document in a task CaseManagementApi | getTaskDocuments | GET /cases/{caseId}/tasks/{taskId}/documents | Get list of document in a task CaseManagementApi | updateCase | PATCH /cases/{caseId} | Update existing Case CaseManagementApi | updateNigo | PATCH /cases/{caseId}/nigos/{nigoId} | Update existing Nigo CaseManagementApi | updateTask | PATCH /cases/{caseId}/tasks/{taskId} | Update existing Task CustomIndexApi | deleteIndex | DELETE /indices/{indexType}/{indexKey} | CustomIndexApi | indexFolderMove | POST /indices/{indexType}/move | CustomIndexApi | indexSearch | POST /indices/search | DocumentActionsApi | addDocumentActions | POST /documents/{documentId}/actions | Add document action DocumentActionsApi | addDocumentRetryAction | POST /documents/{documentId}/actions/retry | Retries failed document action(s) DocumentActionsApi | getDocumentActions | GET /documents/{documentId}/actions | Get document actions DocumentAttributesApi | addDocumentAttributes | POST /documents/{documentId}/attributes | Add attribute to document DocumentAttributesApi | deleteDocumentAttribute | DELETE /documents/{documentId}/attributes/{attributeKey} | Delete document attribute DocumentAttributesApi | deleteDocumentAttributeAndValue | DELETE /documents/{documentId}/attributes/{attributeKey}/{attributeValue} | Delete document's attribute value DocumentAttributesApi | getDocumentAttribute | GET /documents/{documentId}/attributes/{attributeKey} | Get document attribute by key DocumentAttributesApi | getDocumentAttributes | GET /documents/{documentId}/attributes | Get document's attributes DocumentAttributesApi | setDocumentAttributeValue | PUT /documents/{documentId}/attributes/{attributeKey} | Set document's attributes value DocumentAttributesApi | setDocumentAttributes | PUT /documents/{documentId}/attributes | Set document's attributes DocumentDataClassificationApi | getDocumentDataClassification | GET /documents/{documentId}/dataClassification | Get document's data classification DocumentDataClassificationApi | setDocumentDataClassification | PUT /documents/{documentId}/dataClassification | Set document's data classification DocumentFoldersApi | addFolder | POST /folders | Add document folder DocumentFoldersApi | deleteFolder | DELETE /folders/{indexKey} | Delete document folder DocumentFoldersApi | getFolderDocuments | GET /folders | Get document folders DocumentFoldersApi | getFolderPermissions | GET /folders/{indexKey}/permissions | Get folder permissions DocumentFoldersApi | setFolderPermissions | PUT /folders/permissions | Sets Folder Permissions DocumentGenerationApi | addDocumentGenerate | POST /documents/{documentId}/generate | Add Document Generate DocumentOCRApi | addDocumentOcr | POST /documents/{documentId}/ocr | Perform document ocr DocumentOCRApi | deleteDocumentOcr | DELETE /documents/{documentId}/ocr | Delete document ocr DocumentOCRApi | getDocumentOcr | GET /documents/{documentId}/ocr | Get document ocr content DocumentOCRApi | setDocumentOcr | PUT /documents/{documentId}/ocr | Set document ocr result DocumentSearchApi | documentSearch | POST /search | Document search DocumentSharesApi | addFolderShare | POST /shares/folders/{indexKey} | Add folder share DocumentSharesApi | deleteShare | DELETE /shares/{shareKey} | Delete folder share DocumentSharesApi | getUserShares | GET /shares | Get user shared folders DocumentTagsApi | addDocumentTags | POST /documents/{documentId}/tags | Add tag to document DocumentTagsApi | deleteDocumentTag | DELETE /documents/{documentId}/tags/{tagKey} | Delete document tag DocumentTagsApi | deleteDocumentTagAndValue | DELETE /documents/{documentId}/tags/{tagKey}/{tagValue} | Delete document's tag value DocumentTagsApi | getDocumentTag | GET /documents/{documentId}/tags/{tagKey} | Get document tag by key DocumentTagsApi | getDocumentTags | GET /documents/{documentId}/tags | Get document's tags DocumentTagsApi | setDocumentTag | PUT /documents/{documentId}/tags/{tagKey} | Update document tag value(s) DocumentTagsApi | setDocumentTags | PUT /documents/{documentId}/tags | Set document's tags DocumentTagsApi | updateDocumentTags | PATCH /documents/{documentId}/tags | Update document tags DocumentTagsApi | updateMatchingDocumentTags | PATCH /documents/tags | Mass Update document tag(s) DocumentVersionsApi | deleteDocumentVersion | DELETE /documents/{documentId}/versions/{versionKey} | Delete document version DocumentVersionsApi | getDocumentVersions | GET /documents/{documentId}/versions | Get document's versions DocumentVersionsApi | setDocumentVersion | PUT /documents/{documentId}/versions | Set version of document DocumentWorkflowsApi | addDocumentWorkflow | POST /documents/{documentId}/workflows | Add document workflow DocumentWorkflowsApi | addDocumentWorkflowDecisions | POST /documents/{documentId}/workflow/{workflowId}/decisions | Approve/Reject document in approval queue DocumentWorkflowsApi | addQueue | POST /queues | Add queue DocumentWorkflowsApi | addWorkflow | POST /workflows | Add workflow DocumentWorkflowsApi | deleteQueue | DELETE /queues/{queueId} | Delete queue DocumentWorkflowsApi | deleteWorkflow | DELETE /workflows/{workflowId} | Delete workflow DocumentWorkflowsApi | getDocumentWorkflow | GET /documents/{documentId}/workflows/{workflowId} | Get document workflow DocumentWorkflowsApi | getDocumentWorkflows | GET /documents/{documentId}/workflows | Get document workflows DocumentWorkflowsApi | getQueue | GET /queues/{queueId} | Get queue DocumentWorkflowsApi | getQueues | GET /queues | Get queues DocumentWorkflowsApi | getWorkflow | GET /workflows/{workflowId} | Get workflow DocumentWorkflowsApi | getWorkflowDocuments | GET /workflows/{workflowId}/documents | Get list of documents in workflow DocumentWorkflowsApi | getWorkflowQueueDocuments | GET /queues/{queueId}/documents | Get list of documents in queue DocumentWorkflowsApi | getWorkflows | GET /workflows | Get workflows DocumentWorkflowsApi | setWorkflow | PUT /workflows/{workflowId} | Set workflow DocumentWorkflowsApi | updateWorkflow | PATCH /workflows/{workflowId} | Update workflow DocumentsApi | addDocument | POST /documents | Add new document DocumentsApi | addDocumentSync | POST /documents/{documentId}/syncs | Add document sync to service DocumentsApi | addDocumentUpload | POST /documents/upload | Add large document DocumentsApi | compressDocuments | POST /documents/compress | Compress multiple documents into a .zip file DocumentsApi | deleteDocument | DELETE /documents/{documentId} | Delete document DocumentsApi | deleteDocumentCheckoutLegalHold | DELETE /documents/{documentId}/legalHold | Delete document legal hold checkout DocumentsApi | deletePublishedDocumentContent | DELETE /publications/{documentId} | Delete published document's contents DocumentsApi | getDocument | GET /documents/{documentId} | Get document DocumentsApi | getDocumentContent | GET /documents/{documentId}/content | Get document's contents DocumentsApi | getDocumentIdUpload | GET /documents/{documentId}/upload | Get url to update large document DocumentsApi | getDocumentSyncs | GET /documents/{documentId}/syncs | Get document syncs DocumentsApi | getDocumentUpload | GET /documents/upload | Get url to add large document DocumentsApi | getDocumentUrl | GET /documents/{documentId}/url | Get document content url DocumentsApi | getDocuments | GET /documents | Get Documents listing DocumentsApi | getPublishedDocumentContent | GET /publications/{documentId} | Get published document's contents DocumentsApi | purgeDocument | DELETE /documents/{documentId}/purge | Purge document DocumentsApi | setDocumentCheckout | PUT /documents/{documentId}/checkout | Perform document checkout DocumentsApi | setDocumentCheckoutLegalHold | PUT /documents/{documentId}/legalHold | Perform document legal hold checkout DocumentsApi | setDocumentRestore | PUT /documents/{documentId}/restore | Restore soft deleted document DocumentsApi | updateDocument | PATCH /documents/{documentId} | Update document ESignatureApi | addDocusignEnvelopes | POST /esignature/docusign/{documentId}/envelopes | Create Docusign Envelope request ESignatureApi | addDocusignRecipientView | POST /esignature/docusign/{documentId}/envelopes/{envelopeId}/views/recipient | Create Docusign Recipient View request ESignatureApi | addEsignatureDocusignEvents | POST /esignature/docusign/events | Add E-signature event EntityApi | addEntity | POST /entities/{entityTypeId} | Add New Entity EntityApi | addEntityType | POST /entityTypes | Add New EntityType EntityApi | deleteEntity | DELETE /entities/{entityTypeId}/{entityId} | Deletes Entity EntityApi | deleteEntityType | DELETE /entityTypes/{entityTypeId} | Deletes Entity Type EntityApi | getEntities | GET /entities/{entityTypeId} | Get Entities EntityApi | getEntity | GET /entities/{entityTypeId}/{entityId} | Get Entity EntityApi | getEntityType | GET /entityTypes/{entityTypeId} | Get EntityType EntityApi | getEntityTypes | GET /entityTypes | Get EntityTypes EntityApi | updateEntity | PATCH /entities/{entityTypeId}/{entityId} | Update Entity ExamineObjectsApi | getExaminePdf | GET /objects/examine/{id}/pdf | Add Examine Pdf ExamineObjectsApi | getExaminePdfUrl | GET /objects/examine/pdf | Add Examine Pdf GoogleIntegrationApi | addGoogleDocumentExport | POST /integrations/google/drive/documents/{documentId}/export | Add Google Document Export MalwareScanApi | getMalwareScanResults | GET /documents/{documentId}/malwareScan | Get Malware Scan results MalwareScanApi | setAntivirus | PUT /documents/{documentId}/antivirus | Antivirus document scan MalwareScanApi | setMalwareScan | PUT /documents/{documentId}/malwareScan | MalwareScan document scan MappingsApi | addMapping | POST /mappings | Add New Mapping MappingsApi | deleteMapping | DELETE /mappings/{mappingId} | Delete Mapping MappingsApi | getMapping | GET /mappings/{mappingId} | Get Mapping MappingsApi | getMappings | GET /mappings | Get Mappings MappingsApi | setMapping | PUT /mappings/{mappingId} | Set Mapping PublicApi | publicAddDocument | POST /public/documents | Public add document PublicApi | publicAddWebhook | POST /public/webhooks/{webhooks+} | Public add webhook ReindexApi | addReindexDocument | POST /reindex/documents/{documentId} | Reindex metadata on a document RulesetsApi | addRule | POST /rulesets/{rulesetId}/rules | Add New Rule RulesetsApi | addRuleset | POST /rulesets | Add New Ruleset RulesetsApi | deleteRule | DELETE /rulesets/{rulesetId}/rules/{ruleId} | Delete Rule RulesetsApi | deleteRuleset | DELETE /rulesets/{rulesetId} | Delete Ruleset RulesetsApi | getRule | GET /rulesets/{rulesetId}/rules/{ruleId} | Get Rule RulesetsApi | getRules | GET /rulesets/{rulesetId}/rules | Get Rules RulesetsApi | getRuleset | GET /rulesets/{rulesetId} | Get Ruleset RulesetsApi | getRulesets | GET /rulesets | Get Rulesets RulesetsApi | updateRule | PATCH /rulesets/{rulesetId}/rules/{ruleId} | Update Rule RulesetsApi | updateRuleset | PATCH /rulesets/{rulesetId} | Update Ruleset SchemasApi | addClassification | POST /sites/{siteId}/classifications | Add Classification SchemasApi | deleteClassification | DELETE /sites/{siteId}/classifications/{classificationId} | Delete Classification SchemasApi | getClassification | GET /sites/{siteId}/classifications/{classificationId} | Get Classification SchemasApi | getClassificationAttributeAllowedValues | GET /sites/{siteId}/classifications/{classificationId}/attributes/{key}/allowedValues | Get Classification's Attribute Allowed Values SchemasApi | getSitesClassifications | GET /sites/{siteId}/classifications | Get Sites Classifications SchemasApi | getSitesSchema | GET /sites/{siteId}/schema/document | Get Sites Schema SchemasApi | getSitesSchemaAttributeAllowedValues | GET /sites/{siteId}/schema/document/attributes/{key}/allowedValues | Get Attribute Allowed Values SchemasApi | setClassification | PUT /sites/{siteId}/classifications/{classificationId} | Set Classification SchemasApi | setSitesSchema | PUT /sites/{siteId}/schema/document | Set Sites Schema SystemManagementApi | addApiKey | POST /sites/{siteId}/apiKeys | Add API Key SystemManagementApi | addLocale | POST /sites/{siteId}/locales | Add Locale SystemManagementApi | addLocaleResourceItem | POST /sites/{siteId}/locales/{locale}/resourceItems | Add Locale Resource Item SystemManagementApi | addOpenSearchRestoreSnapshot | POST /sites/{siteId}/opensearch/snapshots/{snapshotName}/restore | Add an OpenSearch Restore Snapshot SystemManagementApi | addOpenSearchSnapshot | POST /sites/{siteId}/opensearch/snapshots/{snapshotName} | Add an OpenSearch Snapshot SystemManagementApi | addSite | POST /sites | Add Site SystemManagementApi | deleteApiKey | DELETE /sites/{siteId}/apiKeys/{apiKey} | Delete API Key SystemManagementApi | deleteLocale | DELETE /sites/{siteId}/locales/{locale} | Delete Locale SystemManagementApi | deleteLocaleResourceItem | DELETE /sites/{siteId}/locales/{locale}/resourceItems/{itemKey} | Delete Local Resource Item SystemManagementApi | deleteOpenSearchIndex | DELETE /sites/{siteId}/opensearch/index | Deletes site(s) OpenSearch index SystemManagementApi | deleteOpenSearchIndexByName | DELETE /sites/global/opensearch/indices/{indexName} | Deletes OpenSearch index by name SystemManagementApi | deleteOpenSearchRestoreSnapshot | DELETE /sites/{siteId}/opensearch/snapshots/{snapshotName}/restore | Deletes site(s) OpenSearch Restore Snapshot SystemManagementApi | deleteOpenSearchSnapshot | DELETE /sites/{siteId}/opensearch/snapshots/{snapshotName} | Deletes site(s) OpenSearch Snapshot SystemManagementApi | deleteOpenSearchSnapshotRepository | DELETE /sites/{siteId}/opensearch/snapshotRepository | Deletes site(s) OpenSearch Snapshot Repository SystemManagementApi | deleteSiteGroup | DELETE /sites/{siteId}/groups/{groupName} | Deletes Site Group and permissions SystemManagementApi | getAllOpenSearchIndices | GET /sites/global/opensearch/indices | Get all OpenSearch indices SystemManagementApi | getApiKeys | GET /sites/{siteId}/apiKeys | Get API Keys SystemManagementApi | getConfiguration | GET /sites/{siteId}/configuration | Get site configuration SystemManagementApi | getLocaleResourceItem | GET /sites/{siteId}/locales/{locale}/resourceItems/{itemKey} | Get Resource Item by Locale SystemManagementApi | getLocaleResourceItems | GET /sites/{siteId}/locales/{locale}/resourceItems | Get Resource Items by Locale SystemManagementApi | getLocales | GET /sites/{siteId}/locales | Get Locales SystemManagementApi | getOpenSearchIndex | GET /sites/{siteId}/opensearch/index | Get site(s) OpenSearch index settings SystemManagementApi | getOpenSearchIndices | GET /sites/{siteId}/opensearch/indices | Get site(s) OpenSearch indices SystemManagementApi | getOpenSearchSnapshot | GET /sites/{siteId}/opensearch/snapshots/{snapshotName} | Get site(s) OpenSearch snapshot SystemManagementApi | getOpenSearchSnapshotRepositories | GET /sites/global/opensearch/snapshotRepositories | Get site(s) OpenSearch snapshot repositories SystemManagementApi | getOpenSearchSnapshotRepository | GET /sites/{siteId}/opensearch/snapshotRepository | Get site(s) OpenSearch snapshot repository SystemManagementApi | getOpenSearchSnapshots | GET /sites/{siteId}/opensearch/snapshots | Get site(s) OpenSearch snapshots SystemManagementApi | getSiteGroup | GET /sites/{siteId}/groups/{groupName} | Get group and permissions belonging to site SystemManagementApi | getSiteGroups | GET /sites/{siteId}/groups | Get group(s) and permissions belonging to site SystemManagementApi | getSites | GET /sites | Get site(s) access SystemManagementApi | getVersion | GET /version | Get FormKiQ version SystemManagementApi | setLocaleResourceItem | PUT /sites/{siteId}/locales/{locale}/resourceItems/{itemKey} | Set Locale Resource Item SystemManagementApi | setOpenSearchIndex | PUT /sites/{siteId}/opensearch/index | Set site(s) OpenSearch index settings SystemManagementApi | setOpenSearchIndices | PUT /sites/{siteId}/opensearch/indices | Set site(s) OpenSearch index to use for a SiteId SystemManagementApi | setSiteGroupPermissions | PUT /sites/{siteId}/groups/{groupName}/permissions | Set Site's Group Permissions SystemManagementApi | updateConfiguration | PATCH /sites/{siteId}/configuration | Update site configuration SystemManagementApi | updateSite | PATCH /sites/{siteId} | Update Site TagIndexApi | indexSearch | POST /indices/search | UserActivitiesApi | getDocumentUserActivities | GET /documents/{documentId}/userActivities | Get user activities for a document UserActivitiesApi | getResourceActivities | GET /activities | Get resource activities UserActivitiesApi | getUserActivities | GET /userActivities | Get user activities UserManagementApi | addGroup | POST /groups | Add a group UserManagementApi | addUser | POST /users | Add User UserManagementApi | addUserToGroup | POST /groups/{groupName}/users | Add User to a group UserManagementApi | deleteGroup | DELETE /groups/{groupName} | Delete Group UserManagementApi | deleteUsername | DELETE /users/{username} | Delete Username UserManagementApi | getGroup | GET /groups/{groupName} | Get a user group UserManagementApi | getGroups | GET /groups | Get list of user group(s) UserManagementApi | getListOfUserGroups | GET /users/{username}/groups | Returns a list of group user belongs to UserManagementApi | getUser | GET /users/{username} | Get a user UserManagementApi | getUsers | GET /users | Get list of user(s) UserManagementApi | getUsersInGroup | GET /groups/{groupName}/users | Get users in a group UserManagementApi | removeUsernameFromGroup | DELETE /groups/{groupName}/users/{username} | Remove Username From Group UserManagementApi | setUserOperation | PUT /users/{username}/{userOperation} | Set User Operation WebhooksApi | addWebhook | POST /webhooks | Add webhook WebhooksApi | addWebhookDocument | POST /private/webhooks/{webhooks+} | Add webhook WebhooksApi | addWebhookTag | POST /webhooks/{webhookId}/tags | Add webhook tag WebhooksApi | deleteWebhook | DELETE /webhooks/{webhookId} | Delete webhook WebhooksApi | getWebhook | GET /webhooks/{webhookId} | Get webhook WebhooksApi | getWebhookTags | GET /webhooks/{webhookId}/tags | Get webhook tags WebhooksApi | getWebhooks | GET /webhooks | Get webhooks WebhooksApi | updateWebhook | PATCH /webhooks/{webhookId} | Update webhook
Documentation For Models
- Activity
- ActivityStatus
- AddAction
- AddActionParameters
- AddApiKeyRequest
- AddApiKeyResponse
- AddAttribute
- AddAttributeRequest
- AddAttributeSchemaOptional
- AddAttributeSchemaRequired
- AddCase
- AddCaseRequest
- AddCaseResponse
- AddChildDocument
- AddChildDocumentResponse
- AddClassification
- AddClassificationRequest
- AddClassificationResponse
- AddDocumentActionsRequest
- AddDocumentActionsResponse
- AddDocumentActionsRetryResponse
- AddDocumentAttribute
- AddDocumentAttributeClassification
- AddDocumentAttributeEntity
- AddDocumentAttributeRelationship
- AddDocumentAttributeStandard
- AddDocumentAttributeValue
- AddDocumentAttributesRequest
- AddDocumentFulltextRequest
- AddDocumentFulltextResponse
- AddDocumentGenerateRequest
- AddDocumentGenerateResponse
- AddDocumentMetadata
- AddDocumentOcrRequest
- AddDocumentOcrResponse
- AddDocumentRequest
- AddDocumentResponse
- AddDocumentSync
- AddDocumentSyncRequest
- AddDocumentSyncService
- AddDocumentTag
- AddDocumentTagsRequest
- AddDocumentUploadRequest
- AddDocumentWorkflowDecisionsRequest
- AddDocumentWorkflowDecisionsResponse
- AddDocumentWorkflowRequest
- AddDocumentWorkflowResponse
- AddDocusignEnvelopesRequest
- AddDocusignEnvelopesResponse
- AddDocusignRecipientViewRequest
- AddDocusignRecipientViewResponse
- AddEntity
- AddEntityAttribute
- AddEntityRequest
- AddEntityResponse
- AddEntityType
- AddEntityTypeRequest
- AddEntityTypeResponse
- AddFolderPermission
- AddFolderRequest
- AddFolderResponse
- AddFolderShareRequest
- AddFolderShareResponse
- AddGoogleDocumentExportRequest
- AddGoogleDocumentExportResponse
- AddGroup
- AddGroupRequest
- AddLocaleRequest
- AddLocaleResourceClassificationItem
- AddLocaleResourceInterfaceItem
- AddLocaleResourceItemRequest
- AddLocaleResourceItemResponse
- AddLocaleResourceSchemaItem
- AddMapping
- AddMappingRequest
- AddMappingResponse
- AddNigo
- AddNigoRequest
- AddNigoResponse
- AddQueueRequest
- AddQueueResponse
- AddReindexDocumentRequest
- AddResourceItem
- AddResponse
- AddRule
- AddRuleRequest
- AddRuleResponse
- AddRuleset
- AddRulesetRequest
- AddRulesetResponse
- AddShare
- AddSite
- AddSiteRequest
- AddTask
- AddTaskRequest
- AddTaskResponse
- AddUser
- AddUserRequest
- AddWebhookRequest
- AddWebhookResponse
- AddWebhookTagRequest
- AddWorkflowRequest
- AddWorkflowResponse
- AddWorkflowStep
- AddWorkflowStepDecision
- AddWorkflowStepQueue
- ApiKey
- Attribute
- AttributeDataType
- AttributeSchemaCompositeKey
- AttributeSchemaOptional
- AttributeSchemaRequired
- AttributeType
- AttributeValueType
- Case
- CaseStatus
- ChecksumType
- ChildDocument
- Classification
- ClassificationSummary
- DataClassification
- DataClassificationAttribute
- DeleteApiKeyResponse
- DeleteCaseDocumentResponse
- DeleteCaseNigoDocumentResponse
- DeleteCaseNigoResponse
- DeleteCaseResponse
- DeleteCaseTaskDocumentResponse
- DeleteCaseTaskResponse
- DeleteFolderResponse
- DeleteFulltextResponse
- DeleteIndicesResponse
- DeleteQueueResponse
- DeleteResponse
- DeleteRuleResponse
- DeleteRulesetResponse
- DeleteShareResponse
- DeleteWorkflowResponse
- Document
- DocumentAction
- DocumentActionStatus
- DocumentActionType
- DocumentAttribute
- DocumentFulltextAttribute
- DocumentFulltextAttributeEq
- DocumentFulltextRequest
- DocumentFulltextResponse
- DocumentFulltextSearch
- DocumentFulltextTag
- DocumentGenerateDataSource
- DocumentGenerateInsertDocument
- DocumentGenerateInsertDocumentPosition
- DocumentGenerateOutputType
- DocumentId
- DocumentMetadata
- DocumentRelationshipType
- DocumentSearch
- DocumentSearchAttribute
- DocumentSearchMatchAttribute
- DocumentSearchMatchTag
- DocumentSearchMeta
- DocumentSearchRange
- DocumentSearchRequest
- DocumentSearchResponse
- DocumentSearchTag
- DocumentSearchTags
- DocumentSync
- DocumentSyncService
- DocumentSyncStatus
- DocumentSyncType
- DocumentTag
- DocumentVersion
- DocumentWorkflow
- DocumentWorkflowStatus
- DocumentsCompressRequest
- DocumentsCompressResponse
- DocusignConfig
- DocusignEnvironment
- DocusignInpersonSigner
- DocusignNotification
- DocusignNotificationExpirations
- DocusignNotificationReminders
- DocusignRecipientView
- DocusignSignHereTabs
- DocusignSigner
- DocusignSigningTabs
- Entity
- EntityAttribute
- EntityType
- EntityTypeNamespace
- ErrorsResponse
- FolderPermission
- FolderPermissionType
- FulltextAttribute
- FulltextSearchItem
- GetActivitesResponse
- GetApiKeysResponse
- GetAttributeAllowedValuesResponse
- GetAttributeResponse
- GetAttributesResponse
- GetCaseDocumentsResponse
- GetCaseNigoResponse
- GetCaseNigosResponse
- GetCaseResponse
- GetCaseTaskResponse
- GetCaseTasksResponse
- GetCasesResponse
- GetClassificationResponse
- GetClassificationsResponse
- GetConfigurationResponse
- GetDocumentActionsResponse
- GetDocumentAttributeResponse
- GetDocumentAttributesResponse
- GetDocumentContentResponse
- GetDocumentDataClassificationResponse
- GetDocumentFulltextResponse
- GetDocumentOcrResponse
- GetDocumentResponse
- GetDocumentSyncResponse
- GetDocumentTagResponse
- GetDocumentTagsResponse
- GetDocumentUrlResponse
- GetDocumentVersionsResponse
- GetDocumentWorkflowResponse
- GetDocumentWorkflowsResponse
- GetDocumentsResponse
- GetEntitiesResponse
- GetEntityResponse
- GetEntityTypeResponse
- GetEntityTypesResponse
- GetExaminePdfResponse
- GetExaminePdfUrlResponse
- GetFolderPermissionsResponse
- GetFoldersResponse
- GetGroupResponse
- GetGroupsResponse
- GetLocaleResourceItemResponse
- GetLocaleResourceItemsResponse
- GetLocalesResponse
- GetMalwareScanResponse
- GetMappingResponse
- GetMappingsResponse
- GetOpaAccessPoliciesResponse
- GetOpaAccessPolicyItemsResponse
- GetOpaAccessPolicyResponse
- GetOpenSearchIndexResponse
- GetOpenSearchIndiceResponse
- GetOpenSearchSnapshotRepositoryResponse
- GetOpenSearchSnapshotResponse
- GetQueueResponse
- GetQueuesResponse
- GetRuleResponse
- GetRulesResponse
- GetRulesetResponse
- GetRulesetsResponse
- GetSiteGroupResponse
- GetSiteGroupsResponse
- GetSitesResponse
- GetSitesSchemaResponse
- GetUserActivitesResponse
- GetUserGroupsResponse
- GetUserResponse
- GetUserSharesResponse
- GetUsersInGroupResponse
- GetUsersResponse
- GetVersionResponse
- GetWebhookResponse
- GetWebhookTagsResponse
- GetWebhooksResponse
- GetWorkflowDocumentsResponse
- GetWorkflowQueueDocumentsResponse
- GetWorkflowResponse
- GetWorkflowsResponse
- GoogleConfig
- GoogleExportOutputType
- Group
- IndexFolderMoveRequest
- IndexFolderMoveResponse
- IndexSearch
- IndexSearchRequest
- IndexSearchResponse
- LocaleInfo
- LocaleResourceType
- MalwareEngine
- MalwareScanResult
- MalwareScanStatus
- Mapping
- MappingAttribute
- MappingAttributeLabelMatchingType
- MappingAttributeMetadataField
- MappingAttributeSourceType
- MatchDocumentTag
- ModelError
- Nigo
- NigoStatus
- OcrConfig
- OcrEngine
- OcrKeyValues
- OcrOutputType
- OcrTable
- OcrTableData
- OpaPolicy
- OpaPolicyAttribute
- OpaPolicyAttributeEq
- OpaPolicyAttributeGt
- OpaPolicyAttributeGte
- OpaPolicyAttributeIn
- OpaPolicyAttributeInput
- OpaPolicyAttributeLt
- OpaPolicyAttributeLte
- OpaPolicyAttributeNeq
- OpaPolicyAttributeNotIn
- OpaPolicyInput
- OpaPolicyInputMethod
- OpaPolicyInputResource
- OpaPolicyItem
- OpenSearchAlias
- OpenSearchIndex
- OpenSearchIndexSetting
- OpenSearchS3Repository
- OpenSearchSnapshot
- OpenSearchSnapshotFailure
- OpenSearchSnapshotShard
- PdfDocument
- PdfDocumentField
- QueryFulltextResponse
- Queue
- ReindexTarget
- ResourceItem
- Rule
- RuleCondition
- RuleConditionAttribute
- RuleConditionCriterion
- RuleConditionMust
- RuleConditionOperation
- Ruleset
- RulesetStatus
- SchemaAttributes
- SearchRangeDataType
- SearchResponseFields
- SearchResultDocument
- SearchResultDocumentAttribute
- SetClassificationRequest
- SetDocumentAttributeRequest
- SetDocumentAttributesRequest
- SetDocumentDataClassificationRequest
- SetDocumentDataClassificationResponse
- SetDocumentFulltextRequest
- SetDocumentFulltextResponse
- SetDocumentOcrRequest
- SetDocumentRestoreResponse
- SetDocumentTagKeyRequest
- SetDocumentVersionRequest
- SetDocumentVersionResponse
- SetFolderPermissionsRequest
- SetGroupPermissionsRequest
- SetLocaleResourceItemRequest
- SetMappingRequest
- SetOpaAccessPolicyItemsRequest
- SetOpenSearchIndexRequest
- SetOpenSearchIndexResponse
- SetOpenSearchIndiceRequest
- SetResponse
- SetSchemaAttributes
- SetSitesSchemaRequest
- SetWorkflowRequest
- SetWorkflowResponse
- Site
- SiteConfig
- SiteGroup
- SiteGroupPermissions
- SiteStatus
- SiteUsage
- StringFormat
- StringGeneratorType
- Task
- TaskStatus
- TextractQuery
- UpdateAttribute
- UpdateAttributeRequest
- UpdateCase
- UpdateCaseRequest
- UpdateCaseResponse
- UpdateConfigurationRequest
- UpdateConfigurationResponse
- UpdateDocumentFulltextRequest
- UpdateDocumentFulltextResponse
- UpdateDocumentRequest
- UpdateEntityRequest
- UpdateMatchingDocumentTagsRequest
- UpdateMatchingDocumentTagsRequestMatch
- UpdateMatchingDocumentTagsRequestUpdate
- UpdateMatchingDocumentTagsResponse
- UpdateNigo
- UpdateNigoRequest
- UpdateNigoResponse
- UpdateResponse
- UpdateRule
- UpdateRuleRequest
- UpdateRuleResponse
- UpdateRuleset
- UpdateRulesetRequest
- UpdateRulesetResponse
- UpdateSite
- UpdateSiteRequest
- UpdateTask
- UpdateTaskRequest
- UpdateTaskResponse
- UpdateWorkflowRequest
- UpdateWorkflowResponse
- User
- UserActivity
- UserActivityChanges
- UserActivityType
- UserAttributes
- UserShare
- UserSharePermission
- UserSharePermissionType
- ValidationError
- ValidationErrorsResponse
- Watermark
- WatermarkPosition
- WatermarkPositionXAnchor
- WatermarkPositionYAnchor
- WatermarkScale
- WebhookTag
- WorkflowDocument
- WorkflowQueue
- WorkflowStatus
- WorkflowStep
- WorkflowStepDecision
- WorkflowStepDecisionType
- WorkflowSummary
