Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .codegen.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "41feeaa", "specHash": "1080bb4", "version": "1.13.2" }
{ "engineHash": "41feeaa", "specHash": "c303afc", "version": "1.13.2" }
112 changes: 112 additions & 0 deletions docs/integrationMappings.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
- [Create Slack integration mapping](#create-slack-integration-mapping)
- [Update Slack integration mapping](#update-slack-integration-mapping)
- [Delete Slack integration mapping](#delete-slack-integration-mapping)
- [List Teams integration mappings](#list-teams-integration-mappings)
- [Create Teams integration mapping](#create-teams-integration-mapping)
- [Update Teams integration mapping](#update-teams-integration-mapping)
- [Delete Teams integration mapping](#delete-teams-integration-mapping)

## List Slack integration mappings

Expand Down Expand Up @@ -130,3 +134,111 @@ _Currently we don't have an example for calling `deleteSlackIntegrationMappingBy
This function returns a value of type `undefined`.

Empty body in response

## List Teams integration mappings

Lists [Teams integration mappings](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams) in a users' enterprise.
You need Admin or Co-Admin role to
use this endpoint.

This operation is performed by calling function `getIntegrationMappingTeams`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/get-integration-mappings-teams/).

_Currently we don't have an example for calling `getIntegrationMappingTeams` in integration tests_

### Arguments

- queryParams `GetIntegrationMappingTeamsQueryParams`
- Query parameters of getIntegrationMappingTeams method
- headersInput `GetIntegrationMappingTeamsHeadersInput`
- Headers of getIntegrationMappingTeams method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.

### Returns

This function returns a value of type `IntegrationMappingsTeams`.

Returns a collection of integration mappings

## Create Teams integration mapping

Creates a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams)
by mapping a Teams channel to a Box item.
You need Admin or Co-Admin role to
use this endpoint.

This operation is performed by calling function `createIntegrationMappingTeams`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/post-integration-mappings-teams/).

_Currently we don't have an example for calling `createIntegrationMappingTeams` in integration tests_

### Arguments

- requestBody `IntegrationMappingTeamsCreateRequest`
- Request body of createIntegrationMappingTeams method
- optionalsInput `CreateIntegrationMappingTeamsOptionalsInput`
-

### Returns

This function returns a value of type `IntegrationMappingTeams`.

Returns the created integration mapping.

## Update Teams integration mapping

Updates a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams).
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 `updateIntegrationMappingTeamsById`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/put-integration-mappings-teams-id/).

_Currently we don't have an example for calling `updateIntegrationMappingTeamsById` in integration tests_

### Arguments

- integrationMappingId `string`
- An ID of an integration mapping Example: "11235432"
- optionalsInput `UpdateIntegrationMappingTeamsByIdOptionalsInput`
-

### Returns

This function returns a value of type `IntegrationMappingTeams`.

Returns the updated integration mapping object.

## Delete Teams integration mapping

Deletes a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams).
You need Admin or Co-Admin role to
use this endpoint.

This operation is performed by calling function `deleteIntegrationMappingTeamsById`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/delete-integration-mappings-teams-id/).

_Currently we don't have an example for calling `deleteIntegrationMappingTeamsById` in integration tests_

### Arguments

- integrationMappingId `string`
- An ID of an integration mapping Example: "11235432"
- optionalsInput `DeleteIntegrationMappingTeamsByIdOptionalsInput`
-

### Returns

This function returns a value of type `undefined`.

Empty body in response
Loading
Loading