Minor update

namsor · Jul 17, 2021 · cfed6e0 · cfed6e0
1 parent 62be88d
commit cfed6e0
Show file tree

Hide file tree

Showing 886 changed files with 5,524 additions and 19,025 deletions.
diff --git a/README.md b/README.md
diff --git a/build.gradle b/build.gradle
@@ -2,7 +2,7 @@ apply plugin: 'idea'
 apply plugin: 'eclipse'
 
 group = 'com.namsor'
-version = '2.0.14'
+version = '2.0.15'
 
 buildscript {
     repositories {

diff --git a/build.sbt b/build.sbt
@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "com.namsor",
     name := "namsor-sdk2",
-    version := "2.0.14",
+    version := "2.0.15",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

diff --git a/docs/APIBillingPeriodUsageOut.md b/docs/APIBillingPeriodUsageOut.md
@@ -4,16 +4,16 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**apiKey** | **String** |  |  [optional]
-**subscriptionStarted** | **Long** |  |  [optional]
-**periodStarted** | **Long** |  |  [optional]
-**periodEnded** | **Long** |  |  [optional]
-**stripeCurrentPeriodEnd** | **Long** |  |  [optional]
-**stripeCurrentPeriodStart** | **Long** |  |  [optional]
-**billingStatus** | **String** |  |  [optional]
-**usage** | **Long** |  |  [optional]
-**softLimit** | **Long** |  |  [optional]
-**hardLimit** | **Long** |  |  [optional]
+**apiKey** | **String** | User API Key. |  [optional]
+**subscriptionStarted** | **Long** | Datetime when the user subscribed to the plan. |  [optional]
+**periodStarted** | **Long** | Datetime when the the plan&#39;s current period started. |  [optional]
+**periodEnded** | **Long** | Datetime when the the plan&#39;s current period endend. |  [optional]
+**stripeCurrentPeriodEnd** | **Long** | Datetime when the the plan&#39;s current period endend (in Stripe). Internal and Stripe periodicity should ~coincide. |  [optional]
+**stripeCurrentPeriodStart** | **Long** | Datetime when the the plan&#39;s current period started (in Stripe). Internal and Stripe periodicity should ~coincide. |  [optional]
+**billingStatus** | **String** | Current period billing status ex OPEN. |  [optional]
+**usage** | **Long** | Current period usage in units (NB some API endpoints use more than one unit). |  [optional]
+**softLimit** | **Long** | Current period soft limit (reaching the limit sends an email notification). |  [optional]
+**hardLimit** | **Long** | Current period hard limit (reaching the limit sends an email notification and blocks the API Key). |  [optional]
 
 
 
diff --git a/docs/APIClassifierOut.md b/docs/APIClassifierOut.md
@@ -4,11 +4,11 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**classifierName** | **String** |  |  [optional]
-**serving** | **Boolean** |  |  [optional]
-**learning** | **Boolean** |  |  [optional]
-**shuttingDown** | **Boolean** |  |  [optional]
-**probabilityCalibrated** | **Boolean** |  |  [optional]
+**classifierName** | **String** | The classifier name |  [optional]
+**serving** | **Boolean** | True if the classifier is serving requests (has reached minimal learning, is not shutting down) |  [optional]
+**learning** | **Boolean** | True if the classifier is learning |  [optional]
+**shuttingDown** | **Boolean** | True if the classifier is shutting down |  [optional]
+**probabilityCalibrated** | **Boolean** | True if the classifier has finished the initial learning and calibrated probabilities (meanwhile, during initial learning, probabilities will be equal to -1) |  [optional]
 
 
 
diff --git a/docs/APIClassifierTaxonomyOut.md b/docs/APIClassifierTaxonomyOut.md
@@ -4,8 +4,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**classifierName** | **String** |  |  [optional]
-**taxonomyClasses** | **List&lt;String&gt;** |  |  [optional]
+**classifierName** | **String** | Name of the classifier as per apiStatus (corresponds also to the name of the service in apiServices) |  [optional]
+**taxonomyClasses** | **List&lt;String&gt;** | The taxonomy classes this classifier classifies to |  [optional]
 
 
 
diff --git a/docs/APIClassifiersStatusOut.md b/docs/APIClassifiersStatusOut.md
@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **softwareVersion** | [**SoftwareVersionOut**](SoftwareVersionOut.md) |  |  [optional]
-**classifiers** | [**List&lt;APIClassifierOut&gt;**](APIClassifierOut.md) |  |  [optional]
+**classifiers** | [**List&lt;APIClassifierOut&gt;**](APIClassifierOut.md) | The list of classifiers and versions. |  [optional]
 
 
 
diff --git a/docs/APICounterV2Out.md b/docs/APICounterV2Out.md
@@ -5,12 +5,12 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **apiKey** | [**APIKeyOut**](APIKeyOut.md) |  |  [optional]
-**apiService** | **String** |  |  [optional]
-**createdDateTime** | **Long** |  |  [optional]
-**totalUsage** | **Long** |  |  [optional]
-**lastFlushedDateTime** | **Long** |  |  [optional]
-**lastUsedDateTime** | **Long** |  |  [optional]
-**serviceFeaturesUsage** | **Map&lt;String, Long&gt;** |  |  [optional]
+**apiService** | **String** | The apiService corresponds to the classifier name. |  [optional]
+**createdDateTime** | **Long** | The create datetime of the counter. |  [optional]
+**totalUsage** | **Long** | The usage of the counter. |  [optional]
+**lastFlushedDateTime** | **Long** | The flush datetime of the counter. |  [optional]
+**lastUsedDateTime** | **Long** | The last usage datetime of the counter. |  [optional]
+**serviceFeaturesUsage** | **Map&lt;String, Long&gt;** | Usage of special features, such as Chinese, Japanese. |  [optional]
 
 
 
diff --git a/docs/APIKeyOut.md b/docs/APIKeyOut.md
@@ -4,16 +4,16 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**apiKey** | **String** |  |  [optional]
-**userId** | **String** |  |  [optional]
-**admin** | **Boolean** |  |  [optional]
-**vetted** | **Boolean** |  |  [optional]
-**learnable** | **Boolean** |  |  [optional]
-**anonymized** | **Boolean** |  |  [optional]
-**partner** | **Boolean** |  |  [optional]
-**striped** | **Boolean** |  |  [optional]
-**corporate** | **Boolean** |  |  [optional]
-**disabled** | **Boolean** |  |  [optional]
+**apiKey** | **String** | The user API Key. |  [optional]
+**userId** | **String** | The user identifier. |  [optional]
+**admin** | **Boolean** | The API Key has admin role. |  [optional]
+**vetted** | **Boolean** | The API Key is vetted (assumed truthful) for machine learning. |  [optional]
+**learnable** | **Boolean** | The API Key is learnable (without assuming truthfulness) for machine learning. Set learnable&#x3D;false and anonymized&#x3D;true for highest privacy (ie. to forget data as it&#39;s processed). |  [optional]
+**anonymized** | **Boolean** | The API Key is anonymized (using SHA-252 digest for logging). Set learnable&#x3D;false and anonymized&#x3D;true for highest privacy (ie. to forget data as it&#39;s processed). |  [optional]
+**partner** | **Boolean** | The API Key has partner role. |  [optional]
+**striped** | **Boolean** | The API Key is associated to a valid Stripe account. |  [optional]
+**corporate** | **Boolean** | The API Key has role corporate (ex SWIFT payments instead of Stripe payments). |  [optional]
+**disabled** | **Boolean** | The API Key is temporarily or permanently disabled. |  [optional]
 
 
 
diff --git a/docs/APIPeriodUsageOut.md b/docs/APIPeriodUsageOut.md
@@ -6,10 +6,10 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **subscription** | [**APIPlanSubscriptionOut**](APIPlanSubscriptionOut.md) |  |  [optional]
 **billingPeriod** | [**APIBillingPeriodUsageOut**](APIBillingPeriodUsageOut.md) |  |  [optional]
-**overageExclTax** | **Double** |  |  [optional]
-**overageInclTax** | **Double** |  |  [optional]
-**overageCurrency** | **String** |  |  [optional]
-**overageQuantity** | **Long** |  |  [optional]
+**overageExclTax** | **Double** | Overage amount including any tax. |  [optional]
+**overageInclTax** | **Double** | Overage amount including tax (if applicable). |  [optional]
+**overageCurrency** | **String** | Currency of the overage amount. |  [optional]
+**overageQuantity** | **Long** | Quantity above monthly quota of the current subscritpion, in units. |  [optional]
 
 
 
diff --git a/docs/APIPlanSubscriptionOut.md b/docs/APIPlanSubscriptionOut.md
@@ -4,25 +4,25 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**apiKey** | **String** |  |  [optional]
-**planStarted** | **Long** |  |  [optional]
-**priorPlanStarted** | **Long** |  |  [optional]
-**planEnded** | **Long** |  |  [optional]
-**taxRate** | **Double** |  |  [optional]
-**planName** | **String** |  |  [optional]
-**planBaseFeesKey** | **String** |  |  [optional]
-**planStatus** | **String** |  |  [optional]
-**planQuota** | **Long** |  |  [optional]
-**priceUSD** | **Double** |  |  [optional]
-**priceOverageUSD** | **Double** |  |  [optional]
-**price** | **Double** |  |  [optional]
-**priceOverage** | **Double** |  |  [optional]
-**currency** | **String** |  |  [optional]
-**currencyFactor** | **Double** |  |  [optional]
-**stripeCustomerId** | **String** |  |  [optional]
-**stripeStatus** | **String** |  |  [optional]
-**stripeSubscription** | **String** |  |  [optional]
-**userId** | **String** |  |  [optional]
+**apiKey** | **String** | User API Key. |  [optional]
+**planStarted** | **Long** | Datetime when the user subscribed to the current plan. |  [optional]
+**priorPlanStarted** | **Long** | Datetime when the user subscribed to the prior plan. |  [optional]
+**planEnded** | **Long** | Datetime when the user ended the plan. |  [optional]
+**taxRate** | **Double** | Applicable tax rate for the plan. |  [optional]
+**planName** | **String** | Current plan name. |  [optional]
+**planBaseFeesKey** | **String** | Current plan key (as in Stripe product). |  [optional]
+**planStatus** | **String** | Plan status. |  [optional]
+**planQuota** | **Long** | Current plan quota in quantity of units (NB: some API use several units per name). |  [optional]
+**priceUSD** | **Double** | Current plan monthly price expressed in USD (includes a free quota). |  [optional]
+**priceOverageUSD** | **Double** | Current plan price for overages expressed in USD (extra price per unit above the free quota). |  [optional]
+**price** | **Double** | Current plan price for overages expressed in Currency (extra price per unit above the free quota). |  [optional]
+**priceOverage** | **Double** | Current plan price for overages expressed in Currency (extra price per unit above the free quota). |  [optional]
+**currency** | **String** | Current plan Currency for prices. |  [optional]
+**currencyFactor** | **Double** | For USD, GBP, EUR - the factor is 1. |  [optional]
+**stripeCustomerId** | **String** | Stripe customer identifier. |  [optional]
+**stripeStatus** | **String** | Stripe status ex active. |  [optional]
+**stripeSubscription** | **String** | Stripe subscription identifier. |  [optional]
+**userId** | **String** | Internal user identifier. |  [optional]
 
 
 
diff --git a/docs/APIServiceOut.md b/docs/APIServiceOut.md
@@ -4,9 +4,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**serviceName** | **String** |  |  [optional]
-**serviceGroup** | **String** |  |  [optional]
-**costInUnits** | **Integer** |  |  [optional]
+**serviceName** | **String** | A service name corresponds to classifier name in apiStatus (ex. personalname_gender or personalfullname_gender) |  [optional]
+**serviceGroup** | **String** | Groups together classifiers providing a similar service (ex. gender groups personalname_gender and personalfullname_gender) |  [optional]
+**costInUnits** | **Integer** | Indicates how many units per call this service costs (ex. the number of units per name) |  [optional]
 
 
 
diff --git a/docs/APIServicesOut.md b/docs/APIServicesOut.md
@@ -4,7 +4,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**apiServices** | [**List&lt;APIServiceOut&gt;**](APIServiceOut.md) |  |  [optional]
+**apiServices** | [**List&lt;APIServiceOut&gt;**](APIServiceOut.md) | List of API Services |  [optional]
 
 
 
diff --git a/docs/APIUsageAggregatedOut.md b/docs/APIUsageAggregatedOut.md
@@ -4,14 +4,14 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**timeUnit** | **String** |  |  [optional]
-**periodStart** | **Long** |  |  [optional]
-**periodEnd** | **Long** |  |  [optional]
-**totalUsage** | **Long** |  |  [optional]
-**historyTruncated** | **Boolean** |  |  [optional]
-**data** | [**List&lt;List&lt;Integer&gt;&gt;**](List.md) |  |  [optional]
-**colHeaders** | **List&lt;String&gt;** |  |  [optional]
-**rowHeaders** | **List&lt;String&gt;** |  |  [optional]
+**timeUnit** | **String** | Time unit is DAY, WEEK or MONTH depending on prior usage |  [optional]
+**periodStart** | **Long** | Start datetime of the reporting period |  [optional]
+**periodEnd** | **Long** | End datetime of the reporting period |  [optional]
+**totalUsage** | **Long** | Total usage in the current period |  [optional]
+**historyTruncated** | **Boolean** | If the history was truncaded due to data limit |  [optional]
+**data** | [**List&lt;List&lt;Integer&gt;&gt;**](List.md) | Data points : usage per DAY, WEEK or MONTH and per apiService |  [optional]
+**colHeaders** | **List&lt;String&gt;** | apiServices as column headers  |  [optional]
+**rowHeaders** | **List&lt;String&gt;** | dates as row headers  |  [optional]
 
 
 
diff --git a/docs/APIUsageHistoryOut.md b/docs/APIUsageHistoryOut.md
@@ -0,0 +1,10 @@
+
+# APIUsageHistoryOut
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**detailedUsage** | [**List&lt;APICounterV2Out&gt;**](APICounterV2Out.md) | Detailed usage as reported by the deduplicating API counter. |  [optional]
+
+
+