Document360 Customer API

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for twardoch from gravatar.com twardoch

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License Expression: MIT
    SPDX License Expression
  • Author: AUTHOR_NAME
  • Tags Document360 Customer API , OpenAPI , OpenAPI-Generator
  • Requires: Python >=3.10
  • Provides-Extra: all , dev , test
Classifiers
Report project as malware

Project description

d361api

d361api is a Python client library automatically generated from the Document360 API specification using the OpenAPI Generator. It allows developers to programmatically interact with Document360's knowledge base, enabling tasks like managing articles, users, categories, media files, API references, and performing searches, imports, and exports. It supports Python 3.8+ and includes features like type hints, data validation (using Pydantic), and asynchronous operations (using aiohttp). It's designed to simplify integration of Document360 functionality into other Python applications. The package is intended to be used with API tokens, and its distribution includes generated classes representing various API models, request and response formats.

Document360 RESTful APIs will allow you to integrate your documentation with your software, allowing you to easily onboard new users, manage your articles and more.

You can find detailed API documentation here : API Documentation

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 2.0
  • Package version: 1.0.0
  • Generator version: 7.11.0
  • Build package: org.openapitools.codegen.languages. PythonClientCodegen For more information, please visit https://document360.io/contact-us/

Requirements

Python 3.8+

Installation & Usage

pip install

Install it

uv pip install d361api

or

uv pip install git+https://github.com/twardoch/d361api


Then import the package:

