View Source ExPipedrive.DealProducts (ex_pipedrive v0.2.0)

Pipedrive deal-products resource — products attached to a deal.

Nested under a deal id on API v2: /api/v2/deals/:id/products. Distinct from the catalog ExPipedrive.Products API.

Example

{:ok, page} = ExPipedrive.DealProducts.list_page(client, deal_id)

{:ok, attachment} =
  ExPipedrive.DealProducts.create(client, deal_id, %{
    product_id: 1,
    item_price: 90,
    quantity: 1
  })

{:ok, attachment} =
  ExPipedrive.DealProducts.update(client, deal_id, attachment.id, %{quantity: 2})

{:ok, :ok} = ExPipedrive.DealProducts.delete(client, deal_id, attachment.id)

Summary

Functions

create(client, deal_id, attrs)

Attaches a product to a deal via POST /api/v2/deals/:id/products.

delete(client, deal_id, attachment_id)

Deletes one deal-product via DELETE /api/v2/deals/:id/products/:product_attachment_id.

delete_many(client, deal_id, opts \\ [])

Deletes many deal-products via DELETE /api/v2/deals/:id/products.

get(client, deal_id, attachment_id)

Fetches one deal-product by attachment id (client-side over stream/3).

list_page(client, deal_id, opts \\ [])

Lists one page of products attached to a deal via GET /api/v2/deals/:id/products.

stream(client, deal_id, opts \\ [])

Lazily streams deal-products across v2 cursor pages.

update(client, deal_id, attachment_id, attrs)

Updates a deal-product via PATCH /api/v2/deals/:id/products/:product_attachment_id.

Functions

create(client, deal_id, attrs)

@spec create(Tesla.Client.t(), term(), map()) ::
  {:ok, ExPipedrive.DealProduct.t()} | {:error, ExPipedrive.Error.t()}

Attaches a product to a deal via POST /api/v2/deals/:id/products.

Requires :product_id, :item_price, and :quantity.

delete(client, deal_id, attachment_id)

@spec delete(Tesla.Client.t(), term(), term()) ::
  {:ok, :ok} | {:error, ExPipedrive.Error.t()}

Deletes one deal-product via DELETE /api/v2/deals/:id/products/:product_attachment_id.

delete_many(client, deal_id, opts \\ [])

@spec delete_many(Tesla.Client.t(), term(), keyword()) ::
  {:ok, [pos_integer()]} | {:error, ExPipedrive.Error.t()}

Deletes many deal-products via DELETE /api/v2/deals/:id/products.

Options: :ids — list of attachment ids (or comma-separated string). When omitted, Pipedrive deletes up to 100 attachments on the deal.

Returns {:ok, [id]} of deleted attachment ids.

get(client, deal_id, attachment_id)

@spec get(Tesla.Client.t(), term(), term()) ::
  {:ok, ExPipedrive.DealProduct.t()} | {:error, ExPipedrive.Error.t()}

Fetches one deal-product by attachment id (client-side over stream/3).

Pipedrive has no single-get endpoint for deal-products.

list_page(client, deal_id, opts \\ [])

@spec list_page(Tesla.Client.t(), term(), keyword()) ::
  {:ok, ExPipedrive.Page.t()} | {:error, ExPipedrive.Error.t()}

Lists one page of products attached to a deal via GET /api/v2/deals/:id/products.

Options: :cursor, :limit (clamped to 500), :sort_by, :sort_direction.

stream(client, deal_id, opts \\ [])

@spec stream(Tesla.Client.t(), term(), keyword()) :: Enumerable.t()

Lazily streams deal-products across v2 cursor pages.

update(client, deal_id, attachment_id, attrs)

@spec update(Tesla.Client.t(), term(), term(), map()) ::
  {:ok, ExPipedrive.DealProduct.t()} | {:error, ExPipedrive.Error.t()}

Updates a deal-product via PATCH /api/v2/deals/:id/products/:product_attachment_id.