View Source ExPipedrive.Organizations (ex_pipedrive v0.1.0)

Pipedrive organizations resource.

v2-first helpers (get/2, create/2, update/3, delete/2, list_page/2, stream/2) talk to /api/v2/organizations. Prefer ExPipedrive.Search.search_organizations/3 (or search_v2/3 here) for v2 itemSearch. Legacy get_organization/2, create_organization/2, list_organizations/2, search_organizations/3, and update_organization/3 remain on API v1 for compatibility.

Summary

Functions

Creates an organization via POST /api/v2/organizations.

Deletes an organization via DELETE /api/v2/organizations/:id.

Fetches an organization by id via GET /api/v2/organizations/:id.

Lists one page of organizations via API v2 cursor pagination.

Searches organizations via API v2 itemSearch. See ExPipedrive.Search.search_organizations/3.

Lazily streams organizations across all v2 cursor pages until next_cursor is nil.

Updates an organization via PATCH /api/v2/organizations/:id.

Functions

Creates an organization via POST /api/v2/organizations.

Accepts a map (preferred) or %Organization{}. Returns {:ok, %Organization{}}.

Link to this function

create_organization(client, org)

View Source

Deletes an organization via DELETE /api/v2/organizations/:id.

Fetches an organization by id via GET /api/v2/organizations/:id.

Link to this function

get_organization(client, org_id)

View Source
Link to this function

list_organizations(client, opts \\ [])

View Source
Link to this function

list_organizations_page(client, opts \\ [])

View Source
Link to this function

list_page(client, opts \\ [])

View Source

Lists one page of organizations via API v2 cursor pagination.

Options: :cursor, :limit (clamped to 500), :owner_id.

Link to this function

search_organizations(client, term, opts \\ [])

View Source
Link to this function

search_v2(client, term, opts \\ [])

View Source

Searches organizations via API v2 itemSearch. See ExPipedrive.Search.search_organizations/3.

Link to this function

stream(client, opts \\ [])

View Source

Lazily streams organizations across all v2 cursor pages until next_cursor is nil.

Link to this function

stream_organizations(client, opts \\ [])

View Source
Link to this function

update(client, org_id, attrs)

View Source

Updates an organization via PATCH /api/v2/organizations/:id.

Link to this function

update_organization(client, org_id, body)

View Source