```python
import d361api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import d361api
from d361api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://apihub.document360.io
# See configuration.py for a list of all supported configuration parameters.
configuration = d361api.Configuration(
    host = "https://apihub.document360.io"
)

# 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.

# Configure API key authorization: api_token
configuration.api_key['api_token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_token'] = 'Bearer'

# Enter a context with an instance of the API client
async with d361api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = d361api.APIReferencesApi(api_client)
    api_reference_id = 'api_reference_id_example' # str | The ID of the API reference
    page = 1 # int | Page number (optional) (default to 1)
    results_per_page = 5 # int | Total logs per page (optional) (default to 5)

    try:
        # Get all API reference logs
        api_response = await api_instance.v2_api_references_api_reference_id_logs_get(api_reference_id, page=page, results_per_page=results_per_page)
        print("The response of APIReferencesApi->v2_api_references_api_reference_id_logs_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APIReferencesApi->v2_api_references_api_reference_id_logs_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://apihub.document360.io

Class Method HTTP request Description
APIReferencesApi v2_api_references_api_reference_id_logs_get GET /v2/APIReferences/{apiReferenceId}/Logs Get all API reference logs
APIReferencesApi v2_api_references_api_reference_id_logs_log_id_get GET /v2/APIReferences/{apiReferenceId}/Logs/{logId} Get errors and alerts of a log
APIReferencesApi v2_api_references_delete DELETE /v2/APIReferences Deletes an API reference
APIReferencesApi v2_api_references_post POST /v2/APIReferences Import the API reference spec file
APIReferencesApi v2_api_references_publish_post POST /v2/APIReferences/publish Publishes an API reference
APIReferencesApi v2_api_references_put PUT /v2/APIReferences Resync the API reference spec file
ArticlesApi v2_articles_article_id_delete DELETE /v2/Articles/{articleId} Deletes an article with an ID
ArticlesApi v2_articles_article_id_fork_put PUT /v2/Articles/{articleId}/fork Forks an article with an id
ArticlesApi v2_articles_article_id_lang_code_get GET /v2/Articles/{articleId}/{langCode} Gets an article
ArticlesApi v2_articles_article_id_lang_code_publish_post POST /v2/Articles/{articleId}/{langCode}/publish Publishes an article with an id
ArticlesApi v2_articles_article_id_lang_code_put PUT /v2/Articles/{articleId}/{langCode} Updates an article with the ID
ArticlesApi v2_articles_article_id_lang_code_settings_get GET /v2/Articles/{articleId}/{langCode}/settings Gets settings for the article
ArticlesApi v2_articles_article_id_lang_code_settings_put PUT /v2/Articles/{articleId}/{langCode}/settings Updates settings for the article
ArticlesApi v2_articles_article_id_lang_code_update_description_put PUT /v2/Articles/{articleId}/{langCode}/updateDescription Update the Article Description
ArticlesApi v2_articles_article_id_lang_code_version_version_number_delete DELETE /v2/Articles/{articleId}/{langCode}/version/{versionNumber} Deletes an article version
ArticlesApi v2_articles_article_id_lang_code_versions_get GET /v2/Articles/{articleId}/{langCode}/versions Gets all article versions
ArticlesApi v2_articles_article_id_lang_code_versions_version_number_get GET /v2/Articles/{articleId}/{langCode}/versions/{versionNumber} Gets article by a version number
ArticlesApi v2_articles_article_id_publish_post POST /v2/Articles/{articleId}/publish Publishes an article with an id
ArticlesApi v2_articles_article_id_settings_get GET /v2/Articles/{articleId}/settings Gets settings for the article
ArticlesApi v2_articles_article_id_settings_put PUT /v2/Articles/{articleId}/settings Updates settings for the article
ArticlesApi v2_articles_article_id_update_description_put PUT /v2/Articles/{articleId}/updateDescription Update the Article Description
ArticlesApi v2_articles_article_id_version_version_number_delete DELETE /v2/Articles/{articleId}/version/{versionNumber} Deletes an article version
ArticlesApi v2_articles_article_id_versions_get GET /v2/Articles/{articleId}/versions Gets all article versions
ArticlesApi v2_articles_article_id_versions_version_number_get GET /v2/Articles/{articleId}/versions/{versionNumber} Gets article by a version number
ArticlesApi v2_articles_bulkcreate_post POST /v2/Articles/bulkcreate Adds multiple articles
ArticlesApi v2_articles_bulkdelete_article_versions_delete DELETE /v2/Articles/bulkdelete-article-versions Delete multiple article versions
ArticlesApi v2_articles_bulkdelete_delete DELETE /v2/Articles/bulkdelete Deletes multiple articles
ArticlesApi v2_articles_bulkpublish_lang_code_post POST /v2/Articles/bulkpublish/{langCode} Publishes multiple articles
ArticlesApi v2_articles_bulkupdate_put PUT /v2/Articles/bulkupdate Updates multiple articles
ArticlesApi v2_articles_post POST /v2/Articles Adds an article to an existing category
CategoriesApi v2_categories_bulkcreate_post POST /v2/Categories/bulkcreate Adds multiple Categories
CategoriesApi v2_categories_bulkdelete_category_versions_delete DELETE /v2/Categories/bulkdelete-category-versions Delete multiple category versions
CategoriesApi v2_categories_bulkpublish_lang_code_post POST /v2/Categories/bulkpublish/{langCode} Publishes multiple categories
CategoriesApi v2_categories_bulkupdate_content_put PUT /v2/Categories/bulkupdateContent Update multiple page categories
CategoriesApi v2_categories_category_id_content_lang_code_get GET /v2/Categories/{categoryId}/content/{langCode} Get category page with an ID
CategoriesApi v2_categories_category_id_content_lang_code_put PUT /v2/Categories/{categoryId}/content/{langCode} Update a category page content with the ID
CategoriesApi v2_categories_category_id_delete DELETE /v2/Categories/{categoryId} Deletes an category with an ID
CategoriesApi v2_categories_category_id_fork_put PUT /v2/Categories/{categoryId}/fork Fork category page with an id
CategoriesApi v2_categories_category_id_get GET /v2/Categories/{categoryId} Get category with an ID
CategoriesApi v2_categories_category_id_lang_code_publish_post POST /v2/Categories/{categoryId}/{langCode}/publish Publishes an category with an id
CategoriesApi v2_categories_category_id_lang_code_settings_get GET /v2/Categories/{categoryId}/{langCode}/settings Get settings for the Category
CategoriesApi v2_categories_category_id_lang_code_settings_put PUT /v2/Categories/{categoryId}/{langCode}/settings Update settings for the category
CategoriesApi v2_categories_category_id_lang_code_update_description_put PUT /v2/Categories/{categoryId}/{langCode}/updateDescription Update the category description
CategoriesApi v2_categories_category_id_lang_code_version_version_number_delete DELETE /v2/Categories/{categoryId}/{langCode}/version/{versionNumber} Delete category Version
CategoriesApi v2_categories_category_id_lang_codeversions_get GET /v2/Categories/{categoryId}/{langCode}versions Get category page versions
CategoriesApi v2_categories_category_id_publish_post POST /v2/Categories/{categoryId}/publish Publishes an category with an id
CategoriesApi v2_categories_category_id_put PUT /v2/Categories/{categoryId} Update a category with the ID
CategoriesApi v2_categories_category_id_settings_get GET /v2/Categories/{categoryId}/settings Get settings for the Category
CategoriesApi v2_categories_category_id_settings_put PUT /v2/Categories/{categoryId}/settings Update settings for the category
CategoriesApi v2_categories_category_id_update_category_type_put PUT /v2/Categories/{categoryId}/updateCategoryType Update the Category Type
CategoriesApi v2_categories_category_id_update_description_put PUT /v2/Categories/{categoryId}/updateDescription Update the category description
CategoriesApi v2_categories_category_id_version_version_number_delete DELETE /v2/Categories/{categoryId}/version/{versionNumber} Delete category Version
CategoriesApi v2_categories_category_id_versions_get GET /v2/Categories/{categoryId}/versions Get category page versions
CategoriesApi v2_categories_category_id_versions_lang_code_version_number_get GET /v2/Categories/{categoryId}/versions/{langCode}/{versionNumber} Get category page content with an ID
CategoriesApi v2_categories_category_id_versions_version_number_get GET /v2/Categories/{categoryId}/versions/{versionNumber} Get category page content with an ID
CategoriesApi v2_categories_post POST /v2/Categories Adds a new category
DriveApi v2_drive_folders_delete_file_status_task_id_get GET /v2/Drive/Folders/DeleteFile/Status/{taskId} Get status of the delete file operation
DriveApi v2_drive_folders_files_post POST /v2/Drive/Folders/Files Add file in to drive
DriveApi v2_drive_folders_folder_id_delete DELETE /v2/Drive/Folders/{folderId} Delete a folder
DriveApi v2_drive_folders_folder_id_file_id_copy_post POST /v2/Drive/Folders/{folderId}/{fileId}/Copy Copy file from one folder to another
DriveApi v2_drive_folders_folder_id_file_id_delete DELETE /v2/Drive/Folders/{folderId}/{fileId} Delete file using file ID
DriveApi v2_drive_folders_folder_id_file_id_get GET /v2/Drive/Folders/{folderId}/{fileId} Gets file information
DriveApi v2_drive_folders_folder_id_file_id_put PUT /v2/Drive/Folders/{folderId}/{fileId} Move a file with file ID
DriveApi v2_drive_folders_folder_id_file_id_tags_bulkdelete_post POST /v2/Drive/Folders/{folderId}/{fileId}/Tags/Bulkdelete Delete tags from files
DriveApi v2_drive_folders_folder_id_file_id_tags_post POST /v2/Drive/Folders/{folderId}/{fileId}/Tags Add tags in a file using file ID
DriveApi v2_drive_folders_folder_id_get GET /v2/Drive/Folders/{folderId} Gets folder information by folder ID
DriveApi v2_drive_folders_get GET /v2/Drive/Folders Gets folders information
DriveApi v2_drive_folders_post POST /v2/Drive/Folders Add new folder in drive
DriveApi v2_drive_folders_put PUT /v2/Drive/Folders Update a folder with ID
DriveApi v2_drive_media_files_project_version_id_article_id_lang_code_get GET /v2/Drive/MediaFiles/{projectVersionId}/{articleId}/{langCode} Get all media files inserted in the article
DriveApi v2_drive_search_get GET /v2/Drive/Search Drive search - files and folders
LanguageApi v2_language_project_version_id_get GET /v2/Language/{projectVersionId} Gets all version languages in the project
ProjectApi v2_project_export_export_id_get GET /v2/Project/Export/{exportId} Get the status of export
ProjectApi v2_project_export_post POST /v2/Project/Export Start a new export
ProjectApi v2_project_import_import_id_get GET /v2/Project/Import/{importId} Get the status of import
ProjectApi v2_project_import_post POST /v2/Project/Import Import documentation
ProjectApi v2_project_schemes_get GET /v2/Project/Schemes Get all the schemes for the project
ProjectVersionsApi v2_project_versions_ask_eddy_post POST /v2/ProjectVersions/ask-eddy Perform AI assistive search within project version
ProjectVersionsApi v2_project_versions_get GET /v2/ProjectVersions Gets list of project versions
ProjectVersionsApi v2_project_versions_project_version_id_apireferences_get GET /v2/ProjectVersions/{projectVersionId}/apireferences Gets list of api reference within project version
ProjectVersionsApi v2_project_versions_project_version_id_articles_get GET /v2/ProjectVersions/{projectVersionId}/articles Gets list of articles within project version
ProjectVersionsApi v2_project_versions_project_version_id_categories_get GET /v2/ProjectVersions/{projectVersionId}/categories Gets list of categories within project version
ProjectVersionsApi v2_project_versions_project_version_id_lang_code_get GET /v2/ProjectVersions/{projectVersionId}/{langCode} Searches for a phrase inside project version
ReadersApi v2_readers_get GET /v2/Readers Get all available readers from the project
ReadersApi v2_readers_groups_get GET /v2/Readers/groups Get all reader groups
ReadersApi v2_readers_groups_group_id_delete DELETE /v2/Readers/groups/{groupId} Deletes a reader group
ReadersApi v2_readers_groups_group_id_get GET /v2/Readers/groups/{groupId} Get a reader group via group id
ReadersApi v2_readers_groups_group_id_put PUT /v2/Readers/groups/{groupId} Updates a reader group
ReadersApi v2_readers_groups_post POST /v2/Readers/groups Add a new reader group
ReadersApi v2_readers_jwt_delete DELETE /v2/Readers/JWT Deletes JWT readers from the project
ReadersApi v2_readers_post POST /v2/Readers Add a new reader
ReadersApi v2_readers_reader_id_delete DELETE /v2/Readers/{readerId} Deletes a reader from the project
ReadersApi v2_readers_reader_id_put PUT /v2/Readers/{readerId} Updates a reader
TeamsApi v2_teams_email_exists_get GET /v2/Teams/email-exists Checks if email already exists in the project
TeamsApi v2_teams_get GET /v2/Teams Get all team accounts
TeamsApi v2_teams_groups_get GET /v2/Teams/groups Get all user groups
TeamsApi v2_teams_post POST /v2/Teams Adds a new Team Account
TeamsApi v2_teams_roles_get GET /v2/Teams/roles Get all available roles including default as well as custom roles
TeamsApi v2_teams_user_id_content_put PUT /v2/Teams/{userId}/content Update the content roles of an individual user
TeamsApi v2_teams_user_id_delete DELETE /v2/Teams/{userId} Deletes a user with an ID
TeamsApi v2_teams_user_id_get GET /v2/Teams/{userId} Get complete user details by id
TeamsApi v2_teams_user_id_groups_put PUT /v2/Teams/{userId}/groups Modify the groups associated with the user
TeamsApi v2_teams_user_id_portal_put PUT /v2/Teams/{userId}/portal Update the portal role of a individual user
TranslationsApi v2_translations_project_version_id_lang_code_get GET /v2/Translations/{projectVersionId}/{langCode} Gets articles by translation status

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

api_token

  • Type: API key
  • API key parameter name: api_token
  • Location: HTTP header

Author

support@document360.com

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for twardoch from gravatar.com twardoch

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License Expression: MIT
    SPDX License Expression
  • Author: AUTHOR_NAME
  • Tags Document360 Customer API , OpenAPI , OpenAPI-Generator
  • Requires: Python >=3.10
  • Provides-Extra: all , dev , test
Classifiers

Release history Release notifications | RSS feed

2.2.7

2.2.4

2.2.3

2.2.2

This version

1.0.1

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

d361api-1.0.1.tar.gz (296.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

d361api-1.0.1-py3-none-any.whl (426.1 kB view details)

Uploaded Python 3

File details

Details for the file d361api-1.0.1.tar.gz.

File metadata

  • Download URL: d361api-1.0.1.tar.gz
  • Upload date:
  • Size: 296.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.1

File hashes

Hashes for d361api-1.0.1.tar.gz
Algorithm Hash digest
SHA256 daafc3aa80aee14e04e423b65ae11a7b4b0a4267ba06923834a2890bbe610f5f
MD5 8330b003d6b80c5154b1eff324c0b0d8
BLAKE2b-256 5212cc133e24703cf24eb052e42e002a6bf0e455f67384b022928c5369c9f667

See more details on using hashes here.

File details

Details for the file d361api-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: d361api-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 426.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.1

File hashes

Hashes for d361api-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d4c2cb3551a67585b4500c5edb83be21329df24bf53e12d3d87eda9b7c7d4598
MD5 7a134979839ce3ff6e51d21f1311df08
BLAKE2b-256 173deb7d1a3f9ddee7ecaf21f3a253b16ebc7ff66ae88f37951fc666662079c0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page