Skip to content

Latest commit

 

History

History
1771 lines (1221 loc) · 45.4 KB

AdminApi.md

File metadata and controls

1771 lines (1221 loc) · 45.4 KB
Raw

AdminApi

All URIs are relative to https://v2.namsor.com/NamSorAPIv2

Method HTTP request Description
AddCredits GET /api2/json/addCredits/{apiKey}/{usageCredits}/{userMessage} Add usage credits to an API Key.
Anonymize GET /api2/json/anonymize/{source}/{anonymized} Activate/deactivate anonymization for a source.
ApiStatus GET /api2/json/apiStatus Prints the current status of the classifiers.
ApiUsage GET /api2/json/apiUsage Print current API usage.
ApiUsageHistory GET /api2/json/apiUsageHistory Print historical API usage.
ApiUsageHistoryAggregate GET /api2/json/apiUsageHistoryAggregate Print historical API usage (in an aggregated view, by service, by day/hour/min).
AvailablePlans GET /api2/json/availablePlans List all available plans in the default currency (usd).
AvailablePlans1 GET /api2/json/availablePlans/{token} List all available plans in the user's preferred currency.
AvailableServices GET /api2/json/apiServices List of API services and usage cost in Units (default is 1=ONE Unit).
BillingCurrencies GET /api2/json/billingCurrencies List possible currency options for billing (USD, EUR, GBP, ...)
BillingHistory GET /api2/json/billingHistory/{token} Read the history billing information (invoices paid via Stripe or manually).
BillingInfo GET /api2/json/billingInfo/{token} Read the billing information (company name, address, phone, vat ID)
Charge POST /api2/json/charge Create a Stripe Customer, based on a payment card token (from secure StripeJS) and email.
CorporateKey GET /api2/json/corporateKey/{apiKey}/{corporate} Setting an API Key to a corporate status.
DebugLevel GET /api2/json/debugLevel/{logger}/{level} Update debug level for a classifier
Flush GET /api2/json/flush Flush counters.
InvalidateCache GET /api2/json/invalidateCache Invalidate system caches.
Learnable GET /api2/json/learnable/{source}/{learnable} Activate/deactivate learning from a source.
NamsorCounter GET /api2/json/namsorCounter Get the overall API counter
PaymentInfo GET /api2/json/paymentInfo/{token} Get the Stripe payment information associated with the current google auth session token.
ProcureKey GET /api2/json/procureKey/{token} Procure an API Key (sent via Email), based on an auth token. Keep your API Key secret.
RedeployUI GET /api2/json/redeployUI Redeploy UI from current dev branch.
RedeployUI1 GET /api2/json/redeployUI/{live} Redeploy UI from current dev branch.
RemoveUserAccount GET /api2/json/removeUserAccount/{token} Remove the user account.
RemoveUserAccountOnBehalf GET /api2/json/removeUserAccountOnBehalf/{apiKey} Remove (on behalf) a user account.
Shutdown GET /api2/json/shutdown Stop learning and shutdown system.
SoftwareVersion GET /api2/json/softwareVersion Get the current software version
SourceStats GET /api2/json/sourceStats/{source} Print basic source statistics.
Stats GET /api2/json/stats Print basic system statistics.
StripeConnect GET /api2/json/stripeConnect Connects a Stripe Account.
SubscribePlan GET /api2/json/subscribePlan/{planName}/{token} Subscribe to a give API plan, using the user's preferred or default currency.
SubscribePlanOnBehalf GET /api2/json/subscribePlanOnBehalf/{planName}/{apiKey} Subscribe to a give API plan, using the user's preferred or default currency (admin only).
TaxonomyClasses GET /api2/json/taxonomyClasses/{classifierName} Print the taxonomy classes valid for the given classifier.
UpdateBillingInfo POST /api2/json/updateBillingInfo/{token} Sets or update the billing information (company name, address, phone, vat ID)
UpdateLimit GET /api2/json/updateLimit/{usageLimit}/{hardOrSoft}/{token} Modifies the hard/soft limit on the API plan's overages (default is 0$ soft limit).
UpdatePaymentDefault GET /api2/json/updatePaymentDefault/{defautSourceId}/{token} Update the default Stripe card associated with the current google auth session token.
UserInfo GET /api2/json/userInfo/{token} Get the user profile associated with the current google auth session token.
VerifyEmail GET /api2/json/verifyEmail/{emailToken} Verifies an email, based on token sent to that email
VerifyRemoveEmail GET /api2/json/verifyRemoveEmail/{emailToken} Verifies an email, based on token sent to that email
Vet GET /api2/json/vetting/{source}/{vetted} Vetting of a source.

