Return Board, Section, Pin ID upon creation about py3-pinterest

[bstoilov]

Thank you very much Gmanicus, we should add these to the documentation.

[Gmanicus]

Yw. Created PR #43

[bstoilov]

Good suggestion. The examples should be updated too.
The create board actually returns the full response object

return self.post(url=CREATE_BOARD_RESOURCE, data=data)

Initially I had custom object that contained only the meaningful information from the responses, but it was hard to maintain

[Gmanicus]

Turns out all your functions were set that way and no changes need to be made! Printing the response directly shows something like <Response 200>. If you dig a little deeper by going myresponse.content you get the actual HTML response, which can then be turned into a dict by using JSON.

Example:

import json

pin = upload_pin(board_id="778489554276995995",
             image_path="test.png",
             description="TESTING PIN FUNCTIONALITY WITH LINK",
             title="Foobar Barfood",
             section_id=None,
             link="www.geekoverdrivestudio.com")

pin_response = json.loads(pin.content)

Some helpful notes on the response:
Everything is stored inside the "resource_response" key. You can use that and grab all sorts of data like so:

id = pin_response["resource_response"]["id"]
# When creating such a resource, and you want to see details for what it was created IN,
# you just have to go one further step and access the key for whatever it is: section, board, pinner, etc
board_id = pin_response["resource_response"]["board"]["id"]
# Section will return None/Null if the pin wasn't placed within a section
section_id = pin_response["resource_response"]["section"]["id"]
pinner_username = pin_response["resource_response"]["pinner"]["username"]
pinner_id = pin_response["resource_response"]["pinner"]["id"]

[Gmanicus]

Another note upon further use of this method:

Section and Board IDs are one step further down the dict. It may be the same for Pins too.

id = response["resource_response"]["data"]["id"]