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

ListTasksResponse(*, tasks: Optional[List[TaskObject | Mapping[str, Any]]] = None)

Response for List tasks

Attributes

tasks class-attribute instance-attribute

tasks: Optional[List[TaskObject | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

A collection of tasks

TaskObject dataclass

TaskObject(*, t_a_s_k_id: Optional[int] = None, t_i_t_l_e: Optional[str] = None, d_u_e_d_a_t_e: Optional[str] = None, c_a_t_e_g_o_r_y_id: Optional[int] = None, c_o_m_p_l_e_t_e_d_d_a_t_e_u_t_c: Optional[str] = None, c_o_m_p_l_e_t_e_d: Optional[bool] = None, d_e_t_a_i_l_s: Optional[str] = None, s_t_a_t_u_s: Optional[str] = None, p_r_i_o_r_i_t_y: Optional[int] = None, s_t_a_r_t_d_a_t_e: Optional[str] = None, p_r_o_j_e_c_t_id: Optional[int] = None, o_p_p_o_r_t_u_n_i_t_y_id: Optional[int] = None, m_i_l_e_s_t_o_n_e_id: Optional[int] = None, p_i_p_e_l_i_n_e_id: Optional[int] = None, s_t_a_g_e_id: Optional[int] = None, p_e_r_c_e_n_t_c_o_m_p_l_e_t_e: Optional[int] = None, o_w_n_e_r_u_s_e_r_id: Optional[int] = None, r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id: Optional[int] = None, p_u_b_l_i_c_l_y_v_i_s_i_b_l_e: Optional[bool] = None, d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = None, d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = None, a_s_s_i_g_n_e_d_b_y_u_s_e_r_id: Optional[int] = None, p_a_r_e_n_t_t_a_s_k_id: Optional[int] = None, o_w_n_e_r_v_i_s_i_b_l_e: Optional[bool] = None, a_s_s_i_g_n_e_d_t_e_a_m_id: Optional[int] = None, a_s_s_i_g_n_e_d_d_a_t_e_u_t_c: Optional[str] = None, r_e_m_i_n_d_e_r_d_a_t_e_u_t_c: Optional[str] = None, r_e_m_i_n_d_e_r_s_e_n_t: Optional[bool] = None, r_e_c_u_r_r_e_n_c_e: Optional[str] = None, c_a_n_e_d_i_t: Optional[bool] = None, c_a_n_d_e_l_e_t_e: Optional[bool] = None)

Response for Update task

Attributes

t_a_s_k_id class-attribute instance-attribute

t_a_s_k_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TASK_ID'})

The unique identifier of the task.

t_i_t_l_e class-attribute instance-attribute

t_i_t_l_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TITLE'})

The title of the task.

d_u_e_d_a_t_e class-attribute instance-attribute

d_u_e_d_a_t_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DUE_DATE'})

yyyy-MM-dd HH:mm:ss

c_a_t_e_g_o_r_y_id class-attribute instance-attribute

c_a_t_e_g_o_r_y_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CATEGORY_ID'})

The unique identifier of the category.

c_o_m_p_l_e_t_e_d_d_a_t_e_u_t_c class-attribute instance-attribute

c_o_m_p_l_e_t_e_d_d_a_t_e_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'COMPLETED_DATE_UTC'})

yyyy-MM-dd HH:mm:ss

c_o_m_p_l_e_t_e_d class-attribute instance-attribute

c_o_m_p_l_e_t_e_d: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'COMPLETED'})

A boolean value determining whether or not the task is completed.

d_e_t_a_i_l_s class-attribute instance-attribute

d_e_t_a_i_l_s: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DETAILS'})

The details of the task.

s_t_a_t_u_s class-attribute instance-attribute

s_t_a_t_u_s: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'STATUS'})

The status of the task.

p_r_i_o_r_i_t_y class-attribute instance-attribute

p_r_i_o_r_i_t_y: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PRIORITY'})

The priority of the task.

s_t_a_r_t_d_a_t_e class-attribute instance-attribute

s_t_a_r_t_d_a_t_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'START_DATE'})

yyyy-MM-dd HH:mm:ss

p_r_o_j_e_c_t_id class-attribute instance-attribute

p_r_o_j_e_c_t_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PROJECT_ID'})

The unique identifier of the project.

o_p_p_o_r_t_u_n_i_t_y_id class-attribute instance-attribute

o_p_p_o_r_t_u_n_i_t_y_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OPPORTUNITY_ID'})

The unique identifier of the opportunity.

m_i_l_e_s_t_o_n_e_id class-attribute instance-attribute

m_i_l_e_s_t_o_n_e_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MILESTONE_ID'})

The unique identifier of the milestone.

p_i_p_e_l_i_n_e_id class-attribute instance-attribute

p_i_p_e_l_i_n_e_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PIPELINE_ID'})

The unique identifier of the pipeline.

s_t_a_g_e_id class-attribute instance-attribute

s_t_a_g_e_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'STAGE_ID'})

The unique identifier of the stage.

p_e_r_c_e_n_t_c_o_m_p_l_e_t_e class-attribute instance-attribute

p_e_r_c_e_n_t_c_o_m_p_l_e_t_e: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PERCENT_COMPLETE'})

The task completed value in percent.

o_w_n_e_r_u_s_e_r_id class-attribute instance-attribute

o_w_n_e_r_u_s_e_r_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OWNER_USER_ID'})

The unique identifier of the task owner.

r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id class-attribute instance-attribute

r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_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.

p_u_b_l_i_c_l_y_v_i_s_i_b_l_e class-attribute instance-attribute

p_u_b_l_i_c_l_y_v_i_s_i_b_l_e: 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.

d_a_t_e_c_r_e_a_t_e_d_u_t_c class-attribute instance-attribute

d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_CREATED_UTC'})

yyyy-MM-dd HH:mm:ss

d_a_t_e_u_p_d_a_t_e_d_u_t_c class-attribute instance-attribute

d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_UPDATED_UTC'})

yyyy-MM-dd HH:mm:ss

a_s_s_i_g_n_e_d_b_y_u_s_e_r_id class-attribute instance-attribute

a_s_s_i_g_n_e_d_b_y_u_s_e_r_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.

p_a_r_e_n_t_t_a_s_k_id class-attribute instance-attribute

p_a_r_e_n_t_t_a_s_k_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PARENT_TASK_ID'})

The unique identifier of the parent task.

o_w_n_e_r_v_i_s_i_b_l_e class-attribute instance-attribute

o_w_n_e_r_v_i_s_i_b_l_e: 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.

a_s_s_i_g_n_e_d_t_e_a_m_id class-attribute instance-attribute

a_s_s_i_g_n_e_d_t_e_a_m_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ASSIGNED_TEAM_ID'})

The unique identifier of the assigned team.

a_s_s_i_g_n_e_d_d_a_t_e_u_t_c class-attribute instance-attribute

a_s_s_i_g_n_e_d_d_a_t_e_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ASSIGNED_DATE_UTC'})

yyyy-MM-dd HH:mm:ss

r_e_m_i_n_d_e_r_d_a_t_e_u_t_c class-attribute instance-attribute

r_e_m_i_n_d_e_r_d_a_t_e_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'REMINDER_DATE_UTC'})

yyyy-MM-dd HH:mm:ss

r_e_m_i_n_d_e_r_s_e_n_t class-attribute instance-attribute

