# ncloud-cloudfunctions

> Cloud Functions Client for Naver Cloud Platform

Latest version **1.0.3** (published 2023-05-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install ncloud-cloudfunctions
pnpm add ncloud-cloudfunctions
yarn add ncloud-cloudfunctions
bun add ncloud-cloudfunctions
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2023-05-25 |
| First published | 2023-01-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 1000.9 KB |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | ncp-beagle, jh-kict96 |

## Links

- npm: https://www.npmjs.com/package/ncloud-cloudfunctions
- npm.io page: https://npm.io/package/ncloud-cloudfunctions

## Dependencies (2)

- [crypto-js](https://npm.io/package/crypto-js.md) ^3.1.9-1
- [superagent](https://npm.io/package/superagent.md) 3.5.2

## Recent versions

- 1.0.3 (latest) — 2023-05-25
- 1.0.2 — 2023-01-26
- 1.0.0 — 2023-01-03

## README

# api

Api - JavaScript client for api
Cloud Functions Open API<br/>https://cloudfunctions.apigw.ntruss.com/api/v2
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 2022-08-18T08:02:31Z
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.NcpJavascriptForNcloudClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install api --save
```

#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/YOUR_USERNAME/api
then install it via:

```shell
    npm install YOUR_USERNAME/api --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var Api = require('api');

var defaultClient = Api.ApiClient.instance;

// Configure API key authorization: x-ncp-iam
var x-ncp-iam = defaultClient.authentications['x-ncp-iam'];
x-ncp-iam.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-ncp-iam.apiKeyPrefix['x-ncp-iam'] = "Token"

var api = new Api.V2Api()

var packageName = "packageName_example"; // {String} packageName

var actionName = "actionName_example"; // {String} actionName

var opts = { 
  'platform': "platform_example" // {String} platform
};
api.deleteAction(packageName, actionName, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});


```

## Documentation for API Endpoints

All URIs are relative to *https://cloudfunctions.apigw.ntruss.com/api/v2*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*Api.V2Api* | [**deleteAction**](docs/V2Api.md#deleteAction) | **DELETE** /packages/{packageName}/actions/{actionName} | 
*Api.V2Api* | [**deletePackage**](docs/V2Api.md#deletePackage) | **DELETE** /packages/{packageName} | 
*Api.V2Api* | [**deleteTrigger**](docs/V2Api.md#deleteTrigger) | **DELETE** /triggers/{triggerName} | 
*Api.V2Api* | [**deleteTriggerLinkAction**](docs/V2Api.md#deleteTriggerLinkAction) | **DELETE** /triggers/{triggerName}/link-action | 
*Api.V2Api* | [**getAction**](docs/V2Api.md#getAction) | **GET** /packages/{packageName}/actions/{actionName} | 
*Api.V2Api* | [**getActionActivationDetail**](docs/V2Api.md#getActionActivationDetail) | **GET** /packages/{packageName}/actions/{actionName}/activations/{activationId} | 
*Api.V2Api* | [**getActionActivationList**](docs/V2Api.md#getActionActivationList) | **GET** /packages/{packageName}/actions/{actionName}/activations | 
*Api.V2Api* | [**getActionList**](docs/V2Api.md#getActionList) | **GET** /packages/{packageName}/actions | 
*Api.V2Api* | [**getActivationList**](docs/V2Api.md#getActivationList) | **GET** /activations | 
*Api.V2Api* | [**getPackage**](docs/V2Api.md#getPackage) | **GET** /packages/{packageName} | 
*Api.V2Api* | [**getPackageList**](docs/V2Api.md#getPackageList) | **GET** /packages | 
*Api.V2Api* | [**getTrigger**](docs/V2Api.md#getTrigger) | **GET** /triggers/{triggerName} | 
*Api.V2Api* | [**getTriggerActivationDetail**](docs/V2Api.md#getTriggerActivationDetail) | **GET** /triggers/{triggerName}/activations/{activationId} | 
*Api.V2Api* | [**getTriggerActivationList**](docs/V2Api.md#getTriggerActivationList) | **GET** /triggers/{triggerName}/activations | 
*Api.V2Api* | [**getTriggerList**](docs/V2Api.md#getTriggerList) | **GET** /triggers | 
*Api.V2Api* | [**postAction**](docs/V2Api.md#postAction) | **POST** /packages/{packageName}/actions/{actionName} | 
*Api.V2Api* | [**postActionExternalLink**](docs/V2Api.md#postActionExternalLink) | **POST** /packages/{packageName}/actions/{actionName}/external-link-url | 
*Api.V2Api* | [**postTrigger**](docs/V2Api.md#postTrigger) | **POST** /triggers/{triggerName} | 
*Api.V2Api* | [**postTriggerExternalLink**](docs/V2Api.md#postTriggerExternalLink) | **POST** /triggers/{triggerName}/external-link-url | 
*Api.V2Api* | [**postTriggerLinkAction**](docs/V2Api.md#postTriggerLinkAction) | **POST** /triggers/{triggerName}/link-action | 
*Api.V2Api* | [**putAction**](docs/V2Api.md#putAction) | **PUT** /packages/{packageName}/actions/{actionName} | 
*Api.V2Api* | [**putPackage**](docs/V2Api.md#putPackage) | **PUT** /packages/{packageName} | 


## Documentation for Models

 - [Api.ActionExec](docs/ActionExec.md)
 - [Api.ActionLimits](docs/ActionLimits.md)
 - [Api.ActionMeta](docs/ActionMeta.md)
 - [Api.ActionPath](docs/ActionPath.md)
 - [Api.ActivationResult](docs/ActivationResult.md)
 - [Api.ActivationStatus](docs/ActivationStatus.md)
 - [Api.BasicTrigger](docs/BasicTrigger.md)
 - [Api.CloudIotCoreTrigger](docs/CloudIotCoreTrigger.md)
 - [Api.CronTrigger](docs/CronTrigger.md)
 - [Api.DeleteTriggerLinkActionRequest](docs/DeleteTriggerLinkActionRequest.md)
 - [Api.GetActionListResponse](docs/GetActionListResponse.md)
 - [Api.GetActionResponse](docs/GetActionResponse.md)
 - [Api.GetActivationDetailResponse](docs/GetActivationDetailResponse.md)
 - [Api.GetActivationListResponse](docs/GetActivationListResponse.md)
 - [Api.GetPackageListResponse](docs/GetPackageListResponse.md)
 - [Api.GetPackageResponse](docs/GetPackageResponse.md)
 - [Api.GetTriggerListResponse](docs/GetTriggerListResponse.md)
 - [Api.GetTriggerResponse](docs/GetTriggerResponse.md)
 - [Api.GithubCredential](docs/GithubCredential.md)
 - [Api.GithubTrigger](docs/GithubTrigger.md)
 - [Api.InsightLink](docs/InsightLink.md)
 - [Api.InsightTrigger](docs/InsightTrigger.md)
 - [Api.IotLink](docs/IotLink.md)
 - [Api.Link](docs/Link.md)
 - [Api.ObjectStorageLink](docs/ObjectStorageLink.md)
 - [Api.ObjectStorageTrigger](docs/ObjectStorageTrigger.md)
 - [Api.PackageMeta](docs/PackageMeta.md)
 - [Api.PostActionExternalLinkRequest](docs/PostActionExternalLinkRequest.md)
 - [Api.PostActionExternalLinkResponse](docs/PostActionExternalLinkResponse.md)
 - [Api.PostActionResponse](docs/PostActionResponse.md)
 - [Api.PostTriggerExternalLinkRequest](docs/PostTriggerExternalLinkRequest.md)
 - [Api.PostTriggerExternalLinkResponse](docs/PostTriggerExternalLinkResponse.md)
 - [Api.PostTriggerLinkActionRequest](docs/PostTriggerLinkActionRequest.md)
 - [Api.PostTriggerLinkActionResponse](docs/PostTriggerLinkActionResponse.md)
 - [Api.PutActionRequest](docs/PutActionRequest.md)
 - [Api.PutActionResponse](docs/PutActionResponse.md)
 - [Api.PutBasicTriggerRequest](docs/PutBasicTriggerRequest.md)
 - [Api.PutBasicTriggerResponse](docs/PutBasicTriggerResponse.md)
 - [Api.PutCloudInsightTriggerRequest](docs/PutCloudInsightTriggerRequest.md)
 - [Api.PutCloudInsightTriggerResponse](docs/PutCloudInsightTriggerResponse.md)
 - [Api.PutCloudIoTCoreTriggerRequest](docs/PutCloudIoTCoreTriggerRequest.md)
 - [Api.PutCloudIoTCoreTriggerResponse](docs/PutCloudIoTCoreTriggerResponse.md)
 - [Api.PutCronTriggerRequest](docs/PutCronTriggerRequest.md)
 - [Api.PutCronTriggerResponse](docs/PutCronTriggerResponse.md)
 - [Api.PutGithubTriggerRequest](docs/PutGithubTriggerRequest.md)
 - [Api.PutGithubTriggerResponse](docs/PutGithubTriggerResponse.md)
 - [Api.PutObjectStorageTriggerRequest](docs/PutObjectStorageTriggerRequest.md)
 - [Api.PutObjectStorageTriggerResponse](docs/PutObjectStorageTriggerResponse.md)
 - [Api.PutSourceCommitTriggerRequest](docs/PutSourceCommitTriggerRequest.md)
 - [Api.PutSourceCommitTriggerResponse](docs/PutSourceCommitTriggerResponse.md)
 - [Api.PutPackageRequest](docs/PutPackageRequest.md)
 - [Api.PutPackageResponse](docs/PutPackageResponse.md)
 - [Api.TriggerMeta](docs/TriggerMeta.md)
 - [Api.TriggerPath](docs/TriggerPath.md)
 - [Api.VPC](docs/VPC.md)


## Documentation for Authorization


### x-ncp-iam

- **Type**: API key
- **API key parameter name**: x-ncp-iam
- **Location**: HTTP header

---
_Source: https://npm.io/package/ncloud-cloudfunctions · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._