InsightlyClient
Attributes
TRIGGER_OPERATIONS
module-attribute
TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnTaskAssignedToMe': {'operation_id': 'OnTaskAssignedToMe', 'path': '/{connectionId}/trigger1/Tasks', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'ListTasksResponse'}, 'OnTaskCreated': {'operation_id': 'OnTaskCreated', 'path': '/{connectionId}/trigger2/Tasks', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'ListTasksResponse'}, 'OnTaskUpdated': {'operation_id': 'OnTaskUpdated', 'path': '/{connectionId}/trigger3/Tasks', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'ListTasksResponse'}, 'OnProjectCreated': {'operation_id': 'OnProjectCreated', 'path': '/{connectionId}/trigger2/Projects', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'ListProjectsResponse'}, 'OnProjectUpdated': {'operation_id': 'OnProjectUpdated', 'path': '/{connectionId}/trigger3/Projects', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'ListProjectsResponse'}, 'OnLeadCreated': {'operation_id': 'OnLeadCreated', 'path': '/{connectionId}/trigger1/Leads', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'Lead'}, 'OnLeadUpdated': {'operation_id': 'OnLeadUpdated', 'path': '/{connectionId}/trigger2/Leads', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'Lead'}, 'OnContactCreated': {'operation_id': 'OnContactCreated', 'path': '/{connectionId}/trigger1/Contacts', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'ListContactsResponse'}, 'OnContactUpdated': {'operation_id': 'OnContactUpdated', 'path': '/{connectionId}/trigger2/Contacts', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'ListContactsResponse'}, 'OnEventCreated': {'operation_id': 'OnEventCreated', 'path': '/{connectionId}/trigger1/Events', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'ListEventsResponse'}, 'OnEventUpdated': {'operation_id': 'OnEventUpdated', 'path': '/{connectionId}/trigger2/Events', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'ListEventsResponse'}}
Classes
ListTasksResponse
dataclass
TaskObject
dataclass
TaskObject(*, task_id: Optional[int] = None, title: Optional[str] = None, due_date: Optional[str] = None, category_id: Optional[int] = None, completed_date_utc: Optional[str] = None, completed: Optional[bool] = None, details: Optional[str] = None, status: Optional[str] = None, priority: Optional[int] = None, start_date: Optional[str] = None, project_id: Optional[int] = None, opportunity_id: Optional[int] = None, milestone_id: Optional[int] = None, pipeline_id: Optional[int] = None, stage_id: Optional[int] = None, percent_complete: Optional[int] = None, owner_user_id: Optional[int] = None, responsible_user_id: Optional[int] = None, publicly_visible: Optional[bool] = None, date_created_utc: Optional[str] = None, date_updated_utc: Optional[str] = None, assigned_by_user_id: Optional[int] = None, parent_task_id: Optional[int] = None, owner_visible: Optional[bool] = None, assigned_team_id: Optional[int] = None, assigned_date_utc: Optional[str] = None, reminder_date_utc: Optional[str] = None, reminder_sent: Optional[bool] = None, recurrence: Optional[str] = None, can_edit: Optional[bool] = None, can_delete: Optional[bool] = None)
Response for Update task
Attributes
task_id
class-attribute
instance-attribute
task_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TASK_ID'})
The unique identifier of the task.
title
class-attribute
instance-attribute
The title of the task.
due_date
class-attribute
instance-attribute
due_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DUE_DATE'})
yyyy-MM-dd HH:mm:ss
category_id
class-attribute
instance-attribute
category_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CATEGORY_ID'})
The unique identifier of the category.
completed_date_utc
class-attribute
instance-attribute
completed_date_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'COMPLETED_DATE_UTC'})
yyyy-MM-dd HH:mm:ss
completed
class-attribute
instance-attribute
completed: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'COMPLETED'})
A boolean value determining whether or not the task is completed.
details
class-attribute
instance-attribute
details: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DETAILS'})
The details of the task.
status
class-attribute
instance-attribute
status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'STATUS'})
The status of the task.
priority
class-attribute
instance-attribute
priority: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PRIORITY'})
The priority of the task.
start_date
class-attribute
instance-attribute
start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'START_DATE'})
yyyy-MM-dd HH:mm:ss
project_id
class-attribute
instance-attribute
project_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PROJECT_ID'})
The unique identifier of the project.
opportunity_id
class-attribute
instance-attribute
opportunity_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OPPORTUNITY_ID'})
The unique identifier of the opportunity.
milestone_id
class-attribute
instance-attribute
milestone_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MILESTONE_ID'})
The unique identifier of the milestone.
pipeline_id
class-attribute
instance-attribute
pipeline_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PIPELINE_ID'})
The unique identifier of the pipeline.
stage_id
class-attribute
instance-attribute
stage_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'STAGE_ID'})
The unique identifier of the stage.
percent_complete
class-attribute
instance-attribute
percent_complete: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PERCENT_COMPLETE'})
The task completed value in percent.
owner_user_id
class-attribute
instance-attribute
owner_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OWNER_USER_ID'})
The unique identifier of the task owner.
responsible_user_id
class-attribute
instance-attribute
responsible_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RESPONSIBLE_USER_ID'})
The unique identifier of the user assigned to the task.
publicly_visible
class-attribute
instance-attribute
publicly_visible: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PUBLICLY_VISIBLE'})
A boolean value determining whether or not the task is publicly visible.
date_created_utc
class-attribute
instance-attribute
date_created_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_CREATED_UTC'})
yyyy-MM-dd HH:mm:ss
date_updated_utc
class-attribute
instance-attribute
date_updated_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_UPDATED_UTC'})
yyyy-MM-dd HH:mm:ss
assigned_by_user_id
class-attribute
instance-attribute
assigned_by_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ASSIGNED_BY_USER_ID'})
The unique identifier of the assigned by user.
parent_task_id
class-attribute
instance-attribute
parent_task_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PARENT_TASK_ID'})
The unique identifier of the parent task.
owner_visible
class-attribute
instance-attribute
owner_visible: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OWNER_VISIBLE'})
A boolean value determining whether or not the owner is publicly visible.
assigned_team_id
class-attribute
instance-attribute
assigned_team_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ASSIGNED_TEAM_ID'})
The unique identifier of the assigned team.
assigned_date_utc
class-attribute
instance-attribute
assigned_date_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ASSIGNED_DATE_UTC'})
yyyy-MM-dd HH:mm:ss
reminder_date_utc
class-attribute
instance-attribute
reminder_date_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'REMINDER_DATE_UTC'})
yyyy-MM-dd HH:mm:ss
reminder_sent
class-attribute
instance-attribute
reminder_sent: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'REMINDER_SENT'})
A boolean value determining whether or not a reminder is set.
recurrence
class-attribute
instance-attribute
recurrence: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RECURRENCE'})
Recurrence
ListProjectsResponse
dataclass
ListProjectsResponse(*, projects: Optional[List[Project | Mapping[str, Any]]] = None, next_link: Optional[str] = None)
Response for List projects
Attributes
projects
class-attribute
instance-attribute
A collection of projects
Project
dataclass
Project(*, project_id: Optional[int] = None, project_name: Optional[str] = None, status: Optional[str] = None, project_details: Optional[str] = None, image_url: Optional[str] = None, date_created_utc: Optional[str] = None, visible_to: Optional[str] = None, date_updated_utc: Optional[str] = None, started_date: Optional[str] = None, completed_date: Optional[str] = None, owner_user_id: Optional[int] = None, responsible_user_id: Optional[int] = None, opportunity_id: Optional[int] = None, pipeline_id: Optional[int] = None, stage_id: Optional[int] = None, category_id: Optional[int] = None, visible_team_id: Optional[int] = None, visible_user_ids: Optional[int] = None, can_edit: Optional[bool] = None, can_delete: Optional[bool] = None)
Response for Update project
Attributes
project_id
class-attribute
instance-attribute
project_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PROJECT_ID'})
The unique identifier of the project.
project_name
class-attribute
instance-attribute
project_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PROJECT_NAME'})
The name of the project.
status
class-attribute
instance-attribute
status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'STATUS'})
The status of the project.
project_details
class-attribute
instance-attribute
project_details: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PROJECT_DETAILS'})
The details of the project.
image_url
class-attribute
instance-attribute
image_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IMAGE_URL'})
The image URL of the project.
date_created_utc
class-attribute
instance-attribute
date_created_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_CREATED_UTC'})
yyyy-MM-dd HH:mm:ss
visible_to
class-attribute
instance-attribute
visible_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TO'})
Project Visibility.
date_updated_utc
class-attribute
instance-attribute
date_updated_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_UPDATED_UTC'})
yyyy-MM-dd HH:mm:ss
started_date
class-attribute
instance-attribute
started_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'STARTED_DATE'})
yyyy-MM-dd HH:mm:ss
completed_date
class-attribute
instance-attribute
completed_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'COMPLETED_DATE'})
yyyy-MM-dd HH:mm:ss
owner_user_id
class-attribute
instance-attribute
owner_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OWNER_USER_ID'})
The unique identifier of the project owner.
responsible_user_id
class-attribute
instance-attribute
responsible_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RESPONSIBLE_USER_ID'})
The unique identifier of the assigned user.
opportunity_id
class-attribute
instance-attribute
opportunity_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OPPORTUNITY_ID'})
The unique identifier of the opportunity.
pipeline_id
class-attribute
instance-attribute
pipeline_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PIPELINE_ID'})
The unique identifier of the pipeline.
stage_id
class-attribute
instance-attribute
stage_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'STAGE_ID'})
The unique identifier of the stage.
category_id
class-attribute
instance-attribute
category_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CATEGORY_ID'})
The unique identifier of the category.
visible_team_id
class-attribute
instance-attribute
visible_team_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TEAM_ID'})
The unique identifier of the team.
visible_user_ids
class-attribute
instance-attribute
visible_user_ids: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_USER_IDS'})
The unique identifiers of the users.
ListLeadsResponse
dataclass
Lead
dataclass
Lead(*, lead_id: Optional[int] = None, salutation: Optional[str] = None, title: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, lead_description: Optional[str] = None, date_created_utc: Optional[str] = None, date_updated_utc: Optional[str] = None, converted_date_utc: Optional[str] = None, lead_status_id: Optional[int] = None, visible_to: Optional[str] = None, organization_name: Optional[str] = None, phone_number: Optional[str] = None, mobile_phone_number: Optional[str] = None, email_address: Optional[str] = None, converted: Optional[bool] = None, website_url: Optional[str] = None, owner_user_id: Optional[int] = None, responsible_user_id: Optional[int] = None, employee_count: Optional[int] = None, lead_rating: Optional[int] = None, industry: Optional[str] = None, address_street: Optional[str] = None, address_city: Optional[str] = None, address_state: Optional[str] = None, address_postcode: Optional[str] = None, address_country: Optional[str] = None, fax_number: Optional[str] = None, converted_contact_id: Optional[int] = None, converted_organization_id: Optional[int] = None, converted_opportunity_id: Optional[int] = None, lead_source_id: Optional[int] = None, visible_team_id: Optional[int] = None, visible_user_ids: Optional[int] = None, image_url: Optional[str] = None, can_edit: Optional[bool] = None, can_delete: Optional[bool] = None)
Response for Update lead
Attributes
lead_id
class-attribute
instance-attribute
lead_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LEAD_ID'})
The unique identifier of the lead.
salutation
class-attribute
instance-attribute
salutation: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SALUTATION'})
The salutation of the lead.
title
class-attribute
instance-attribute
The title of the lead.
first_name
class-attribute
instance-attribute
first_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FIRST_NAME'})
First name of the lead.
last_name
class-attribute
instance-attribute
last_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LAST_NAME'})
Last name of the lead.
lead_description
class-attribute
instance-attribute
lead_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LEAD_DESCRIPTION'})
A brief description of the lead.
date_created_utc
class-attribute
instance-attribute
date_created_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_CREATED_UTC'})
yyyy-MM-dd HH:mm:ss
date_updated_utc
class-attribute
instance-attribute
date_updated_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_UPDATED_UTC'})
yyyy-MM-dd HH:mm:ss
converted_date_utc
class-attribute
instance-attribute
converted_date_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONVERTED_DATE_UTC'})
yyyy-MM-dd HH:mm:ss
lead_status_id
class-attribute
instance-attribute
lead_status_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LEAD_STATUS_ID'})
The status Id of the lead.
visible_to
class-attribute
instance-attribute
visible_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TO'})
Lead visibility.
organization_name
class-attribute
instance-attribute
organization_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ORGANIZATION_NAME'})
The name of the organization.
phone_number
class-attribute
instance-attribute
phone_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PHONE_NUMBER'})
Lead phone number.
mobile_phone_number
class-attribute
instance-attribute
mobile_phone_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MOBILE_PHONE_NUMBER'})
Lead mobile phone number.
email_address
class-attribute
instance-attribute
email_address: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_ADDRESS'})
Lead email address.
converted
class-attribute
instance-attribute
converted: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONVERTED'})
A boolean value determining whether or not the lead is converted.
website_url
class-attribute
instance-attribute
website_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WEBSITE_URL'})
Lead website URL
owner_user_id
class-attribute
instance-attribute
owner_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OWNER_USER_ID'})
The unique identifier of the lead owner.
responsible_user_id
class-attribute
instance-attribute
responsible_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RESPONSIBLE_USER_ID'})
The unique identifier of the responsible user.
employee_count
class-attribute
instance-attribute
employee_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMPLOYEE_COUNT'})
The employee count of the lead.
lead_rating
class-attribute
instance-attribute
lead_rating: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LEAD_RATING'})
The rating of the lead.
industry
class-attribute
instance-attribute
industry: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'INDUSTRY'})
The industry of the lead.
address_street
class-attribute
instance-attribute
address_street: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESS_STREET'})
Address street.
address_city
class-attribute
instance-attribute
address_city: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESS_CITY'})
Address city.
address_state
class-attribute
instance-attribute
address_state: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESS_STATE'})
Address state.
address_postcode
class-attribute
instance-attribute
address_postcode: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESS_POSTCODE'})
Address postcode.
address_country
class-attribute
instance-attribute
address_country: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESS_COUNTRY'})
Address country.
fax_number
class-attribute
instance-attribute
fax_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FAX_NUMBER'})
Lead fax number.
converted_contact_id
class-attribute
instance-attribute
converted_contact_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONVERTED_CONTACT_ID'})
The unique identifier of the converted contact.
converted_organization_id
class-attribute
instance-attribute
converted_organization_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONVERTED_ORGANIZATION_ID'})
The unique identifier of the converted organization.
converted_opportunity_id
class-attribute
instance-attribute
converted_opportunity_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONVERTED_OPPORTUNITY_ID'})
The unique identifier of the opportunity.
lead_source_id
class-attribute
instance-attribute
lead_source_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LEAD_SOURCE_ID'})
The unique identifier of the lead source.
visible_team_id
class-attribute
instance-attribute
visible_team_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TEAM_ID'})
The unique identifier of the team.
visible_user_ids
class-attribute
instance-attribute
visible_user_ids: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_USER_IDS'})
The unique identifiers of the users.
image_url
class-attribute
instance-attribute
image_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IMAGE_URL'})
Lead Image URL
ListContactsResponse
dataclass
Contact
dataclass
Contact(*, address_work: Optional[Dict[str, Any]] = None, address_home: Optional[Dict[str, Any]] = None, address_postal: Optional[Dict[str, Any]] = None, address_primary: Optional[Dict[str, Any]] = None, address_other: Optional[Dict[str, Any]] = None, email_work: Optional[str] = None, email_home: Optional[str] = None, email_personal: Optional[str] = None, email_other: Optional[str] = None, phone_work: Optional[str] = None, phone_home: Optional[str] = None, phone_mobile: Optional[str] = None, phone_other: Optional[str] = None, contact_id: Optional[int] = None, salutation: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, image_url: Optional[str] = None, date_created_utc: Optional[str] = None, visible_to: Optional[str] = None, background: Optional[str] = None, default_linked_organisation: Optional[int] = None, owner_user_id: Optional[int] = None, date_updated_utc: Optional[str] = None, visible_team_id: Optional[int] = None, visible_user_ids: Optional[int] = None, can_edit: Optional[bool] = None, can_delete: Optional[bool] = None, social_linkedin: Optional[str] = None, social_facebook: Optional[str] = None, social_twitter: Optional[str] = None)
Response for Update contact
Attributes
email_work
class-attribute
instance-attribute
email_work: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_WORK'})
The work email of the contact.
email_home
class-attribute
instance-attribute
email_home: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_HOME'})
The home email of the contact.
email_personal
class-attribute
instance-attribute
email_personal: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_PERSONAL'})
The personal email of the contact.
email_other
class-attribute
instance-attribute
email_other: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_OTHER'})
The other email of the contact.
phone_work
class-attribute
instance-attribute
phone_work: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PHONE_WORK'})
The work phone number of the contact.
phone_home
class-attribute
instance-attribute
phone_home: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PHONE_HOME'})
The home phone number of the contact.
phone_mobile
class-attribute
instance-attribute
phone_mobile: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PHONE_MOBILE'})
The mobile phone number of the contact.
phone_other
class-attribute
instance-attribute
phone_other: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PHONE_OTHER'})
The other phone number of the contact.
contact_id
class-attribute
instance-attribute
contact_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONTACT_ID'})
The unique identifier of the contact.
salutation
class-attribute
instance-attribute
salutation: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SALUTATION'})
The salutation of the contact.
first_name
class-attribute
instance-attribute
first_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FIRST_NAME'})
First name of the contact.
last_name
class-attribute
instance-attribute
last_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LAST_NAME'})
Last name of the contact.
image_url
class-attribute
instance-attribute
image_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IMAGE_URL'})
Contact image URL.
date_created_utc
class-attribute
instance-attribute
date_created_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_CREATED_UTC'})
yyyy-MM-dd HH:mm:ss
visible_to
class-attribute
instance-attribute
visible_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TO'})
Contact visibility.
background
class-attribute
instance-attribute
background: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BACKGROUND'})
Background
default_linked_organisation
class-attribute
instance-attribute
default_linked_organisation: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DEFAULT_LINKED_ORGANISATION'})
Default linked organization.
owner_user_id
class-attribute
instance-attribute
owner_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OWNER_USER_ID'})
The unique identifier of the owner.
date_updated_utc
class-attribute
instance-attribute
date_updated_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_UPDATED_UTC'})
yyyy-MM-dd HH:mm:ss
visible_team_id
class-attribute
instance-attribute
visible_team_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TEAM_ID'})
The unique identifier of the team.
visible_user_ids
class-attribute
instance-attribute
visible_user_ids: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_USER_IDS'})
The unique identifiers of the users.
can_edit
class-attribute
instance-attribute
can_edit: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CAN_EDIT'})
Can edit
can_delete
class-attribute
instance-attribute
can_delete: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CAN_DELETE'})
Can delete
social_linkedin
class-attribute
instance-attribute
social_linkedin: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SOCIAL_LINKEDIN'})
Social LinkedIn.
ListUsersResponse
dataclass
ObjectEntity
dataclass
ListEventsResponse
dataclass
Organization
dataclass
Organization(*, organisation_id: Optional[int] = None, organisation_background: Optional[str] = None, organisation_name: Optional[str] = None, date_created_utc: Optional[str] = None, date_updated_utc: Optional[str] = None, owner_user_id: Optional[int] = None, visible_to: Optional[str] = None, addresses: Optional[List[Address | Mapping[str, Any]]] = None, contactinfos: Optional[List[ContactInfo | Mapping[str, Any]]] = None, background: Optional[str] = None, image_url: Optional[str] = None, visible_team_id: Optional[int] = None, visible_user_ids: Optional[int] = None)
Response for Add organization
Attributes
organisation_id
class-attribute
instance-attribute
organisation_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ORGANISATION_ID'})
The unique identifier of the organization.
organisation_background
class-attribute
instance-attribute
organisation_background: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ORGANISATION_BACKGROUND'})
The background of the organization.
organisation_name
class-attribute
instance-attribute
organisation_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ORGANISATION_NAME'})
The name of the organization.
date_created_utc
class-attribute
instance-attribute
date_created_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_CREATED_UTC'})
yyyy-MM-dd HH:mm:ss
date_updated_utc
class-attribute
instance-attribute
date_updated_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_UPDATED_UTC'})
yyyy-MM-dd HH:mm:ss
owner_user_id
class-attribute
instance-attribute
owner_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OWNER_USER_ID'})
The unique identifier of the owner.
visible_to
class-attribute
instance-attribute
visible_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TO'})
Organization visibility.
addresses
class-attribute
instance-attribute
addresses: Optional[List[Address | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESSES'})
Organization Addresses
contactinfos
class-attribute
instance-attribute
contactinfos: Optional[List[ContactInfo | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONTACTINFOS'})
Contact Information
background
class-attribute
instance-attribute
background: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BACKGROUND'})
The background of the organization.
image_url
class-attribute
instance-attribute
image_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IMAGE_URL'})
Organization image URL.
TaskRequest
dataclass
TaskRequest(title: str, completed: bool, status: str, publicly_visible: bool, *, due_date: Optional[str] = None, details: Optional[str] = None, priority: Optional[int] = None)
Definition: TaskRequest
Attributes
title
class-attribute
instance-attribute
The title of the task.
due_date
class-attribute
instance-attribute
due_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DUE_DATE'})
yyyy-MM-dd HH:mm:ss
completed
class-attribute
instance-attribute
A boolean value determining whether or not the task is completed.
details
class-attribute
instance-attribute
details: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DETAILS'})
The details of the task.
status
class-attribute
instance-attribute
The status of the task.
Tag
dataclass
ProjectRequest
dataclass
ProjectRequest(project_name: str, status: str, *, project_details: Optional[str] = None, image_url: Optional[str] = None, visible_to: Optional[str] = None, visible_team_id: Optional[int] = None, visible_user_ids: Optional[int] = None, opportunity_id: Optional[int] = None, pipeline_id: Optional[int] = None, stage_id: Optional[int] = None, tags: Optional[List[Tag | Mapping[str, Any]]] = None)
Definition: ProjectRequest
Attributes
project_name
class-attribute
instance-attribute
The name of the project.
project_details
class-attribute
instance-attribute
project_details: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PROJECT_DETAILS'})
The details of the project.
status
class-attribute
instance-attribute
The status of the project.
image_url
class-attribute
instance-attribute
image_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IMAGE_URL'})
The image URL of the project.
visible_to
class-attribute
instance-attribute
visible_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TO'})
Project Visibility.
visible_team_id
class-attribute
instance-attribute
visible_team_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TEAM_ID'})
Visible Team Id (Required when team visibility state is selected)
visible_user_ids
class-attribute
instance-attribute
visible_user_ids: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_USER_IDS'})
Visible User IDs (Required when individuals visibility state is selected)
opportunity_id
class-attribute
instance-attribute
opportunity_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OPPORTUNITY_ID'})
The unique identifier of the opportunity.
pipeline_id
class-attribute
instance-attribute
pipeline_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PIPELINE_ID'})
The unique identifier of the pipeline.
LeadRequest
dataclass
LeadRequest(last_name: str, *, title: Optional[str] = None, first_name: Optional[str] = None, lead_description: Optional[str] = None, converted_date_utc: Optional[str] = None, visible_to: Optional[str] = None, visible_team_id: Optional[int] = None, visible_user_ids: Optional[int] = None, organization_name: Optional[str] = None, phone_number: Optional[str] = None, mobile_phone_number: Optional[str] = None, email_address: Optional[str] = None, converted: Optional[bool] = None, website_url: Optional[str] = None, owner_user_id: Optional[int] = None, responsible_user_id: Optional[int] = None, employee_count: Optional[int] = None, lead_rating: Optional[int] = None, industry: Optional[str] = None, tags: Optional[List[Tag | Mapping[str, Any]]] = None)
Definition: LeadRequest
Attributes
title
class-attribute
instance-attribute
The title of the lead.
first_name
class-attribute
instance-attribute
first_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FIRST_NAME'})
First name of the lead.
last_name
class-attribute
instance-attribute
Last name of the lead.
lead_description
class-attribute
instance-attribute
lead_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LEAD_DESCRIPTION'})
A brief description of the lead.
converted_date_utc
class-attribute
instance-attribute
converted_date_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONVERTED_DATE_UTC'})
yyyy-MM-dd HH:mm:ss
visible_to
class-attribute
instance-attribute
visible_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TO'})
Lead Visibility
visible_team_id
class-attribute
instance-attribute
visible_team_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TEAM_ID'})
Visible Team Id (Required when team visibility state is selected)
visible_user_ids
class-attribute
instance-attribute
visible_user_ids: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_USER_IDS'})
Visible User IDs (Required when individuals visibility state is selected)
organization_name
class-attribute
instance-attribute
organization_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ORGANIZATION_NAME'})
The name of the organization.
phone_number
class-attribute
instance-attribute
phone_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PHONE_NUMBER'})
Lead phone number.
mobile_phone_number
class-attribute
instance-attribute
mobile_phone_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MOBILE_PHONE_NUMBER'})
Lead mobile phone number.
email_address
class-attribute
instance-attribute
email_address: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_ADDRESS'})
Lead email address.
converted
class-attribute
instance-attribute
converted: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONVERTED'})
A boolean value determining whether or not the lead is converted.
website_url
class-attribute
instance-attribute
website_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WEBSITE_URL'})
Lead website URL
owner_user_id
class-attribute
instance-attribute
owner_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OWNER_USER_ID'})
The unique identifier of the lead owner.
responsible_user_id
class-attribute
instance-attribute
responsible_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RESPONSIBLE_USER_ID'})
The unique identifier of the responsible user.
employee_count
class-attribute
instance-attribute
employee_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMPLOYEE_COUNT'})
The employee count of the lead.
lead_rating
class-attribute
instance-attribute
lead_rating: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LEAD_RATING'})
The rating of the lead.
Address
dataclass
Address(*, address_id: Optional[int] = None, address_type: Optional[str] = None, street: Optional[str] = None, city: Optional[str] = None, state: Optional[str] = None, postcode: Optional[str] = None, country: Optional[str] = None)
Definition: Address
Attributes
address_id
class-attribute
instance-attribute
address_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESS_ID'})
The unique identifier of the address.
address_type
class-attribute
instance-attribute
address_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESS_TYPE'})
Address type.
street
class-attribute
instance-attribute
street: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'STREET'})
Address street.
city
class-attribute
instance-attribute
Address city.
state
class-attribute
instance-attribute
Address state.
ContactInfo
dataclass
ContactInfo(*, contact_info_id: Optional[int] = None, type_: Optional[str] = None, subtype: Optional[str] = None, label: Optional[str] = None, detail: Optional[str] = None)
Definition: ContactInfo
Attributes
contact_info_id
class-attribute
instance-attribute
contact_info_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONTACT_INFO_ID'})
The unique identifier of the contact info.
type_
class-attribute
instance-attribute
Contact info type.
subtype
class-attribute
instance-attribute
subtype: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SUBTYPE'})
Contact info sub-type.
label
class-attribute
instance-attribute
Contact info label.
ContactRequest
dataclass
ContactRequest(first_name: str, last_name: str, *, salutation: Optional[str] = None, background: Optional[str] = None, visible_to: Optional[str] = None, visible_team_id: Optional[int] = None, visible_user_ids: Optional[int] = None, contactinfos: Optional[List[ContactInfo | Mapping[str, Any]]] = None, tags: Optional[List[Tag | Mapping[str, Any]]] = None)
Definition: ContactRequest
Attributes
salutation
class-attribute
instance-attribute
salutation: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SALUTATION'})
The salutation of the contact.
first_name
class-attribute
instance-attribute
First name of the contact.
last_name
class-attribute
instance-attribute
Last name of the lead.
background
class-attribute
instance-attribute
background: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BACKGROUND'})
Background
visible_to
class-attribute
instance-attribute
visible_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TO'})
Contact Visibility
visible_team_id
class-attribute
instance-attribute
visible_team_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TEAM_ID'})
Visible Team Id (Required when team visibility state is selected)
visible_user_ids
class-attribute
instance-attribute
visible_user_ids: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_USER_IDS'})
Visible User IDs (Required when individuals visibility state is selected)
User
dataclass
User(*, user_id: Optional[int] = None, contact_id: Optional[int] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, email_address: Optional[str] = None, timezone_id: Optional[str] = None, email_dropbox_identifier: Optional[str] = None, email_dropbox_address: Optional[str] = None, administrator: Optional[bool] = None, account_owner: Optional[bool] = None, active: Optional[bool] = None, date_created_utc: Optional[str] = None, date_updated_utc: Optional[str] = None, user_currency: Optional[str] = None, contact_display: Optional[str] = None, contact_order: Optional[str] = None, task_week_start: Optional[int] = None, instance_id: Optional[int] = None)
Definition: User
Attributes
user_id
class-attribute
instance-attribute
user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'USER_ID'})
The unique identifier of the user.
contact_id
class-attribute
instance-attribute
contact_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONTACT_ID'})
The unique identifier of the contact.
first_name
class-attribute
instance-attribute
first_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FIRST_NAME'})
First name of the user.
last_name
class-attribute
instance-attribute
last_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LAST_NAME'})
Last name of the user.
email_address
class-attribute
instance-attribute
email_address: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_ADDRESS'})
User email address.
timezone_id
class-attribute
instance-attribute
timezone_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TIMEZONE_ID'})
The unique identifier of the timezone.
email_dropbox_identifier
class-attribute
instance-attribute
email_dropbox_identifier: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_DROPBOX_IDENTIFIER'})
The unique identifier of the email dropbox.
email_dropbox_address
class-attribute
instance-attribute
email_dropbox_address: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_DROPBOX_ADDRESS'})
Email dropbox address
administrator
class-attribute
instance-attribute
administrator: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADMINISTRATOR'})
A boolean value determining whether or not the user is an administrator.
account_owner
class-attribute
instance-attribute
account_owner: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ACCOUNT_OWNER'})
A boolean value determining whether or not the user is the account owner.
active
class-attribute
instance-attribute
active: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ACTIVE'})
A boolean value determining whether or not the user is active.
date_created_utc
class-attribute
instance-attribute
date_created_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_CREATED_UTC'})
yyyy-MM-dd HH:mm:ss
date_updated_utc
class-attribute
instance-attribute
date_updated_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_UPDATED_UTC'})
yyyy-MM-dd HH:mm:ss
user_currency
class-attribute
instance-attribute
user_currency: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'USER_CURRENCY'})
User currency.
contact_display
class-attribute
instance-attribute
contact_display: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONTACT_DISPLAY'})
Contact display.
contact_order
class-attribute
instance-attribute
contact_order: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONTACT_ORDER'})
Contact order.
Event
dataclass
Event(*, event_id: Optional[int] = None, title: Optional[str] = None, start_date_utc: Optional[str] = None, end_date_utc: Optional[str] = None, date_created_utc: Optional[str] = None, date_updated_utc: Optional[str] = None, owner_user_id: Optional[int] = None, reminder_sent: Optional[bool] = None, all_day: Optional[bool] = None, publicly_visible: Optional[bool] = None, can_edit: Optional[bool] = None, can_delete: Optional[bool] = None)
Definition: Event
Attributes
event_id
class-attribute
instance-attribute
event_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EVENT_ID'})
The unique identifier of the event.
title
class-attribute
instance-attribute
The title of the event.
start_date_utc
class-attribute
instance-attribute
start_date_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'START_DATE_UTC'})
yyyy-MM-dd HH:mm:ss
end_date_utc
class-attribute
instance-attribute
end_date_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'END_DATE_UTC'})
yyyy-MM-dd HH:mm:ss
date_created_utc
class-attribute
instance-attribute
date_created_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_CREATED_UTC'})
yyyy-MM-dd HH:mm:ss
date_updated_utc
class-attribute
instance-attribute
date_updated_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_UPDATED_UTC'})
yyyy-MM-dd HH:mm:ss
owner_user_id
class-attribute
instance-attribute
owner_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OWNER_USER_ID'})
The unique identifier of the owner.
reminder_sent
class-attribute
instance-attribute
reminder_sent: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'REMINDER_SENT'})
A boolean value determining whether or not the reminder was sent.
all_day
class-attribute
instance-attribute
all_day: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ALL_DAY'})
A boolean value determining whether or not the event is all day.
publicly_visible
class-attribute
instance-attribute
publicly_visible: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PUBLICLY_VISIBLE'})
A boolean value determining whether or not the event is publicly visible.
OrganizationRequest
dataclass
OrganizationRequest(organisation_name: str, *, organisation_background: Optional[str] = None, visible_to: Optional[str] = None, visible_team_id: Optional[int] = None, visible_user_ids: Optional[int] = None, addresses: Optional[List[Address | Mapping[str, Any]]] = None, contactinfos: Optional[List[ContactInfo | Mapping[str, Any]]] = None, tags: Optional[List[Tag | Mapping[str, Any]]] = None)
Definition: OrganizationRequest
Attributes
organisation_name
class-attribute
instance-attribute
The name of the organization.
organisation_background
class-attribute
instance-attribute
organisation_background: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ORGANISATION_BACKGROUND'})
The background of the organization.
visible_to
class-attribute
instance-attribute
visible_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TO'})
Organization visibility.
visible_team_id
class-attribute
instance-attribute
visible_team_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TEAM_ID'})
Visible Team Id (Required when team visibility state is selected)
visible_user_ids
class-attribute
instance-attribute
visible_user_ids: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_USER_IDS'})
Visible User IDs (Required when individuals visibility state is selected)
addresses
class-attribute
instance-attribute
addresses: Optional[List[Address | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESSES'})
Organization Addresses
InsightlyClient
InsightlyClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
Bases: ConnectorClientBase
Typed client for insightly connector.
Initialize a InsightlyClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
list_tasks
list_tasks(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List tasks
List tasks
Returns a single-page Azure Core async collection.
Swagger operation ID: ListTasks.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
update_task
async
update_task(input: TaskRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update task
Update task
Swagger operation ID: UpdateTask.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
TaskRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
id
|
str
|
Unique Id of the task to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
add_task
async
add_task(input: TaskRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Add task
Add task
Swagger operation ID: AddTask.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
TaskRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_projects
list_projects(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List projects
List projects
Returns an Azure Core async pager that follows the connector continuation URL.
Swagger operation ID: ListProjects.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
update_project
async
update_project(input: ProjectRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update project
Update project
Swagger operation ID: UpdateProject.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ProjectRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
id
|
str
|
Unique Id of the project to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
add_project
async
add_project(input: ProjectRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Add project
Add project
Swagger operation ID: AddProject.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ProjectRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_leads
list_leads(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List leads
List leads
Returns a single-page Azure Core async collection.
Swagger operation ID: ListLeads.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
update_lead
async
update_lead(input: LeadRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update lead
Update lead
Swagger operation ID: UpdateLead.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
LeadRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
id
|
str
|
Unique Id of the lead to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
add_lead
async
add_lead(input: LeadRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Add lead
Add lead
Swagger operation ID: AddLead.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
LeadRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_contacts
list_contacts(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List contacts
List contacts
Returns a single-page Azure Core async collection.
Swagger operation ID: ListContacts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
update_contact
async
update_contact(input: ContactRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update contact
Update contact
Swagger operation ID: UpdateContact.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ContactRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
id
|
str
|
Unique Id of the contact to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
add_contact
async
add_contact(input: ContactRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Add contact
Add contact
Swagger operation ID: AddContact.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ContactRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_users
list_users(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List users
List users
Returns a single-page Azure Core async collection.
Swagger operation ID: ListUsers.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
delete_task
async
delete_task(task_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Delete task
Delete task
Swagger operation ID: DeleteTask.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id
|
int
|
Task Id. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
follow_task
async
follow_task(task_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Follow a task
Follow a task
Swagger operation ID: FollowTask.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id
|
int
|
Task Id. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
delete_project
async
delete_project(project_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Delete project
Delete project
Swagger operation ID: DeleteProject.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_id
|
int
|
Project Id. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
delete_lead
async
delete_lead(lead_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Delete lead
Delete lead
Swagger operation ID: DeleteLead.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
lead_id
|
int
|
Lead Id. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
delete_contact
async
delete_contact(contact_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Delete contact
Delete contact
Swagger operation ID: DeleteContact.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
contact_id
|
int
|
Contact Id. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
add_organization
async
add_organization(input: OrganizationRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Add organization
Add organization
Swagger operation ID: AddOrganization.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
OrganizationRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |