`flywheel.api.gears_api`

`GearsApi`

Bases: object

`add_gear(gear_name, body, **kwargs)`

Create or update a gear.

If no existing gear is found, one will be created Otherwise, the specified gear will be updated This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_name`	`str`	Name of the gear to interact with	required
`body`	`GearDocumentLegacyInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_gear_permission(gear_name, permission_type, body, **kwargs)`

Add an individual permission to the given gear

Add an individual permission to the given gear. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_name`	`str`	Name of the gear to interact with	required
`permission_type`	`GearPermissionsType`		required
`body`	`GearPermissionsInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_gear_permission_with_http_info(gear_name, permission_type, body, **kwargs)`

Add an individual permission to the given gear

Add an individual permission to the given gear. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_name`	`str`	Name of the gear to interact with	required
`permission_type`	`GearPermissionsType`		required
`body`	`GearPermissionsInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_gear_with_http_info(gear_name, body, **kwargs)`

Create or update a gear.

If no existing gear is found, one will be created Otherwise, the specified gear will be updated This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_name`	`str`	Name of the gear to interact with	required
`body`	`GearDocumentLegacyInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_gear(gear_id, **kwargs)`

Delete a gear (not recommended)

Disable a gear by id. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_id`	`str`	Id of the gear to interact with	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_gear_permission(gear_name, permission_type, permission_id, **kwargs)`

Delete an individual permission of the given gear

Delete an individual permission of the given gear. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_name`	`str`		required
`permission_type`	`GearPermissionsType`		required
`permission_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_gear_permission_with_http_info(gear_name, permission_type, permission_id, **kwargs)`

Delete an individual permission of the given gear

Delete an individual permission of the given gear. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_name`	`str`		required
`permission_type`	`GearPermissionsType`		required
`permission_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_gear_permissions(gear_name, **kwargs)`

Delete permissions of the given gear

Delete permissions of the given gear. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_name`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_gear_permissions_with_http_info(gear_name, **kwargs)`

Delete permissions of the given gear

Delete permissions of the given gear. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_name`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_gear_with_http_info(gear_id, **kwargs)`

Delete a gear (not recommended)

Disable a gear by id. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_id`	`str`	Id of the gear to interact with	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_all_gears(**kwargs)`

List all gears

List all gears This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`project_id`	`(str, optional)`		required
`all_versions`	`(bool, optional)`	return all versions of each gear, defaults to false	required
`include_invalid`	`(bool, optional)`	return gears with the 'invalid' flag set, defaults to false	required
`filter`	`(str, optional)`	Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22)	required
`sort`	`(str, optional)`	The sort fields and order. (e.g. label:asc,created:desc)	required
`limit`	`(int, optional)`	The maximum number of entries to return.	required
`skip`	`(int, optional)`	The number of entries to skip.	required
`page`	`(int, optional)`	The page number (i.e. skip limit*page entries)	required
`after_id`	`(str, optional)`	Paginate after the given id. (Cannot be used with sort, page or skip)	required
`exhaustive`	`(bool, optional)`	Set to return a complete list regardless of permissions, defaults to false	required
`x_accept_feature`	`(list[union[HeaderFeature, str]], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_all_gears_with_http_info(**kwargs)`

List all gears

List all gears This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`project_id`	`(str, optional)`		required
`all_versions`	`(bool, optional)`	return all versions of each gear, defaults to false	required
`include_invalid`	`(bool, optional)`	return gears with the 'invalid' flag set, defaults to false	required
`filter`	`(str, optional)`	Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22)	required
`sort`	`(str, optional)`	The sort fields and order. (e.g. label:asc,created:desc)	required
`limit`	`(int, optional)`	The maximum number of entries to return.	required
`skip`	`(int, optional)`	The number of entries to skip.	required
`page`	`(int, optional)`	The page number (i.e. skip limit*page entries)	required
`after_id`	`(str, optional)`	Paginate after the given id. (Cannot be used with sort, page or skip)	required
`exhaustive`	`(bool, optional)`	Set to return a complete list regardless of permissions, defaults to false	required
`x_accept_feature`	`(list[union[HeaderFeature, str]], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_gear(gear_id, **kwargs)`

Retrieve details about a specific gear

Retrieve details about a specific gear This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_gear_context(gear_id, container_name, container_id, **kwargs)`

Get context values for the given gear and container.

Ref: https://github.com/flywheel-io/gears/tree/master/spec#contextual-values This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_id`	`str`		required
`container_name`	`str`		required
`container_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_gear_context_with_http_info(gear_id, container_name, container_id, **kwargs)`

