Skip to content

Commit df45dea

Browse files
author
box-sdk-build
committed
Auto resolve conflict by keeping our changes
2 parents 8bb6458 + d1aa250 commit df45dea

File tree

1 file changed

+116
-0
lines changed

1 file changed

+116
-0
lines changed

docs/integration_mappings.md

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,3 +305,119 @@ user_client.integration_mappings.delete_teams_integration_mapping_by_id(
305305
This function returns a value of type `None`.
306306

307307
Empty body in response
308+
309+
## List Teams integration mappings
310+
311+
Lists [Teams integration mappings](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams) in a users' enterprise.
312+
You need Admin or Co-Admin role to
313+
use this endpoint.
314+
315+
This operation is performed by calling function `get_integration_mapping_teams`.
316+
317+
See the endpoint docs at
318+
[API Reference](https://developer.box.com/reference/get-integration-mappings-teams/).
319+
320+
_Currently we don't have an example for calling `get_integration_mapping_teams` in integration tests_
321+
322+
### Arguments
323+
324+
- partner_item_type `Optional[GetIntegrationMappingTeamsPartnerItemType]`
325+
- Mapped item type, for which the mapping should be returned
326+
- partner_item_id `Optional[str]`
327+
- ID of the mapped item, for which the mapping should be returned
328+
- box_item_id `Optional[str]`
329+
- Box item ID, for which the mappings should be returned
330+
- box_item_type `Optional[GetIntegrationMappingTeamsBoxItemType]`
331+
- Box item type, for which the mappings should be returned
332+
- extra_headers `Optional[Dict[str, Optional[str]]]`
333+
- Extra headers that will be included in the HTTP request.
334+
335+
### Returns
336+
337+
This function returns a value of type `IntegrationMappingsTeams`.
338+
339+
Returns a collection of integration mappings
340+
341+
## Create Teams integration mapping
342+
343+
Creates a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams)
344+
by mapping a Teams channel to a Box item.
345+
You need Admin or Co-Admin role to
346+
use this endpoint.
347+
348+
This operation is performed by calling function `create_integration_mapping_teams`.
349+
350+
See the endpoint docs at
351+
[API Reference](https://developer.box.com/reference/post-integration-mappings-teams/).
352+
353+
_Currently we don't have an example for calling `create_integration_mapping_teams` in integration tests_
354+
355+
### Arguments
356+
357+
- partner_item `IntegrationMappingPartnerItemTeamsCreateRequest`
358+
-
359+
- box_item `FolderReference`
360+
-
361+
- extra_headers `Optional[Dict[str, Optional[str]]]`
362+
- Extra headers that will be included in the HTTP request.
363+
364+
### Returns
365+
366+
This function returns a value of type `IntegrationMappingTeams`.
367+
368+
Returns the created integration mapping.
369+
370+
## Update Teams integration mapping
371+
372+
Updates a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams).
373+
Supports updating the Box folder ID and options.
374+
You need Admin or Co-Admin role to
375+
use this endpoint.
376+
377+
This operation is performed by calling function `update_integration_mapping_teams_by_id`.
378+
379+
See the endpoint docs at
380+
[API Reference](https://developer.box.com/reference/put-integration-mappings-teams-id/).
381+
382+
_Currently we don't have an example for calling `update_integration_mapping_teams_by_id` in integration tests_
383+
384+
### Arguments
385+
386+
- integration_mapping_id `str`
387+
- An ID of an integration mapping Example: "11235432"
388+
- box_item `Optional[FolderReference]`
389+
-
390+
- extra_headers `Optional[Dict[str, Optional[str]]]`
391+
- Extra headers that will be included in the HTTP request.
392+
393+
### Returns
394+
395+
This function returns a value of type `IntegrationMappingTeams`.
396+
397+
Returns the updated integration mapping object.
398+
399+
## Delete Teams integration mapping
400+
401+
Deletes a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams).
402+
You need Admin or Co-Admin role to
403+
use this endpoint.
404+
405+
This operation is performed by calling function `delete_integration_mapping_teams_by_id`.
406+
407+
See the endpoint docs at
408+
[API Reference](https://developer.box.com/reference/delete-integration-mappings-teams-id/).
409+
410+
_Currently we don't have an example for calling `delete_integration_mapping_teams_by_id` in integration tests_
411+
412+
### Arguments
413+
414+
- integration_mapping_id `str`
415+
- An ID of an integration mapping Example: "11235432"
416+
- extra_headers `Optional[Dict[str, Optional[str]]]`
417+
- Extra headers that will be included in the HTTP request.
418+
419+
### Returns
420+
421+
This function returns a value of type `None`.
422+
423+
Empty body in response

0 commit comments

Comments
 (0)