Skip to content

Commit

Permalink
Minor update
Browse files Browse the repository at this point in the history
  • Loading branch information
NamSor SAS committed Jul 17, 2021
1 parent 01d3d7f commit 2fffac8
Show file tree
Hide file tree
Showing 193 changed files with 1,304 additions and 5,934 deletions.
86 changes: 16 additions & 70 deletions README.md
View file

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/APIBillingPeriodUsageOut.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**api_key** | **str** | | [optional]
**subscription_started** | **int** | | [optional]
**period_started** | **int** | | [optional]
**period_ended** | **int** | | [optional]
**stripe_current_period_end** | **int** | | [optional]
**stripe_current_period_start** | **int** | | [optional]
**billing_status** | **str** | | [optional]
**usage** | **int** | | [optional]
**soft_limit** | **int** | | [optional]
**hard_limit** | **int** | | [optional]
**api_key** | **str** | User API Key. | [optional]
**subscription_started** | **int** | Datetime when the user subscribed to the plan. | [optional]
**period_started** | **int** | Datetime when the the plan's current period started. | [optional]
**period_ended** | **int** | Datetime when the the plan's current period endend. | [optional]
**stripe_current_period_end** | **int** | Datetime when the the plan's current period endend (in Stripe). Internal and Stripe periodicity should ~coincide. | [optional]
**stripe_current_period_start** | **int** | Datetime when the the plan's current period started (in Stripe). Internal and Stripe periodicity should ~coincide. | [optional]
**billing_status** | **str** | Current period billing status ex OPEN. | [optional]
**usage** | **int** | Current period usage in units (NB some API endpoints use more than one unit). | [optional]
**soft_limit** | **int** | Current period soft limit (reaching the limit sends an email notification). | [optional]
**hard_limit** | **int** | Current period hard limit (reaching the limit sends an email notification and blocks the API Key). | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
10 changes: 5 additions & 5 deletions docs/APIClassifierOut.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**classifier_name** | **str** | | [optional]
**serving** | **bool** | | [optional]
**learning** | **bool** | | [optional]
**shutting_down** | **bool** | | [optional]
**probability_calibrated** | **bool** | | [optional]
**classifier_name** | **str** | The classifier name | [optional]
**serving** | **bool** | True if the classifier is serving requests (has reached minimal learning, is not shutting down) | [optional]
**learning** | **bool** | True if the classifier is learning | [optional]
**shutting_down** | **bool** | True if the classifier is shutting down | [optional]
**probability_calibrated** | **bool** | True if the classifier has finished the initial learning and calibrated probabilities (meanwhile, during initial learning, probabilities will be equal to -1) | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
4 changes: 2 additions & 2 deletions docs/APIClassifierTaxonomyOut.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**classifier_name** | **str** | | [optional]
**taxonomy_classes** | **list[str]** | | [optional]
**classifier_name** | **str** | Name of the classifier as per apiStatus (corresponds also to the name of the service in apiServices) | [optional]
**taxonomy_classes** | **list[str]** | The taxonomy classes this classifier classifies to | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/APIClassifiersStatusOut.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**software_version** | [**SoftwareVersionOut**](SoftwareVersionOut.md) | | [optional]
**classifiers** | [**list[APIClassifierOut]**](APIClassifierOut.md) | | [optional]
**classifiers** | [**list[APIClassifierOut]**](APIClassifierOut.md) | The list of classifiers and versions. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
12 changes: 6 additions & 6 deletions docs/APICounterV2Out.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**api_key** | [**APIKeyOut**](APIKeyOut.md) | | [optional]
**api_service** | **str** | | [optional]
**created_date_time** | **int** | | [optional]
**total_usage** | **int** | | [optional]
**last_flushed_date_time** | **int** | | [optional]
**last_used_date_time** | **int** | | [optional]
**service_features_usage** | **dict(str, int)** | | [optional]
**api_service** | **str** | The apiService corresponds to the classifier name. | [optional]
**created_date_time** | **int** | The create datetime of the counter. | [optional]
**total_usage** | **int** | The usage of the counter. | [optional]
**last_flushed_date_time** | **int** | The flush datetime of the counter. | [optional]
**last_used_date_time** | **int** | The last usage datetime of the counter. | [optional]
**service_features_usage** | **dict(str, int)** | Usage of special features, such as Chinese, Japanese. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
20 changes: 10 additions & 10 deletions docs/APIKeyOut.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**api_key** | **str** | | [optional]
**user_id** | **str** | | [optional]
**admin** | **bool** | | [optional]
**vetted** | **bool** | | [optional]
**learnable** | **bool** | | [optional]
**anonymized** | **bool** | | [optional]
**partner** | **bool** | | [optional]
**striped** | **bool** | | [optional]
**corporate** | **bool** | | [optional]
**disabled** | **bool** | | [optional]
**api_key** | **str** | The user API Key. | [optional]
**user_id** | **str** | The user identifier. | [optional]
**admin** | **bool** | The API Key has admin role. | [optional]
**vetted** | **bool** | The API Key is vetted (assumed truthful) for machine learning. | [optional]
**learnable** | **bool** | The API Key is learnable (without assuming truthfulness) for machine learning. Set learnable=false and anonymized=true for highest privacy (ie. to forget data as it's processed). | [optional]
**anonymized** | **bool** | The API Key is anonymized (using SHA-252 digest for logging). Set learnable=false and anonymized=true for highest privacy (ie. to forget data as it's processed). | [optional]
**partner** | **bool** | The API Key has partner role. | [optional]
**striped** | **bool** | The API Key is associated to a valid Stripe account. | [optional]
**corporate** | **bool** | The API Key has role corporate (ex SWIFT payments instead of Stripe payments). | [optional]
**disabled** | **bool** | The API Key is temporarily or permanently disabled. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
8 changes: 4 additions & 4 deletions docs/APIPeriodUsageOut.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**subscription** | [**APIPlanSubscriptionOut**](APIPlanSubscriptionOut.md) | | [optional]
**billing_period** | [**APIBillingPeriodUsageOut**](APIBillingPeriodUsageOut.md) | | [optional]
**overage_excl_tax** | **float** | | [optional]
**overage_incl_tax** | **float** | | [optional]
**overage_currency** | **str** | | [optional]
**overage_quantity** | **int** | | [optional]
**overage_excl_tax** | **float** | Overage amount including any tax. | [optional]
**overage_incl_tax** | **float** | Overage amount including tax (if applicable). | [optional]
**overage_currency** | **str** | Currency of the overage amount. | [optional]
**overage_quantity** | **int** | Quantity above monthly quota of the current subscritpion, in units. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
38 changes: 19 additions & 19 deletions docs/APIPlanSubscriptionOut.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,25 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**api_key** | **str** | | [optional]
**plan_started** | **int** | | [optional]
**prior_plan_started** | **int** | | [optional]
**plan_ended** | **int** | | [optional]
**tax_rate** | **float** | | [optional]
**plan_name** | **str** | | [optional]
**plan_base_fees_key** | **str** | | [optional]
**plan_status** | **str** | | [optional]
**plan_quota** | **int** | | [optional]
**price_usd** | **float** | | [optional]
**price_overage_usd** | **float** | | [optional]
**price** | **float** | | [optional]
**price_overage** | **float** | | [optional]
**currency** | **str** | | [optional]
**currency_factor** | **float** | | [optional]
**stripe_customer_id** | **str** | | [optional]
**stripe_status** | **str** | | [optional]
**stripe_subscription** | **str** | | [optional]
**user_id** | **str** | | [optional]
**api_key** | **str** | User API Key. | [optional]
**plan_started** | **int** | Datetime when the user subscribed to the current plan. | [optional]
**prior_plan_started** | **int** | Datetime when the user subscribed to the prior plan. | [optional]
**plan_ended** | **int** | Datetime when the user ended the plan. | [optional]
**tax_rate** | **float** | Applicable tax rate for the plan. | [optional]
**plan_name** | **str** | Current plan name. | [optional]
**plan_base_fees_key** | **str** | Current plan key (as in Stripe product). | [optional]
**plan_status** | **str** | Plan status. | [optional]
**plan_quota** | **int** | Current plan quota in quantity of units (NB: some API use several units per name). | [optional]
**price_usd** | **float** | Current plan monthly price expressed in USD (includes a free quota). | [optional]
**price_overage_usd** | **float** | Current plan price for overages expressed in USD (extra price per unit above the free quota). | [optional]
**price** | **float** | Current plan price for overages expressed in Currency (extra price per unit above the free quota). | [optional]
**price_overage** | **float** | Current plan price for overages expressed in Currency (extra price per unit above the free quota). | [optional]
**currency** | **str** | Current plan Currency for prices. | [optional]
**currency_factor** | **float** | For USD, GBP, EUR - the factor is 1. | [optional]
**stripe_customer_id** | **str** | Stripe customer identifier. | [optional]
**stripe_status** | **str** | Stripe status ex active. | [optional]
**stripe_subscription** | **str** | Stripe subscription identifier. | [optional]
**user_id** | **str** | Internal user identifier. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
6 changes: 3 additions & 3 deletions docs/APIServiceOut.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**service_name** | **str** | | [optional]
**service_group** | **str** | | [optional]
**cost_in_units** | **int** | | [optional]
**service_name** | **str** | A service name corresponds to classifier name in apiStatus (ex. personalname_gender or personalfullname_gender) | [optional]
**service_group** | **str** | Groups together classifiers providing a similar service (ex. gender groups personalname_gender and personalfullname_gender) | [optional]
**cost_in_units** | **int** | Indicates how many units per call this service costs (ex. the number of units per name) | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/APIServicesOut.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**api_services** | [**list[APIServiceOut]**](APIServiceOut.md) | | [optional]
**api_services** | [**list[APIServiceOut]**](APIServiceOut.md) | List of API Services | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
16 changes: 8 additions & 8 deletions docs/APIUsageAggregatedOut.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**time_unit** | **str** | | [optional]
**period_start** | **int** | | [optional]
**period_end** | **int** | | [optional]
**total_usage** | **int** | | [optional]
**history_truncated** | **bool** | | [optional]
**data** | **list[list[int]]** | | [optional]
**col_headers** | **list[str]** | | [optional]
**row_headers** | **list[str]** | | [optional]
**time_unit** | **str** | Time unit is DAY, WEEK or MONTH depending on prior usage | [optional]
**period_start** | **int** | Start datetime of the reporting period | [optional]
**period_end** | **int** | End datetime of the reporting period | [optional]
**total_usage** | **int** | Total usage in the current period | [optional]
**history_truncated** | **bool** | If the history was truncaded due to data limit | [optional]
**data** | **list[list[int]]** | Data points : usage per DAY, WEEK or MONTH and per apiService | [optional]
**col_headers** | **list[str]** | apiServices as column headers | [optional]
**row_headers** | **list[str]** | dates as row headers | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
10 changes: 10 additions & 0 deletions docs/APIUsageHistoryOut.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# APIUsageHistoryOut

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**detailed_usage** | [**list[APICounterV2Out]**](APICounterV2Out.md) | Detailed usage as reported by the deduplicating API counter. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading

0 comments on commit 2fffac8

Please sign in to comment.