flywheel-sdk 21.3.0__py3-none-any.whl → 21.4.0__py3-none-any.whl

flywheel/api/form_responses_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -37,10 +30,13 @@ class FormResponsesApi(object):
         Create or replace a response for a task using its protocol's form schema.  If no response exists, a new one is created. If a response exists and is NOT submitted, it is replaced. If a response exists and IS submitted, returns 409 Conflict. Only the task assignee can create/replace responses.  Responses can be saved multiple times as drafts before submission without validation. Validation is enforced only when submitting or completing the task.
         This method makes a synchronous HTTP request by default.
 
-        :param str task_id: (required)
-        :param FormResponseCreate body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: CoreWorkflowsFormResponsesModelsFormResponseOutput
+        :param task_id:
+        :type task_id: str
+        :param body:
+        :type body: FormResponseCreate
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: CoreWorkflowsFormResponsesModelsFormResponseOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -64,10 +60,13 @@ class FormResponsesApi(object):
         Create or replace a response for a task using its protocol's form schema.  If no response exists, a new one is created. If a response exists and is NOT submitted, it is replaced. If a response exists and IS submitted, returns 409 Conflict. Only the task assignee can create/replace responses.  Responses can be saved multiple times as drafts before submission without validation. Validation is enforced only when submitting or completing the task.
         This method makes a synchronous HTTP request by default.
 
-        :param str task_id: (required)
-        :param FormResponseCreate body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: CoreWorkflowsFormResponsesModelsFormResponseOutput
+        :param task_id:
+        :type task_id: str
+        :param body:
+        :type body: FormResponseCreate
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: CoreWorkflowsFormResponsesModelsFormResponseOutput
         """
 
         all_params = ['task_id','body',]  # noqa: E501
@@ -153,9 +152,11 @@ class FormResponsesApi(object):
         Retrieve a specific response.
         This method makes a synchronous HTTP request by default.
 
-        :param str response_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: CoreWorkflowsFormResponsesModelsFormResponseOutput
+        :param response_id:
+        :type response_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: CoreWorkflowsFormResponsesModelsFormResponseOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -179,9 +180,11 @@ class FormResponsesApi(object):
         Retrieve a specific response.
         This method makes a synchronous HTTP request by default.
 
-        :param str response_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: CoreWorkflowsFormResponsesModelsFormResponseOutput
+        :param response_id:
+        :type response_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: CoreWorkflowsFormResponsesModelsFormResponseOutput
         """
 
         all_params = ['response_id',]  # noqa: E501
@@ -250,15 +253,23 @@ class FormResponsesApi(object):
         List all responses for a given task.
         This method makes a synchronous HTTP request by default.
 
-        :param str task_id: (required)
-        :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
-        :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
-        :param int limit: The maximum number of entries to return.
-        :param int skip: The number of entries to skip.
-        :param int page: The page number (i.e. skip limit*page entries)
-        :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
-        :param bool async_: Perform the request asynchronously
-        :return: PageGenericFormResponseOutput
+        :param task_id:
+        :type task_id: str
+        :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
+        :type filter: str, optional
+        :param sort: The sort fields and order. (e.g. label:asc,created:desc)
+        :type sort: str, optional
+        :param limit: The maximum number of entries to return.
+        :type limit: int, optional
+        :param skip: The number of entries to skip., defaults to 0
+        :type skip: int, optional
+        :param page: The page number (i.e. skip limit*page entries)
+        :type page: int, optional
+        :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
+        :type after_id: str, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: PageGenericFormResponseOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -282,15 +293,23 @@ class FormResponsesApi(object):
         List all responses for a given task.
         This method makes a synchronous HTTP request by default.
 