AddCredits

SystemMetricsOut AddCredits(api.key, usage.credits, user.message)

Add usage credits to an API Key.

Example

library(namsor)

var.api.key <- 'api.key_example' # character | 
var.usage.credits <- 56 # integer | 
var.user.message <- 'user.message_example' # character | 

#Add usage credits to an API Key.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$AddCredits(var.api.key, var.usage.credits, var.user.message)
dput(result)

Parameters

Name Type Description Notes
api.key character
usage.credits integer
user.message character

Return type

SystemMetricsOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Estimate new after applying credits. -
401 Missing or incorrect API Key -

Anonymize

Anonymize(source, anonymized)

Activate/deactivate anonymization for a source.

Example

library(namsor)

var.source <- 'source_example' # character | 
var.anonymized <- 'anonymized_example' # character | 

#Activate/deactivate anonymization for a source.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
api.instance$Anonymize(var.source, var.anonymized)

Parameters

Name Type Description Notes
source character
anonymized character

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Anonymization of a source. -
401 Missing or incorrect API Key -

ApiStatus

APIPlansOut ApiStatus()

Prints the current status of the classifiers.

Example

library(namsor)


#Prints the current status of the classifiers.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ApiStatus()
dput(result)

Parameters

This endpoint does not need any parameter.

Return type

APIPlansOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Available classifiers and status -
401 Missing or incorrect token -

ApiUsage

APIPeriodUsageOut ApiUsage()

Print current API usage.

Example

library(namsor)


#Print current API usage.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ApiUsage()
dput(result)

Parameters

This endpoint does not need any parameter.

Return type

APIPeriodUsageOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Print current API usage. -
401 Missing or incorrect API Key -

ApiUsageHistory

APIPeriodUsageOut ApiUsageHistory()

Print historical API usage.

Example

library(namsor)


#Print historical API usage.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ApiUsageHistory()
dput(result)

Parameters

This endpoint does not need any parameter.

Return type

APIPeriodUsageOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Print historical API usage. -
401 Missing or incorrect API Key -

ApiUsageHistoryAggregate

APIPeriodUsageOut ApiUsageHistoryAggregate()

Print historical API usage (in an aggregated view, by service, by day/hour/min).

Example

library(namsor)


#Print historical API usage (in an aggregated view, by service, by day/hour/min).
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ApiUsageHistoryAggregate()
dput(result)

Parameters

This endpoint does not need any parameter.

Return type

APIPeriodUsageOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Print historical API usage. -
401 Missing or incorrect API Key -

AvailablePlans

APIPlansOut AvailablePlans()

List all available plans in the default currency (usd).

Example

library(namsor)


#List all available plans in the default currency (usd).
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$AvailablePlans()
dput(result)

Parameters

This endpoint does not need any parameter.

Return type

APIPlansOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Available plans -
401 Missing or incorrect token -

AvailablePlans1

APIPlansOut AvailablePlans1(token)

List all available plans in the user's preferred currency.

Example

library(namsor)

var.token <- 'token_example' # character | 

#List all available plans in the user's preferred currency.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$AvailablePlans1(var.token)
dput(result)

Parameters

Name Type Description Notes
token character

Return type

APIPlansOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Available plans -
401 Missing or incorrect token -

AvailableServices

APIPlansOut AvailableServices()

List of API services and usage cost in Units (default is 1=ONE Unit).

Example

library(namsor)


#List of API services and usage cost in Units (default is 1=ONE Unit).
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$AvailableServices()
dput(result)

Parameters

This endpoint does not need any parameter.

Return type

APIPlansOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Available services -
401 Missing or incorrect token -

BillingCurrencies

CurrenciesOut BillingCurrencies()

List possible currency options for billing (USD, EUR, GBP, ...)

Example

library(namsor)


#List possible currency options for billing (USD, EUR, GBP, ...)
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$BillingCurrencies()
dput(result)

Parameters

This endpoint does not need any parameter.

Return type

CurrenciesOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 The supported billing currencies. -
401 Missing or incorrect token -

BillingHistory

BillingHistoryOut BillingHistory(token)

Read the history billing information (invoices paid via Stripe or manually).