r_e_m_i_n_d_e_r_s_e_n_t: 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.

r_e_c_u_r_r_e_n_c_e class-attribute instance-attribute

r_e_c_u_r_r_e_n_c_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RECURRENCE'})

Recurrence

c_a_n_e_d_i_t class-attribute instance-attribute

c_a_n_e_d_i_t: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CAN_EDIT'})

Can edit.

c_a_n_d_e_l_e_t_e class-attribute instance-attribute

c_a_n_d_e_l_e_t_e: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CAN_DELETE'})

Can delete

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

projects: Optional[List[Project | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

A collection of projects

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

The URL to retrieve the next page.

Project dataclass

Project(*, p_r_o_j_e_c_t_id: Optional[int] = None, p_r_o_j_e_c_t_n_a_m_e: Optional[str] = None, s_t_a_t_u_s: Optional[str] = None, p_r_o_j_e_c_t_d_e_t_a_i_l_s: Optional[str] = None, i_m_a_g_e_u_r_l: Optional[str] = None, d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = None, v_i_s_i_b_l_e_t_o: Optional[str] = None, d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = None, s_t_a_r_t_e_d_d_a_t_e: Optional[str] = None, c_o_m_p_l_e_t_e_d_d_a_t_e: Optional[str] = None, o_w_n_e_r_u_s_e_r_id: Optional[int] = None, r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id: Optional[int] = None, o_p_p_o_r_t_u_n_i_t_y_id: Optional[int] = None, p_i_p_e_l_i_n_e_id: Optional[int] = None, s_t_a_g_e_id: Optional[int] = None, c_a_t_e_g_o_r_y_id: Optional[int] = None, v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = None, v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = None, c_a_n_e_d_i_t: Optional[bool] = None, c_a_n_d_e_l_e_t_e: Optional[bool] = None)

Response for Update project

Attributes

p_r_o_j_e_c_t_id class-attribute instance-attribute

p_r_o_j_e_c_t_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PROJECT_ID'})

The unique identifier of the project.

p_r_o_j_e_c_t_n_a_m_e class-attribute instance-attribute

p_r_o_j_e_c_t_n_a_m_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PROJECT_NAME'})

The name of the project.

s_t_a_t_u_s class-attribute instance-attribute

s_t_a_t_u_s: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'STATUS'})

The status of the project.

p_r_o_j_e_c_t_d_e_t_a_i_l_s class-attribute instance-attribute

p_r_o_j_e_c_t_d_e_t_a_i_l_s: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PROJECT_DETAILS'})

The details of the project.

i_m_a_g_e_u_r_l class-attribute instance-attribute

i_m_a_g_e_u_r_l: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IMAGE_URL'})

The image URL of the project.

d_a_t_e_c_r_e_a_t_e_d_u_t_c class-attribute instance-attribute

d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_CREATED_UTC'})

yyyy-MM-dd HH:mm:ss

v_i_s_i_b_l_e_t_o class-attribute instance-attribute

v_i_s_i_b_l_e_t_o: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TO'})

Project Visibility.

d_a_t_e_u_p_d_a_t_e_d_u_t_c class-attribute instance-attribute

d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_UPDATED_UTC'})

yyyy-MM-dd HH:mm:ss

s_t_a_r_t_e_d_d_a_t_e class-attribute instance-attribute

s_t_a_r_t_e_d_d_a_t_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'STARTED_DATE'})

yyyy-MM-dd HH:mm:ss

c_o_m_p_l_e_t_e_d_d_a_t_e class-attribute instance-attribute

c_o_m_p_l_e_t_e_d_d_a_t_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'COMPLETED_DATE'})

yyyy-MM-dd HH:mm:ss

o_w_n_e_r_u_s_e_r_id class-attribute instance-attribute

o_w_n_e_r_u_s_e_r_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OWNER_USER_ID'})

The unique identifier of the project owner.

r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id class-attribute instance-attribute

r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RESPONSIBLE_USER_ID'})

The unique identifier of the assigned user.

o_p_p_o_r_t_u_n_i_t_y_id class-attribute instance-attribute

o_p_p_o_r_t_u_n_i_t_y_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OPPORTUNITY_ID'})

The unique identifier of the opportunity.

p_i_p_e_l_i_n_e_id class-attribute instance-attribute

p_i_p_e_l_i_n_e_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PIPELINE_ID'})

The unique identifier of the pipeline.

s_t_a_g_e_id class-attribute instance-attribute

s_t_a_g_e_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'STAGE_ID'})

The unique identifier of the stage.

c_a_t_e_g_o_r_y_id class-attribute instance-attribute

c_a_t_e_g_o_r_y_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CATEGORY_ID'})

The unique identifier of the category.

v_i_s_i_b_l_e_t_e_a_m_id class-attribute instance-attribute

v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TEAM_ID'})

The unique identifier of the team.

v_i_s_i_b_l_e_u_s_e_r_id_s class-attribute instance-attribute

v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_USER_IDS'})

The unique identifiers of the users.

c_a_n_e_d_i_t class-attribute instance-attribute

c_a_n_e_d_i_t: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CAN_EDIT'})

Can edit

c_a_n_d_e_l_e_t_e class-attribute instance-attribute

c_a_n_d_e_l_e_t_e: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CAN_DELETE'})

Can delete

ListLeadsResponse dataclass

ListLeadsResponse(*, leads: Optional[List[Lead | Mapping[str, Any]]] = None)

Response for List leads

Attributes

leads class-attribute instance-attribute

