rebrickable.api.api.users_api module¶
The version of the OpenAPI document: Generated by: https://openapi-generator.tech
-
class
rebrickable.api.api.users_api.
UsersApi
(api_client=None)¶ Bases:
object
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
-
users_allparts_list
(user_token, **kwargs)¶ Get a list of all the Parts in all the user’s Part Lists as well as the Parts inside Sets in the user’s Set Lists. # noqa: E501
Get a list of all the Parts in all the user’s Part Lists as well as the Parts inside Sets in the user’s Set Lists. ###WARNING this call is very resource intensive, do not overuse it! Optionally, filter by one or more of the below query parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_allparts_list(user_token, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
page (str) – page
page_size (str) – page_size
part_num (str) – part_num
part_cat_id (str) – part_cat_id
color_id (str) – color_id
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ArrayOfAllParts If the method is called asynchronously, returns the request thread.
-
users_allparts_list_with_http_info
(user_token, **kwargs)¶ Get a list of all the Parts in all the user’s Part Lists as well as the Parts inside Sets in the user’s Set Lists. # noqa: E501
Get a list of all the Parts in all the user’s Part Lists as well as the Parts inside Sets in the user’s Set Lists. ###WARNING this call is very resource intensive, do not overuse it! Optionally, filter by one or more of the below query parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_allparts_list_with_http_info(user_token, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
page (str) – page
page_size (str) – page_size
part_num (str) – part_num
part_cat_id (str) – part_cat_id
color_id (str) – color_id
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(ArrayOfAllParts, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_badges_list
(**kwargs)¶ Get a list of all the available Badges # noqa: E501
Get a list of all the available Badges # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_badges_list(async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
page (str) – page
page_size (str) – page_size
ordering (str) – ordering
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ArrayOfBadges If the method is called asynchronously, returns the request thread.
-
users_badges_list_with_http_info
(**kwargs)¶ Get a list of all the available Badges # noqa: E501
Get a list of all the available Badges # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_badges_list_with_http_info(async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
page (str) – page
page_size (str) – page_size
ordering (str) – ordering
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(ArrayOfBadges, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_badges_read
(id, **kwargs)¶ Get details about a specific Badge # noqa: E501
Get details about a specific Badge # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_badges_read(id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
id (str) – id (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Badge If the method is called asynchronously, returns the request thread.
-
users_badges_read_with_http_info
(id, **kwargs)¶ Get details about a specific Badge # noqa: E501
Get details about a specific Badge # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_badges_read_with_http_info(id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
id (str) – id (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(Badge, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_build_read
(user_token, set_num, **kwargs)¶ Find out how many parts the user needs to build the specified Set. # noqa: E501
Find out how many parts the user needs to build the specified Set. The user’s default Build Settings will be used to calculate a Build Match % using their LEGO Collection of Sets and Parts. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_build_read(user_token, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
set_num (str) – set_num (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Build If the method is called asynchronously, returns the request thread.
-
users_build_read_with_http_info
(user_token, set_num, **kwargs)¶ Find out how many parts the user needs to build the specified Set. # noqa: E501
Find out how many parts the user needs to build the specified Set. The user’s default Build Settings will be used to calculate a Build Match % using their LEGO Collection of Sets and Parts. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_build_read_with_http_info(user_token, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
set_num (str) – set_num (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(Build, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_lost_parts_create
(user_token, inv_part_id, **kwargs)¶ Add one or more Lost Parts to the user. # noqa: E501
Add one or more Lost Parts to the user. ### Single Part When adding a single Part, returns the successfully created Part (status 201) or details for why the Part could not be added. ### Multiple Parts To add multiple Parts, POST a JSON list of them (using a Content-Type header of ‘application/json’). The inv_part_id field can be retrieved from the Set’s inventory. e.g: [{“inv_part_id”: 806698, “lost_quantity”: 3}, {“inv_part_id”: 256007, “lost_quantity”: 2}] Returns a list of successfully added Parts. If the Part already exists or is unrecognised, it will be skipped. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_lost_parts_create(user_token, inv_part_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
inv_part_id (str) – inv_part_id (required)
lost_quantity (str) – lost_quantity
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_lost_parts_create_with_http_info
(user_token, inv_part_id, **kwargs)¶ Add one or more Lost Parts to the user. # noqa: E501
Add one or more Lost Parts to the user. ### Single Part When adding a single Part, returns the successfully created Part (status 201) or details for why the Part could not be added. ### Multiple Parts To add multiple Parts, POST a JSON list of them (using a Content-Type header of ‘application/json’). The inv_part_id field can be retrieved from the Set’s inventory. e.g: [{“inv_part_id”: 806698, “lost_quantity”: 3}, {“inv_part_id”: 256007, “lost_quantity”: 2}] Returns a list of successfully added Parts. If the Part already exists or is unrecognised, it will be skipped. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_lost_parts_create_with_http_info(user_token, inv_part_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
inv_part_id (str) – inv_part_id (required)
lost_quantity (str) – lost_quantity
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_lost_parts_delete
(user_token, id, **kwargs)¶ Remove the Lost Part from the user. # noqa: E501
Remove the Lost Part from the user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_lost_parts_delete(user_token, id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
id (str) – id (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_lost_parts_delete_with_http_info
(user_token, id, **kwargs)¶ Remove the Lost Part from the user. # noqa: E501
Remove the Lost Part from the user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_lost_parts_delete_with_http_info(user_token, id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
id (str) – id (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_lost_parts_list
(user_token, **kwargs)¶ Get a list of all the Lost Parts from the user’s LEGO collection. # noqa: E501
Get a list of all the Lost Parts from the user’s LEGO collection. Optionally, filter by one or more of the below query parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_lost_parts_list(user_token, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
page (str) – page
page_size (str) – page_size
ordering (str) – ordering
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ArrayOfLostParts If the method is called asynchronously, returns the request thread.
-
users_lost_parts_list_with_http_info
(user_token, **kwargs)¶ Get a list of all the Lost Parts from the user’s LEGO collection. # noqa: E501
Get a list of all the Lost Parts from the user’s LEGO collection. Optionally, filter by one or more of the below query parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_lost_parts_list_with_http_info(user_token, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
page (str) – page
page_size (str) – page_size
ordering (str) – ordering
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(ArrayOfLostParts, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_partlists_create
(user_token, name, **kwargs)¶ Add a new Part List. # noqa: E501
Add a new Part List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_create(user_token, name, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
name (str) – name (required)
is_buildable (str) – is_buildable
num_parts (str) – num_parts
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
PartList If the method is called asynchronously, returns the request thread.
-
users_partlists_create_with_http_info
(user_token, name, **kwargs)¶ Add a new Part List. # noqa: E501
Add a new Part List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_create_with_http_info(user_token, name, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
name (str) – name (required)
is_buildable (str) – is_buildable
num_parts (str) – num_parts
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(PartList, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_partlists_delete
(user_token, list_id, **kwargs)¶ Delete a Part List and all it’s Parts. # noqa: E501
Delete a Part List and all it’s Parts. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_delete(user_token, list_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_partlists_delete_with_http_info
(user_token, list_id, **kwargs)¶ Delete a Part List and all it’s Parts. # noqa: E501
Delete a Part List and all it’s Parts. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_delete_with_http_info(user_token, list_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_partlists_list
(user_token, **kwargs)¶ Get a list of all the user’s Part Lists. # noqa: E501
Get a list of all the user’s Part Lists. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_list(user_token, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
page (str) – page
page_size (str) – page_size
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ArrayOfPartLists If the method is called asynchronously, returns the request thread.
-
users_partlists_list_with_http_info
(user_token, **kwargs)¶ Get a list of all the user’s Part Lists. # noqa: E501
Get a list of all the user’s Part Lists. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_list_with_http_info(user_token, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
page (str) – page
page_size (str) – page_size
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(ArrayOfPartLists, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_partlists_partial_update
(user_token, list_id, **kwargs)¶ Update an existing Part List’s details. # noqa: E501
Update an existing Part List’s details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_partial_update(user_token, list_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
is_buildable (str) – is_buildable
name (str) – name
num_parts (str) – num_parts
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_partlists_partial_update_with_http_info
(user_token, list_id, **kwargs)¶ Update an existing Part List’s details. # noqa: E501
Update an existing Part List’s details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_partial_update_with_http_info(user_token, list_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
is_buildable (str) – is_buildable
name (str) – name
num_parts (str) – num_parts
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_partlists_parts_create
(user_token, list_id, part_num, quantity, color_id, **kwargs)¶ Add one or more Parts to the Part List. # noqa: E501
Add one or more Parts to the Part List. ### Single Part When adding a single Part, returns the successfully created Part (status 201) or details for why the Part could not be added. ### Multiple Parts To add multiple Parts, POST a JSON list of them (using a Content-Type header of ‘application/json’). e.g: [{“part_num”:”3001”, “color_id”: 1, “quantity”: 10}, {“part_num”:”3001”, “color_id”: 2, “quantity”: 20}, {“part_num”:”3002”, “color_id”: 14, “quantity”: 30}] Returns a list of successfully added Parts. If the Part already exists or is unrecognised, it will be skipped. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_parts_create(user_token, list_id, part_num, quantity, color_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
part_num (str) – part_num (required)
quantity (str) – quantity (required)
color_id (str) – color_id (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_partlists_parts_create_with_http_info
(user_token, list_id, part_num, quantity, color_id, **kwargs)¶ Add one or more Parts to the Part List. # noqa: E501
Add one or more Parts to the Part List. ### Single Part When adding a single Part, returns the successfully created Part (status 201) or details for why the Part could not be added. ### Multiple Parts To add multiple Parts, POST a JSON list of them (using a Content-Type header of ‘application/json’). e.g: [{“part_num”:”3001”, “color_id”: 1, “quantity”: 10}, {“part_num”:”3001”, “color_id”: 2, “quantity”: 20}, {“part_num”:”3002”, “color_id”: 14, “quantity”: 30}] Returns a list of successfully added Parts. If the Part already exists or is unrecognised, it will be skipped. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_parts_create_with_http_info(user_token, list_id, part_num, quantity, color_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
part_num (str) – part_num (required)
quantity (str) – quantity (required)
color_id (str) – color_id (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_partlists_parts_delete
(user_token, list_id, color_id, part_num, **kwargs)¶ Delete a Part from the Part List. # noqa: E501
Delete a Part from the Part List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_parts_delete(user_token, list_id, color_id, part_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
color_id (str) – color_id (required)
part_num (str) – part_num (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_partlists_parts_delete_with_http_info
(user_token, list_id, color_id, part_num, **kwargs)¶ Delete a Part from the Part List. # noqa: E501
Delete a Part from the Part List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_parts_delete_with_http_info(user_token, list_id, color_id, part_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
color_id (str) – color_id (required)
part_num (str) – part_num (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_partlists_parts_list
(user_token, list_id, **kwargs)¶ Get a list of all the Parts in a specific Part List. # noqa: E501
Get a list of all the Parts in a specific Part List. Optional parameter inc_part_details=1 can be used to return additional part fields, the same as for a single part lookup. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_parts_list(user_token, list_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
page (str) – page
page_size (str) – page_size
ordering (str) – ordering
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ArrayOfPartListParts If the method is called asynchronously, returns the request thread.
-
users_partlists_parts_list_with_http_info
(user_token, list_id, **kwargs)¶ Get a list of all the Parts in a specific Part List. # noqa: E501
Get a list of all the Parts in a specific Part List. Optional parameter inc_part_details=1 can be used to return additional part fields, the same as for a single part lookup. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_parts_list_with_http_info(user_token, list_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
page (str) – page
page_size (str) – page_size
ordering (str) – ordering
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(ArrayOfPartListParts, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_partlists_parts_read
(user_token, list_id, color_id, part_num, **kwargs)¶ Get details about a specific Part in the Part List. # noqa: E501
Get details about a specific Part in the Part List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_parts_read(user_token, list_id, color_id, part_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
color_id (str) – color_id (required)
part_num (str) – part_num (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
PartListPart If the method is called asynchronously, returns the request thread.
-
users_partlists_parts_read_with_http_info
(user_token, list_id, color_id, part_num, **kwargs)¶ Get details about a specific Part in the Part List. # noqa: E501
Get details about a specific Part in the Part List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_parts_read_with_http_info(user_token, list_id, color_id, part_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
color_id (str) – color_id (required)
part_num (str) – part_num (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(PartListPart, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_partlists_parts_update
(user_token, list_id, color_id, part_num, quantity, **kwargs)¶ Replace an existing Part’s details in the Part List. # noqa: E501
Replace an existing Part’s details in the Part List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_parts_update(user_token, list_id, color_id, part_num, quantity, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
color_id (str) – color_id (required)
part_num (str) – part_num (required)
quantity (str) – quantity (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_partlists_parts_update_with_http_info
(user_token, list_id, color_id, part_num, quantity, **kwargs)¶ Replace an existing Part’s details in the Part List. # noqa: E501
Replace an existing Part’s details in the Part List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_parts_update_with_http_info(user_token, list_id, color_id, part_num, quantity, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
color_id (str) – color_id (required)
part_num (str) – part_num (required)
quantity (str) – quantity (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_partlists_read
(user_token, list_id, **kwargs)¶ Get details about a specific Part List. # noqa: E501
Get details about a specific Part List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_read(user_token, list_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
PartList If the method is called asynchronously, returns the request thread.
-
users_partlists_read_with_http_info
(user_token, list_id, **kwargs)¶ Get details about a specific Part List. # noqa: E501
Get details about a specific Part List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_read_with_http_info(user_token, list_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(PartList, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_partlists_update
(user_token, list_id, name, **kwargs)¶ Replace an existing Part List’s details. # noqa: E501
Replace an existing Part List’s details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_update(user_token, list_id, name, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
name (str) – name (required)
is_buildable (str) – is_buildable
num_parts (str) – num_parts
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_partlists_update_with_http_info
(user_token, list_id, name, **kwargs)¶ Replace an existing Part List’s details. # noqa: E501
Replace an existing Part List’s details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_partlists_update_with_http_info(user_token, list_id, name, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
name (str) – name (required)
is_buildable (str) – is_buildable
num_parts (str) – num_parts
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_parts_list
(user_token, **kwargs)¶ Get a list of all the Parts in all the user’s Part Lists. # noqa: E501
Get a list of all the Parts in all the user’s Part Lists. Optional parameter inc_part_details=1 can be used to return additional part fields, the same as for a single part lookup. ###Set List logic Parts appearing in multiple Part Lists will be listed multiple times. Optionally, filter by one or more of the below query parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_parts_list(user_token, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
page (str) – page
page_size (str) – page_size
part_num (str) – part_num
part_cat_id (str) – part_cat_id
color_id (str) – color_id
ordering (str) – ordering
search (str) – search
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ArrayOfPartListParts If the method is called asynchronously, returns the request thread.
-
users_parts_list_with_http_info
(user_token, **kwargs)¶ Get a list of all the Parts in all the user’s Part Lists. # noqa: E501
Get a list of all the Parts in all the user’s Part Lists. Optional parameter inc_part_details=1 can be used to return additional part fields, the same as for a single part lookup. ###Set List logic Parts appearing in multiple Part Lists will be listed multiple times. Optionally, filter by one or more of the below query parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_parts_list_with_http_info(user_token, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
page (str) – page
page_size (str) – page_size
part_num (str) – part_num
part_cat_id (str) – part_cat_id
color_id (str) – color_id
ordering (str) – ordering
search (str) – search
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(ArrayOfPartListParts, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_profile_list
(user_token, **kwargs)¶ Get details about a specific user. # noqa: E501
Get details about a specific user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_profile_list(user_token, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
page (str) – page
page_size (str) – page_size
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Profile If the method is called asynchronously, returns the request thread.
-
users_profile_list_with_http_info
(user_token, **kwargs)¶ Get details about a specific user. # noqa: E501
Get details about a specific user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_profile_list_with_http_info(user_token, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
page (str) – page
page_size (str) – page_size
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(Profile, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_setlists_create
(user_token, name, **kwargs)¶ Add a new Set List. # noqa: E501
Add a new Set List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_create(user_token, name, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
name (str) – name (required)
is_buildable (str) – is_buildable
num_sets (str) – num_sets
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
SetList If the method is called asynchronously, returns the request thread.
-
users_setlists_create_with_http_info
(user_token, name, **kwargs)¶ Add a new Set List. # noqa: E501
Add a new Set List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_create_with_http_info(user_token, name, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
name (str) – name (required)
is_buildable (str) – is_buildable
num_sets (str) – num_sets
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(SetList, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_setlists_delete
(user_token, list_id, **kwargs)¶ Delete a Set List and all it’s Sets. # noqa: E501
Delete a Set List and all it’s Sets. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_delete(user_token, list_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_setlists_delete_with_http_info
(user_token, list_id, **kwargs)¶ Delete a Set List and all it’s Sets. # noqa: E501
Delete a Set List and all it’s Sets. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_delete_with_http_info(user_token, list_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_setlists_list
(user_token, **kwargs)¶ Get a list of all the user’s Set Lists. # noqa: E501
Get a list of all the user’s Set Lists. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_list(user_token, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
page (str) – page
page_size (str) – page_size
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ArrayOfSetLists If the method is called asynchronously, returns the request thread.
-
users_setlists_list_with_http_info
(user_token, **kwargs)¶ Get a list of all the user’s Set Lists. # noqa: E501
Get a list of all the user’s Set Lists. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_list_with_http_info(user_token, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
page (str) – page
page_size (str) – page_size
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(ArrayOfSetLists, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_setlists_partial_update
(user_token, list_id, **kwargs)¶ Update an existing Set List’s details. # noqa: E501
Update an existing Set List’s details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_partial_update(user_token, list_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
is_buildable (str) – is_buildable
name (str) – name
num_sets (str) – num_sets
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_setlists_partial_update_with_http_info
(user_token, list_id, **kwargs)¶ Update an existing Set List’s details. # noqa: E501
Update an existing Set List’s details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_partial_update_with_http_info(user_token, list_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
is_buildable (str) – is_buildable
name (str) – name
num_sets (str) – num_sets
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_setlists_read
(user_token, list_id, **kwargs)¶ Get details about a specific Set List. # noqa: E501
Get details about a specific Set List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_read(user_token, list_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
SetList If the method is called asynchronously, returns the request thread.
-
users_setlists_read_with_http_info
(user_token, list_id, **kwargs)¶ Get details about a specific Set List. # noqa: E501
Get details about a specific Set List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_read_with_http_info(user_token, list_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(SetList, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_setlists_sets_create
(user_token, list_id, set_num, **kwargs)¶ Add one or more Sets to the Set List. Existing Sets are unaffected. # noqa: E501
Add one or more Sets to the Set List. Existing Sets are unaffected. ### Single Set When adding a single Set, returns the successfully created Set (status 201) or details for why the Set could not be added. ### Multiple Sets To add multiple Sets, POST a JSON list of them (using a Content-Type header of ‘application/json’). e.g: [{“set_num”:”8043-1”, “quantity”: 1}, {“set_num”:”8110-1”, “quantity”: 2, “include_spares”: “False”}] Returns a list of successfully added Sets. If the Set already exists or is unrecognised, it will be skipped. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_sets_create(user_token, list_id, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
set_num (str) – set_num (required)
quantity (str) – quantity
include_spares (str) – include_spares
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_setlists_sets_create_with_http_info
(user_token, list_id, set_num, **kwargs)¶ Add one or more Sets to the Set List. Existing Sets are unaffected. # noqa: E501
Add one or more Sets to the Set List. Existing Sets are unaffected. ### Single Set When adding a single Set, returns the successfully created Set (status 201) or details for why the Set could not be added. ### Multiple Sets To add multiple Sets, POST a JSON list of them (using a Content-Type header of ‘application/json’). e.g: [{“set_num”:”8043-1”, “quantity”: 1}, {“set_num”:”8110-1”, “quantity”: 2, “include_spares”: “False”}] Returns a list of successfully added Sets. If the Set already exists or is unrecognised, it will be skipped. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_sets_create_with_http_info(user_token, list_id, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
set_num (str) – set_num (required)
quantity (str) – quantity
include_spares (str) – include_spares
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_setlists_sets_delete
(user_token, list_id, set_num, **kwargs)¶ Delete a Set from the Set List. # noqa: E501
Delete a Set from the Set List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_sets_delete(user_token, list_id, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
set_num (str) – set_num (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_setlists_sets_delete_with_http_info
(user_token, list_id, set_num, **kwargs)¶ Delete a Set from the Set List. # noqa: E501
Delete a Set from the Set List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_sets_delete_with_http_info(user_token, list_id, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
set_num (str) – set_num (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_setlists_sets_list
(user_token, list_id, **kwargs)¶ Get a list of all the Sets in a specific Set List. # noqa: E501
Get a list of all the Sets in a specific Set List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_sets_list(user_token, list_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
page (str) – page
page_size (str) – page_size
ordering (str) – ordering
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ArrayOfSetListSets If the method is called asynchronously, returns the request thread.
-
users_setlists_sets_list_with_http_info
(user_token, list_id, **kwargs)¶ Get a list of all the Sets in a specific Set List. # noqa: E501
Get a list of all the Sets in a specific Set List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_sets_list_with_http_info(user_token, list_id, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
page (str) – page
page_size (str) – page_size
ordering (str) – ordering
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(ArrayOfSetListSets, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_setlists_sets_partial_update
(user_token, list_id, set_num, **kwargs)¶ Update an existing Set’s details in the Set List. # noqa: E501
Update an existing Set’s details in the Set List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_sets_partial_update(user_token, list_id, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
set_num (str) – set_num (required)
quantity (str) – quantity
include_spares (str) – include_spares
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_setlists_sets_partial_update_with_http_info
(user_token, list_id, set_num, **kwargs)¶ Update an existing Set’s details in the Set List. # noqa: E501
Update an existing Set’s details in the Set List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_sets_partial_update_with_http_info(user_token, list_id, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
set_num (str) – set_num (required)
quantity (str) – quantity
include_spares (str) – include_spares
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_setlists_sets_read
(user_token, list_id, set_num, **kwargs)¶ Get details about a specific Set in the Set List. # noqa: E501
Get details about a specific Set in the Set List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_sets_read(user_token, list_id, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
set_num (str) – set_num (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
SetListSet If the method is called asynchronously, returns the request thread.
-
users_setlists_sets_read_with_http_info
(user_token, list_id, set_num, **kwargs)¶ Get details about a specific Set in the Set List. # noqa: E501
Get details about a specific Set in the Set List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_sets_read_with_http_info(user_token, list_id, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
set_num (str) – set_num (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(SetListSet, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_setlists_sets_update
(user_token, list_id, set_num, **kwargs)¶ Replace an existing Set’s details in the Set List. # noqa: E501
Replace an existing Set’s details in the Set List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_sets_update(user_token, list_id, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
set_num (str) – set_num (required)
quantity (str) – quantity
include_spares (str) – include_spares
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_setlists_sets_update_with_http_info
(user_token, list_id, set_num, **kwargs)¶ Replace an existing Set’s details in the Set List. # noqa: E501
Replace an existing Set’s details in the Set List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_sets_update_with_http_info(user_token, list_id, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
set_num (str) – set_num (required)
quantity (str) – quantity
include_spares (str) – include_spares
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_setlists_update
(user_token, list_id, name, **kwargs)¶ Replace an existing Set List’s details. # noqa: E501
Replace an existing Set List’s details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_update(user_token, list_id, name, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
name (str) – name (required)
is_buildable (str) – is_buildable
num_sets (str) – num_sets
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_setlists_update_with_http_info
(user_token, list_id, name, **kwargs)¶ Replace an existing Set List’s details. # noqa: E501
Replace an existing Set List’s details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_setlists_update_with_http_info(user_token, list_id, name, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
list_id (str) – list_id (required)
name (str) – name (required)
is_buildable (str) – is_buildable
num_sets (str) – num_sets
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_sets_create
(user_token, set_num, **kwargs)¶ Add one or more Sets to the user’s LEGO collection. Existing Sets are unaffected. # noqa: E501
Add one or more Sets to the user’s LEGO collection. Existing Sets are unaffected. ### Set List logic The Set List used when adding sets is chosen in the following order: 1. If no Set Lists exist, one will be created and used 2. User’s configured default Set List for Imports 3. The first Set List alphabetically ### Single Set When adding a single Set, returns the successfully created Set (status 201) or details for why the Set could not be added. ### Multiple Sets To add multiple Sets, POST a JSON list of them (using a Content-Type header of ‘application/json’). e.g: [{“set_num”:”8043-1”, “quantity”: 1}, {“set_num”:”8110-1”, “quantity”: 2, “include_spares”: “False”}] Returns a list of successfully added Sets. If the Set already exists or is unrecognised, it will be skipped. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_sets_create(user_token, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
set_num (str) – set_num (required)
quantity (str) – quantity
include_spares (str) – include_spares
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
SetListSet If the method is called asynchronously, returns the request thread.
-
users_sets_create_with_http_info
(user_token, set_num, **kwargs)¶ Add one or more Sets to the user’s LEGO collection. Existing Sets are unaffected. # noqa: E501
Add one or more Sets to the user’s LEGO collection. Existing Sets are unaffected. ### Set List logic The Set List used when adding sets is chosen in the following order: 1. If no Set Lists exist, one will be created and used 2. User’s configured default Set List for Imports 3. The first Set List alphabetically ### Single Set When adding a single Set, returns the successfully created Set (status 201) or details for why the Set could not be added. ### Multiple Sets To add multiple Sets, POST a JSON list of them (using a Content-Type header of ‘application/json’). e.g: [{“set_num”:”8043-1”, “quantity”: 1}, {“set_num”:”8110-1”, “quantity”: 2, “include_spares”: “False”}] Returns a list of successfully added Sets. If the Set already exists or is unrecognised, it will be skipped. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_sets_create_with_http_info(user_token, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
set_num (str) – set_num (required)
quantity (str) – quantity
include_spares (str) – include_spares
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(SetListSet, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_sets_delete
(user_token, set_num, **kwargs)¶ Delete the Set from all the user’s Set Lists. # noqa: E501
Delete the Set from all the user’s Set Lists. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_sets_delete(user_token, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
set_num (str) – set_num (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_sets_delete_with_http_info
(user_token, set_num, **kwargs)¶ Delete the Set from all the user’s Set Lists. # noqa: E501
Delete the Set from all the user’s Set Lists. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_sets_delete_with_http_info(user_token, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
set_num (str) – set_num (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_sets_list
(user_token, **kwargs)¶ Get a list of all the Sets in the user’s LEGO collection. # noqa: E501
Get a list of all the Sets in the user’s LEGO collection. ### Set List logic Sets appearing in multiple Set Lists will be listed multiple times. Optionally, filter by one or more of the below query parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_sets_list(user_token, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
page (str) – page
page_size (str) – page_size
set_num (str) – set_num
theme_id (str) – theme_id
min_year (str) – min_year
max_year (str) – max_year
min_parts (str) – min_parts
max_parts (str) – max_parts
ordering (str) – ordering
search (str) – search
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ArrayOfSetListSets If the method is called asynchronously, returns the request thread.
-
users_sets_list_with_http_info
(user_token, **kwargs)¶ Get a list of all the Sets in the user’s LEGO collection. # noqa: E501
Get a list of all the Sets in the user’s LEGO collection. ### Set List logic Sets appearing in multiple Set Lists will be listed multiple times. Optionally, filter by one or more of the below query parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_sets_list_with_http_info(user_token, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
page (str) – page
page_size (str) – page_size
set_num (str) – set_num
theme_id (str) – theme_id
min_year (str) – min_year
max_year (str) – max_year
min_parts (str) – min_parts
max_parts (str) – max_parts
ordering (str) – ordering
search (str) – search
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(ArrayOfSetListSets, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_sets_read
(user_token, set_num, **kwargs)¶ Get details about a specific Set in the user’s LEGO collection. # noqa: E501
Get details about a specific Set in the user’s LEGO collection. ### Set List logic Because this merges sets found across all Set Lists the fields list_id and include_spares may not be accurate unless the Set actually only exists in a single Set List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_sets_read(user_token, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
set_num (str) – set_num (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
SetListSet If the method is called asynchronously, returns the request thread.
-
users_sets_read_with_http_info
(user_token, set_num, **kwargs)¶ Get details about a specific Set in the user’s LEGO collection. # noqa: E501
Get details about a specific Set in the user’s LEGO collection. ### Set List logic Because this merges sets found across all Set Lists the fields list_id and include_spares may not be accurate unless the Set actually only exists in a single Set List. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_sets_read_with_http_info(user_token, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
set_num (str) – set_num (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(SetListSet, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-
users_sets_sync_create
(user_token, set_num, **kwargs)¶ Synchronise a user’s Sets to the POSTed list. # noqa: E501
Synchronise a user’s Sets to the POSTed list. ### Set List logic This is used to completely replace the user’s Sets with those in the supplied list. It will remove any Sets in Rebrickable that are not found in the supplied list. It will attempt to keep any current Rebrickable Sets in their existing Set Lists, and will add any new Sets found into the Default Set List for Imports in the user’s settings. ### Single Set When adding a single Set, returns the successfully created Set (status 201) or details for why the Set could not be added. ### Multiple Sets To add multiple Sets, POST a JSON list of them (using a Content-Type header of ‘application/json’). e.g: [{“set_num”:”8043-1”, “quantity”: 1}, {“set_num”:”8110-1”, “quantity”: 2, “include_spares”: “False”}] Returns a list of successfully added Sets. If the Set is unrecognised, it will be skipped. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_sets_sync_create(user_token, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
set_num (str) – set_num (required)
quantity (str) – quantity
include_spares (str) – include_spares
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_sets_sync_create_with_http_info
(user_token, set_num, **kwargs)¶ Synchronise a user’s Sets to the POSTed list. # noqa: E501
Synchronise a user’s Sets to the POSTed list. ### Set List logic This is used to completely replace the user’s Sets with those in the supplied list. It will remove any Sets in Rebrickable that are not found in the supplied list. It will attempt to keep any current Rebrickable Sets in their existing Set Lists, and will add any new Sets found into the Default Set List for Imports in the user’s settings. ### Single Set When adding a single Set, returns the successfully created Set (status 201) or details for why the Set could not be added. ### Multiple Sets To add multiple Sets, POST a JSON list of them (using a Content-Type header of ‘application/json’). e.g: [{“set_num”:”8043-1”, “quantity”: 1}, {“set_num”:”8110-1”, “quantity”: 2, “include_spares”: “False”}] Returns a list of successfully added Sets. If the Set is unrecognised, it will be skipped. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_sets_sync_create_with_http_info(user_token, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
set_num (str) – set_num (required)
quantity (str) – quantity
include_spares (str) – include_spares
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_sets_update
(user_token, set_num, **kwargs)¶ Update an existing Set’s quantity in all Set Lists. This PUT call is different to others in that it will create # noqa: E501
Update an existing Set’s quantity in all Set Lists. This PUT call is different to others in that it will create the Set if it doesn’t already exist, and it will delete the Set if you pass a quantity of 0. ### Set List logic * Default Set List = user’s configured default import list or the first alphabetically if none exist. * Increasing quantity = add to Set in default Set List if it exists, else add it there * Decreasing quantity = remove from Set in default Set List first, then from remaining lists until done # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_sets_update(user_token, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
set_num (str) – set_num (required)
quantity (str) – quantity
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_sets_update_with_http_info
(user_token, set_num, **kwargs)¶ Update an existing Set’s quantity in all Set Lists. This PUT call is different to others in that it will create # noqa: E501
Update an existing Set’s quantity in all Set Lists. This PUT call is different to others in that it will create the Set if it doesn’t already exist, and it will delete the Set if you pass a quantity of 0. ### Set List logic * Default Set List = user’s configured default import list or the first alphabetically if none exist. * Increasing quantity = add to Set in default Set List if it exists, else add it there * Decreasing quantity = remove from Set in default Set List first, then from remaining lists until done # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_sets_update_with_http_info(user_token, set_num, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
user_token (str) – user_token (required)
set_num (str) – set_num (required)
quantity (str) – quantity
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
None If the method is called asynchronously, returns the request thread.
-
users_token_create
(username, password, **kwargs)¶ Generate a User Token to be used for authorising user account actions in subsequent calls. Username can be either # noqa: E501
Generate a User Token to be used for authorising user account actions in subsequent calls. Username can be either the actual username or the user’s email address. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_token_create(username, password, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
username (str) – username (required)
password (str) – password (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
UsersTokenResponse If the method is called asynchronously, returns the request thread.
-
users_token_create_with_http_info
(username, password, **kwargs)¶ Generate a User Token to be used for authorising user account actions in subsequent calls. Username can be either # noqa: E501
Generate a User Token to be used for authorising user account actions in subsequent calls. Username can be either the actual username or the user’s email address. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.users_token_create_with_http_info(username, password, async_req=True) >>> result = thread.get()
- Parameters
bool (async_req) – execute request asynchronously
username (str) – username (required)
password (str) – password (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
tuple(UsersTokenResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
-