Example

library(namsor)

var.token <- 'token_example' # character | 

#Read the history billing information (invoices paid via Stripe or manually).
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$BillingHistory(var.token)
dput(result)

Parameters

Name Type Description Notes
token character

Return type

BillingHistoryOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 The billing history -
401 Missing or incorrect token -

BillingInfo

BillingInfoInOut BillingInfo(token)

Read the billing information (company name, address, phone, vat ID)

Example

library(namsor)

var.token <- 'token_example' # character | 

#Read the billing information (company name, address, phone, vat ID)
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$BillingInfo(var.token)
dput(result)

Parameters

Name Type Description Notes
token character

Return type

BillingInfoInOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 The current billing info -
401 Missing or incorrect token -

Charge

APIKeyOut Charge(inline.object=var.inline.object)

Create a Stripe Customer, based on a payment card token (from secure StripeJS) and email.

Example

library(namsor)

var.inline.object <- inline_object$new("stripeToken_example", "stripeEmail_example") # InlineObject | 

#Create a Stripe Customer, based on a payment card token (from secure StripeJS) and email.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Charge(inline.object=var.inline.object)
dput(result)

Parameters

Name Type Description Notes
inline.object InlineObject [optional]

Return type

APIKeyOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A stripe customerID -
401 Missing or incorrect email or payment token -

CorporateKey

CorporateKey(api.key, corporate)

Setting an API Key to a corporate status.

Example

library(namsor)

var.api.key <- 'api.key_example' # character | 
var.corporate <- 'corporate_example' # character | 

#Setting an API Key to a corporate status.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
api.instance$CorporateKey(var.api.key, var.corporate)

Parameters

Name Type Description Notes
api.key character
corporate character

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 API Key set to a corporate status. -
401 Missing or incorrect API Key -

DebugLevel

DebugLevel(logger, level)

Update debug level for a classifier

Example

library(namsor)

var.logger <- 'logger_example' # character | 
var.level <- 'level_example' # character | 

#Update debug level for a classifier
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
api.instance$DebugLevel(var.logger, var.level)

Parameters

Name Type Description Notes
logger character
level character

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
401 Missing or incorrect API Key -

Flush

Flush()

Flush counters.

Example

library(namsor)


#Flush counters.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
api.instance$Flush()

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Flush API Key caches. -
401 Missing or incorrect API Key -

InvalidateCache

InvalidateCache()

Invalidate system caches.

Example

library(namsor)


#Invalidate system caches.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
api.instance$InvalidateCache()

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Clear caches. -
401 Missing or incorrect API Key -

Learnable

Learnable(source, learnable)

Activate/deactivate learning from a source.

Example

library(namsor)

var.source <- 'source_example' # character | 
var.learnable <- 'learnable_example' # character | 

#Activate/deactivate learning from a source.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
api.instance$Learnable(var.source, var.learnable)

Parameters

Name Type Description Notes
source character
learnable character

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Vetting of a source. -
401 Missing or incorrect API Key -

NamsorCounter

SoftwareVersionOut NamsorCounter()

Get the overall API counter

Example

library(namsor)


#Get the overall API counter
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$NamsorCounter()
dput(result)

Parameters

This endpoint does not need any parameter.

Return type

SoftwareVersionOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 The overall API counter -
401 Missing or incorrect token -

PaymentInfo

APIKeyOut PaymentInfo(token)

Get the Stripe payment information associated with the current google auth session token.

Example

library(namsor)

var.token <- 'token_example' # character | 

#Get the Stripe payment information associated with the current google auth session token.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$PaymentInfo(var.token)
dput(result)

Parameters

Name Type Description Notes
token character

Return type

APIKeyOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An session token -
401 Missing or incorrect token -

ProcureKey

APIKeyOut ProcureKey(token)

Procure an API Key (sent via Email), based on an auth token. Keep your API Key secret.

Example

library(namsor)

var.token <- 'token_example' # character | 

#Procure an API Key (sent via Email), based on an auth token. Keep your API Key secret.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ProcureKey(var.token)
dput(result)

Parameters

Name Type Description Notes
token character

Return type

APIKeyOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An API Key -
401 Missing or incorrect token -

RedeployUI

RedeployUI()

Redeploy UI from current dev branch.

Example

library(namsor)


#Redeploy UI from current dev branch.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
api.instance$RedeployUI()

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Redeploy UI from DEV. -
401 Missing or incorrect API Key -