leads: Optional[List[Lead | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

A collection of leads

Lead dataclass

Lead(*, l_e_a_d_id: Optional[int] = None, s_a_l_u_t_a_t_i_o_n: Optional[str] = None, t_i_t_l_e: Optional[str] = None, f_i_r_s_t_n_a_m_e: Optional[str] = None, l_a_s_t_n_a_m_e: Optional[str] = None, l_e_a_d_d_e_s_c_r_i_p_t_i_o_n: Optional[str] = None, d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = None, d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = None, c_o_n_v_e_r_t_e_d_d_a_t_e_u_t_c: Optional[str] = None, l_e_a_d_s_t_a_t_u_s_id: Optional[int] = None, v_i_s_i_b_l_e_t_o: Optional[str] = None, o_r_g_a_n_i_z_a_t_i_o_n_n_a_m_e: Optional[str] = None, p_h_o_n_e_n_u_m_b_e_r: Optional[str] = None, m_o_b_i_l_e_p_h_o_n_e_n_u_m_b_e_r: Optional[str] = None, e_m_a_i_l_a_d_d_r_e_s_s: Optional[str] = None, c_o_n_v_e_r_t_e_d: Optional[bool] = None, w_e_b_s_i_t_e_u_r_l: Optional[str] = None, o_w_n_e_r_u_s_e_r_id: Optional[int] = None, r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id: Optional[int] = None, e_m_p_l_o_y_e_e_c_o_u_n_t: Optional[int] = None, l_e_a_d_r_a_t_i_n_g: Optional[int] = None, i_n_d_u_s_t_r_y: Optional[str] = None, a_d_d_r_e_s_s_s_t_r_e_e_t: Optional[str] = None, a_d_d_r_e_s_s_c_i_t_y: Optional[str] = None, a_d_d_r_e_s_s_s_t_a_t_e: Optional[str] = None, a_d_d_r_e_s_s_p_o_s_t_c_o_d_e: Optional[str] = None, a_d_d_r_e_s_s_c_o_u_n_t_r_y: Optional[str] = None, f_a_x_n_u_m_b_e_r: Optional[str] = None, c_o_n_v_e_r_t_e_d_c_o_n_t_a_c_t_id: Optional[int] = None, c_o_n_v_e_r_t_e_d_o_r_g_a_n_i_z_a_t_i_o_n_id: Optional[int] = None, c_o_n_v_e_r_t_e_d_o_p_p_o_r_t_u_n_i_t_y_id: Optional[int] = None, l_e_a_d_s_o_u_r_c_e_id: Optional[int] = None, v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = None, v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = None, i_m_a_g_e_u_r_l: Optional[str] = None, c_a_n_e_d_i_t: Optional[bool] = None, c_a_n_d_e_l_e_t_e: Optional[bool] = None)

Response for Update lead

Attributes

l_e_a_d_id class-attribute instance-attribute

l_e_a_d_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LEAD_ID'})

The unique identifier of the lead.

s_a_l_u_t_a_t_i_o_n class-attribute instance-attribute

s_a_l_u_t_a_t_i_o_n: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SALUTATION'})

The salutation of the lead.

t_i_t_l_e class-attribute instance-attribute

t_i_t_l_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TITLE'})

The title of the lead.

f_i_r_s_t_n_a_m_e class-attribute instance-attribute

f_i_r_s_t_n_a_m_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FIRST_NAME'})

First name of the lead.

l_a_s_t_n_a_m_e class-attribute instance-attribute

l_a_s_t_n_a_m_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LAST_NAME'})

Last name of the lead.

l_e_a_d_d_e_s_c_r_i_p_t_i_o_n class-attribute instance-attribute

l_e_a_d_d_e_s_c_r_i_p_t_i_o_n: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LEAD_DESCRIPTION'})

A brief description of the lead.

d_a_t_e_c_r_e_a_t_e_d_u_t_c class-attribute instance-attribute

d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_CREATED_UTC'})

yyyy-MM-dd HH:mm:ss

d_a_t_e_u_p_d_a_t_e_d_u_t_c class-attribute instance-attribute

d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_UPDATED_UTC'})

yyyy-MM-dd HH:mm:ss

c_o_n_v_e_r_t_e_d_d_a_t_e_u_t_c class-attribute instance-attribute

c_o_n_v_e_r_t_e_d_d_a_t_e_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONVERTED_DATE_UTC'})

yyyy-MM-dd HH:mm:ss

l_e_a_d_s_t_a_t_u_s_id class-attribute instance-attribute

l_e_a_d_s_t_a_t_u_s_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LEAD_STATUS_ID'})

The status Id of the lead.

v_i_s_i_b_l_e_t_o class-attribute instance-attribute

v_i_s_i_b_l_e_t_o: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TO'})

Lead visibility.

o_r_g_a_n_i_z_a_t_i_o_n_n_a_m_e class-attribute instance-attribute

o_r_g_a_n_i_z_a_t_i_o_n_n_a_m_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ORGANIZATION_NAME'})

The name of the organization.

p_h_o_n_e_n_u_m_b_e_r class-attribute instance-attribute

p_h_o_n_e_n_u_m_b_e_r: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PHONE_NUMBER'})

Lead phone number.

m_o_b_i_l_e_p_h_o_n_e_n_u_m_b_e_r class-attribute instance-attribute

m_o_b_i_l_e_p_h_o_n_e_n_u_m_b_e_r: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MOBILE_PHONE_NUMBER'})

Lead mobile phone number.

e_m_a_i_l_a_d_d_r_e_s_s class-attribute instance-attribute

e_m_a_i_l_a_d_d_r_e_s_s: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_ADDRESS'})

Lead email address.

c_o_n_v_e_r_t_e_d class-attribute instance-attribute

c_o_n_v_e_r_t_e_d: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONVERTED'})

A boolean value determining whether or not the lead is converted.

w_e_b_s_i_t_e_u_r_l class-attribute instance-attribute

w_e_b_s_i_t_e_u_r_l: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WEBSITE_URL'})

Lead website URL

o_w_n_e_r_u_s_e_r_id class-attribute instance-attribute

o_w_n_e_r_u_s_e_r_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OWNER_USER_ID'})

The unique identifier of the lead owner.

r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id class-attribute instance-attribute

r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RESPONSIBLE_USER_ID'})

The unique identifier of the responsible user.

e_m_p_l_o_y_e_e_c_o_u_n_t class-attribute instance-attribute

e_m_p_l_o_y_e_e_c_o_u_n_t: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMPLOYEE_COUNT'})

The employee count of the lead.

l_e_a_d_r_a_t_i_n_g class-attribute instance-attribute

l_e_a_d_r_a_t_i_n_g: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LEAD_RATING'})

The rating of the lead.

i_n_d_u_s_t_r_y class-attribute instance-attribute

i_n_d_u_s_t_r_y: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'INDUSTRY'})

The industry of the lead.

a_d_d_r_e_s_s_s_t_r_e_e_t class-attribute instance-attribute

a_d_d_r_e_s_s_s_t_r_e_e_t: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESS_STREET'})

Address street.

a_d_d_r_e_s_s_c_i_t_y class-attribute instance-attribute

a_d_d_r_e_s_s_c_i_t_y: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESS_CITY'})

Address city.

a_d_d_r_e_s_s_s_t_a_t_e class-attribute instance-attribute

a_d_d_r_e_s_s_s_t_a_t_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESS_STATE'})

Address state.

a_d_d_r_e_s_s_p_o_s_t_c_o_d_e class-attribute instance-attribute

a_d_d_r_e_s_s_p_o_s_t_c_o_d_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESS_POSTCODE'})

Address postcode.

a_d_d_r_e_s_s_c_o_u_n_t_r_y class-attribute instance-attribute

a_d_d_r_e_s_s_c_o_u_n_t_r_y: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESS_COUNTRY'})

Address country.

f_a_x_n_u_m_b_e_r class-attribute instance-attribute

f_a_x_n_u_m_b_e_r: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FAX_NUMBER'})

Lead fax number.

c_o_n_v_e_r_t_e_d_c_o_n_t_a_c_t_id class-attribute instance-attribute

c_o_n_v_e_r_t_e_d_c_o_n_t_a_c_t_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONVERTED_CONTACT_ID'})

The unique identifier of the converted contact.

c_o_n_v_e_r_t_e_d_o_r_g_a_n_i_z_a_t_i_o_n_id class-attribute instance-attribute

c_o_n_v_e_r_t_e_d_o_r_g_a_n_i_z_a_t_i_o_n_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONVERTED_ORGANIZATION_ID'})

The unique identifier of the converted organization.

c_o_n_v_e_r_t_e_d_o_p_p_o_r_t_u_n_i_t_y_id class-attribute instance-attribute

c_o_n_v_e_r_t_e_d_o_p_p_o_r_t_u_n_i_t_y_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONVERTED_OPPORTUNITY_ID'})

The unique identifier of the opportunity.

l_e_a_d_s_o_u_r_c_e_id class-attribute instance-attribute

l_e_a_d_s_o_u_r_c_e_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LEAD_SOURCE_ID'})

The unique identifier of the lead source.

