@fvpn/[email protected]

This generator creates TypeScript/JavaScript client that utilizes 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)

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/[email protected] --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 | POST /v1/account/codes/{code}/approve/ | Approve a device authentication code AccountApi | createAccount | POST /v1/accounts/ | Create a new account AccountApi | createDeviceCode | POST /v1/account/codes/ | Create a device authentication code AccountApi | deleteCurrentAccount | DELETE /v1/account/ | Delete the current account AccountApi | getAccountTokenPair | POST /v1/account/token/ | Get account token pair AccountApi | getCurrentAccount | GET /v1/account/ | Retrieve the current account AccountApi | getCurrentAccountBillingUsage | GET /v1/account/billing-usage/ | Retrieve current account billing usage AccountApi | getDeviceCode | GET /v1/account/codes/{code}/ | Check device code AccountApi | refreshAccountToken | POST /v1/account/token/refresh/ | Refresh account token BillingApi | cancelSubscription | DELETE /v1/billing/subscriptions/{subscription_id}/ | Cancel subscription BillingApi | changeSubscriptionPlan | POST /v1/billing/subscriptions/{subscription_id}/change-plan/ | Change subscription plan BillingApi | deletePaymentMethod | DELETE /v1/billing/payment-methods/{payment_method_id}/ | Delete a payment method BillingApi | getBillingAccount | GET /v1/billing/account/ | Retrieve the current account BillingApi | getBillingOptions | GET /v1/billing/options/ | Retrieve billing options BillingApi | getCurrencies | GET /v1/billing/currencies/ | Retrieve all available currencies BillingApi | getCurrentSubscription | GET /v1/billing/current-subscription/ | Retrieve the current subscription BillingApi | getCurrentWallet | GET /v1/billing/current-wallet/ | Retrieve the current wallet BillingApi | getEntitlement | GET /v1/billing/entitlements/{entitlement_id}/ | Retrieve a specific entitlement BillingApi | getEntitlements | GET /v1/billing/entitlements/ | List account entitlements BillingApi | getPaymentMethod | GET /v1/billing/payment-methods/{payment_method_id}/ | Retrieve a payment method BillingApi | getPaymentMethods | GET /v1/billing/payment-methods/ | List all payment methods BillingApi | getPlanBySlug | GET /v1/billing/plans/{slug}/ | Retrieve a plan BillingApi | getPlanTimeline | GET /v1/billing/plans/timeline/ | Get billing timeline for a plan BillingApi | getPlans | GET /v1/billing/plans/ | List all plans BillingApi | getSubscription | GET /v1/billing/subscriptions/{subscription_id}/ | Retrieve subscription BillingApi | getSubscriptions | GET /v1/billing/subscriptions/ | List subscriptions BillingApi | getWallet | GET /v1/billing/wallets/{wallet_id}/ | Retrieve wallet details BillingApi | getWalletTransaction | GET /v1/billing/transactions/{transaction_id}/ | Retrieve transaction details BillingApi | getWalletTransactions | GET /v1/billing/transactions/ | List wallet transactions BillingApi | getWallets | GET /v1/billing/wallets/ | List wallets BillingApi | reactivateSubscription | POST /v1/billing/subscriptions/{subscription_id}/reactivate/ | Reactivate subscription BillingApi | setDefaultPaymentMethod | POST /v1/billing/account/set-default-payment-method/ | Set the default payment method for the account BillingApi | subscribeToPlan | POST /v1/billing/subscriptions/ | Subscribe to a plan CloudpaymentsApi | completeCloudpaymentsPaymentMethodThreeDs | POST /v1/billing/cloudpayments/payment-methods/{payment_method_id}/complete-3ds/ | Complete 3D Secure authentication CloudpaymentsApi | createCloudpaymentsPaymentMethod | POST /v1/billing/cloudpayments/payment-methods/ | Create a new payment method CloudpaymentsApi | getCloudpaymentsPaymentMethod | GET /v1/billing/cloudpayments/payment-methods/{payment_method_id}/ | Retrieve a payment method DeviceApi | createDevice | POST /v1/devices/ | Create a new account DeviceApi | deleteDevice | DELETE /v1/devices/{device_id}/ | Delete a device DeviceApi | getDashboardAnalytics | GET /v1/devices/analytics/dashboard/ | Get device data usage analytics for dashboard DeviceApi | getDevice | GET /v1/devices/{device_id}/ | Retrieve a device DeviceApi | getDeviceAnalytics | GET /v1/devices/{device_id}/analytics/ | Get data usage analytics for a specific device DeviceApi | getDeviceNode | GET /v1/devices/{device_id}/node/ | Get the node of a device DeviceApi | getDevices | GET /v1/devices/ | List all devices DeviceApi | partialUpdateDevice | PATCH /v1/devices/{device_id}/ | Partially update a device DeviceApi | setDeviceNode | POST /v1/devices/{device_id}/set-node/ | Set a node on a device DeviceApi | updateDevice | PUT /v1/devices/{device_id}/ | Update a device GeoApi | getCountries | GET /v1/countries/ | List countries GeoApi | getCountry | GET /v1/countries/{country_id}/ | Retrieve country GeoApi | getLocation | GET /v1/locations/{place_id}/ | Retrieve location GeoApi | getLocations | GET /v1/locations/ | List locations GeoApi | getRegion | GET /v1/regions/{region_id}/ | Retrieve region GeoApi | getRegions | GET /v1/regions/ | List regions NodeApi | createNode | POST /v1/nodes/ | Create a new node NodeApi | createNodeCondition | POST /v1/nodes/{node_id}/conditions/ | Create a new node condition NodeApi | createNodeDataUsageReport | POST /v1/nodes/{node_id}/data-usage-report/ | Create a new node data usage NodeApi | deleteNode | DELETE /v1/nodes/{node_id}/ | Delete a node NodeApi | getNode | GET /v1/nodes/{node_id}/ | Retrieve a node NodeApi | getNodeConditions | GET /v1/nodes/{node_id}/conditions/ | List node conditions NodeApi | getNodeDevices | GET /v1/nodes/{node_id}/devices/ | List node devices NodeApi | getNodes | GET /v1/nodes/ | List nodes NodeApi | partialUpdateNode | PATCH /v1/nodes/{node_id}/ | Partially update a device NodeApi | updateNode | PUT /v1/nodes/{node_id}/ | Update a node ProviderApi | getProvider | GET /v1/providers/{provider_id}/ | Retrieve a provider ProviderApi | getProviders | GET /v1/providers/ | List all providers StripeApi | createStripeSetupIntent | POST /v1/billing/stripe/setup-intents/ | Create a new stripe setup intent

Documentation For Models

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

Documentation For Authorization

Authentication schemes defined for the API:

apiKey

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

bearerToken

• Type: Bearer authentication