Skip to content

Commit 6ce1c7c

Browse files
box-sdk-buildbox-sdk-build
and
box-sdk-build
authored
feat: add Integration Mappings Teams API (box/box-openapi#517) (#548)
Co-authored-by: box-sdk-build <[email protected]>
1 parent 916502c commit 6ce1c7c

10 files changed

+1290
-1
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "41feeaa", "specHash": "1080bb4", "version": "1.13.2" }
1+
{ "engineHash": "41feeaa", "specHash": "c303afc", "version": "1.13.2" }

docs/integrationMappings.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
- [Create Slack integration mapping](#create-slack-integration-mapping)
55
- [Update Slack integration mapping](#update-slack-integration-mapping)
66
- [Delete Slack integration mapping](#delete-slack-integration-mapping)
7+
- [List Teams integration mappings](#list-teams-integration-mappings)
8+
- [Create Teams integration mapping](#create-teams-integration-mapping)
9+
- [Update Teams integration mapping](#update-teams-integration-mapping)
10+
- [Delete Teams integration mapping](#delete-teams-integration-mapping)
711

812
## List Slack integration mappings
913

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

132136
Empty body in response
137+
138+
## List Teams integration mappings
139+
140+
Lists [Teams integration mappings](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams) in a users' enterprise.
141+
You need Admin or Co-Admin role to
142+
use this endpoint.
143+
144+
This operation is performed by calling function `getIntegrationMappingTeams`.
145+
146+
See the endpoint docs at
147+
[API Reference](https://developer.box.com/reference/get-integration-mappings-teams/).
148+
149+
_Currently we don't have an example for calling `getIntegrationMappingTeams` in integration tests_
150+
151+
### Arguments
152+
153+
- queryParams `GetIntegrationMappingTeamsQueryParams`
154+
- Query parameters of getIntegrationMappingTeams method
155+
- headersInput `GetIntegrationMappingTeamsHeadersInput`
156+
- Headers of getIntegrationMappingTeams method
157+
- cancellationToken `undefined | CancellationToken`
158+
- Token used for request cancellation.
159+
160+
### Returns
161+
162+
This function returns a value of type `IntegrationMappingsTeams`.
163+
164+
Returns a collection of integration mappings
165+
166+
## Create Teams integration mapping
167+
168+
Creates a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams)
169+
by mapping a Teams channel to a Box item.
170+
You need Admin or Co-Admin role to
171+
use this endpoint.
172+
173+
This operation is performed by calling function `createIntegrationMappingTeams`.
174+
175+
See the endpoint docs at
176+
[API Reference](https://developer.box.com/reference/post-integration-mappings-teams/).
177+
178+
_Currently we don't have an example for calling `createIntegrationMappingTeams` in integration tests_
179+
180+
### Arguments
181+
182+
- requestBody `IntegrationMappingTeamsCreateRequest`
183+
- Request body of createIntegrationMappingTeams method
184+
- optionalsInput `CreateIntegrationMappingTeamsOptionalsInput`
185+
-
186+
187+
### Returns
188+
189+
This function returns a value of type `IntegrationMappingTeams`.
190+
191+
Returns the created integration mapping.
192+
193+
## Update Teams integration mapping
194+
195+
Updates a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams).
196+
Supports updating the Box folder ID and options.
197+
You need Admin or Co-Admin role to
198+
use this endpoint.
199+
200+
This operation is performed by calling function `updateIntegrationMappingTeamsById`.
201+
202+
See the endpoint docs at
203+
[API Reference](https://developer.box.com/reference/put-integration-mappings-teams-id/).
204+
205+
_Currently we don't have an example for calling `updateIntegrationMappingTeamsById` in integration tests_
206+
207+
### Arguments
208+
209+
- integrationMappingId `string`
210+
- An ID of an integration mapping Example: "11235432"
211+
- optionalsInput `UpdateIntegrationMappingTeamsByIdOptionalsInput`
212+
-
213+
214+
### Returns
215+
216+
This function returns a value of type `IntegrationMappingTeams`.
217+
218+
Returns the updated integration mapping object.
219+
220+
## Delete Teams integration mapping
221+
222+
Deletes a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams).
223+
You need Admin or Co-Admin role to
224+
use this endpoint.
225+
226+
This operation is performed by calling function `deleteIntegrationMappingTeamsById`.
227+
228+
See the endpoint docs at
229+
[API Reference](https://developer.box.com/reference/delete-integration-mappings-teams-id/).
230+
231+
_Currently we don't have an example for calling `deleteIntegrationMappingTeamsById` in integration tests_
232+
233+
### Arguments
234+
235+
- integrationMappingId `string`
236+
- An ID of an integration mapping Example: "11235432"
237+
- optionalsInput `DeleteIntegrationMappingTeamsByIdOptionalsInput`
238+
-
239+
240+
### Returns
241+
242+
This function returns a value of type `undefined`.
243+
244+
Empty body in response

0 commit comments

Comments
 (0)