v_i_s_i_b_l_e_t_e_a_m_id class-attribute instance-attribute

v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TEAM_ID'})

The unique identifier of the team.

v_i_s_i_b_l_e_u_s_e_r_id_s class-attribute instance-attribute

v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_USER_IDS'})

The unique identifiers of the users.

i_m_a_g_e_u_r_l class-attribute instance-attribute

i_m_a_g_e_u_r_l: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IMAGE_URL'})

Lead Image URL

c_a_n_e_d_i_t class-attribute instance-attribute

c_a_n_e_d_i_t: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CAN_EDIT'})

Can edit

c_a_n_d_e_l_e_t_e class-attribute instance-attribute

c_a_n_d_e_l_e_t_e: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CAN_DELETE'})

Can delete

ListContactsResponse dataclass

ListContactsResponse(*, contacts: Optional[List[Contact | Mapping[str, Any]]] = None)

Response for List contacts

Attributes

contacts class-attribute instance-attribute

contacts: Optional[List[Contact | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

A collection of contacts

Contact dataclass

Contact(*, a_d_d_r_e_s_s_w_o_r_k: Optional[Dict[str, Any]] = None, a_d_d_r_e_s_s_h_o_m_e: Optional[Dict[str, Any]] = None, a_d_d_r_e_s_s_p_o_s_t_a_l: Optional[Dict[str, Any]] = None, a_d_d_r_e_s_s_p_r_i_m_a_r_y: Optional[Dict[str, Any]] = None, a_d_d_r_e_s_s_o_t_h_e_r: Optional[Dict[str, Any]] = None, e_m_a_i_l_w_o_r_k: Optional[str] = None, e_m_a_i_l_h_o_m_e: Optional[str] = None, e_m_a_i_l_p_e_r_s_o_n_a_l: Optional[str] = None, e_m_a_i_l_o_t_h_e_r: Optional[str] = None, p_h_o_n_e_w_o_r_k: Optional[str] = None, p_h_o_n_e_h_o_m_e: Optional[str] = None, p_h_o_n_e_m_o_b_i_l_e: Optional[str] = None, p_h_o_n_e_o_t_h_e_r: Optional[str] = None, c_o_n_t_a_c_t_id: Optional[int] = None, s_a_l_u_t_a_t_i_o_n: Optional[str] = None, f_i_r_s_t_n_a_m_e: Optional[str] = None, l_a_s_t_n_a_m_e: Optional[str] = None, i_m_a_g_e_u_r_l: Optional[str] = None, d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = None, v_i_s_i_b_l_e_t_o: Optional[str] = None, b_a_c_k_g_r_o_u_n_d: Optional[str] = None, d_e_f_a_u_l_t_l_i_n_k_e_d_o_r_g_a_n_i_s_a_t_i_o_n: Optional[int] = None, o_w_n_e_r_u_s_e_r_id: Optional[int] = None, d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = None, v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = None, v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = None, c_a_n_e_d_i_t: Optional[bool] = None, c_a_n_d_e_l_e_t_e: Optional[bool] = None, s_o_c_i_a_l_l_i_n_k_e_d_i_n: Optional[str] = None, s_o_c_i_a_l_f_a_c_e_b_o_o_k: Optional[str] = None, s_o_c_i_a_l_t_w_i_t_t_e_r: Optional[str] = None)

Response for Update contact

Attributes

e_m_a_i_l_w_o_r_k class-attribute instance-attribute

e_m_a_i_l_w_o_r_k: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_WORK'})

The work email of the contact.

e_m_a_i_l_h_o_m_e class-attribute instance-attribute

e_m_a_i_l_h_o_m_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_HOME'})

The home email of the contact.

e_m_a_i_l_p_e_r_s_o_n_a_l class-attribute instance-attribute

e_m_a_i_l_p_e_r_s_o_n_a_l: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_PERSONAL'})

The personal email of the contact.

e_m_a_i_l_o_t_h_e_r class-attribute instance-attribute

e_m_a_i_l_o_t_h_e_r: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_OTHER'})

The other email of the contact.

p_h_o_n_e_w_o_r_k class-attribute instance-attribute

p_h_o_n_e_w_o_r_k: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PHONE_WORK'})

The work phone number of the contact.

p_h_o_n_e_h_o_m_e class-attribute instance-attribute

p_h_o_n_e_h_o_m_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PHONE_HOME'})

The home phone number of the contact.

p_h_o_n_e_m_o_b_i_l_e class-attribute instance-attribute

p_h_o_n_e_m_o_b_i_l_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PHONE_MOBILE'})

The mobile phone number of the contact.

p_h_o_n_e_o_t_h_e_r class-attribute instance-attribute

p_h_o_n_e_o_t_h_e_r: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PHONE_OTHER'})

The other phone number of the contact.

c_o_n_t_a_c_t_id class-attribute instance-attribute

c_o_n_t_a_c_t_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONTACT_ID'})

The unique identifier of the contact.

s_a_l_u_t_a_t_i_o_n class-attribute instance-attribute

s_a_l_u_t_a_t_i_o_n: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SALUTATION'})

The salutation of the contact.

f_i_r_s_t_n_a_m_e class-attribute instance-attribute

f_i_r_s_t_n_a_m_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FIRST_NAME'})

First name of the contact.

l_a_s_t_n_a_m_e class-attribute instance-attribute

l_a_s_t_n_a_m_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LAST_NAME'})

Last name of the contact.

i_m_a_g_e_u_r_l class-attribute instance-attribute

i_m_a_g_e_u_r_l: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IMAGE_URL'})

Contact image URL.

d_a_t_e_c_r_e_a_t_e_d_u_t_c class-attribute instance-attribute

d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_CREATED_UTC'})

yyyy-MM-dd HH:mm:ss

v_i_s_i_b_l_e_t_o class-attribute instance-attribute

v_i_s_i_b_l_e_t_o: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TO'})

Contact visibility.

b_a_c_k_g_r_o_u_n_d class-attribute instance-attribute

b_a_c_k_g_r_o_u_n_d: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BACKGROUND'})

Background

d_e_f_a_u_l_t_l_i_n_k_e_d_o_r_g_a_n_i_s_a_t_i_o_n class-attribute instance-attribute

d_e_f_a_u_l_t_l_i_n_k_e_d_o_r_g_a_n_i_s_a_t_i_o_n: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DEFAULT_LINKED_ORGANISATION'})

Default linked organization.

o_w_n_e_r_u_s_e_r_id class-attribute instance-attribute

o_w_n_e_r_u_s_e_r_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OWNER_USER_ID'})

The unique identifier of the owner.

d_a_t_e_u_p_d_a_t_e_d_u_t_c class-attribute instance-attribute

d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_UPDATED_UTC'})

yyyy-MM-dd HH:mm:ss

v_i_s_i_b_l_e_t_e_a_m_id class-attribute instance-attribute

v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TEAM_ID'})

The unique identifier of the team.

v_i_s_i_b_l_e_u_s_e_r_id_s class-attribute instance-attribute

v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_USER_IDS'})

The unique identifiers of the users.

c_a_n_e_d_i_t class-attribute instance-attribute

c_a_n_e_d_i_t: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CAN_EDIT'})

Can edit

c_a_n_d_e_l_e_t_e class-attribute instance-attribute

c_a_n_d_e_l_e_t_e: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CAN_DELETE'})

Can delete

s_o_c_i_a_l_l_i_n_k_e_d_i_n class-attribute instance-attribute

s_o_c_i_a_l_l_i_n_k_e_d_i_n: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SOCIAL_LINKEDIN'})

Social LinkedIn.

s_o_c_i_a_l_f_a_c_e_b_o_o_k class-attribute instance-attribute

s_o_c_i_a_l_f_a_c_e_b_o_o_k: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SOCIAL_FACEBOOK'})

Social Facebook.

s_o_c_i_a_l_t_w_i_t_t_e_r class-attribute instance-attribute

s_o_c_i_a_l_t_w_i_t_t_e_r: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SOCIAL_TWITTER'})

Social Twitter.

ListUsersResponse dataclass

ListUsersResponse(*, users: Optional[List[User | Mapping[str, Any]]] = None)

Response for List users

Attributes

users class-attribute instance-attribute

users: Optional[List[User | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

A collection of users

ObjectEntity dataclass

ObjectEntity(*, additional_properties: Dict[str, Any] = dict())

Response for Delete task

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ListEventsResponse dataclass

ListEventsResponse(*, events: Optional[List[Event | Mapping[str, Any]]] = None)

Response for When an event is created

Attributes

events class-attribute instance-attribute

events: Optional[List[Event | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

A collection of events

Organization dataclass

Organization(*, o_r_g_a_n_i_s_a_t_i_o_n_id: Optional[int] = None, o_r_g_a_n_i_s_a_t_i_o_n_b_a_c_k_g_r_o_u_n_d: Optional[str] = None, o_r_g_a_n_i_s_a_t_i_o_n_n_a_m_e: Optional[str] = None, d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = None, d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = None, o_w_n_e_r_u_s_e_r_id: Optional[int] = None, v_i_s_i_b_l_e_t_o: Optional[str] = None, a_d_d_r_e_s_s_e_s: Optional[List[Address | Mapping[str, Any]]] = None, c_o_n_t_a_c_t_i_n_f_o_s: Optional[List[ContactInfo | Mapping[str, Any]]] = None, b_a_c_k_g_r_o_u_n_d: Optional[str] = None, i_m_a_g_e_u_r_l: Optional[str] = None, v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = None, v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = None)

Response for Add organization

Attributes

o_r_g_a_n_i_s_a_t_i_o_n_id class-attribute instance-attribute

o_r_g_a_n_i_s_a_t_i_o_n_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ORGANISATION_ID'})

The unique identifier of the organization.

o_r_g_a_n_i_s_a_t_i_o_n_b_a_c_k_g_r_o_u_n_d class-attribute instance-attribute

o_r_g_a_n_i_s_a_t_i_o_n_b_a_c_k_g_r_o_u_n_d: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ORGANISATION_BACKGROUND'})

The background of the organization.

o_r_g_a_n_i_s_a_t_i_o_n_n_a_m_e class-attribute instance-attribute

o_r_g_a_n_i_s_a_t_i_o_n_n_a_m_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ORGANISATION_NAME'})

The name of the organization.

d_a_t_e_c_r_e_a_t_e_d_u_t_c class-attribute instance-attribute

d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_CREATED_UTC'})

yyyy-MM-dd HH:mm:ss

d_a_t_e_u_p_d_a_t_e_d_u_t_c class-attribute instance-attribute

d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_UPDATED_UTC'})

yyyy-MM-dd HH:mm:ss

o_w_n_e_r_u_s_e_r_id class-attribute instance-attribute

o_w_n_e_r_u_s_e_r_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OWNER_USER_ID'})

The unique identifier of the owner.

v_i_s_i_b_l_e_t_o class-attribute instance-attribute

v_i_s_i_b_l_e_t_o: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TO'})

Organization visibility.

a_d_d_r_e_s_s_e_s class-attribute instance-attribute

a_d_d_r_e_s_s_e_s: Optional[List[Address | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESSES'})

Organization Addresses

c_o_n_t_a_c_t_i_n_f_o_s class-attribute instance-attribute

c_o_n_t_a_c_t_i_n_f_o_s: Optional[List[ContactInfo | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONTACTINFOS'})

Contact Information

b_a_c_k_g_r_o_u_n_d class-attribute instance-attribute

b_a_c_k_g_r_o_u_n_d: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BACKGROUND'})

The background of the organization.

i_m_a_g_e_u_r_l class-attribute instance-attribute

i_m_a_g_e_u_r_l: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IMAGE_URL'})

Organization image URL.

v_i_s_i_b_l_e_t_e_a_m_id class-attribute instance-attribute

v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TEAM_ID'})

The unique identifier of the team.

v_i_s_i_b_l_e_u_s_e_r_id_s class-attribute instance-attribute

v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_USER_IDS'})

The unique identifiers of the users.

TaskRequest dataclass

TaskRequest(t_i_t_l_e: str, c_o_m_p_l_e_t_e_d: bool, s_t_a_t_u_s: str, p_u_b_l_i_c_l_y_v_i_s_i_b_l_e: bool, *, d_u_e_d_a_t_e: Optional[str] = None, d_e_t_a_i_l_s: Optional[str] = None, p_r_i_o_r_i_t_y: Optional[int] = None)

Definition: TaskRequest

Attributes

t_i_t_l_e class-attribute instance-attribute

t_i_t_l_e: str = dataclass_field(metadata={'wire_name': 'TITLE'})

The title of the task.

d_u_e_d_a_t_e class-attribute instance-attribute

d_u_e_d_a_t_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DUE_DATE'})

yyyy-MM-dd HH:mm:ss

c_o_m_p_l_e_t_e_d class-attribute instance-attribute

c_o_m_p_l_e_t_e_d: bool = dataclass_field(metadata={'wire_name': 'COMPLETED'})

A boolean value determining whether or not the task is completed.

d_e_t_a_i_l_s class-attribute instance-attribute

d_e_t_a_i_l_s: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DETAILS'})

The details of the task.

s_t_a_t_u_s class-attribute instance-attribute

s_t_a_t_u_s: str = dataclass_field(metadata={'wire_name': 'STATUS'})

The status of the task.

p_r_i_o_r_i_t_y class-attribute instance-attribute

p_r_i_o_r_i_t_y: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PRIORITY'})

The priority of the task.

p_u_b_l_i_c_l_y_v_i_s_i_b_l_e class-attribute instance-attribute

p_u_b_l_i_c_l_y_v_i_s_i_b_l_e: bool = dataclass_field(metadata={'wire_name': 'PUBLICLY_VISIBLE'})

A boolean value determining whether or not the task is publicly visible.

Tag dataclass

Tag(*, t_a_g_n_a_m_e: Optional[str] = None)

Definition: Tag

Attributes

t_a_g_n_a_m_e class-attribute instance-attribute

t_a_g_n_a_m_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TAG_NAME'})

The name of the tag.

ProjectRequest dataclass

ProjectRequest(p_r_o_j_e_c_t_n_a_m_e: str, s_t_a_t_u_s: str, *, p_r_o_j_e_c_t_d_e_t_a_i_l_s: Optional[str] = None, i_m_a_g_e_u_r_l: Optional[str] = None, v_i_s_i_b_l_e_t_o: Optional[str] = None, v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = None, v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = None, o_p_p_o_r_t_u_n_i_t_y_id: Optional[int] = None, p_i_p_e_l_i_n_e_id: Optional[int] = None, s_t_a_g_e_id: Optional[int] = None, t_a_g_s: Optional[List[Tag | Mapping[str, Any]]] = None)

Definition: ProjectRequest

Attributes

p_r_o_j_e_c_t_n_a_m_e class-attribute instance-attribute

p_r_o_j_e_c_t_n_a_m_e: str = dataclass_field(metadata={'wire_name': 'PROJECT_NAME'})

The name of the project.

p_r_o_j_e_c_t_d_e_t_a_i_l_s class-attribute instance-attribute

p_r_o_j_e_c_t_d_e_t_a_i_l_s: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PROJECT_DETAILS'})

The details of the project.

s_t_a_t_u_s class-attribute instance-attribute

s_t_a_t_u_s: str = dataclass_field(metadata={'wire_name': 'STATUS'})

The status of the project.

i_m_a_g_e_u_r_l class-attribute instance-attribute

i_m_a_g_e_u_r_l: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IMAGE_URL'})

The image URL of the project.

v_i_s_i_b_l_e_t_o class-attribute instance-attribute

v_i_s_i_b_l_e_t_o: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TO'})

Project Visibility.

v_i_s_i_b_l_e_t_e_a_m_id class-attribute instance-attribute

v_i_s_i_b_l_e_t_e_a_m_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)

v_i_s_i_b_l_e_u_s_e_r_id_s class-attribute instance-attribute

v_i_s_i_b_l_e_u_s_e_r_id_s: 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)

o_p_p_o_r_t_u_n_i_t_y_id class-attribute instance-attribute

o_p_p_o_r_t_u_n_i_t_y_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OPPORTUNITY_ID'})

The unique identifier of the opportunity.

p_i_p_e_l_i_n_e_id class-attribute instance-attribute

p_i_p_e_l_i_n_e_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PIPELINE_ID'})

The unique identifier of the pipeline.

s_t_a_g_e_id class-attribute instance-attribute

s_t_a_g_e_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'STAGE_ID'})

The unique identifier of the stage.

t_a_g_s class-attribute instance-attribute

t_a_g_s: Optional[List[Tag | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TAGS'})

Tags

LeadRequest dataclass

LeadRequest(l_a_s_t_n_a_m_e: str, *, t_i_t_l_e: Optional[str] = None, f_i_r_s_t_n_a_m_e: Optional[str] = None, l_e_a_d_d_e_s_c_r_i_p_t_i_o_n: Optional[str] = None, c_o_n_v_e_r_t_e_d_d_a_t_e_u_t_c: Optional[str] = None, v_i_s_i_b_l_e_t_o: Optional[str] = None, v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = None, v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = None, o_r_g_a_n_i_z_a_t_i_o_n_n_a_m_e: Optional[str] = None, p_h_o_n_e_n_u_m_b_e_r: Optional[str] = None, m_o_b_i_l_e_p_h_o_n_e_n_u_m_b_e_r: Optional[str] = None, e_m_a_i_l_a_d_d_r_e_s_s: Optional[str] = None, c_o_n_v_e_r_t_e_d: Optional[bool] = None, w_e_b_s_i_t_e_u_r_l: Optional[str] = None, o_w_n_e_r_u_s_e_r_id: Optional[int] = None, r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id: Optional[int] = None, e_m_p_l_o_y_e_e_c_o_u_n_t: Optional[int] = None, l_e_a_d_r_a_t_i_n_g: Optional[int] = None, i_n_d_u_s_t_r_y: Optional[str] = None, t_a_g_s: Optional[List[Tag | Mapping[str, Any]]] = None)

Definition: LeadRequest

Attributes

t_i_t_l_e class-attribute instance-attribute

t_i_t_l_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TITLE'})

The title of the lead.

f_i_r_s_t_n_a_m_e class-attribute instance-attribute

f_i_r_s_t_n_a_m_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FIRST_NAME'})

First name of the lead.

l_a_s_t_n_a_m_e class-attribute instance-attribute

l_a_s_t_n_a_m_e: str = dataclass_field(metadata={'wire_name': 'LAST_NAME'})

Last name of the lead.

l_e_a_d_d_e_s_c_r_i_p_t_i_o_n class-attribute instance-attribute

l_e_a_d_d_e_s_c_r_i_p_t_i_o_n: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LEAD_DESCRIPTION'})

A brief description of the lead.

c_o_n_v_e_r_t_e_d_d_a_t_e_u_t_c class-attribute instance-attribute

c_o_n_v_e_r_t_e_d_d_a_t_e_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONVERTED_DATE_UTC'})

yyyy-MM-dd HH:mm:ss

v_i_s_i_b_l_e_t_o class-attribute instance-attribute

v_i_s_i_b_l_e_t_o: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TO'})

Lead Visibility

v_i_s_i_b_l_e_t_e_a_m_id class-attribute instance-attribute

v_i_s_i_b_l_e_t_e_a_m_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)

v_i_s_i_b_l_e_u_s_e_r_id_s class-attribute instance-attribute

v_i_s_i_b_l_e_u_s_e_r_id_s: 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)

o_r_g_a_n_i_z_a_t_i_o_n_n_a_m_e class-attribute instance-attribute

o_r_g_a_n_i_z_a_t_i_o_n_n_a_m_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ORGANIZATION_NAME'})

The name of the organization.

p_h_o_n_e_n_u_m_b_e_r class-attribute instance-attribute

p_h_o_n_e_n_u_m_b_e_r: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PHONE_NUMBER'})

Lead phone number.

m_o_b_i_l_e_p_h_o_n_e_n_u_m_b_e_r class-attribute instance-attribute

m_o_b_i_l_e_p_h_o_n_e_n_u_m_b_e_r: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MOBILE_PHONE_NUMBER'})

Lead mobile phone number.

e_m_a_i_l_a_d_d_r_e_s_s class-attribute instance-attribute

e_m_a_i_l_a_d_d_r_e_s_s: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_ADDRESS'})

Lead email address.

c_o_n_v_e_r_t_e_d class-attribute instance-attribute

c_o_n_v_e_r_t_e_d: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONVERTED'})

A boolean value determining whether or not the lead is converted.

w_e_b_s_i_t_e_u_r_l class-attribute instance-attribute

w_e_b_s_i_t_e_u_r_l: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WEBSITE_URL'})

Lead website URL

o_w_n_e_r_u_s_e_r_id class-attribute instance-attribute

o_w_n_e_r_u_s_e_r_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OWNER_USER_ID'})

The unique identifier of the lead owner.

r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id class-attribute instance-attribute

r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RESPONSIBLE_USER_ID'})

The unique identifier of the responsible user.

e_m_p_l_o_y_e_e_c_o_u_n_t class-attribute instance-attribute

e_m_p_l_o_y_e_e_c_o_u_n_t: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMPLOYEE_COUNT'})

The employee count of the lead.

l_e_a_d_r_a_t_i_n_g class-attribute instance-attribute

l_e_a_d_r_a_t_i_n_g: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LEAD_RATING'})

The rating of the lead.

i_n_d_u_s_t_r_y class-attribute instance-attribute

i_n_d_u_s_t_r_y: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'INDUSTRY'})

The industry of the lead.

t_a_g_s class-attribute instance-attribute

t_a_g_s: Optional[List[Tag | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TAGS'})

Tag

Address dataclass

Address(*, a_d_d_r_e_s_s_id: Optional[int] = None, a_d_d_r_e_s_s_t_y_p_e: Optional[str] = None, s_t_r_e_e_t: Optional[str] = None, c_i_t_y: Optional[str] = None, s_t_a_t_e: Optional[str] = None, p_o_s_t_c_o_d_e: Optional[str] = None, c_o_u_n_t_r_y: Optional[str] = None)

Definition: Address

Attributes

a_d_d_r_e_s_s_id class-attribute instance-attribute

a_d_d_r_e_s_s_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESS_ID'})

The unique identifier of the address.

a_d_d_r_e_s_s_t_y_p_e class-attribute instance-attribute

a_d_d_r_e_s_s_t_y_p_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESS_TYPE'})

Address type.

s_t_r_e_e_t class-attribute instance-attribute

s_t_r_e_e_t: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'STREET'})

Address street.

c_i_t_y class-attribute instance-attribute

c_i_t_y: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CITY'})

Address city.

s_t_a_t_e class-attribute instance-attribute

s_t_a_t_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'STATE'})

Address state.

p_o_s_t_c_o_d_e class-attribute instance-attribute

p_o_s_t_c_o_d_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'POSTCODE'})

