Add support for URL params in `get_url` method

[bipster-shakya]

Is your feature request related to a problem? Please describe.

I think the way get_url generates URL is great, but does not support when we need to generate a URL with URL parameters.

Describe the solution you'd like

I think the get_url method could accept kwargs to build and return a URL with URL parameters, as passed in the kwargs.

Describe alternatives you've considered

I am currently wiring a wrapper method on top of the sdk method to get a URL with URL params. I think the quick one liner I wrote could be added to the function directly.

Additional context

None.

[bipster-shakya]

PR in my fork:
https://github.com/bipsterbot/box-python-sdk/pull/1/files

[Jeff-Meadows]

How do you plan to use the url generated by get_url? In my experience, it's usually used to pass to something like make_request, which already accepts a parameters called params. params is a dict that gets translated to URL params.

Did you have another use case in mind?

[bipster-shakya]

How do you plan to use the url generated by get_url? In my experience, it's usually used to pass to something like make_request, which already accepts a parameters called params. params is a dict that gets translated to URL params.

Did you have another use case in mind?

Hmm. I was not aware that make_request accepts params as parameter.
Could you perhaps point me towards a documentation if you have one? Thanks!

[swfree]

Hi @bipsterbot, good point, it looks like the params parameter is not documented for make_request yet. I've added a ticket to our backlog to update our docs to address that.

In the meantime, here's an example code snippet:

json_response = client.make_request(
    'GET',
    client.get_url('users', 'me'),
    params={'fields': 'name,login'}
).json()

For more information, our default network request layer is built on top of the requests library, which has documentation on passing parameters in URLs.

[bipster-shakya]

Hi @bipsterbot, good point, it looks like the params parameter is not documented for make_request yet. I've added a ticket to our backlog to update our docs to address that.

In the meantime, here's an example code snippet:

json_response = client.make_request(
    'GET',
    client.get_url('users', 'me'),
    params={'fields': 'name,login'}
).json()

For more information, our default network request layer is built on top of the requests library, which has documentation on passing parameters in URLs.

Thanks, @swfree
Appreciate the response and information.