nimble-rest-client 1.0rc1__tar.gz

nimble_rest_client-1.0rc1/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: nimble-rest-client
+Version: 1.0rc1
+Summary: Nimble REST OpenAPI
+Home-page: 
+Author: API Support
+Author-email: support@nimblework.com
+Keywords: OpenAPI,OpenAPI-Generator,Nimble REST OpenAPI
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<2.1.0,>=1.25.3
+Requires-Dist: python-dateutil
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: summary
+
+    REST API for Nimble Forms 2.0. Provides read access to Workspaces and Forms, and full create, read, update, and delete operations on Instances. All endpoints require OAuth 2.0 authentication.  **workspaceId convention**: Pass &#x60;workspaceId&#x60; as a query parameter on GET requests (e.g. &#x60;?workspaceId&#x3D;2110769&#x60;) or in the JSON body on POST requests. It is no longer sent as a header. 
+    

nimble_rest_client-1.0rc1/README.md

@@ -0,0 +1,243 @@
+# nimble-rest-client
+REST API for Nimble Forms 2.0. Provides read access to Workspaces and Forms, and full
+create, read, update, and delete operations on Instances. All endpoints require OAuth 2.0 authentication.
+
+**workspaceId convention**: Pass `workspaceId` as a query parameter on GET requests
+(e.g. `?workspaceId=2110769`) or in the JSON body on POST requests. It is no longer
+sent as a header.
+
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 5.0.0
+- Package version: 1.0rc1
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+
+## Requirements.
+
+Python 3.7+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+
+Then import the package:
+```python
+import nimble_rest_client
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import nimble_rest_client
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import time
+import nimble_rest_client
+from nimble_rest_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost:8080
+# See configuration.py for a list of all supported configuration parameters.
+configuration = nimble_rest_client.Configuration(
+    host = "http://localhost:8080"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+
+# Enter a context with an instance of the API client
+with nimble_rest_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = nimble_rest_client.AttachmentsApi(api_client)
+    instance_id = 'instance_id_example' # str | ID of the workitem instance
+    file = None # bytearray | File to upload (max 32 MB)
+
+    try:
+        # Upload a file attachment to an instance
+        api_response = api_instance.create_attachment(instance_id, file)
+        print("The response of AttachmentsApi->create_attachment:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling AttachmentsApi->create_attachment: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost:8080*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AttachmentsApi* | [**create_attachment**](docs/AttachmentsApi.md#create_attachment) | **POST** /rest/v2/instances/{instanceId}/attachments | Upload a file attachment to an instance
+*AttachmentsApi* | [**delete_attachment**](docs/AttachmentsApi.md#delete_attachment) | **DELETE** /rest/v2/instances/{instanceId}/attachments/{attachmentId} | Delete an attachment
+*AttachmentsApi* | [**link_attachment**](docs/AttachmentsApi.md#link_attachment) | **POST** /rest/v2/instances/{instanceId}/attachments/link | Link an external resource as an attachment
+*AttachmentsApi* | [**list_attachments**](docs/AttachmentsApi.md#list_attachments) | **GET** /rest/v2/instances/{instanceId}/attachments | List attachments for an instance
+*AuthApi* | [**get_token**](docs/AuthApi.md#get_token) | **POST** /rest/v1/oauth/token | Get an OAuth access token
+*BoardsApi* | [**list_boards**](docs/BoardsApi.md#list_boards) | **GET** /rest/v2/workspaces/{workspaceId}/boards | List boards for a workspace
+*CommentsApi* | [**create_comment**](docs/CommentsApi.md#create_comment) | **POST** /rest/v2/instances/{instanceId}/comments | Add a comment to an instance
+*CommentsApi* | [**create_reply**](docs/CommentsApi.md#create_reply) | **PUT** /rest/v2/instances/{instanceId}/comments/{commentId}/replies | Add a reply to a comment
+*CommentsApi* | [**delete_comment**](docs/CommentsApi.md#delete_comment) | **DELETE** /rest/v2/instances/{instanceId}/comments/{commentId} | Delete a comment
+*CommentsApi* | [**get_comment**](docs/CommentsApi.md#get_comment) | **GET** /rest/v2/instances/{instanceId}/comments/{commentId} | Get a single comment by ID
+*CommentsApi* | [**list_comments**](docs/CommentsApi.md#list_comments) | **GET** /rest/v2/instances/{instanceId}/comments | List comments for an instance
+*CommentsApi* | [**update_comment**](docs/CommentsApi.md#update_comment) | **PUT** /rest/v2/instances/{instanceId}/comments/{commentId}/content | Edit a comment's content
+*FormsApi* | [**get_form_by_id**](docs/FormsApi.md#get_form_by_id) | **GET** /rest/v2/forms/{formId} | Get form by ID
+*FormsApi* | [**list_forms**](docs/FormsApi.md#list_forms) | **GET** /rest/v2/forms | List forms
+*InstancesApi* | [**block_instance**](docs/InstancesApi.md#block_instance) | **POST** /rest/v2/instances/{instanceId}/blocks | Block an instance
+*InstancesApi* | [**create_instance**](docs/InstancesApi.md#create_instance) | **POST** /rest/v2/instances | Create a new instance
+*InstancesApi* | [**delete_instance_by_id**](docs/InstancesApi.md#delete_instance_by_id) | **DELETE** /rest/v2/instances/{instanceId} | Delete instance
+*InstancesApi* | [**flag_instance**](docs/InstancesApi.md#flag_instance) | **POST** /rest/v2/instances/{instanceId}/flags | Flag an instance
+*InstancesApi* | [**get_instance_by_id**](docs/InstancesApi.md#get_instance_by_id) | **GET** /rest/v2/instances/{instanceId} | Get instance by ID
+*InstancesApi* | [**get_subblocks**](docs/InstancesApi.md#get_subblocks) | **GET** /rest/v2/instances/{instanceId}/subblocks | Get sub-block instances of an instance
+*InstancesApi* | [**link_workitem**](docs/InstancesApi.md#link_workitem) | **PUT** /rest/v2/instances/{instanceId}/link | Link two workitem instances
+*InstancesApi* | [**list_instances**](docs/InstancesApi.md#list_instances) | **GET** /rest/v2/instances | List all instances
+*InstancesApi* | [**unblock_instance**](docs/InstancesApi.md#unblock_instance) | **DELETE** /rest/v2/instances/{instanceId}/blocks/{actionId} | Unblock an instance
+*InstancesApi* | [**unflag_instance**](docs/InstancesApi.md#unflag_instance) | **DELETE** /rest/v2/instances/{instanceId}/flags/{actionId} | Unflag an instance
+*InstancesApi* | [**unlink_workitem**](docs/InstancesApi.md#unlink_workitem) | **DELETE** /rest/v2/instances/{instanceId}/link/{targetId} | Remove a link between two workitem instances
+*InstancesApi* | [**unvote_instance**](docs/InstancesApi.md#unvote_instance) | **DELETE** /rest/v2/instances/{instanceId}/votes | Remove vote from an instance
+*InstancesApi* | [**update_instance_by_id**](docs/InstancesApi.md#update_instance_by_id) | **PATCH** /rest/v2/instances/{instanceId} | Partially update instance
+*InstancesApi* | [**upsert_instance**](docs/InstancesApi.md#upsert_instance) | **PUT** /rest/v2/instances/{instanceId} | Full replace instance
+*InstancesApi* | [**vote_instance**](docs/InstancesApi.md#vote_instance) | **POST** /rest/v2/instances/{instanceId}/votes | Vote for an instance
+*TimeEntriesApi* | [**create_time_entry**](docs/TimeEntriesApi.md#create_time_entry) | **POST** /rest/v2/instances/{instanceId}/todos/{todoId}/timeentries/{date} | Create or update a time entry
+*TimeEntriesApi* | [**get_time_entry**](docs/TimeEntriesApi.md#get_time_entry) | **GET** /rest/v2/instances/{instanceId}/todos/{todoId}/timeentries/{date} | Get a time entry by todo and date
+*TimeEntriesApi* | [**list_time_entries_by_user**](docs/TimeEntriesApi.md#list_time_entries_by_user) | **GET** /rest/v2/timeentries | List time entries for a user
+*TodosApi* | [**close_todo**](docs/TodosApi.md#close_todo) | **POST** /rest/v2/instances/{instanceId}/todos/{todoId}/close | Close a todo
+*TodosApi* | [**create_todo**](docs/TodosApi.md#create_todo) | **POST** /rest/v2/instances/{instanceId}/todos | Create a todo for an instance
+*TodosApi* | [**delete_todo**](docs/TodosApi.md#delete_todo) | **DELETE** /rest/v2/instances/{instanceId}/todos/{todoId} | Delete a todo
+*TodosApi* | [**get_todo**](docs/TodosApi.md#get_todo) | **GET** /rest/v2/instances/{instanceId}/todos/{todoId} | Get a todo by ID
+*TodosApi* | [**list_todos**](docs/TodosApi.md#list_todos) | **GET** /rest/v2/instances/{instanceId}/todos | List todos for an instance
+*TodosApi* | [**reopen_todo**](docs/TodosApi.md#reopen_todo) | **POST** /rest/v2/instances/{instanceId}/todos/{todoId}/reopen | Reopen a closed todo
+*TodosApi* | [**update_todo**](docs/TodosApi.md#update_todo) | **PATCH** /rest/v2/instances/{instanceId}/todos/{todoId} | Update a todo
+*WorkspacesApi* | [**get_workspace_by_id**](docs/WorkspacesApi.md#get_workspace_by_id) | **GET** /rest/v2/workspaces/{workspaceId} | Get workspace by ID
+*WorkspacesApi* | [**list_workspaces**](docs/WorkspacesApi.md#list_workspaces) | **GET** /rest/v2/workspaces | List all workspaces
+
+
+## Documentation For Models
+
+ - [ActorObject](docs/ActorObject.md)
+ - [ActorObjectOnBehalfOf](docs/ActorObjectOnBehalfOf.md)
+ - [Attachment](docs/Attachment.md)
+ - [BlockInstanceRequest](docs/BlockInstanceRequest.md)
+ - [Board](docs/Board.md)
+ - [BoardCard](docs/BoardCard.md)
+ - [CloseTodo200Response](docs/CloseTodo200Response.md)
+ - [Comment](docs/Comment.md)
+ - [CreateAttachment201Response](docs/CreateAttachment201Response.md)
+ - [CreateComment201Response](docs/CreateComment201Response.md)
+ - [CreateCommentRequest](docs/CreateCommentRequest.md)
+ - [CreateInstanceRequest](docs/CreateInstanceRequest.md)
+ - [CreateReplyRequest](docs/CreateReplyRequest.md)
+ - [CreateTimeEntryRequest](docs/CreateTimeEntryRequest.md)
+ - [CreateTodo201Response](docs/CreateTodo201Response.md)
+ - [CreateTodoRequest](docs/CreateTodoRequest.md)
+ - [DeleteTodo200Response](docs/DeleteTodo200Response.md)
+ - [Error](docs/Error.md)
+ - [FlagInstanceRequest](docs/FlagInstanceRequest.md)
+ - [Form](docs/Form.md)
+ - [FormFieldsInner](docs/FormFieldsInner.md)
+ - [GetSubblocks200Response](docs/GetSubblocks200Response.md)
+ - [GetToken200Response](docs/GetToken200Response.md)
+ - [GetTokenRequest](docs/GetTokenRequest.md)
+ - [Instance](docs/Instance.md)
+ - [InstanceBlocks](docs/InstanceBlocks.md)
+ - [InstanceFlags](docs/InstanceFlags.md)
+ - [LinkAttachment201Response](docs/LinkAttachment201Response.md)
+ - [LinkAttachmentRequest](docs/LinkAttachmentRequest.md)
+ - [LinkWorkitemRequest](docs/LinkWorkitemRequest.md)
+ - [LinkWorkitemRequestTo](docs/LinkWorkitemRequestTo.md)
+ - [ListAttachments200Response](docs/ListAttachments200Response.md)
+ - [ListBoards200Response](docs/ListBoards200Response.md)
+ - [ListComments200Response](docs/ListComments200Response.md)
+ - [ListForms200Response](docs/ListForms200Response.md)
+ - [ListInstances200Response](docs/ListInstances200Response.md)
+ - [ListTimeEntriesByUser200Response](docs/ListTimeEntriesByUser200Response.md)
+ - [ListTodos200Response](docs/ListTodos200Response.md)
+ - [ListWorkspaces200Response](docs/ListWorkspaces200Response.md)
+ - [Queue](docs/Queue.md)
+ - [ReopenTodo200Response](docs/ReopenTodo200Response.md)
+ - [SubblockNode](docs/SubblockNode.md)
+ - [SwimLane](docs/SwimLane.md)
+ - [TimeEntry](docs/TimeEntry.md)
+ - [TimeEntryCreateResponse](docs/TimeEntryCreateResponse.md)
+ - [Todo](docs/Todo.md)
+ - [UnblockInstanceRequest](docs/UnblockInstanceRequest.md)
+ - [UnflagInstanceRequest](docs/UnflagInstanceRequest.md)
+ - [UpdateComment200Response](docs/UpdateComment200Response.md)
+ - [UpdateCommentRequest](docs/UpdateCommentRequest.md)
+ - [UpdateTodo200Response](docs/UpdateTodo200Response.md)
+ - [UpdateTodoRequest](docs/UpdateTodoRequest.md)
+ - [WorkItemLink](docs/WorkItemLink.md)
+ - [WorkItemLinkFrom](docs/WorkItemLinkFrom.md)
+ - [Workspace](docs/Workspace.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="oauth2"></a>
+### oauth2
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: 
+ - **read:workspaces**: Read access to workspaces
+ - **write:workspaces**: Write access to workspaces
+ - **read:forms**: Read access to forms
+ - **write:forms**: Write access to forms
+ - **read:instances**: Read access to form instances
+ - **write:instances**: Write access to form instances
+
+<a id="oauth2"></a>
+### oauth2
+
+- **Type**: OAuth
+- **Flow**: accessCode
+- **Authorization URL**: https://auth.digite.com/oauth/authorize
+- **Scopes**: 
+ - **read:workspaces**: Read access to workspaces
+ - **write:workspaces**: Write access to workspaces
+ - **read:forms**: Read access to forms
+ - **write:forms**: Write access to forms
+ - **read:instances**: Read access to form instances
+ - **write:instances**: Write access to form instances
+
+
+## Author
+
+support@nimblework.com
+
+

nimble_rest_client-1.0rc1/nimble_rest_client/__init__.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Nimble REST OpenAPI
+
+    REST API for Nimble Forms 2.0. Provides read access to Workspaces and Forms, and full create, read, update, and delete operations on Instances. All endpoints require OAuth 2.0 authentication.  **workspaceId convention**: Pass `workspaceId` as a query parameter on GET requests (e.g. `?workspaceId=2110769`) or in the JSON body on POST requests. It is no longer sent as a header. 
+
+    The version of the OpenAPI document: 5.0.0
+    Contact: support@nimblework.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0rc1"
+
+# import apis into sdk package
+from nimble_rest_client.api.attachments_api import AttachmentsApi
+from nimble_rest_client.api.auth_api import AuthApi
+from nimble_rest_client.api.boards_api import BoardsApi
+from nimble_rest_client.api.comments_api import CommentsApi
+from nimble_rest_client.api.forms_api import FormsApi
+from nimble_rest_client.api.instances_api import InstancesApi
+from nimble_rest_client.api.time_entries_api import TimeEntriesApi
+from nimble_rest_client.api.todos_api import TodosApi
+from nimble_rest_client.api.workspaces_api import WorkspacesApi
+
+# import ApiClient
+from nimble_rest_client.api_response import ApiResponse
+from nimble_rest_client.api_client import ApiClient
+from nimble_rest_client.configuration import Configuration
+from nimble_rest_client.exceptions import OpenApiException
+from nimble_rest_client.exceptions import ApiTypeError
+from nimble_rest_client.exceptions import ApiValueError
+from nimble_rest_client.exceptions import ApiKeyError
+from nimble_rest_client.exceptions import ApiAttributeError
+from nimble_rest_client.exceptions import ApiException
+
+# import models into sdk package
+from nimble_rest_client.models.actor_object import ActorObject
+from nimble_rest_client.models.actor_object_on_behalf_of import ActorObjectOnBehalfOf
+from nimble_rest_client.models.attachment import Attachment
+from nimble_rest_client.models.block_instance_request import BlockInstanceRequest
+from nimble_rest_client.models.board import Board
+from nimble_rest_client.models.board_card import BoardCard
+from nimble_rest_client.models.close_todo200_response import CloseTodo200Response
+from nimble_rest_client.models.comment import Comment
+from nimble_rest_client.models.create_attachment201_response import CreateAttachment201Response
+from nimble_rest_client.models.create_comment201_response import CreateComment201Response
+from nimble_rest_client.models.create_comment_request import CreateCommentRequest
+from nimble_rest_client.models.create_instance_request import CreateInstanceRequest
+from nimble_rest_client.models.create_reply_request import CreateReplyRequest
+from nimble_rest_client.models.create_time_entry_request import CreateTimeEntryRequest
+from nimble_rest_client.models.create_todo201_response import CreateTodo201Response
+from nimble_rest_client.models.create_todo_request import CreateTodoRequest
+from nimble_rest_client.models.delete_todo200_response import DeleteTodo200Response
+from nimble_rest_client.models.error import Error
+from nimble_rest_client.models.flag_instance_request import FlagInstanceRequest
+from nimble_rest_client.models.form import Form
+from nimble_rest_client.models.form_fields_inner import FormFieldsInner
+from nimble_rest_client.models.get_subblocks200_response import GetSubblocks200Response
+from nimble_rest_client.models.get_token200_response import GetToken200Response
+from nimble_rest_client.models.get_token_request import GetTokenRequest
+from nimble_rest_client.models.instance import Instance
+from nimble_rest_client.models.instance_blocks import InstanceBlocks
+from nimble_rest_client.models.instance_flags import InstanceFlags
+from nimble_rest_client.models.link_attachment201_response import LinkAttachment201Response
+from nimble_rest_client.models.link_attachment_request import LinkAttachmentRequest
+from nimble_rest_client.models.link_workitem_request import LinkWorkitemRequest
+from nimble_rest_client.models.link_workitem_request_to import LinkWorkitemRequestTo
+from nimble_rest_client.models.list_attachments200_response import ListAttachments200Response
+from nimble_rest_client.models.list_boards200_response import ListBoards200Response
+from nimble_rest_client.models.list_comments200_response import ListComments200Response
+from nimble_rest_client.models.list_forms200_response import ListForms200Response
+from nimble_rest_client.models.list_instances200_response import ListInstances200Response
+from nimble_rest_client.models.list_time_entries_by_user200_response import ListTimeEntriesByUser200Response
+from nimble_rest_client.models.list_todos200_response import ListTodos200Response
+from nimble_rest_client.models.list_workspaces200_response import ListWorkspaces200Response
+from nimble_rest_client.models.queue import Queue
+from nimble_rest_client.models.reopen_todo200_response import ReopenTodo200Response
+from nimble_rest_client.models.subblock_node import SubblockNode
+from nimble_rest_client.models.swim_lane import SwimLane
+from nimble_rest_client.models.time_entry import TimeEntry
+from nimble_rest_client.models.time_entry_create_response import TimeEntryCreateResponse
+from nimble_rest_client.models.todo import Todo
+from nimble_rest_client.models.unblock_instance_request import UnblockInstanceRequest
+from nimble_rest_client.models.unflag_instance_request import UnflagInstanceRequest
+from nimble_rest_client.models.update_comment200_response import UpdateComment200Response
+from nimble_rest_client.models.update_comment_request import UpdateCommentRequest
+from nimble_rest_client.models.update_todo200_response import UpdateTodo200Response
+from nimble_rest_client.models.update_todo_request import UpdateTodoRequest
+from nimble_rest_client.models.work_item_link import WorkItemLink
+from nimble_rest_client.models.work_item_link_from import WorkItemLinkFrom
+from nimble_rest_client.models.workspace import Workspace

nimble_rest_client-1.0rc1/nimble_rest_client/api/__init__.py

@@ -0,0 +1,13 @@
+# flake8: noqa
+
+# import apis into api package
+from nimble_rest_client.api.attachments_api import AttachmentsApi
+from nimble_rest_client.api.auth_api import AuthApi
+from nimble_rest_client.api.boards_api import BoardsApi
+from nimble_rest_client.api.comments_api import CommentsApi
+from nimble_rest_client.api.forms_api import FormsApi
+from nimble_rest_client.api.instances_api import InstancesApi
+from nimble_rest_client.api.time_entries_api import TimeEntriesApi
+from nimble_rest_client.api.todos_api import TodosApi
+from nimble_rest_client.api.workspaces_api import WorkspacesApi
+