Skip to main content

@wildix/wim-integrations-client

wim-integrations-client package

Classes

Class

Description

BulkDeleteIntegrationsCommand

Deletes multiple integrations in a single batch operation. This is a deprecated operation - use DeleteIntegrations instead.

BulkPutIntegrationsCommand

Creates multiple integrations in a single batch operation. This is a deprecated operation - use CreateIntegrations instead.

CreateIntegrationCommand

Creates a new integration for the specified company with the provided configuration.

CreateIntegrationsCommand

Creates multiple integrations in a single batch operation.

DeleteIntegrationCommand

Deletes an existing integration for the specified company and integration ID.

DeleteIntegrationsCommand

Deletes multiple integrations in a single batch operation, either by integration IDs or company IDs.

ForbiddenException

GetCompanyIntegrationListCommand

Retrieves a list of all companies with their integration information. This is a deprecated operation - use ListIntegrations instead.

GetIntegrationByIdCommand

Retrieves details of a specific integration by its unique identifier. This is a deprecated operation - use GetIntegration instead.

GetIntegrationCommand

Retrieves details of a specific integration by its unique identifier.

GetIntegrationsByCompaniesAndServicesCommand

Retrieves integrations filtered by multiple companies and services. This is a deprecated operation - use ListIntegrations instead.

GetIntegrationsByCompanyIdCommand

Retrieves all integrations for a specific company. This is a deprecated operation - use ListIntegrations instead.

GetIntegrationsByServiceCommand

Retrieves all integrations for a specific service with optional filtering. This is a deprecated operation - use ListIntegrations instead.

GetIntegrationsByServicesCommand

Retrieves all integrations for multiple services. This is a deprecated operation - use ListIntegrations instead.

IntegrationNotFoundException

Integrations

IntegrationsClient

IntegrationsServiceException

Base exception class for all service exceptions from Integrations service.

ListIntegrationsCommand

Retrieves a paginated list of integrations with optional filtering by company, service, status, and custom field filters.

ListWebhookIntegrationsCommand

Fetch the whole list of webhook integrations

PatchIntegrationCommand

Updates an existing integration for a specific company. This is a deprecated operation - use UpdateIntegration instead.

PutIntegrationCommand

Creates or updates an integration for a specific company. This is a deprecated operation - use CreateIntegration instead.

RemoveIntegrationCommand

Removes an existing integration for a specific company. This is a deprecated operation - use DeleteIntegration instead.

UpdateIntegrationCommand

Updates the configuration of an existing integration for the specified company.

ValidationException

Functions

Function

Description

paginateListIntegrations(config, input, rest)

Interfaces

Interface

Description

BriefIntegration

BulkDeleteIntegrationsCommandInput

The input for BulkDeleteIntegrationsCommand.

BulkDeleteIntegrationsCommandOutput

The output of BulkDeleteIntegrationsCommand.

BulkDeleteIntegrationsInput

BulkDeleteIntegrationsOutput

BulkPutIntegrationsCommandInput

The input for BulkPutIntegrationsCommand.

BulkPutIntegrationsCommandOutput

The output of BulkPutIntegrationsCommand.

BulkPutIntegrationsInput

BulkPutIntegrationsOutput

ClientDefaults

CompanyIntegrations

CreateIntegrationCommandInput

The input for CreateIntegrationCommand.

CreateIntegrationCommandOutput

The output of CreateIntegrationCommand.

CreateIntegrationInput

CreateIntegrationOutput

CreateIntegrationsCommandInput

The input for CreateIntegrationsCommand.

CreateIntegrationsCommandOutput

The output of CreateIntegrationsCommand.

CreateIntegrationsInput

CreateIntegrationsOutput

DeleteIntegrationCommandInput

The input for DeleteIntegrationCommand.

DeleteIntegrationCommandOutput

The output of DeleteIntegrationCommand.

DeleteIntegrationInput

DeleteIntegrationOutput

DeleteIntegrationsCommandInput

The input for DeleteIntegrationsCommand.

DeleteIntegrationsCommandOutput

The output of DeleteIntegrationsCommand.