Address postcode.

c_o_u_n_t_r_y class-attribute instance-attribute

c_o_u_n_t_r_y: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'COUNTRY'})

Address country.

ContactInfo dataclass

ContactInfo(*, c_o_n_t_a_c_t_i_n_f_o_id: Optional[int] = None, t_y_p_e: Optional[str] = None, s_u_b_t_y_p_e: Optional[str] = None, l_a_b_e_l: Optional[str] = None, d_e_t_a_i_l: Optional[str] = None)

Definition: ContactInfo

Attributes

c_o_n_t_a_c_t_i_n_f_o_id class-attribute instance-attribute

c_o_n_t_a_c_t_i_n_f_o_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONTACT_INFO_ID'})

The unique identifier of the contact info.

t_y_p_e class-attribute instance-attribute

t_y_p_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TYPE'})

Contact info type.

s_u_b_t_y_p_e class-attribute instance-attribute

s_u_b_t_y_p_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SUBTYPE'})

Contact info sub-type.

l_a_b_e_l class-attribute instance-attribute

l_a_b_e_l: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LABEL'})

Contact info label.

d_e_t_a_i_l class-attribute instance-attribute

d_e_t_a_i_l: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DETAIL'})

Contact info detail.

ContactRequest dataclass

ContactRequest(f_i_r_s_t_n_a_m_e: str, l_a_s_t_n_a_m_e: str, *, s_a_l_u_t_a_t_i_o_n: Optional[str] = None, b_a_c_k_g_r_o_u_n_d: Optional[str] = None, v_i_s_i_b_l_e_t_o: Optional[str] = None, v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = None, v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = None, c_o_n_t_a_c_t_i_n_f_o_s: Optional[List[ContactInfo | Mapping[str, Any]]] = None, t_a_g_s: Optional[List[Tag | Mapping[str, Any]]] = None)

