Class: IntegrationMappingsManager

IntegrationMappingsManager(client)

new IntegrationMappingsManager(client)

Parameters:
Name Type Description
client BoxClient The Box API Client that is responsible for making calls to the API
Source:

Classes

IntegrationMappingsManager

Methods

createSlackIntegrationMapping(body, optionsopt, callbackopt) → {Promise.<schemas.IntegrationMapping>}

Create Slack integration mapping Creates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) by mapping a Slack channel to a Box item. You need Admin or Co-Admin role to use this endpoint.
Parameters:
Name Type Attributes Description
body schemas.IntegrationMappingSlackCreateRequest
options object <optional>
 Options for the request
callback function <optional>
 Passed the result if successful, error otherwise
Source:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<schemas.IntegrationMapping>

createSlackIntegrationMapping(body, optionsopt, callbackopt) → {Promise.<schemas.IntegrationMapping>}

Create Slack integration mapping Creates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) by mapping a Slack channel to a Box item. You need Admin or Co-Admin role to use this endpoint.
Parameters:
Name Type Attributes Description
body schemas.IntegrationMappingSlackCreateRequest
options object <optional>
 Options for the request
callback function <optional>
 Passed the result if successful, error otherwise
Source:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<schemas.IntegrationMapping>

deleteSlackIntegrationMappingById(options, callbackopt) → {Promise.<void>}

Delete Slack integration mapping Deletes a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack). You need Admin or Co-Admin role to use this endpoint.
Parameters:
Name Type Attributes Description
options object Options for the request
Properties
Name Type Description
integration_mapping_id string An ID of an integration mapping
callback function <optional>
 Passed the result if successful, error otherwise
Source:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<void>

deleteSlackIntegrationMappingById(options, callbackopt) → {Promise.<void>}

Delete Slack integration mapping Deletes a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack). You need Admin or Co-Admin role to use this endpoint.
Parameters:
Name Type Attributes Description
options object Options for the request
Properties
Name Type Description
integration_mapping_id string An ID of an integration mapping
callback function <optional>
 Passed the result if successful, error otherwise
Source:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<void>

getSlackIntegrationMappings(optionsopt, callbackopt) → {Promise.<schemas.IntegrationMappings>}

List Slack integration mappings Lists [Slack integration mappings](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) in a users' enterprise. You need Admin or Co-Admin role to use this endpoint.
Parameters:
Name Type Attributes Description
options object <optional>
 Options for the request
Properties
Name Type Attributes Description
marker string <optional>
 Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
limit number <optional>
 The maximum number of items to return per page.
partner_item_type "channel" <optional>
 Mapped item type, for which the mapping should be returned
partner_item_id string <optional>
 ID of the mapped item, for which the mapping should be returned
box_item_id string <optional>
 Box item ID, for which the mappings should be returned
box_item_type "folder" <optional>
 Box item type, for which the mappings should be returned
is_manually_created boolean <optional>
 Whether the mapping has been manually created
callback function <optional>
 Passed the result if successful, error otherwise
Source:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<schemas.IntegrationMappings>

getSlackIntegrationMappings(optionsopt, callbackopt) → {Promise.<schemas.IntegrationMappings>}

List Slack integration mappings Lists [Slack integration mappings](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) in a users' enterprise. You need Admin or Co-Admin role to use this endpoint.
Parameters:
Name Type Attributes Description
options object <optional>
 Options for the request
Properties
Name Type Attributes Description
marker string <optional>
 Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
limit number <optional>
 The maximum number of items to return per page.
partner_item_type "channel" <optional>
 Mapped item type, for which the mapping should be returned
partner_item_id string <optional>
 ID of the mapped item, for which the mapping should be returned
box_item_id string <optional>
 Box item ID, for which the mappings should be returned
box_item_type "folder" <optional>
 Box item type, for which the mappings should be returned
is_manually_created boolean <optional>
 Whether the mapping has been manually created
callback function <optional>
 Passed the result if successful, error otherwise
Source:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<schemas.IntegrationMappings>

updateSlackIntegrationMapping(body, options, callbackopt) → {Promise.<schemas.IntegrationMapping>}

Update Slack integration mapping Updates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack). Supports updating the Box folder ID and options. You need Admin or Co-Admin role to use this endpoint.
Parameters:
Name Type Attributes Description
body object
options object Options for the request
Properties
Name Type Description
integration_mapping_id string An ID of an integration mapping
callback function <optional>
 Passed the result if successful, error otherwise
Source:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<schemas.IntegrationMapping>

updateSlackIntegrationMapping(body, options, callbackopt) → {Promise.<schemas.IntegrationMapping>}

Update Slack integration mapping Updates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack). Supports updating the Box folder ID and options. You need Admin or Co-Admin role to use this endpoint.
Parameters:
Name Type Attributes Description
body object
options object Options for the request
Properties
Name Type Description
integration_mapping_id string An ID of an integration mapping
callback function <optional>
 Passed the result if successful, error otherwise
Source:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<schemas.IntegrationMapping>