DeleteIntegrationsInput

DeleteIntegrationsOutput

GetCompanyIntegrationListCommandInput

The input for GetCompanyIntegrationListCommand.

GetCompanyIntegrationListCommandOutput

The output of GetCompanyIntegrationListCommand.

GetCompanyIntegrationListInput

GetCompanyIntegrationListOutput

GetIntegrationByIdCommandInput

The input for GetIntegrationByIdCommand.

GetIntegrationByIdCommandOutput

The output of GetIntegrationByIdCommand.

GetIntegrationByIdInput

GetIntegrationByIdOutput

GetIntegrationCommandInput

The input for GetIntegrationCommand.

GetIntegrationCommandOutput

The output of GetIntegrationCommand.

GetIntegrationInput

GetIntegrationOutput

GetIntegrationsByCompaniesAndServicesCommandInput

The input for GetIntegrationsByCompaniesAndServicesCommand.

GetIntegrationsByCompaniesAndServicesCommandOutput

The output of GetIntegrationsByCompaniesAndServicesCommand.

GetIntegrationsByCompaniesAndServicesInput

GetIntegrationsByCompaniesAndServicesOutput

GetIntegrationsByCompanyIdCommandInput

The input for GetIntegrationsByCompanyIdCommand.

GetIntegrationsByCompanyIdCommandOutput

The output of GetIntegrationsByCompanyIdCommand.

GetIntegrationsByCompanyIdInput

GetIntegrationsByCompanyIdOutput

GetIntegrationsByServiceCommandInput

The input for GetIntegrationsByServiceCommand.

GetIntegrationsByServiceCommandOutput

The output of GetIntegrationsByServiceCommand.

GetIntegrationsByServiceInput

GetIntegrationsByServiceOutput

GetIntegrationsByServicesCommandInput

The input for GetIntegrationsByServicesCommand.

GetIntegrationsByServicesCommandOutput

The output of GetIntegrationsByServicesCommand.

GetIntegrationsByServicesInput

GetIntegrationsByServicesOutput

Integration

Integrations

IntegrationsClientConfig

The configuration interface of IntegrationsClient class constructor that set the region, credentials and other options.

IntegrationsClientResolvedConfig

The resolved configuration interface of IntegrationsClient class. This is resolved and normalized from the constructor configuration interface.

IntegrationsPaginationConfiguration

Keys

ListIntegrationsCommandInput

The input for ListIntegrationsCommand.

ListIntegrationsCommandOutput

The output of ListIntegrationsCommand.

ListIntegrationsInput

ListIntegrationsOutput

ListWebhookIntegrationsCommandInput

The input for ListWebhookIntegrationsCommand.

ListWebhookIntegrationsCommandOutput

The output of ListWebhookIntegrationsCommand.

ListWebhookIntegrationsInput

ListWebhookIntegrationsOutput

PatchIntegrationCommandInput

The input for PatchIntegrationCommand.

PatchIntegrationCommandOutput

The output of PatchIntegrationCommand.

PatchIntegrationInput

PatchIntegrationOutput

PutIntegrationCommandInput

The input for PutIntegrationCommand.

PutIntegrationCommandOutput

The output of PutIntegrationCommand.

PutIntegrationDataItem

PutIntegrationInput

PutIntegrationOutput

RemoveIntegrationCommandInput

The input for RemoveIntegrationCommand.

RemoveIntegrationCommandOutput

The output of RemoveIntegrationCommand.

RemoveIntegrationInput

RemoveIntegrationOutput

RuntimeExtension

UpdateIntegrationCommandInput

The input for UpdateIntegrationCommand.

UpdateIntegrationCommandOutput

The output of UpdateIntegrationCommand.

UpdateIntegrationInput

UpdateIntegrationOutput

WebhookIntegration

Variables

Variable

Description

EntityType

IntegrationStatusType

Service

WebhookEndpointType

Type Aliases

Type Alias

Description

EntityType

IntegrationsClientConfigType

IntegrationsClientResolvedConfigType

IntegrationStatusType

Service

ServiceInputTypes

ServiceOutputTypes

WebhookEndpointType