Add support for copyInstanceOnItemCopy field for metadata templates (#546)

Author: sujaygarlanka

HISTORY.rst

@@ -7,6 +7,7 @@ Next Release
 ++++++++
 - Allow ints to be passed in as item IDs
 - Fix bug with updating a collaboration role to owner
+- Add support for `copyInstanceOnItemCopy` field for metadata templates
 
 2.9.0 (2020-06-23)
 ++++++++

boxsdk/client/client.py

@@ -1623,7 +1623,7 @@ def get_metadata_templates(self, scope='enterprise', limit=None, marker=None, fi
         )
 
     @api_call
-    def create_metadata_template(self, display_name, fields, template_key=None, hidden=False, scope='enterprise'):
+    def create_metadata_template(self, display_name, fields, template_key=None, hidden=False, scope='enterprise', copy_instance_on_item_copy=False):
         """
         Create a new metadata template.  By default, only the display name and fields are required; the template key
         will be automatically generated based on the display name and the template will be created in the enterprise
@@ -1649,13 +1649,18 @@ def create_metadata_template(self, display_name, fields, template_key=None, hidd
             The scope the template should be created in
         :type scope:
             `unicode`
+        :param copy_instance_on_item_copy:
+            Whether or not to include the metadata when a file or folder is copied.
+        :type copy_instance_on_item_copy:
+            `bool`
         """
         url = self._session.get_url('metadata_templates', 'schema')
         body = {
             'scope': scope,
             'displayName': display_name,
             'hidden': hidden,
-            'fields': [field.json() for field in fields]
+            'fields': [field.json() for field in fields],
+            'copyInstanceOnItemCopy': copy_instance_on_item_copy
         }
 
         if template_key is not None:

docs/usage/metadata.md

@@ -39,7 +39,7 @@ Create Metadata Template
 ------------------------
 
 To create a new metadata template, call
-[`client.create_metadata_template(display_name, fields, template_key=None, hidden=False, scope='enterprise')`][create_template]
+[`client.create_metadata_template(display_name, fields, template_key=None, hidden=False, scope='enterprise', copy_instance_on_item_copy=False)`][create_template]
 with the human-readable name of the template and the [`MetadataField`s][metadata_field_class] the template should have.
 You can optionally specify a key for the template, otherwise one will be derived from the display name.  At the current
 time, only `enterprise` scope templates are supported.  This method returns a
@@ -111,6 +111,7 @@ template = client.metadata_template('enterprise', 'employeeRecord')
 updates = template.start_update()
 updates.add_enum_option('state', 'WI')
 updates.edit_template({'hidden': False})
+updates.edit_template({'copyInstanceOnItemCopy': False})
 updated_template = template.update_info(updates)
 ```
 

test/unit/client/test_client.py

@@ -1271,6 +1271,7 @@ def test_create_metadata_template(mock_client, mock_box_session):
                 ],
             },
         ],
+        'copyInstanceOnItemCopy': False,
         'templateKey': 'vContract',
     }