flexget.components.managed_lists.lists.pending_list.api module

class flexget.components.managed_lists.lists.pending_list.api.ObjectsContainer

Bases: object

base_entry_object = {'additionalProperties': True, 'properties': {'approved': {'type': 'boolean'}, 'original_url': {'type': 'string'}, 'title': {'type': 'string'}}, 'required': ['title', 'original_url'], 'type': 'object'}

batch_ids = {'items': {'type': 'integer'}, 'minItems': 1, 'type': 'array', 'uniqueItems': True}

batch_operation_object = {'additionalProperties': False, 'properties': {'ids': {'items': {'type': 'integer'}, 'minItems': 1, 'type': 'array', 'uniqueItems': True}, 'operation': {'enum': ['approve', 'reject'], 'type': 'string'}}, 'required': ['operation', 'ids'], 'type': 'object'}

batch_remove_object = {'additionalProperties': False, 'properties': {'ids': {'items': {'type': 'integer'}, 'minItems': 1, 'type': 'array', 'uniqueItems': True}}, 'required': ['ids'], 'type': 'object'}

operation_object = {'additionalProperties': False, 'properties': {'operation': {'enum': ['approve', 'reject'], 'type': 'string'}}, 'required': ['operation'], 'type': 'object'}

pending_list_base_object = {'properties': {'added_on': {'type': 'string'}, 'id': {'type': 'integer'}, 'name': {'type': 'string'}}, 'type': 'object'}

pending_list_entry_base_object = {'properties': {'added_on': {'type': 'string'}, 'approved': {'type': 'boolean'}, 'entry': {'additionalProperties': True, 'properties': {'approved': {'type': 'boolean'}, 'original_url': {'type': 'string'}, 'title': {'type': 'string'}}, 'required': ['title', 'original_url'], 'type': 'object'}, 'id': {'type': 'integer'}, 'name': {'type': 'string'}, 'original_url': {'type': 'string'}, 'title': {'type': 'string'}}, 'type': 'object'}

pending_list_input_object = {'properties': {'name': {'type': 'string'}}, 'type': 'object'}

pending_list_return_lists = {'items': {'properties': {'added_on': {'type': 'string'}, 'id': {'type': 'integer'}, 'name': {'type': 'string'}}, 'type': 'object'}, 'type': 'array'}

pending_lists_entries_return_object = {'items': {'properties': {'added_on': {'type': 'string'}, 'approved': {'type': 'boolean'}, 'entry': {'additionalProperties': True, 'properties': {'approved': {'type': 'boolean'}, 'original_url': {'type': 'string'}, 'title': {'type': 'string'}}, 'required': ['title', 'original_url'], 'type': 'object'}, 'id': {'type': 'integer'}, 'name': {'type': 'string'}, 'original_url': {'type': 'string'}, 'title': {'type': 'string'}}, 'type': 'object'}, 'type': 'array'}

class flexget.components.managed_lists.lists.pending_list.api.PendingListEntriesAPI(api, *args, **kwargs)

Bases: APIResource

Parameters:

api (RestxAPI)

get(list_id, session=None)

Get entries by list ID.

mediatypes()

post(list_id, session=None)

Create a new entry object.

endpoint = 'pending_list_pending_list_entries_api'

methods: ClassVar[Collection[str] | None] = {'GET', 'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class flexget.components.managed_lists.lists.pending_list.api.PendingListEntriesBatchAPI(api, *args, **kwargs)

Bases: APIResource

Parameters:

api (RestxAPI)

delete(list_id, session=None)

Remove multiple entries.

mediatypes()

put(list_id, session=None)

Perform operations on multiple entries.

endpoint = 'pending_list_pending_list_entries_batch_api'

methods: ClassVar[Collection[str] | None] = {'DELETE', 'PUT'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class flexget.components.managed_lists.lists.pending_list.api.PendingListEntryAPI(api, *args, **kwargs)

Bases: APIResource

Parameters:

api (RestxAPI)

delete(list_id, entry_id, session=None)

Delete an entry by list ID and entry ID.

get(list_id, entry_id, session=None)

Get an entry by list ID and entry ID.

mediatypes()

put(list_id, entry_id, session=None)

Set entry object’s pending status.

endpoint = 'pending_list_pending_list_entry_api'

methods: ClassVar[Collection[str] | None] = {'DELETE', 'GET', 'PUT'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class flexget.components.managed_lists.lists.pending_list.api.PendingListListAPI(api, *args, **kwargs)

Bases: APIResource

Parameters:

api (RestxAPI)

delete(list_id, session=None)

Delete pending list by ID.

get(list_id, session=None)

Get pending list by ID.

mediatypes()

endpoint = 'pending_list_pending_list_list_api'

methods: ClassVar[Collection[str] | None] = {'DELETE', 'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class flexget.components.managed_lists.lists.pending_list.api.PendingListListsAPI(api, *args, **kwargs)

Bases: APIResource

Parameters:

api (RestxAPI)

get(session=None)

Get pending lists.

mediatypes()

post(session=None)

Create a new pending list.

endpoint = 'pending_list_pending_list_lists_api'

methods: ClassVar[Collection[str] | None] = {'GET', 'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.