Definition: ContactRequest

Attributes

s_a_l_u_t_a_t_i_o_n class-attribute instance-attribute

s_a_l_u_t_a_t_i_o_n: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SALUTATION'})

The salutation of the contact.

f_i_r_s_t_n_a_m_e class-attribute instance-attribute

f_i_r_s_t_n_a_m_e: str = dataclass_field(metadata={'wire_name': 'FIRST_NAME'})

First name of the contact.

l_a_s_t_n_a_m_e class-attribute instance-attribute

l_a_s_t_n_a_m_e: str = dataclass_field(metadata={'wire_name': 'LAST_NAME'})

Last name of the lead.

b_a_c_k_g_r_o_u_n_d class-attribute instance-attribute

b_a_c_k_g_r_o_u_n_d: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BACKGROUND'})

Background

v_i_s_i_b_l_e_t_o class-attribute instance-attribute

v_i_s_i_b_l_e_t_o: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TO'})

Contact Visibility

v_i_s_i_b_l_e_t_e_a_m_id class-attribute instance-attribute

v_i_s_i_b_l_e_t_e_a_m_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)

v_i_s_i_b_l_e_u_s_e_r_id_s class-attribute instance-attribute

v_i_s_i_b_l_e_u_s_e_r_id_s: 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)

c_o_n_t_a_c_t_i_n_f_o_s class-attribute instance-attribute