Get context values for the given gear and container.

Ref: https://github.com/flywheel-io/gears/tree/master/spec#contextual-values This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_id`	`str`		required
`container_name`	`str`		required
`container_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_gear_invocation(gear_id, **kwargs)`

Get a schema for invoking a gear

Get a schema for invoking a gear. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_gear_invocation_with_http_info(gear_id, **kwargs)`

Get a schema for invoking a gear

Get a schema for invoking a gear. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_gear_series(gear_name, **kwargs)`

Get gear series.

Gets the series for the gear by its name This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_name`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_gear_series_with_http_info(gear_name, **kwargs)`

Get gear series.

Gets the series for the gear by its name This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_name`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_gear_suggest(gear_id, container_name, container_id, **kwargs)`

Get files with input suggestions, parent containers, and child containers for the given container.

Get files with input suggestions, parent containers, and child containers for the given container. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_id`	`str`	Id of the gear to interact with	required
`container_name`	`str`	Type of the container to interact with	required
`container_id`	`str`	Id of the container to interact with	required
`filter`	`(str, optional)`		required
`sort`	`(str, optional)`		required
`limit`	`(int, optional)`	, defaults to 100	required
`skip`	`(int, optional)`		required
`page`	`(int, optional)`		required
`include`	`(list[str], optional)`	Include only "children" or "files", defaults to ["children","files"]	required
`collection`	`(str, optional)`	Get suggestions for a collection	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_gear_suggest_with_http_info(gear_id, container_name, container_id, **kwargs)`

Get files with input suggestions, parent containers, and child containers for the given container.

Get files with input suggestions, parent containers, and child containers for the given container. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_id`	`str`	Id of the gear to interact with	required
`container_name`	`str`	Type of the container to interact with	required
`container_id`	`str`	Id of the container to interact with	required
`filter`	`(str, optional)`		required
`sort`	`(str, optional)`		required
`limit`	`(int, optional)`	, defaults to 100	required
`skip`	`(int, optional)`		required
`page`	`(int, optional)`		required
`include`	`(list[str], optional)`	Include only "children" or "files", defaults to ["children","files"]	required
`collection`	`(str, optional)`	Get suggestions for a collection	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_gear_ticket(ticket_id, **kwargs)`

Retrieve a specific gear ticket

Retrieve a specific gear ticket. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`ticket_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_gear_ticket_with_http_info(ticket_id, **kwargs)`

Retrieve a specific gear ticket

Retrieve a specific gear ticket. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`ticket_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_gear_with_http_info(gear_id, **kwargs)`

Retrieve details about a specific gear

Retrieve details about a specific gear This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_my_gear_tickets(**kwargs)`

Retrieve all gear tickets for the current user

Retrieve all gear tickets for the current user. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_my_gear_tickets_with_http_info(**kwargs)`

Retrieve all gear tickets for the current user

Retrieve all gear tickets for the current user. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_gear_series(gear_name, body, **kwargs)`

Update a gear series

Update a gear series. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_name`	`str`	Name of the gear series to modify	required
`body`	`GearSeriesUpdate`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_gear_series_with_http_info(gear_name, body, **kwargs)`

Update a gear series

Update a gear series. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_name`	`str`	Name of the gear series to modify	required
`body`	`GearSeriesUpdate`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`prepare_add_gear(body, **kwargs)`

Prepare a gear upload

Prepare a gear upload This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`GearDocumentInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`prepare_add_gear_with_http_info(body, **kwargs)`

Prepare a gear upload

Prepare a gear upload This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`GearDocumentInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`replace_gear_permissions(gear_name, body, **kwargs)`

Replace permissions for the given gear

Replace permissions for the given gear. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_name`	`str`	Name of the gear to interact with	required
`body`	`GearPermissions`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`replace_gear_permissions_with_http_info(gear_name, body, **kwargs)`

Replace permissions for the given gear

Replace permissions for the given gear. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`gear_name`	`str`	Name of the gear to interact with	required
`body`	`GearPermissions`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`save_gear(body, **kwargs)`

Report the result of a gear upload and save the ticket

Report the result of a gear upload and save the ticket This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`GearSaveSubmission`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`save_gear_with_http_info(body, **kwargs)`

Report the result of a gear upload and save the ticket

Report the result of a gear upload and save the ticket This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`GearSaveSubmission`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required