Types

pydantic model pypipedrive.orm.types.AddressDict

Show JSON schema

{
   "title": "AddressDict",
   "type": "object",
   "properties": {
      "value": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Value"
      },
      "street_number": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Street Number"
      },
      "route": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Route"
      },
      "sublocality": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Sublocality"
      },
      "locality": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Locality"
      },
      "admin_area_level_1": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Admin Area Level 1"
      },
      "admin_area_level_2": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Admin Area Level 2"
      },
      "country": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Country"
      },
      "postal_code": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Postal Code"
      },
      "formatted_address": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Formatted Address"
      }
   }
}

Fields:

• admin_area_level_1 (str | None)

• admin_area_level_2 (str | None)

• country (str | None)

• formatted_address (str | None)

• locality (str | None)

• postal_code (str | None)

• route (str | None)

• street_number (str | None)

• sublocality (str | None)

• value (str | None)

field admin_area_level_1: str | None = None

field admin_area_level_2: str | None = None

field country: str | None = None

field formatted_address: str | None = None

field locality: str | None = None

field postal_code: str | None = None

field route: str | None = None

field street_number: str | None = None

field sublocality: str | None = None

field value: str | None = None

pydantic model pypipedrive.orm.types.AssigneeDict

Represents the assignee of a Goal.

Show JSON schema

{
   "title": "AssigneeDict",
   "description": "Represents the assignee of a Goal.",
   "type": "object",
   "properties": {
      "id": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Id"
      },
      "type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Type"
      }
   }
}

Fields:

• id (int | None)

• type (str | None)

field id: int | None = None

field type: str | None = None

pydantic model pypipedrive.orm.types.AttendeeDict

Show JSON schema

{
   "title": "AttendeeDict",
   "type": "object",
   "properties": {
      "email": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Email"
      },
      "name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Name"
      },
      "status": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Status"
      },
      "is_organizer": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Is Organizer"
      },
      "person_id": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Person Id"
      },
      "user_id": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "User Id"
      }
   }
}

Fields:

• email (str | None)

• is_organizer (bool | None)

• name (str | None)

• person_id (int | None)

• status (str | None)

• user_id (int | None)

field email: str | None = None

field is_organizer: bool | None = None

field name: str | None = None

field person_id: int | None = None

field status: str | None = None

field user_id: int | None = None

pydantic model pypipedrive.orm.types.CodeDict

Show JSON schema

{
   "title": "CodeDict",
   "type": "object",
   "properties": {
      "code": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Code"
      }
   }
}

Fields:

• code (str | None)

field code: str | None = None

pydantic model pypipedrive.orm.types.CustomFieldsProductDict

Represents the custom fields for a Product entity.

Show JSON schema

{
   "title": "CustomFieldsProductDict",
   "description": "Represents the custom fields for a Product entity.",
   "type": "object",
   "properties": {
      "type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Type"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "additional_properties": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": {},
         "title": "Additional Properties"
      }
   }
}

Fields:

• additional_properties (Dict | None)

• description (str | None)

• type (str | None)

field additional_properties: Dict | None = {}

field description: str | None = None

field type: str | None = None

pydantic model pypipedrive.orm.types.EntityUpdateDict

Represents a single change in the changelog of an entity.

Show JSON schema

{
   "title": "EntityUpdateDict",
   "description": "Represents a single change in the changelog of an entity.",
   "type": "object",
   "properties": {
      "field_key": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Field Key"
      },
      "old_value": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "items": {
                  "type": "object"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Old Value"
      },
      "new_value": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "items": {
                  "type": "object"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "New Value"
      },
      "actor_user_id": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Actor User Id"
      },
      "time": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Time"
      },
      "change_source": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Change Source"
      },
      "change_source_user_agent": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Change Source User Agent"
      },
      "is_bulk_update_flag": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Is Bulk Update Flag"
      }
   }
}

Fields:

• actor_user_id (int | None)

• change_source (str | None)

• change_source_user_agent (str | None)

• field_key (str | None)

• is_bulk_update_flag (bool | None)

• new_value (str | list[typing.Dict] | None)

• old_value (str | list[typing.Dict] | None)

• time (str | None)

field actor_user_id: int | None = None

field change_source: str | None = None

field change_source_user_agent: str | None = None

field field_key: str | None = None

field is_bulk_update_flag: bool | None = None

field new_value: str | list[Dict] | None = None

field old_value: str | list[Dict] | None = None

field time: str | None = None

pydantic model pypipedrive.orm.types.ExpectedOutcomeDict

Represents the expected outcome of a Goal.

Show JSON schema

{
   "title": "ExpectedOutcomeDict",
   "description": "Represents the expected outcome of a Goal.",
   "type": "object",
   "properties": {
      "target": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Target"
      },
      "tracking_metric": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Tracking Metric"
      }
   }
}

