Skip to content

Legal Hold

class _incydr_sdk.legal_hold.client.LegalHoldV1(parent)

Client for /v1/orgs endpoints.

Usage example:

>>> import incydr
>>>
>>> client = incydr.Client(**kwargs)
>>> client.legal_hold.v1.get_matter("matter_id")
add_custodian(self, matter_id, user_id)

Add a user to a matter

Parameters:

  • matter_id: str (required) - The matter ID.
  • user_id: str (required) - The user ID of the user to add to the matter.

Returns: An [AddCustodianResponse][addcustodianresponse-model] object with the membership for the given matter and user.

create_matter(self, policy_id, name, description=None, notes=None)

Create a matter.

Parameters:

  • policy_id: str (Required) - The policy ID to be used by the created matter.
  • name: str (Required) - The name of the matter to be created.
  • description: str - The description of the matter to be created.
  • notes: str - The notes for the matter to be created.

Returns: A [Matter][matter-model] object with details of the created matter.

create_policy(self, name)

Create a legal hold policy.

Parameters:

  • name: str (Required) - The name of the policy to create.

Returns: A [LegalHoldPolicy][legalholdpolicy-model] object with details of the created policy.

deactivate_matter(self, matter_id)

Deactivate a matter.

Parameters:

  • matter_id: str (required) - The unique ID for the matter.

Returns: A requests.Response indicating success.

get_custodians_page(self, matter_id, page_num=None, page_size=None)

Get a page of custodians for a given matter

Parameters:

  • matter_id: str (required) - The matter ID being queried.
  • page_num: int - The page number to request.
  • page_size: int - The page size to request

Returns: A [CustodiansPage][custodianspage-model] object with the page of memberships for that matter.

get_matter(self, matter_id)

Get a matter

Parameters:

  • matter_id: str (required) - The ID of the matter.

Returns: A [Matter][matter-model] object with matter details.

get_matters_page(self, creator_user_id=None, active=None, name=None, page_num=None, page_size=None)

Get a page of matters

Parameters:

  • creator_user_id: str - Find legal hold matters that were created by the user with this unique identifier.
  • active: bool - When true, return only active matters. When false, return inactive legal hold matters. Defaults to returning all matters.
  • name: str - Find legal hold matters whose 'name' either equals or partially contains this value.
  • page_num: int - The page number to request.
  • page_size: int - The page size to request

Returns: A [MattersPage][matterspage-model] object with the page of matters.

get_memberships_page_for_user(self, user_id, page_num=None, page_size=None)

Get a page of matter memberships for a given user

Parameters:

  • user_id: str (required) - The user ID for the user being queried.
  • page_num: int - The page number to request.
  • page_size: int - The page size to request

Returns: A [CustodianMattersPage][custodianmatterspage-model] object with the page of memberships for that user.

get_policies_page(self, page_num=None, page_size=None)

Get a page of policies

Parameters:

  • page_num: int - The page number to request.
  • page_size: int - The page size to request

Returns: A [LegalHoldPolicyPage][legalholdpolicypage-model] object with the page of policies.

get_policy(self, policy_id)

Get details of a legal hold policy.

Parameters:

  • policy_id: str (Required) - The unique ID of the policy.

Returns: A [LegalHoldPolicy][legalholdpolicy-model] object with details of the policy.

iter_all_custodians(self, matter_id, page_size=None)

Get all custodians for a given matter

Parameters:

  • matter_id: str (required) - The matter ID being queried.
  • page_size: int - The page size to request

Returns: A generator object that yields [Custodian][custodian-model] objects with the memberships for the given matter.

iter_all_matters(self, creator_user_id=None, active=None, name=None, page_size=None)

Get all matters

Parameters:

  • creator_user_id: str - Find legal hold matters that were created by the user with this unique identifier.
  • active: bool - When true, return only active matters. When false, return inactive legal hold matters. Defaults to returning all matters.
  • name: str - Find legal hold matters whose 'name' either equals or partially contains this value.
  • page_num: int - The page number to request.
  • page_size: int - The page size to request

Returns: A generator object that yields [Matter][matter-model] objects with the details of each matter.

iter_all_memberships_for_user(self, user_id, page_size=None)

Get all matter memberships for a given user

Parameters:

  • user_id: str (required) - The user ID for the user being queried.
  • page_size: int - The page size to request

Returns: A generator object that yields [CustodianMatter][custodianmatter-model] objects with the memberships for the given user.

iter_all_policies(self, page_size=None)

Iterate through all policies

Parameters:

  • page_size: int - The page size to request

Returns: A generator that yields [LegalHoldPolicy][legalholdpolicy-model] objects.

reactivate_matter(self, matter_id)

Reactivate a matter.

Parameters:

  • matter_id: str (required) - The unique ID for the matter.

Returns: A requests.Response indicating success.

remove_custodian(self, matter_id, user_id)

Remove a custodian from a matter.

Parameters:

  • matter_id: str (required) - The unique ID for the matter.
  • user_id: str (required) - The unique ID of the user.

Returns: A requests.Response indicating success.