c_o_n_t_a_c_t_i_n_f_o_s: Optional[List[ContactInfo | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONTACTINFOS'})

Contact Information

t_a_g_s class-attribute instance-attribute

t_a_g_s: Optional[List[Tag | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TAGS'})

Tag

User dataclass

User(*, u_s_e_r_id: Optional[int] = None, c_o_n_t_a_c_t_id: Optional[int] = None, f_i_r_s_t_n_a_m_e: Optional[str] = None, l_a_s_t_n_a_m_e: Optional[str] = None, e_m_a_i_l_a_d_d_r_e_s_s: Optional[str] = None, t_i_m_e_z_o_n_e_id: Optional[str] = None, e_m_a_i_l_d_r_o_p_b_o_x_id_e_n_t_i_f_i_e_r: Optional[str] = None, e_m_a_i_l_d_r_o_p_b_o_x_a_d_d_r_e_s_s: Optional[str] = None, a_d_m_i_n_i_s_t_r_a_t_o_r: Optional[bool] = None, a_c_c_o_u_n_t_o_w_n_e_r: Optional[bool] = None, a_c_t_i_v_e: Optional[bool] = None, d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = None, d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = None, u_s_e_r_c_u_r_r_e_n_c_y: Optional[str] = None, c_o_n_t_a_c_t_d_i_s_p_l_a_y: Optional[str] = None, c_o_n_t_a_c_t_o_r_d_e_r: Optional[str] = None, t_a_s_k_w_e_e_k_s_t_a_r_t: Optional[int] = None, i_n_s_t_a_n_c_e_id: Optional[int] = None)

Definition: User

Attributes

u_s_e_r_id class-attribute instance-attribute

u_s_e_r_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'USER_ID'})

The unique identifier of the user.

c_o_n_t_a_c_t_id class-attribute instance-attribute

c_o_n_t_a_c_t_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONTACT_ID'})

The unique identifier of the contact.

f_i_r_s_t_n_a_m_e class-attribute instance-attribute

f_i_r_s_t_n_a_m_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FIRST_NAME'})

First name of the user.

l_a_s_t_n_a_m_e class-attribute instance-attribute

l_a_s_t_n_a_m_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LAST_NAME'})

Last name of the user.

e_m_a_i_l_a_d_d_r_e_s_s class-attribute instance-attribute

e_m_a_i_l_a_d_d_r_e_s_s: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_ADDRESS'})

User email address.

t_i_m_e_z_o_n_e_id class-attribute instance-attribute

t_i_m_e_z_o_n_e_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TIMEZONE_ID'})

The unique identifier of the timezone.

e_m_a_i_l_d_r_o_p_b_o_x_id_e_n_t_i_f_i_e_r class-attribute instance-attribute

e_m_a_i_l_d_r_o_p_b_o_x_id_e_n_t_i_f_i_e_r: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_DROPBOX_IDENTIFIER'})

The unique identifier of the email dropbox.

e_m_a_i_l_d_r_o_p_b_o_x_a_d_d_r_e_s_s class-attribute instance-attribute

e_m_a_i_l_d_r_o_p_b_o_x_a_d_d_r_e_s_s: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EMAIL_DROPBOX_ADDRESS'})

Email dropbox address

a_d_m_i_n_i_s_t_r_a_t_o_r class-attribute instance-attribute

a_d_m_i_n_i_s_t_r_a_t_o_r: 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.

a_c_c_o_u_n_t_o_w_n_e_r class-attribute instance-attribute

a_c_c_o_u_n_t_o_w_n_e_r: 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.

a_c_t_i_v_e class-attribute instance-attribute

a_c_t_i_v_e: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ACTIVE'})

A boolean value determining whether or not the user is active.

d_a_t_e_c_r_e_a_t_e_d_u_t_c class-attribute instance-attribute

d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_CREATED_UTC'})

yyyy-MM-dd HH:mm:ss

d_a_t_e_u_p_d_a_t_e_d_u_t_c class-attribute instance-attribute

d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_UPDATED_UTC'})

yyyy-MM-dd HH:mm:ss

u_s_e_r_c_u_r_r_e_n_c_y class-attribute instance-attribute

u_s_e_r_c_u_r_r_e_n_c_y: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'USER_CURRENCY'})

