pandadoc-api-python-client icon indicating copy to clipboard operation
pandadoc-api-python-client copied to clipboard

Template details irretrievable when field is `None`

Open Burhan-Q opened this issue 1 year ago • 1 comments

Error raised when requesting template details using python SDK but not when using requests. It would be nice to allow for arbitrary (especially when they might be unknown) fields to be null/None

Example with SDK

import pandadoc_client
from pandadoc_client.api import templates_api

API_KEY = ""
TEMPLATE_ID = ""

cfg = pandadoc_client.Configuration(
    host="https://api.pandadoc.com",
    api_key={"apiKey": f"API-Key {API_KEY}"},
)

client = pandadoc_client.ApiClient(cfg)
templates = templates_api.TemplatesApi(client)

template_detail = templates.details_template(id=TEMPLATE_ID)

Raises

pandadoc_client.exceptions.ApiTypeError: Invalid type for variable 'placeholder_name'.
Required value type is str and passed type was NoneType at 
['received_data']['roles'][0]['preassigned_person']['placeholder_name']

Example with GET

import requests

API_KEY = ""
TEMPLATE_ID = "" # same template as previous example

headers = {
    "Content-Type": "application/json",
    "Authorization": f"API-Key {API_KEY}"
}

url = "https://api.pandadoc.com/" + f"public/v1/templates/{TEMPLATE_ID}/details"
res = requests.get(url, headers=headers)
template_dict = res.json()

type(template_dict.get("roles")[0].get("preassigned_person").get("placeholder_name"))
>>> <class 'NoneType'>

Burhan-Q avatar Apr 09 '24 13:04 Burhan-Q

running into the same issue. Seems to be a blocker for using the client

shtafinf avatar Sep 02 '25 22:09 shtafinf