Integrations Module API

API reference for integration endpoints.

BriteCore V2 integrations API endpoint wrappers.

britecore_sdk.api.api_calls.v2.integrations.get_installed_integrations(policy_type_id=None, integration_point_code=None, **kwargs)[source]

Get Installed Integrations.

POST /api/v2/integrations/get_installed_integrations

Parameters:

  • policy_type_id (str | None)

  • integration_point_code (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.integrations.get_integration_dependencies(policy_type_id=None, include_optionals=None, **kwargs)[source]

Get Integration Dependencies.

POST /api/v2/integrations/get_integration_dependencies

Parameters:

  • policy_type_id (str | None)

  • include_optionals (bool | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.integrations.get_integration_dependencies_stored(integration_id=None, policy_type_id=None, **kwargs)[source]

Get Integration Dependencies Stored.

POST /api/v2/integrations/get_integration_dependencies_stored

Parameters:

  • integration_id (str | None)

  • policy_type_id (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.integrations.get_policy_types_for_integration_instance(integration_instance_external_id=None, **kwargs)[source]

Get Policy Types For Integration Instance.

POST /api/v2/integrations/get_policy_types_for_integration_instance

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.integrations.is_integration_point_installed(integration_point_code=None, policy_type_id=None, **kwargs)[source]

Is Integration Point Installed.

POST /api/v2/integrations/is_integration_point_installed

Parameters:

  • integration_point_code (str | None)

  • policy_type_id (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.integrations.list_integration_points(None_=None, **kwargs)[source]

List Integration Points.

POST /api/v2/integrations/list_integration_points

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.integrations.make_note(integration_instance_external_id=None, reference_id=None, contents=None, title=None, **kwargs)[source]

Make Note.

POST /api/v2/integrations/make_note

Parameters:

  • integration_instance_external_id (str | None)

  • reference_id (str | None)

  • contents (str | None)

  • title (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.integrations.persist_file(file_data_base64=None, integration_instance_external_id=None, mime_type=None, title=None, **kwargs)[source]

Persist File.

POST /api/v2/integrations/persist_file

Parameters:

  • file_data_base64 (str | None)

  • integration_instance_external_id (str | None)

  • mime_type (str | None)

  • title (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.integrations.send_britecore_email(plain_body=None, reply_to_emails=None, to_emails=None, attachments=None, integration_instance_external_id=None, cc_emails=None, attachments_exceed_message=None, subject=None, html_body=None, **kwargs)[source]

Send Britecore Email.

POST /api/v2/integrations/send_britecore_email

Parameters:

  • plain_body (str | None)

  • reply_to_emails (list[str] | None)

  • to_emails (list[str] | None)

  • attachments (list[str] | None)

  • integration_instance_external_id (str | None)

  • cc_emails (list[str] | None)

  • attachments_exceed_message (str | None)

  • subject (str | None)

  • html_body (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.integrations.send_integration_alert_email(email_subject=None, integration_instance_external_id=None, email_body=None, **kwargs)[source]

Send Integration Alert Email.

POST /api/v2/integrations/send_integration_alert_email

Parameters:

  • email_subject (str | None)

  • integration_instance_external_id (str | None)

  • email_body (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.integrations.store_integration_dependencies(integration_id=None, policy_type_id=None, dependencies=None, **kwargs)[source]

Store Integration Dependencies.

POST /api/v2/integrations/store_integration_dependencies

Parameters:

  • integration_id (str | None)

  • policy_type_id (str | None)

  • dependencies (list[str] | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any