User currency.

c_o_n_t_a_c_t_d_i_s_p_l_a_y class-attribute instance-attribute

c_o_n_t_a_c_t_d_i_s_p_l_a_y: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONTACT_DISPLAY'})

Contact display.

c_o_n_t_a_c_t_o_r_d_e_r class-attribute instance-attribute

c_o_n_t_a_c_t_o_r_d_e_r: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONTACT_ORDER'})

Contact order.

t_a_s_k_w_e_e_k_s_t_a_r_t class-attribute instance-attribute

t_a_s_k_w_e_e_k_s_t_a_r_t: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TASK_WEEK_START'})

Task week start.

i_n_s_t_a_n_c_e_id class-attribute instance-attribute

i_n_s_t_a_n_c_e_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'INSTANCE_ID'})

The unique identifier of the instance.

Event dataclass

Event(*, e_v_e_n_t_id: Optional[int] = None, t_i_t_l_e: Optional[str] = None, s_t_a_r_t_d_a_t_e_u_t_c: Optional[str] = None, e_n_d_d_a_t_e_u_t_c: Optional[str] = None, d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = None, d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = None, o_w_n_e_r_u_s_e_r_id: Optional[int] = None, r_e_m_i_n_d_e_r_s_e_n_t: Optional[bool] = None, a_l_l_d_a_y: Optional[bool] = None, p_u_b_l_i_c_l_y_v_i_s_i_b_l_e: Optional[bool] = None, c_a_n_e_d_i_t: Optional[bool] = None, c_a_n_d_e_l_e_t_e: Optional[bool] = None)

Definition: Event

Attributes

e_v_e_n_t_id class-attribute instance-attribute

e_v_e_n_t_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EVENT_ID'})

The unique identifier of the event.

t_i_t_l_e class-attribute instance-attribute

t_i_t_l_e: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TITLE'})

The title of the event.

s_t_a_r_t_d_a_t_e_u_t_c class-attribute instance-attribute

s_t_a_r_t_d_a_t_e_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'START_DATE_UTC'})

yyyy-MM-dd HH:mm:ss

e_n_d_d_a_t_e_u_t_c class-attribute instance-attribute

e_n_d_d_a_t_e_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'END_DATE_UTC'})

yyyy-MM-dd HH:mm:ss

d_a_t_e_c_r_e_a_t_e_d_u_t_c class-attribute instance-attribute

d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_CREATED_UTC'})

yyyy-MM-dd HH:mm:ss

d_a_t_e_u_p_d_a_t_e_d_u_t_c class-attribute instance-attribute

d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DATE_UPDATED_UTC'})

yyyy-MM-dd HH:mm:ss

o_w_n_e_r_u_s_e_r_id class-attribute instance-attribute

o_w_n_e_r_u_s_e_r_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OWNER_USER_ID'})

The unique identifier of the owner.

r_e_m_i_n_d_e_r_s_e_n_t class-attribute instance-attribute

r_e_m_i_n_d_e_r_s_e_n_t: 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.

a_l_l_d_a_y class-attribute instance-attribute

a_l_l_d_a_y: 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.

p_u_b_l_i_c_l_y_v_i_s_i_b_l_e class-attribute instance-attribute

p_u_b_l_i_c_l_y_v_i_s_i_b_l_e: 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.

c_a_n_e_d_i_t class-attribute instance-attribute

c_a_n_e_d_i_t: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CAN_EDIT'})

Can edit

c_a_n_d_e_l_e_t_e class-attribute instance-attribute

c_a_n_d_e_l_e_t_e: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CAN_DELETE'})

Can delete

OrganizationRequest dataclass

OrganizationRequest(o_r_g_a_n_i_s_a_t_i_o_n_n_a_m_e: str, *, o_r_g_a_n_i_s_a_t_i_o_n_b_a_c_k_g_r_o_u_n_d: Optional[str] = None, v_i_s_i_b_l_e_t_o: Optional[str] = None, v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = None, v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = None, a_d_d_r_e_s_s_e_s: Optional[List[Address | Mapping[str, Any]]] = None, c_o_n_t_a_c_t_i_n_f_o_s: Optional[List[ContactInfo | Mapping[str, Any]]] = None, t_a_g_s: Optional[List[Tag | Mapping[str, Any]]] = None)

Definition: OrganizationRequest

Attributes

o_r_g_a_n_i_s_a_t_i_o_n_n_a_m_e class-attribute instance-attribute

o_r_g_a_n_i_s_a_t_i_o_n_n_a_m_e: str = dataclass_field(metadata={'wire_name': 'ORGANISATION_NAME'})

The name of the organization.

o_r_g_a_n_i_s_a_t_i_o_n_b_a_c_k_g_r_o_u_n_d class-attribute instance-attribute

o_r_g_a_n_i_s_a_t_i_o_n_b_a_c_k_g_r_o_u_n_d: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ORGANISATION_BACKGROUND'})

The background of the organization.

v_i_s_i_b_l_e_t_o class-attribute instance-attribute

v_i_s_i_b_l_e_t_o: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VISIBLE_TO'})

Organization visibility.

v_i_s_i_b_l_e_t_e_a_m_id class-attribute instance-attribute

v_i_s_i_b_l_e_t_e_a_m_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)

v_i_s_i_b_l_e_u_s_e_r_id_s class-attribute instance-attribute

v_i_s_i_b_l_e_u_s_e_r_id_s: 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)

a_d_d_r_e_s_s_e_s class-attribute instance-attribute

a_d_d_r_e_s_s_e_s: Optional[List[Address | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ADDRESSES'})

Organization Addresses

c_o_n_t_a_c_t_i_n_f_o_s class-attribute instance-attribute

c_o_n_t_a_c_t_i_n_f_o_s: Optional[List[ContactInfo | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CONTACTINFOS'})

Contact Information

t_a_g_s class-attribute instance-attribute

t_a_g_s: Optional[List[Tag | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TAGS'})

Tags

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 async for.

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 async for.

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 async for.

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 async for.

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 async for.

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.