RedeployUI1

RedeployUI1(live)

Redeploy UI from current dev branch.

Example

library(namsor)

var.live <- 'live_example' # character | 

#Redeploy UI from current dev branch.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
api.instance$RedeployUI1(var.live)

Parameters

Name Type Description Notes
live character

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Redeploy UI from DEV. -
401 Missing or incorrect API Key -

RemoveUserAccount

APIPlanSubscriptionOut RemoveUserAccount(token)

Remove the user account.

Example

library(namsor)

var.token <- 'token_example' # character | 

#Remove the user account.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$RemoveUserAccount(var.token)
dput(result)

Parameters

Name Type Description Notes
token character

Return type

APIPlanSubscriptionOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An API subscription -
401 Missing or incorrect token -

RemoveUserAccountOnBehalf

APIPlanSubscriptionOut RemoveUserAccountOnBehalf(api.key)

Remove (on behalf) a user account.

Example

library(namsor)

var.api.key <- 'api.key_example' # character | 

#Remove (on behalf) a user account.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$RemoveUserAccountOnBehalf(var.api.key)
dput(result)

Parameters

Name Type Description Notes
api.key character

Return type

APIPlanSubscriptionOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An API subscription -
401 Missing or incorrect token -

Shutdown

Shutdown()

Stop learning and shutdown system.

Example

library(namsor)


#Stop learning and shutdown system.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
api.instance$Shutdown()

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Shutdown AI. -
401 Missing or incorrect API Key -

SoftwareVersion

SoftwareVersionOut SoftwareVersion()

Get the current software version

Example

library(namsor)


#Get the current software version
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SoftwareVersion()
dput(result)

Parameters

This endpoint does not need any parameter.

Return type

SoftwareVersionOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 The current software version -
401 Missing or incorrect token -

SourceStats

SystemMetricsOut SourceStats(source)

Print basic source statistics.

Example

library(namsor)

var.source <- 'source_example' # character | 

#Print basic source statistics.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SourceStats(var.source)
dput(result)

Parameters

Name Type Description Notes
source character

Return type

SystemMetricsOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Current system status. -
401 Missing or incorrect API Key -

Stats

SystemMetricsOut Stats()

Print basic system statistics.

Example

library(namsor)


#Print basic system statistics.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Stats()
dput(result)

Parameters

This endpoint does not need any parameter.

Return type

SystemMetricsOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Current system status. -
401 Missing or incorrect API Key -

StripeConnect

StripeConnect(scope=var.scope, code=var.code, error=var.error, error.description=var.error.description)

Connects a Stripe Account.

Example

library(namsor)

var.scope <- 'scope_example' # character | 
var.code <- 'code_example' # character | 
var.error <- 'error_example' # character | 
var.error.description <- 'error.description_example' # character | 

#Connects a Stripe Account.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
api.instance$StripeConnect(scope=var.scope, code=var.code, error=var.error, error.description=var.error.description)

Parameters

Name Type Description Notes
scope character [optional]
code character [optional]
error character [optional]
error.description character [optional]

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
401 Missing or incorrect email or payment token -

SubscribePlan

APIPlanSubscriptionOut SubscribePlan(plan.name, token)

Subscribe to a give API plan, using the user's preferred or default currency.

Example

library(namsor)

var.plan.name <- 'plan.name_example' # character | 
var.token <- 'token_example' # character | 

#Subscribe to a give API plan, using the user's preferred or default currency.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SubscribePlan(var.plan.name, var.token)
dput(result)

Parameters

Name Type Description Notes
plan.name character
token character

Return type

APIPlanSubscriptionOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An API subscription -
401 Missing or incorrect token -

SubscribePlanOnBehalf

APIPlanSubscriptionOut SubscribePlanOnBehalf(plan.name, api.key)

Subscribe to a give API plan, using the user's preferred or default currency (admin only).

Example

library(namsor)

var.plan.name <- 'plan.name_example' # character | 
var.api.key <- 'api.key_example' # character | 

#Subscribe to a give API plan, using the user's preferred or default currency (admin only).
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SubscribePlanOnBehalf(var.plan.name, var.api.key)
dput(result)

Parameters

Name Type Description Notes
plan.name character
api.key character

Return type

APIPlanSubscriptionOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An API subscription -
401 Missing or incorrect token -

TaxonomyClasses

APIPlansOut TaxonomyClasses(classifier.name)

