npm package: @fvpn/api
Description: OpenAPI client for @fvpn/api
Author: OpenAPI-Generator Contributors
Latest version: 1.3.4

## @fvpn/api@1.0.0

This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:

Environment
* Node.js
* Webpack
* Browserify

Language level
* ES5 - you must have a Promises/A+ library installed
* ES6

Module system
* CommonJS
* ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))

### Building

To build and compile the typescript sources to javascript use:
```
npm install
npm run build
```

### Publishing

First build the package then run `npm publish`

### Consuming

navigate to the folder of your consuming project and run one of the following commands.

_published:_

```
npm install @fvpn/api@1.0.0 --save
```

_unPublished (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
```

### Documentation for API Endpoints

All URIs are relative to *https://api.fvpn.io*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountApi* | [**approveDeviceCode**](docs/AccountApi.md#approvedevicecode) | **POST** /v1/account/codes/{code}/approve/ | Approve a device authentication code
*AccountApi* | [**createAccount**](docs/AccountApi.md#createaccount) | **POST** /v1/accounts/ | Create a new account
*AccountApi* | [**createDeviceCode**](docs/AccountApi.md#createdevicecode) | **POST** /v1/account/codes/ | Create a device authentication code
*AccountApi* | [**deleteCurrentAccount**](docs/AccountApi.md#deletecurrentaccount) | **DELETE** /v1/account/ | Delete the current account
*AccountApi* | [**getAccountTokenPair**](docs/AccountApi.md#getaccounttokenpair) | **POST** /v1/account/token/ | Get account token pair
*AccountApi* | [**getCurrentAccount**](docs/AccountApi.md#getcurrentaccount) | **GET** /v1/account/ | Retrieve the current account
*AccountApi* | [**getCurrentAccountBillingUsage**](docs/AccountApi.md#getcurrentaccountbillingusage) | **GET** /v1/account/billing-usage/ | Retrieve current account billing usage
*AccountApi* | [**getDeviceCode**](docs/AccountApi.md#getdevicecode) | **GET** /v1/account/codes/{code}/ | Check device code
*AccountApi* | [**refreshAccountToken**](docs/AccountApi.md#refreshaccounttoken) | **POST** /v1/account/token/refresh/ | Refresh account token
*BillingApi* | [**cancelSubscription**](docs/BillingApi.md#cancelsubscription) | **DELETE** /v1/billing/subscriptions/{subscription_id}/ | Cancel subscription
*BillingApi* | [**changeSubscriptionPlan**](docs/BillingApi.md#changesubscriptionplan) | **POST** /v1/billing/subscriptions/{subscription_id}/change-plan/ | Change subscription plan
*BillingApi* | [**deletePaymentMethod**](docs/BillingApi.md#deletepaymentmethod) | **DELETE** /v1/billing/payment-methods/{payment_method_id}/ | Delete a payment method
*BillingApi* | [**getBillingAccount**](docs/BillingApi.md#getbillingaccount) | **GET** /v1/billing/account/ | Retrieve the current account
*BillingApi* | [**getBillingOptions**](docs/BillingApi.md#getbillingoptions) | **GET** /v1/billing/options/ | Retrieve billing options
*BillingApi* | [**getCurrencies**](docs/BillingApi.md#getcurrencies) | **GET** /v1/billing/currencies/ | Retrieve all available currencies
*BillingApi* | [**getCurrentSubscription**](docs/BillingApi.md#getcurrentsubscription) | **GET** /v1/billing/current-subscription/ | Retrieve the current subscription
*BillingApi* | [**getCurrentWallet**](docs/BillingApi.md#getcurrentwallet) | **GET** /v1/billing/current-wallet/ | Retrieve the current wallet
*BillingApi* | [**getEntitlement**](docs/BillingApi.md#getentitlement) | **GET** /v1/billing/entitlements/{entitlement_id}/ | Retrieve a specific entitlement
*BillingApi* | [**getEntitlements**](docs/BillingApi.md#getentitlements) | **GET** /v1/billing/entitlements/ | List account entitlements
*BillingApi* | [**getPaymentMethod**](docs/BillingApi.md#getpaymentmethod) | **GET** /v1/billing/payment-methods/{payment_method_id}/ | Retrieve a payment method
*BillingApi* | [**getPaymentMethods**](docs/BillingApi.md#getpaymentmethods) | **GET** /v1/billing/payment-methods/ | List all payment methods
*BillingApi* | [**getPlanBySlug**](docs/BillingApi.md#getplanbyslug) | **GET** /v1/billing/plans/{slug}/ | Retrieve a plan
*BillingApi* | [**getPlanTimeline**](docs/BillingApi.md#getplantimeline) | **GET** /v1/billing/plans/timeline/ | Get billing timeline for a plan
*BillingApi* | [**getPlans**](docs/BillingApi.md#getplans) | **GET** /v1/billing/plans/ | List all plans
*BillingApi* | [**getSubscription**](docs/BillingApi.md#getsubscription) | **GET** /v1/billing/subscriptions/{subscription_id}/ | Retrieve subscription
*BillingApi* | [**getSubscriptions**](docs/BillingApi.md#getsubscriptions) | **GET** /v1/billing/subscriptions/ | List subscriptions
*BillingApi* | [**getWallet**](docs/BillingApi.md#getwallet) | **GET** /v1/billing/wallets/{wallet_id}/ | Retrieve wallet details
*BillingApi* | [**getWalletTransaction**](docs/BillingApi.md#getwallettransaction) | **GET** /v1/billing/transactions/{transaction_id}/ | Retrieve transaction details
*BillingApi* | [**getWalletTransactions**](docs/BillingApi.md#getwallettransactions) | **GET** /v1/billing/transactions/ | List wallet transactions
*BillingApi* | [**getWallets**](docs/BillingApi.md#getwallets) | **GET** /v1/billing/wallets/ | List wallets
*BillingApi* | [**reactivateSubscription**](docs/BillingApi.md#reactivatesubscription) | **POST** /v1/billing/subscriptions/{subscription_id}/reactivate/ | Reactivate subscription
*BillingApi* | [**setDefaultPaymentMethod**](docs/BillingApi.md#setdefaultpaymentmethod) | **POST** /v1/billing/account/set-default-payment-method/ | Set the default payment method for the account
*BillingApi* | [**subscribeToPlan**](docs/BillingApi.md#subscribetoplan) | **POST** /v1/billing/subscriptions/ | Subscribe to a plan
*CloudpaymentsApi* | [**completeCloudpaymentsPaymentMethodThreeDs**](docs/CloudpaymentsApi.md#completecloudpaymentspaymentmethodthreeds) | **POST** /v1/billing/cloudpayments/payment-methods/{payment_method_id}/complete-3ds/ | Complete 3D Secure authentication
*CloudpaymentsApi* | [**createCloudpaymentsPaymentMethod**](docs/CloudpaymentsApi.md#createcloudpaymentspaymentmethod) | **POST** /v1/billing/cloudpayments/payment-methods/ | Create a new payment method
*CloudpaymentsApi* | [**getCloudpaymentsPaymentMethod**](docs/CloudpaymentsApi.md#getcloudpaymentspaymentmethod) | **GET** /v1/billing/cloudpayments/payment-methods/{payment_method_id}/ | Retrieve a payment method
*DeviceApi* | [**createDevice**](docs/DeviceApi.md#createdevice) | **POST** /v1/devices/ | Create a new account
*DeviceApi* | [**deleteDevice**](docs/DeviceApi.md#deletedevice) | **DELETE** /v1/devices/{device_id}/ | Delete a device
*DeviceApi* | [**getDashboardAnalytics**](docs/DeviceApi.md#getdashboardanalytics) | **GET** /v1/devices/analytics/dashboard/ | Get device data usage analytics for dashboard
*DeviceApi* | [**getDevice**](docs/DeviceApi.md#getdevice) | **GET** /v1/devices/{device_id}/ | Retrieve a device
*DeviceApi* | [**getDeviceAnalytics**](docs/DeviceApi.md#getdeviceanalytics) | **GET** /v1/devices/{device_id}/analytics/ | Get data usage analytics for a specific device
*DeviceApi* | [**getDeviceNode**](docs/DeviceApi.md#getdevicenode) | **GET** /v1/devices/{device_id}/node/ | Get the node of a device
*DeviceApi* | [**getDevices**](docs/DeviceApi.md#getdevices) | **GET** /v1/devices/ | List all devices
*DeviceApi* | [**partialUpdateDevice**](docs/DeviceApi.md#partialupdatedevice) | **PATCH** /v1/devices/{device_id}/ | Partially update a device
*DeviceApi* | [**setDeviceNode**](docs/DeviceApi.md#setdevicenode) | **POST** /v1/devices/{device_id}/set-node/ | Set a node on a device
*DeviceApi* | [**updateDevice**](docs/DeviceApi.md#updatedevice) | **PUT** /v1/devices/{device_id}/ | Update a device
*GeoApi* | [**getCountries**](docs/GeoApi.md#getcountries) | **GET** /v1/countries/ | List countries
*GeoApi* | [**getCountry**](docs/GeoApi.md#getcountry) | **GET** /v1/countries/{country_id}/ | Retrieve country
*GeoApi* | [**getLocation**](docs/GeoApi.md#getlocation) | **GET** /v1/locations/{place_id}/ | Retrieve location
*GeoApi* | [**getLocations**](docs/GeoApi.md#getlocations) | **GET** /v1/locations/ | List locations
*GeoApi* | [**getRegion**](docs/GeoApi.md#getregion) | **GET** /v1/regions/{region_id}/ | Retrieve region
*GeoApi* | [**getRegions**](docs/GeoApi.md#getregions) | **GET** /v1/regions/ | List regions
*NodeApi* | [**createNode**](docs/NodeApi.md#createnode) | **POST** /v1/nodes/ | Create a new node
*NodeApi* | [**createNodeCondition**](docs/NodeApi.md#createnodecondition) | **POST** /v1/nodes/{node_id}/conditions/ | Create a new node condition
*NodeApi* | [**createNodeDataUsageReport**](docs/NodeApi.md#createnodedatausagereport) | **POST** /v1/nodes/{node_id}/data-usage-report/ | Create a new node data usage
*NodeApi* | [**deleteNode**](docs/NodeApi.md#deletenode) | **DELETE** /v1/nodes/{node_id}/ | Delete a node
*NodeApi* | [**getNode**](docs/NodeApi.md#getnode) | **GET** /v1/nodes/{node_id}/ | Retrieve a node
*NodeApi* | [**getNodeConditions**](docs/NodeApi.md#getnodeconditions) | **GET** /v1/nodes/{node_id}/conditions/ | List node conditions
*NodeApi* | [**getNodeDevices**](docs/NodeApi.md#getnodedevices) | **GET** /v1/nodes/{node_id}/devices/ | List node devices
*NodeApi* | [**getNodes**](docs/NodeApi.md#getnodes) | **GET** /v1/nodes/ | List nodes
*NodeApi* | [**partialUpdateNode**](docs/NodeApi.md#partialupdatenode) | **PATCH** /v1/nodes/{node_id}/ | Partially update a device
*NodeApi* | [**updateNode**](docs/NodeApi.md#updatenode) | **PUT** /v1/nodes/{node_id}/ | Update a node
*ProviderApi* | [**getProvider**](docs/ProviderApi.md#getprovider) | **GET** /v1/providers/{provider_id}/ | Retrieve a provider
*ProviderApi* | [**getProviders**](docs/ProviderApi.md#getproviders) | **GET** /v1/providers/ | List all providers
*StripeApi* | [**createStripeSetupIntent**](docs/StripeApi.md#createstripesetupintent) | **POST** /v1/billing/stripe/setup-intents/ | Create a new stripe setup intent


### Documentation For Models

 - [ASN](docs/ASN.md)
 - [ASNRequest](docs/ASNRequest.md)
 - [Account](docs/Account.md)
 - [AccountStatus](docs/AccountStatus.md)
 - [AccountTokenPair](docs/AccountTokenPair.md)
 - [AccountTokenPairRequest](docs/AccountTokenPairRequest.md)
 - [AccountTokenRefresh](docs/AccountTokenRefresh.md)
 - [AccountTokenRefreshRequest](docs/AccountTokenRefreshRequest.md)
 - [BillingAccount](docs/BillingAccount.md)
 - [BillingDataQuota](docs/BillingDataQuota.md)
 - [BillingDeviceQuota](docs/BillingDeviceQuota.md)
 - [BillingOptions](docs/BillingOptions.md)
 - [BillingPeriod](docs/BillingPeriod.md)
 - [BillingUsage](docs/BillingUsage.md)
 - [CloudPaymentsCardDetails](docs/CloudPaymentsCardDetails.md)
 - [CloudPaymentsPaymentMethod](docs/CloudPaymentsPaymentMethod.md)
 - [CloudPaymentsPaymentMethodCreateRequest](docs/CloudPaymentsPaymentMethodCreateRequest.md)
 - [CloudPaymentsThreeDSecure](docs/CloudPaymentsThreeDSecure.md)
 - [CloudPaymentsThreeDSecureCompleteRequest](docs/CloudPaymentsThreeDSecureCompleteRequest.md)
 - [ComparisonData](docs/ComparisonData.md)
 - [Condition](docs/Condition.md)
 - [ConnectionStatus](docs/ConnectionStatus.md)
 - [Country](docs/Country.md)
 - [CountryRequest](docs/CountryRequest.md)
 - [Currency](docs/Currency.md)
 - [DashboardAnalytics](docs/DashboardAnalytics.md)
 - [DataPoint](docs/DataPoint.md)
 - [Device](docs/Device.md)
 - [DeviceAnalytics](docs/DeviceAnalytics.md)
 - [DeviceAnalyticsDevice](docs/DeviceAnalyticsDevice.md)
 - [DeviceCode](docs/DeviceCode.md)
 - [DeviceCodeRequest](docs/DeviceCodeRequest.md)
 - [DeviceCodeStatus](docs/DeviceCodeStatus.md)
 - [DeviceData](docs/DeviceData.md)
 - [DeviceDataUsage](docs/DeviceDataUsage.md)
 - [DeviceDataUsageRequest](docs/DeviceDataUsageRequest.md)
 - [DeviceRequest](docs/DeviceRequest.md)
 - [Entitlement](docs/Entitlement.md)
 - [IPInfo](docs/IPInfo.md)
 - [IPInfoRequest](docs/IPInfoRequest.md)
 - [Interval](docs/Interval.md)
 - [Invoice](docs/Invoice.md)
 - [InvoiceLine](docs/InvoiceLine.md)
 - [InvoiceStatus](docs/InvoiceStatus.md)
 - [InvoiceTotalDetails](docs/InvoiceTotalDetails.md)
 - [Location](docs/Location.md)
 - [LocationRegion](docs/LocationRegion.md)
 - [LocationRegionRequest](docs/LocationRegionRequest.md)
 - [LocationRequest](docs/LocationRequest.md)
 - [ManagedBy](docs/ManagedBy.md)
 - [Node](docs/Node.md)
 - [NodeCondition](docs/NodeCondition.md)
 - [NodeConditionRequest](docs/NodeConditionRequest.md)
 - [NodeConditionsRequest](docs/NodeConditionsRequest.md)
 - [NodeDataUsageItemRequest](docs/NodeDataUsageItemRequest.md)
 - [NodeDataUsageReportRequest](docs/NodeDataUsageReportRequest.md)
 - [NodeDevice](docs/NodeDevice.md)
 - [NodeRequest](docs/NodeRequest.md)
 - [NodeStatus](docs/NodeStatus.md)
 - [Null](docs/Null.md)
 - [PaginatedDeviceList](docs/PaginatedDeviceList.md)
 - [PaginatedLocationList](docs/PaginatedLocationList.md)
 - [PaginatedNodeList](docs/PaginatedNodeList.md)
 - [PaginatedPaymentMethodList](docs/PaginatedPaymentMethodList.md)
 - [PaginatedProviderList](docs/PaginatedProviderList.md)
 - [PaginatedSubscriptionList](docs/PaginatedSubscriptionList.md)
 - [PaginatedWalletList](docs/PaginatedWalletList.md)
 - [PaginatedWalletTransactionList](docs/PaginatedWalletTransactionList.md)
 - [PatchedDeviceRequest](docs/PatchedDeviceRequest.md)
 - [PatchedNodeRequest](docs/PatchedNodeRequest.md)
 - [PaymentMethod](docs/PaymentMethod.md)
 - [PaymentMethodCard](docs/PaymentMethodCard.md)
 - [Period](docs/Period.md)
 - [Plan](docs/Plan.md)
 - [PlanPrice](docs/PlanPrice.md)
 - [PriceDiffInfo](docs/PriceDiffInfo.md)
 - [Provider](docs/Provider.md)
 - [ProviderDetail](docs/ProviderDetail.md)
 - [Region](docs/Region.md)
 - [RegionDetail](docs/RegionDetail.md)
 - [SetDefaultPaymentMethodRequest](docs/SetDefaultPaymentMethodRequest.md)
 - [SetNodeRequest](docs/SetNodeRequest.md)
 - [StripeSetupIntent](docs/StripeSetupIntent.md)
 - [Subscription](docs/Subscription.md)
 - [SubscriptionChangePlanRequest](docs/SubscriptionChangePlanRequest.md)
 - [SubscriptionCreationRequest](docs/SubscriptionCreationRequest.md)
 - [SubscriptionPendingUpdate](docs/SubscriptionPendingUpdate.md)
 - [SubscriptionStatus](docs/SubscriptionStatus.md)
 - [SummaryPeriod](docs/SummaryPeriod.md)
 - [Timeline](docs/Timeline.md)
 - [TimelineEvent](docs/TimelineEvent.md)
 - [TimelineEventType](docs/TimelineEventType.md)
 - [TopDevices](docs/TopDevices.md)
 - [TransactionType](docs/TransactionType.md)
 - [Type](docs/Type.md)
 - [Wallet](docs/Wallet.md)
 - [WalletStatus](docs/WalletStatus.md)
 - [WalletTransaction](docs/WalletTransaction.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="apiKey"></a>
### apiKey

- **Type**: API key
- **API key parameter name**: X-API-Key
- **Location**: HTTP header

<a id="bearerToken"></a>
### bearerToken

- **Type**: Bearer authentication