-        :param str task_id: (required)
-        :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
-        :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
-        :param int limit: The maximum number of entries to return.
-        :param int skip: The number of entries to skip.
-        :param int page: The page number (i.e. skip limit*page entries)
-        :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
-        :param bool async_: Perform the request asynchronously
-        :return: PageGenericFormResponseOutput
+        :param task_id:
+        :type task_id: str
+        :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
+        :type filter: str, optional
+        :param sort: The sort fields and order. (e.g. label:asc,created:desc)
+        :type sort: str, optional
+        :param limit: The maximum number of entries to return.
+        :type limit: int, optional
+        :param skip: The number of entries to skip., defaults to 0
+        :type skip: int, optional
+        :param page: The page number (i.e. skip limit*page entries)
+        :type page: int, optional
+        :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
+        :type after_id: str, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: PageGenericFormResponseOutput
         """
 
         all_params = ['task_id','filter','sort','limit','skip','page','after_id',]  # noqa: E501
@@ -371,11 +390,15 @@ class FormResponsesApi(object):
         Create or replace a response for a task using its protocol's form schema.  If no response exists, a new one is created. If a response exists and is NOT submitted, it is replaced. If a response exists and IS submitted, returns 409 Conflict. Only the task assignee can create/replace responses.  Responses can be saved multiple times as drafts before submission without validation. Validation is enforced only when submitting or completing the task.
         This method makes a synchronous HTTP request by default.
 
-        :param str task_id: (required)
-        :param str response_id: (required)
-        :param FormResponseCreate body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: CoreWorkflowsFormResponsesModelsFormResponseOutput
+        :param task_id:
+        :type task_id: str
+        :param response_id:
+        :type response_id: str
+        :param body:
+        :type body: FormResponseCreate
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: CoreWorkflowsFormResponsesModelsFormResponseOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -399,11 +422,15 @@ class FormResponsesApi(object):
         Create or replace a response for a task using its protocol's form schema.  If no response exists, a new one is created. If a response exists and is NOT submitted, it is replaced. If a response exists and IS submitted, returns 409 Conflict. Only the task assignee can create/replace responses.  Responses can be saved multiple times as drafts before submission without validation. Validation is enforced only when submitting or completing the task.
         This method makes a synchronous HTTP request by default.
 
-        :param str task_id: (required)
-        :param str response_id: (required)
-        :param FormResponseCreate body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: CoreWorkflowsFormResponsesModelsFormResponseOutput
+        :param task_id:
+        :type task_id: str
+        :param response_id:
+        :type response_id: str
+        :param body:
+        :type body: FormResponseCreate
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: CoreWorkflowsFormResponsesModelsFormResponseOutput
         """
 
         all_params = ['task_id','response_id','body',]  # noqa: E501
@@ -495,9 +522,11 @@ class FormResponsesApi(object):
         Submit a response. Validate against form schema and lock it.  Once submitted: - submitted flag is set to true - submitted_at timestamp is recorded - origin is set to the submitting user - further edits are disabled
         This method makes a synchronous HTTP request by default.
 
-        :param str response_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: CoreWorkflowsFormResponsesModelsFormResponseOutput
+        :param response_id:
+        :type response_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: CoreWorkflowsFormResponsesModelsFormResponseOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -521,9 +550,11 @@ class FormResponsesApi(object):
         Submit a response. Validate against form schema and lock it.  Once submitted: - submitted flag is set to true - submitted_at timestamp is recorded - origin is set to the submitting user - further edits are disabled
         This method makes a synchronous HTTP request by default.
 
-        :param str response_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: CoreWorkflowsFormResponsesModelsFormResponseOutput
+        :param response_id:
+        :type response_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: CoreWorkflowsFormResponsesModelsFormResponseOutput
         """
 
         all_params = ['response_id',]  # noqa: E501
@@ -592,10 +623,13 @@ class FormResponsesApi(object):
         Update a response only if not submitted.  Responses can be saved multiple times as drafts before submission without validation. Validation is enforced only when submitting or completing the task. Once submitted, further edits are disabled.
         This method makes a synchronous HTTP request by default.
 
-        :param str response_id: (required)
-        :param FormResponseBase body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: CoreWorkflowsFormResponsesModelsFormResponseOutput
+        :param response_id:
+        :type response_id: str
+        :param body:
+        :type body: FormResponseBase
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: CoreWorkflowsFormResponsesModelsFormResponseOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -619,10 +653,13 @@ class FormResponsesApi(object):
         Update a response only if not submitted.  Responses can be saved multiple times as drafts before submission without validation. Validation is enforced only when submitting or completing the task. Once submitted, further edits are disabled.
         This method makes a synchronous HTTP request by default.
 
-        :param str response_id: (required)
-        :param FormResponseBase body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: CoreWorkflowsFormResponsesModelsFormResponseOutput
+        :param response_id:
+        :type response_id: str
+        :param body:
+        :type body: FormResponseBase
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: CoreWorkflowsFormResponsesModelsFormResponseOutput
         """
 
         all_params = ['response_id','body',]  # noqa: E501