@nestbox-ai/doc-processing-api 0.0.1 → 1.0.62

package/docs/WebhooksApi.md

@@ -0,0 +1,280 @@
+# WebhooksApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**webhooksControllerCreateWebhook**](#webhookscontrollercreatewebhook) | **POST** /webhooks | Create webhook|
+|[**webhooksControllerDeleteWebhook**](#webhookscontrollerdeletewebhook) | **DELETE** /webhooks/{webhookId} | Delete webhook|
+|[**webhooksControllerGetWebhook**](#webhookscontrollergetwebhook) | **GET** /webhooks/{webhookId} | Read webhook|
+|[**webhooksControllerListWebhooks**](#webhookscontrollerlistwebhooks) | **GET** /webhooks | List webhooks|
+|[**webhooksControllerUpdateWebhook**](#webhookscontrollerupdatewebhook) | **PATCH** /webhooks/{webhookId} | Update webhook|
+
+# **webhooksControllerCreateWebhook**
+> WebhookDto webhooksControllerCreateWebhook(createWebhookInputDto)
+
+
+### Example
+
+```typescript
+import {
+    WebhooksApi,
+    Configuration,
+    CreateWebhookInputDto
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new WebhooksApi(configuration);
+
+let createWebhookInputDto: CreateWebhookInputDto; //
+
+const { status, data } = await apiInstance.webhooksControllerCreateWebhook(
+    createWebhookInputDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createWebhookInputDto** | **CreateWebhookInputDto**|  | |
+
+
+### Return type
+
+**WebhookDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Webhook created |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **webhooksControllerDeleteWebhook**
+> WebhookDto webhooksControllerDeleteWebhook()
+
+
+### Example
+
+```typescript
+import {
+    WebhooksApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new WebhooksApi(configuration);
+
+let webhookId: string; //Webhook ID. (default to undefined)
+
+const { status, data } = await apiInstance.webhooksControllerDeleteWebhook(
+    webhookId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **webhookId** | [**string**] | Webhook ID. | defaults to undefined|
+
+
+### Return type
+
+**WebhookDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Webhook deleted |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **webhooksControllerGetWebhook**
+> WebhookDto webhooksControllerGetWebhook()
+
+
+### Example
+
+```typescript
+import {
+    WebhooksApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new WebhooksApi(configuration);
+
+let webhookId: string; //Webhook ID. (default to undefined)
+
+const { status, data } = await apiInstance.webhooksControllerGetWebhook(
+    webhookId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **webhookId** | [**string**] | Webhook ID. | defaults to undefined|
+
+
+### Return type
+
+**WebhookDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Webhook details |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **webhooksControllerListWebhooks**
+> PaginatedWebhooksDto webhooksControllerListWebhooks()
+
+
+### Example
+
+```typescript
+import {
+    WebhooksApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new WebhooksApi(configuration);
+
+let page: number; //1-based page number. (optional) (default to 1)
+let limit: number; //Page size. (optional) (default to 10)
+
+const { status, data } = await apiInstance.webhooksControllerListWebhooks(
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] | 1-based page number. | (optional) defaults to 1|
+| **limit** | [**number**] | Page size. | (optional) defaults to 10|
+
+
+### Return type
+
+**PaginatedWebhooksDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Paginated list of webhooks |  -  |
+|**401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **webhooksControllerUpdateWebhook**
+> WebhookDto webhooksControllerUpdateWebhook(updateWebhookBodyInputDto)
+
+
+### Example
+
+```typescript
+import {
+    WebhooksApi,
+    Configuration,
+    UpdateWebhookBodyInputDto
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new WebhooksApi(configuration);
+
+let webhookId: string; //Webhook ID. (default to undefined)
+let updateWebhookBodyInputDto: UpdateWebhookBodyInputDto; //
+
+const { status, data } = await apiInstance.webhooksControllerUpdateWebhook(
+    webhookId,
+    updateWebhookBodyInputDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateWebhookBodyInputDto** | **UpdateWebhookBodyInputDto**|  | |
+| **webhookId** | [**string**] | Webhook ID. | defaults to undefined|
+
+
+### Return type
+
+**WebhookDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Webhook updated |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="NestboxAI"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="nestbox-ai-clients"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

package/index.ts

@@ -0,0 +1,18 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nestbox API Documents Processing API
+ * API for Nestbox Documents Processing
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export * from "./api";
+export * from "./configuration";
+

package/package.json

@@ -1,10 +1,33 @@
 {
   "name": "@nestbox-ai/doc-processing-api",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @nestbox-ai/doc-processing-api",
+  "version": "1.0.62",
+  "description": "OpenAPI client for @nestbox-ai/doc-processing-api",
+  "author": "OpenAPI-Generator Contributors",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/NestboxAI/nestbox-ai-clients.git"
+  },
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
+    "axios",
+    "typescript",
+    "openapi-client",
+    "openapi-generator",
+    "@nestbox-ai/doc-processing-api"
+  ],
+  "license": "Unlicense",
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "prepare": "npm run build"
+  },
+  "dependencies": {
+    "axios": "^1.6.1"
+  },
+  "devDependencies": {
+    "@types/node": "12.11.5 - 12.20.42",
+    "typescript": "^4.0 || ^5.0"
+  }
 }

package/tsconfig.esm.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "esnext",
+    "outDir": "dist/esm"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "target": "ES6",
+    "module": "commonjs",
+    "noImplicitAny": true,
+    "outDir": "dist",
+    "rootDir": ".",
+    "moduleResolution": "node",
+    "typeRoots": [
+      "node_modules/@types"
+    ]
+  },
+  "exclude": [
+    "dist",
+    "node_modules"
+  ]
+}