Fields:

• target (float | int | None)

• tracking_metric (str | None)

field target: float | int | None = None

field tracking_metric: str | None = None

pypipedrive.orm.types.FieldName

An alias for str used internally for disambiguation. Field names can be any valid string.

pydantic model pypipedrive.orm.types.GoalDurationDict

Represents the duration of a Goal.

Show JSON schema

{
   "title": "GoalDurationDict",
   "description": "Represents the duration of a Goal.",
   "type": "object",
   "properties": {
      "start": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "format": "date",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Start"
      },
      "end": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "format": "date",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "End"
      }
   }
}

Fields:

• end (str | datetime.date | None)

• start (str | datetime.date | None)

Validators:

• _coerce_end » end

• _coerce_start » start

field end: str | date | None = None

Validated by:

• _coerce_end

field start: str | date | None = None

Validated by:

• _coerce_start

pydantic model pypipedrive.orm.types.IdLabelDict

Show JSON schema

{
   "title": "IdLabelDict",
   "type": "object",
   "properties": {
      "id": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Id"
      },
      "label": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Label"
      },
      "color": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Color"
      }
   }
}

Fields:

• color (str | None)

• id (int | str | None)

• label (str | None)

field color: str | None = None

field id: int | str | None = None

field label: str | None = None

pydantic model pypipedrive.orm.types.ItemSearchDealDict

Show JSON schema

{
   "title": "ItemSearchDealDict",
   "type": "object",
   "properties": {
      "item": {
         "anyOf": [
            {
               "$ref": "#/$defs/_ItemSearchDeal"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "result_score": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Result Score"
      }
   },
   "$defs": {
      "_ItemId": {
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Id"
            }
         },
         "required": [
            "id"
         ],
         "title": "_ItemId",
         "type": "object"
      },
      "_ItemIdName": {
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Id"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            }
         },
         "required": [
            "id"
         ],
         "title": "_ItemIdName",
         "type": "object"
      },
      "_ItemIdNameAddress": {
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Id"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            },
            "address": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Address"
            }
         },
         "required": [
            "id"
         ],
         "title": "_ItemIdNameAddress",
         "type": "object"
      },
      "_ItemSearchDeal": {
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "type": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Type"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Title"
            },
            "value": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Value"
            },
            "currency": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Currency"
            },
            "status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            },
            "visible_to": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Visible To"
            },
            "owner": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/_ItemId"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": {}
            },
            "stage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/_ItemIdName"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": {}
            },
            "person": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/_ItemIdName"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": {}
            },
            "organization": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/_ItemIdNameAddress"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": {}
            },
            "custom_fields": {
               "anyOf": [
                  {
                     "items": {},
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": [],
               "title": "Custom Fields"
            },
            "notes": {
               "anyOf": [
                  {
                     "items": {},
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": [],
               "title": "Notes"
            },
            "is_archived": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Is Archived"
            }
         },
         "title": "_ItemSearchDeal",
         "type": "object"
      }
   }
}

Fields:

• item (pypipedrive.orm.types._ItemSearchDeal | None)

• result_score (float | None)

field item: _ItemSearchDeal | None = None

field result_score: float | None = None

pydantic model pypipedrive.orm.types.ItemSearchDict

Show JSON schema

{
   "title": "ItemSearchDict",
   "type": "object",
   "properties": {
      "item": {
         "anyOf": [
            {
               "$ref": "#/$defs/_ItemSearch"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "result_score": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Result Score"
      }
   },
   "$defs": {
      "_ItemId": {
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Id"
            }
         },
         "required": [
            "id"
         ],
         "title": "_ItemId",
         "type": "object"
      },
      "_ItemIdName": {
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Id"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            }
         },
         "required": [
            "id"
         ],
         "title": "_ItemIdName",
         "type": "object"
      },
      "_ItemIdNameAddress": {
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Id"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            },
            "address": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Address"
            }
         },
         "required": [
            "id"
         ],
         "title": "_ItemIdNameAddress",
         "type": "object"
      },
      "_ItemSearch": {
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "type": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Type"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            },
            "code": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Code"
            },
            "address": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Address"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Title"
            },
            "value": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Value"
            },
            "currency": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Currency"
            },
            "status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            },
            "visible_to": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Visible To"
            },
            "owner": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/_ItemId"
                  },
                  {
                     "type": "integer"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": {},
               "title": "Owner"
            },
            "stage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/_ItemIdName"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": {}
            },
            "person": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/_ItemIdName"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": {}
            },
            "organization": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/_ItemIdNameAddress"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": {}
            },
            "phones": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": [],
               "title": "Phones"
            },
            "emails": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": [],
               "title": "Emails"
            },
            "custom_fields": {
               "anyOf": [
                  {
                     "items": {},
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": [],
               "title": "Custom Fields"
            },
            "notes": {
               "anyOf": [
                  {
                     "items": {},
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": [],
               "title": "Notes"
            },
            "is_archived": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Is Archived"
            }
         },
         "title": "_ItemSearch",
         "type": "object"
      }
   }
}