Print the taxonomy classes valid for the given classifier.

Example

library(namsor)

var.classifier.name <- 'classifier.name_example' # character | 

#Print the taxonomy classes valid for the given classifier.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$TaxonomyClasses(var.classifier.name)
dput(result)

Parameters

Name Type Description Notes
classifier.name character

Return type

APIPlansOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Available plans -
401 Missing or incorrect token -

UpdateBillingInfo

BillingInfoInOut UpdateBillingInfo(token, billing.info.in.out=var.billing.info.in.out)

Sets or update the billing information (company name, address, phone, vat ID)

Example

library(namsor)

var.token <- 'token_example' # character | 
var.billing.info.in.out <- BillingInfoInOut$new("billingEmail_example", "preferredCurrency_example", "customerName_example", "customerPhone_example", "addressLine1_example", "addressLine2_example", "addressCity_example", "addressPostalCode_example", "addressState_example", "addressCountry_example", "vatID_example") # BillingInfoInOut | 

#Sets or update the billing information (company name, address, phone, vat ID)
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UpdateBillingInfo(var.token, billing.info.in.out=var.billing.info.in.out)
dput(result)

Parameters

Name Type Description Notes
token character
billing.info.in.out BillingInfoInOut [optional]

Return type

BillingInfoInOut

Authorization

api_key

HTTP request headers

  • Content-Type: application/json;charset=UTF-8
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 The updated billing info -
401 Missing or incorrect token -

UpdateLimit

APIPeriodUsageOut UpdateLimit(usage.limit, hard.or.soft, token)

Modifies the hard/soft limit on the API plan's overages (default is 0$ soft limit).

Example

library(namsor)

var.usage.limit <- 56 # integer | 
var.hard.or.soft <- 'hard.or.soft_example' # character | 
var.token <- 'token_example' # character | 

#Modifies the hard/soft limit on the API plan's overages (default is 0$ soft limit).
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UpdateLimit(var.usage.limit, var.hard.or.soft, var.token)
dput(result)

Parameters

Name Type Description Notes
usage.limit integer
hard.or.soft character
token character

Return type

APIPeriodUsageOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An API subscription -
401 Missing or incorrect token -

UpdatePaymentDefault

APIKeyOut UpdatePaymentDefault(defaut.source.id, token)

Update the default Stripe card associated with the current google auth session token.

Example

library(namsor)

var.defaut.source.id <- 'defaut.source.id_example' # character | 
var.token <- 'token_example' # character | 

#Update the default Stripe card associated with the current google auth session token.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UpdatePaymentDefault(var.defaut.source.id, var.token)
dput(result)

Parameters

Name Type Description Notes
defaut.source.id character
token character

Return type

APIKeyOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An session token -
401 Missing or incorrect token -

UserInfo

APIKeyOut UserInfo(token)

Get the user profile associated with the current google auth session token.

Example

library(namsor)

var.token <- 'token_example' # character | 

#Get the user profile associated with the current google auth session token.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UserInfo(var.token)
dput(result)

Parameters

Name Type Description Notes
token character

Return type

APIKeyOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An session token -
401 Missing or incorrect token -

VerifyEmail

APIKeyOut VerifyEmail(email.token)

Verifies an email, based on token sent to that email

Example

library(namsor)

var.email.token <- 'email.token_example' # character | 

#Verifies an email, based on token sent to that email
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$VerifyEmail(var.email.token)
dput(result)

Parameters

Name Type Description Notes
email.token character

Return type

APIKeyOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An API Key -
401 Missing or incorrect token -

VerifyRemoveEmail

APIKeyOut VerifyRemoveEmail(email.token)

Verifies an email, based on token sent to that email

Example

library(namsor)

var.email.token <- 'email.token_example' # character | 

#Verifies an email, based on token sent to that email
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$VerifyRemoveEmail(var.email.token)
dput(result)

Parameters

Name Type Description Notes
email.token character

Return type

APIKeyOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An API Key -
401 Missing or incorrect token -

Vet

Vet(source, vetted)

Vetting of a source.

Example

library(namsor)

var.source <- 'source_example' # character | 
var.vetted <- 'vetted_example' # character | 

#Vetting of a source.
api.instance <- AdminApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
api.instance$Vet(var.source, var.vetted)

Parameters

Name Type Description Notes
source character
vetted character

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Vetting of a source. -
401 Missing or incorrect API Key -