Skip to content

Latest commit

 

History

History
140 lines (93 loc) · 4.52 KB

integrationMappings.md

File metadata and controls

140 lines (93 loc) · 4.52 KB
Raw

IntegrationMappingsManager

List Slack integration mappings

Lists Slack integration mappings in a users' enterprise.

You need Admin or Co-Admin role to use this endpoint.

This operation is performed by calling function getSlackIntegrationMapping.

See the endpoint docs at API Reference.

await userClient.integrationMappings.getSlackIntegrationMapping();

Arguments

  • queryParams GetSlackIntegrationMappingQueryParams
    • Query parameters of getSlackIntegrationMapping method
  • headers GetSlackIntegrationMappingHeaders
    • Headers of getSlackIntegrationMapping method
  • cancellationToken undefined | CancellationToken
    • Token used for request cancellation.

Returns

This function returns a value of type IntegrationMappings.

Returns a collection of integration mappings

Create Slack integration mapping

Creates a Slack integration mapping by mapping a Slack channel to a Box item.

You need Admin or Co-Admin role to use this endpoint.

This operation is performed by calling function createSlackIntegrationMapping.

See the endpoint docs at API Reference.

await userClient.integrationMappings.createSlackIntegrationMapping({
  partnerItem: new IntegrationMappingPartnerItemSlack({
    id: partnerItemId,
    slackOrgId: slackOrgId,
  }),
  boxItem: new IntegrationMappingBoxItemSlack({ id: folder.id }),
} satisfies IntegrationMappingSlackCreateRequest);

Arguments

  • requestBody IntegrationMappingSlackCreateRequest
    • Request body of createSlackIntegrationMapping method
  • headers CreateSlackIntegrationMappingHeaders
    • Headers of createSlackIntegrationMapping method
  • cancellationToken undefined | CancellationToken
    • Token used for request cancellation.

Returns

This function returns a value of type IntegrationMapping.

Returns the created integration mapping.

Update Slack integration mapping

Updates a Slack integration mapping. Supports updating the Box folder ID and options.

You need Admin or Co-Admin role to use this endpoint.

This operation is performed by calling function updateSlackIntegrationMappingById.

See the endpoint docs at API Reference.

Currently we don't have an example for calling updateSlackIntegrationMappingById in integration tests

Arguments

  • integrationMappingId string
    • An ID of an integration mapping Example: "11235432"
  • requestBody UpdateSlackIntegrationMappingByIdRequestBody
    • Request body of updateSlackIntegrationMappingById method
  • headers UpdateSlackIntegrationMappingByIdHeaders
    • Headers of updateSlackIntegrationMappingById method
  • cancellationToken undefined | CancellationToken
    • Token used for request cancellation.

Returns

This function returns a value of type IntegrationMapping.

Returns the updated integration mapping object.

Delete Slack integration mapping

Deletes a Slack integration mapping.

You need Admin or Co-Admin role to use this endpoint.

This operation is performed by calling function deleteSlackIntegrationMappingById.

See the endpoint docs at API Reference.

Currently we don't have an example for calling deleteSlackIntegrationMappingById in integration tests

Arguments

  • integrationMappingId string
    • An ID of an integration mapping Example: "11235432"
  • headers DeleteSlackIntegrationMappingByIdHeaders
    • Headers of deleteSlackIntegrationMappingById method
  • cancellationToken undefined | CancellationToken
    • Token used for request cancellation.

Returns

This function returns a value of type undefined.

Empty body in response