Fields:

• item (pypipedrive.orm.types._ItemSearch | None)

• result_score (float | None)

field item: _ItemSearch | None = None

field result_score: float | None = None

pydantic model pypipedrive.orm.types.ItemSearchPersonDict

Show JSON schema

{
   "title": "ItemSearchPersonDict",
   "type": "object",
   "properties": {
      "result_score": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Result Score"
      },
      "item": {
         "anyOf": [
            {
               "$ref": "#/$defs/_ItemSearchPerson"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "_ItemId": {
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Id"
            }
         },
         "required": [
            "id"
         ],
         "title": "_ItemId",
         "type": "object"
      },
      "_ItemIdNameAddress": {
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Id"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            },
            "address": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Address"
            }
         },
         "required": [
            "id"
         ],
         "title": "_ItemIdNameAddress",
         "type": "object"
      },
      "_ItemSearchPerson": {
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "type": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Type"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            },
            "phones": {
               "anyOf": [
                  {
                     "items": {},
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": [],
               "title": "Phones"
            },
            "emails": {
               "anyOf": [
                  {
                     "items": {},
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": [],
               "title": "Emails"
            },
            "visible_to": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Visible To"
            },
            "owner": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/_ItemId"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": {}
            },
            "organization": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/_ItemIdNameAddress"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": {}
            },
            "custom_fields": {
               "anyOf": [
                  {
                     "items": {},
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": [],
               "title": "Custom Fields"
            },
            "notes": {
               "anyOf": [
                  {
                     "items": {},
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": [],
               "title": "Notes"
            }
         },
         "title": "_ItemSearchPerson",
         "type": "object"
      }
   }
}

Fields:

• item (pypipedrive.orm.types._ItemSearchPerson | None)

• result_score (float | None)

field item: _ItemSearchPerson | None = None

field result_score: float | None = None

pydantic model pypipedrive.orm.types.LabelValuePrimaryDict

Show JSON schema

{
   "title": "LabelValuePrimaryDict",
   "type": "object",
   "properties": {
      "label": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Label"
      },
      "value": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Value"
      },
      "primary": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Primary"
      }
   }
}

Fields:

• label (str | None)

• primary (bool | None)

• value (str | None)

field label: str | None = None

field primary: bool | None = None

field value: str | None = None

pydantic model pypipedrive.orm.types.MonetaryDict

Show JSON schema

{
   "title": "MonetaryDict",
   "type": "object",
   "properties": {
      "amount": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Amount"
      },
      "currency": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Currency"
      }
   }
}

Fields:

• amount (float | int | None)

• currency (str | None)

field amount: float | int | None = None

field currency: str | None = None

pydantic model pypipedrive.orm.types.ParticipantDict

Show JSON schema

{
   "title": "ParticipantDict",
   "type": "object",
   "properties": {
      "person_id": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Person Id"
      },
      "primary": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Primary"
      }
   }
}

Fields:

• person_id (int | None)

• primary (bool | None)

field person_id: int | None = None

field primary: bool | None = None

pydantic model pypipedrive.orm.types.PartiesDict

Represents the parties involved in a MailThread.

Show JSON schema

{
   "title": "PartiesDict",
   "description": "Represents the parties involved in a MailThread.",
   "type": "object",
   "properties": {
      "to": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/PartyDict"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "To"
      },
      "cc": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/PartyDict"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Cc"
      },
      "bcc": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/PartyDict"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Bcc"
      },
      "from": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/PartyDict"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "From"
      }
   },
   "$defs": {
      "PartyDict": {
         "description": "Represents the individual party of a MailThread (to, from, cc, bcc).",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            },
            "email_address": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Email Address"
            },
            "message_time": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Message Time"
            },
            "linked_person_id": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Linked Person Id"
            },
            "linked_person_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Linked Person Name"
            },
            "linked_organization_id": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Linked Organization Id"
            },
            "mail_message_party_id": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Mail Message Party Id"
            }
         },
         "title": "PartyDict",
         "type": "object"
      }
   }
}

Fields:

• bcc (List[pypipedrive.orm.types.PartyDict] | None)

• cc (List[pypipedrive.orm.types.PartyDict] | None)

• from_ (List[pypipedrive.orm.types.PartyDict] | None)

• to (List[pypipedrive.orm.types.PartyDict] | None)

field bcc: List[PartyDict] | None = None

field cc: List[PartyDict] | None = None

field from_: List[PartyDict] | None = None (alias 'from')

field to: List[PartyDict] | None = None

pydantic model pypipedrive.orm.types.PartyDict

Represents the individual party of a MailThread (to, from, cc, bcc).

Show JSON schema

{
   "title": "PartyDict",
   "description": "Represents the individual party of a MailThread (to, from, cc, bcc).",
   "type": "object",
   "properties": {
      "id": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Id"
      },
      "name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Name"
      },
      "email_address": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Email Address"
      },
      "message_time": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Message Time"
      },
      "linked_person_id": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Linked Person Id"
      },
      "linked_person_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Linked Person Name"
      },
      "linked_organization_id": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Linked Organization Id"
      },
      "mail_message_party_id": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Mail Message Party Id"
      }
   }
}

Fields:

• email_address (str | None)

• id (int | None)

• linked_organization_id (int | None)

• linked_person_id (int | None)

• linked_person_name (str | None)

• mail_message_party_id (int | None)

• message_time (int | None)

• name (str | None)

field email_address: str | None = None

field id: int | None = None

field linked_organization_id: int | None = None

field linked_person_id: int | None = None

field linked_person_name: str | None = None

field mail_message_party_id: int | None = None

field message_time: int | None = None

field name: str | None = None

pydantic model pypipedrive.orm.types.PriceDict

Show JSON schema

{
   "title": "PriceDict",
   "type": "object",
   "properties": {
      "product_id": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Product Id"
      },
      "price": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Price"
      },
      "currency": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Currency"
      },
      "cost": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Cost"
      },
      "direct_cost": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Direct Cost"
      },
      "notes": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Notes"
      }
   }
}

Fields:

• cost (float | None)

• currency (str | None)

• direct_cost (float | None)

• notes (str | None)

• price (float | int | None)

• product_id (int | None)

field cost: float | None = None

field currency: str | None = None

field direct_cost: float | None = None

field notes: str | None = None

field price: float | int | None = None

field product_id: int | None = None

pydantic model pypipedrive.orm.types.SeasonalityDict

Represents the seasonality of a Goal.

Show JSON schema

{
   "title": "SeasonalityDict",
   "description": "Represents the seasonality of a Goal.",
   "type": "object",
   "properties": {
      "currency_id": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Currency Id"
      },
      "intervals": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/_SeasonalityIntervalDict"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Intervals"
      },
      "tracking_metric": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Tracking Metric"
      }
   },
   "$defs": {
      "_SeasonalityIntervalDict": {
         "description": "Represents a seasonality interval of a Goal (adds target to start/end).",
         "properties": {
            "start": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "date",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Start"
            },
            "end": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "date",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "End"
            },
            "target": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Target"
            }
         },
         "title": "_SeasonalityIntervalDict",
         "type": "object"
      }
   }
}

Fields:

• currency_id (int | None)

• intervals (List[pypipedrive.orm.types._SeasonalityIntervalDict] | None)

• tracking_metric (str | None)

field currency_id: int | None = None

field intervals: List[_SeasonalityIntervalDict] | None = None

field tracking_metric: str | None = None

pydantic model pypipedrive.orm.types.SubfieldDict

Show JSON schema

{
   "title": "SubfieldDict",
   "type": "object",
   "properties": {
      "field_code": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Field Code"
      },
      "field_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Field Name"
      },
      "field_type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Field Type"
      }
   }
}

Fields:

• field_code (str | None)

• field_name (str | None)

• field_type (str | None)

field field_code: str | None = None

field field_name: str | None = None

field field_type: str | None = None

pydantic model pypipedrive.orm.types.TypeDict

Represents the type of a Goal.

Show JSON schema

{
   "title": "TypeDict",
   "description": "Represents the type of a Goal.",
   "type": "object",
   "properties": {
      "name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Name"
      },
      "params": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Params"
      }
   }
}

Fields:

• name (str | None)

• params (Dict | None)

field name: str | None = None

field params: Dict | None = None

pypipedrive.orm.types.assert_typed_dict(cls: Type[T], obj: Any) → T

Check that obj is a dict and conforms to the pydantic model cls, else raise TypeError or pydantic.ValidationError.

Args:

cls: The pydantic model class representing the expected dict type. obj: The object to check.

Returns:

An instance of cls constructed from obj if the checks pass.

pypipedrive.orm.types.assert_typed_obj(cls: Type[T], obj: Any) → T

Check that obj is an instance of cls, else raise TypeError.

Args:

cls: The expected class/type of obj. obj: The object to check.

Returns:

The object obj typed as cls if the check passes.