spartera_api_sdk 1.0.62 → 1.0.69
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/config.json +1 -1
- data/docs/APIKeysApi.md +45 -35
- data/docs/AlertsApi.md +71 -57
- data/docs/AssetPriceHistoryApi.md +80 -64
- data/docs/AssetsApi.md +116 -378
- data/docs/CloudProvidersApi.md +18 -215
- data/docs/CompaniesApi.md +81 -63
- data/docs/CompaniesCompanyIdApiKeysGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdDelete200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdDelete200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdPatch200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdPatch200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdAssetsGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsPost200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsPost200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdConnectionsConnectionIdDelete200Response.md +20 -0
- data/docs/CompaniesCompanyIdConnectionsConnectionIdDelete200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdConnectionsConnectionIdGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdConnectionsConnectionIdPatch200Response.md +20 -0
- data/docs/CompaniesCompanyIdConnectionsConnectionIdPatch200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdConnectionsGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdConnectionsPost200Response.md +20 -0
- data/docs/CompaniesCompanyIdConnectionsPost200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersPost200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersPost200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsPost200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsPost200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersUserIdDelete200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdDelete200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesPost200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesPost200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersUserIdGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdPatch200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdPatch200ResponseData.md +18 -0
- data/docs/ConnectionsApi.md +67 -53
- data/docs/FavoritesApi.md +84 -68
- data/docs/MeGet200Response.md +36 -0
- data/docs/MeGet200ResponseApiKeyInfo.md +20 -0
- data/docs/MeGet200ResponseProfile.md +36 -0
- data/docs/MeGet200ResponseTokenMetadata.md +24 -0
- data/docs/StorageEnginesApi.md +149 -0
- data/docs/UsersApi.md +116 -39
- data/lib/spartera_api_sdk/api/alerts_api.rb +32 -32
- data/lib/spartera_api_sdk/api/api_keys_api.rb +20 -20
- data/lib/spartera_api_sdk/api/asset_price_history_api.rb +36 -36
- data/lib/spartera_api_sdk/api/assets_api.rb +52 -328
- data/lib/spartera_api_sdk/api/cloud_providers_api.rb +8 -185
- data/lib/spartera_api_sdk/api/companies_api.rb +36 -36
- data/lib/spartera_api_sdk/api/connections_api.rb +30 -30
- data/lib/spartera_api_sdk/api/favorites_api.rb +38 -38
- data/lib/spartera_api_sdk/api/storage_engines_api.rb +150 -0
- data/lib/spartera_api_sdk/api/users_api.rb +77 -22
- data/lib/spartera_api_sdk/configuration.rb +2 -10
- data/lib/spartera_api_sdk/models/companies_company_id_api_keys_get200_response.rb +248 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_delete200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_delete200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_get200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_patch200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_patch200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_get200_response.rb +266 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_post200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_post200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_delete200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_delete200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_get200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_patch200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_patch200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_connections_get200_response.rb +266 -0
- data/lib/spartera_api_sdk/models/companies_company_id_connections_post200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_connections_post200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_get200_response.rb +266 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_post200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_post200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_get200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_get200_response.rb +266 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_post200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_post200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_delete200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_delete200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_get200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_get200_response.rb +266 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_post200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_post200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_get200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_patch200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_patch200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/me_get200_response.rb +417 -0
- data/lib/spartera_api_sdk/models/me_get200_response_api_key_info.rb +232 -0
- data/lib/spartera_api_sdk/models/me_get200_response_profile.rb +345 -0
- data/lib/spartera_api_sdk/models/me_get200_response_token_metadata.rb +252 -0
- data/lib/spartera_api_sdk/version.rb +1 -1
- data/lib/spartera_api_sdk.rb +46 -0
- data/spec/api/alerts_api_spec.rb +9 -9
- data/spec/api/api_keys_api_spec.rb +5 -5
- data/spec/api/asset_price_history_api_spec.rb +10 -10
- data/spec/api/assets_api_spec.rb +14 -64
- data/spec/api/cloud_providers_api_spec.rb +2 -34
- data/spec/api/companies_api_spec.rb +9 -9
- data/spec/api/connections_api_spec.rb +8 -8
- data/spec/api/favorites_api_spec.rb +11 -11
- data/spec/api/storage_engines_api_spec.rb +58 -0
- data/spec/api/users_api_spec.rb +16 -6
- data/spec/models/companies_company_id_api_keys_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_assets_asset_id_delete200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_assets_asset_id_delete200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_assets_asset_id_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_assets_asset_id_patch200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_assets_asset_id_patch200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_assets_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_assets_post200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_assets_post200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_connections_connection_id_delete200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_connections_connection_id_delete200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_connections_connection_id_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_connections_connection_id_patch200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_connections_connection_id_patch200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_connections_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_connections_post200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_connections_post200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_post200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_post200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_alerts_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_alerts_post200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_user_id_alerts_post200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_delete200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_user_id_delete200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_favorites_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_favorites_post200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_user_id_favorites_post200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_patch200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_user_id_patch200_response_spec.rb +42 -0
- data/spec/models/me_get200_response_api_key_info_spec.rb +42 -0
- data/spec/models/me_get200_response_profile_spec.rb +94 -0
- data/spec/models/me_get200_response_spec.rb +94 -0
- data/spec/models/me_get200_response_token_metadata_spec.rb +54 -0
- metadata +208 -22
- data/Gemfile.lock +0 -69
data/docs/FavoritesApi.md
CHANGED
@@ -5,18 +5,18 @@ All URIs are relative to *https://api.spartera.com*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**companies_company_id_users_user_id_favorites_category_category_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_category_category_get) | **GET** /companies/{company_id}/users/{user_id}/favorites/category/{category} | Get all favorites for the specified user in a specific category |
|
8
|
-
| [**companies_company_id_users_user_id_favorites_check_asset_id_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_check_asset_id_get) | **GET** /companies/{company_id}/users/{user_id}/favorites/check/{asset_id} | Check if the specified user has favorited a specific asset
|
8
|
+
| [**companies_company_id_users_user_id_favorites_check_asset_id_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_check_asset_id_get) | **GET** /companies/{company_id}/users/{user_id}/favorites/check/{asset_id} | Check if the specified user has favorited a specific asset |
|
9
9
|
| [**companies_company_id_users_user_id_favorites_favorite_id_delete**](FavoritesApi.md#companies_company_id_users_user_id_favorites_favorite_id_delete) | **DELETE** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Delete single favorite by ID (unfavorite an asset) |
|
10
10
|
| [**companies_company_id_users_user_id_favorites_favorite_id_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_favorite_id_get) | **GET** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Get single favorite by ID |
|
11
|
-
| [**companies_company_id_users_user_id_favorites_favorite_id_patch**](FavoritesApi.md#companies_company_id_users_user_id_favorites_favorite_id_patch) | **PATCH** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Update an existing favorite by ID
|
12
|
-
| [**companies_company_id_users_user_id_favorites_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_get) | **GET** /companies/{company_id}/users/{user_id}/favorites | Get a list of all favorites for a specific user
|
11
|
+
| [**companies_company_id_users_user_id_favorites_favorite_id_patch**](FavoritesApi.md#companies_company_id_users_user_id_favorites_favorite_id_patch) | **PATCH** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Update an existing favorite by ID |
|
12
|
+
| [**companies_company_id_users_user_id_favorites_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_get) | **GET** /companies/{company_id}/users/{user_id}/favorites | Get a list of all favorites for a specific user |
|
13
13
|
| [**companies_company_id_users_user_id_favorites_post**](FavoritesApi.md#companies_company_id_users_user_id_favorites_post) | **POST** /companies/{company_id}/users/{user_id}/favorites | POST /companies/{company_id}/users/{user_id}/favorites |
|
14
14
|
| [**companies_company_id_users_user_id_favorites_uncategorized_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_uncategorized_get) | **GET** /companies/{company_id}/users/{user_id}/favorites/uncategorized | Get all favorites for the specified user that don't have a category |
|
15
15
|
|
16
16
|
|
17
17
|
## companies_company_id_users_user_id_favorites_category_category_get
|
18
18
|
|
19
|
-
>
|
19
|
+
> <CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response> companies_company_id_users_user_id_favorites_category_category_get(company_id, user_id, category)
|
20
20
|
|
21
21
|
Get all favorites for the specified user in a specific category
|
22
22
|
|
@@ -27,8 +27,10 @@ require 'time'
|
|
27
27
|
require 'spartera_api_sdk'
|
28
28
|
# setup authorization
|
29
29
|
SparteraApiSdk.configure do |config|
|
30
|
-
# Configure
|
31
|
-
config.
|
30
|
+
# Configure API key authorization: ApiKeyAuth
|
31
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
32
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
33
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
32
34
|
end
|
33
35
|
|
34
36
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
@@ -49,7 +51,7 @@ end
|
|
49
51
|
|
50
52
|
This returns an Array which contains the response data, status code and headers.
|
51
53
|
|
52
|
-
> <Array(
|
54
|
+
> <Array(<CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response>, Integer, Hash)> companies_company_id_users_user_id_favorites_category_category_get_with_http_info(company_id, user_id, category)
|
53
55
|
|
54
56
|
```ruby
|
55
57
|
begin
|
@@ -57,7 +59,7 @@ begin
|
|
57
59
|
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_category_category_get_with_http_info(company_id, user_id, category)
|
58
60
|
p status_code # => 2xx
|
59
61
|
p headers # => { ... }
|
60
|
-
p data # =>
|
62
|
+
p data # => <CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response>
|
61
63
|
rescue SparteraApiSdk::ApiError => e
|
62
64
|
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_category_category_get_with_http_info: #{e}"
|
63
65
|
end
|
@@ -73,11 +75,11 @@ end
|
|
73
75
|
|
74
76
|
### Return type
|
75
77
|
|
76
|
-
**
|
78
|
+
[**CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response**](CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response.md)
|
77
79
|
|
78
80
|
### Authorization
|
79
81
|
|
80
|
-
[
|
82
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
81
83
|
|
82
84
|
### HTTP request headers
|
83
85
|
|
@@ -87,9 +89,9 @@ end
|
|
87
89
|
|
88
90
|
## companies_company_id_users_user_id_favorites_check_asset_id_get
|
89
91
|
|
90
|
-
>
|
92
|
+
> <CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response> companies_company_id_users_user_id_favorites_check_asset_id_get(company_id, user_id, asset_id)
|
91
93
|
|
92
|
-
Check if the specified user has favorited a specific asset
|
94
|
+
Check if the specified user has favorited a specific asset
|
93
95
|
|
94
96
|
### Examples
|
95
97
|
|
@@ -98,8 +100,10 @@ require 'time'
|
|
98
100
|
require 'spartera_api_sdk'
|
99
101
|
# setup authorization
|
100
102
|
SparteraApiSdk.configure do |config|
|
101
|
-
# Configure
|
102
|
-
config.
|
103
|
+
# Configure API key authorization: ApiKeyAuth
|
104
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
105
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
106
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
103
107
|
end
|
104
108
|
|
105
109
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
@@ -108,7 +112,7 @@ user_id = 'user_id_example' # String |
|
|
108
112
|
asset_id = 'asset_id_example' # String |
|
109
113
|
|
110
114
|
begin
|
111
|
-
# Check if the specified user has favorited a specific asset
|
115
|
+
# Check if the specified user has favorited a specific asset
|
112
116
|
result = api_instance.companies_company_id_users_user_id_favorites_check_asset_id_get(company_id, user_id, asset_id)
|
113
117
|
p result
|
114
118
|
rescue SparteraApiSdk::ApiError => e
|
@@ -120,15 +124,15 @@ end
|
|
120
124
|
|
121
125
|
This returns an Array which contains the response data, status code and headers.
|
122
126
|
|
123
|
-
> <Array(
|
127
|
+
> <Array(<CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response>, Integer, Hash)> companies_company_id_users_user_id_favorites_check_asset_id_get_with_http_info(company_id, user_id, asset_id)
|
124
128
|
|
125
129
|
```ruby
|
126
130
|
begin
|
127
|
-
# Check if the specified user has favorited a specific asset
|
131
|
+
# Check if the specified user has favorited a specific asset
|
128
132
|
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_check_asset_id_get_with_http_info(company_id, user_id, asset_id)
|
129
133
|
p status_code # => 2xx
|
130
134
|
p headers # => { ... }
|
131
|
-
p data # =>
|
135
|
+
p data # => <CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response>
|
132
136
|
rescue SparteraApiSdk::ApiError => e
|
133
137
|
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_check_asset_id_get_with_http_info: #{e}"
|
134
138
|
end
|
@@ -144,11 +148,11 @@ end
|
|
144
148
|
|
145
149
|
### Return type
|
146
150
|
|
147
|
-
**
|
151
|
+
[**CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response**](CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response.md)
|
148
152
|
|
149
153
|
### Authorization
|
150
154
|
|
151
|
-
[
|
155
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
152
156
|
|
153
157
|
### HTTP request headers
|
154
158
|
|
@@ -158,7 +162,7 @@ end
|
|
158
162
|
|
159
163
|
## companies_company_id_users_user_id_favorites_favorite_id_delete
|
160
164
|
|
161
|
-
>
|
165
|
+
> <CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200Response> companies_company_id_users_user_id_favorites_favorite_id_delete(company_id, user_id, favorite_id)
|
162
166
|
|
163
167
|
Delete single favorite by ID (unfavorite an asset)
|
164
168
|
|
@@ -169,8 +173,10 @@ require 'time'
|
|
169
173
|
require 'spartera_api_sdk'
|
170
174
|
# setup authorization
|
171
175
|
SparteraApiSdk.configure do |config|
|
172
|
-
# Configure
|
173
|
-
config.
|
176
|
+
# Configure API key authorization: ApiKeyAuth
|
177
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
178
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
179
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
174
180
|
end
|
175
181
|
|
176
182
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
@@ -191,7 +197,7 @@ end
|
|
191
197
|
|
192
198
|
This returns an Array which contains the response data, status code and headers.
|
193
199
|
|
194
|
-
> <Array(
|
200
|
+
> <Array(<CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200Response>, Integer, Hash)> companies_company_id_users_user_id_favorites_favorite_id_delete_with_http_info(company_id, user_id, favorite_id)
|
195
201
|
|
196
202
|
```ruby
|
197
203
|
begin
|
@@ -199,7 +205,7 @@ begin
|
|
199
205
|
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_favorite_id_delete_with_http_info(company_id, user_id, favorite_id)
|
200
206
|
p status_code # => 2xx
|
201
207
|
p headers # => { ... }
|
202
|
-
p data # =>
|
208
|
+
p data # => <CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200Response>
|
203
209
|
rescue SparteraApiSdk::ApiError => e
|
204
210
|
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_favorite_id_delete_with_http_info: #{e}"
|
205
211
|
end
|
@@ -215,11 +221,11 @@ end
|
|
215
221
|
|
216
222
|
### Return type
|
217
223
|
|
218
|
-
**
|
224
|
+
[**CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200Response**](CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200Response.md)
|
219
225
|
|
220
226
|
### Authorization
|
221
227
|
|
222
|
-
[
|
228
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
223
229
|
|
224
230
|
### HTTP request headers
|
225
231
|
|
@@ -229,7 +235,7 @@ end
|
|
229
235
|
|
230
236
|
## companies_company_id_users_user_id_favorites_favorite_id_get
|
231
237
|
|
232
|
-
>
|
238
|
+
> <CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response> companies_company_id_users_user_id_favorites_favorite_id_get(company_id, user_id, favorite_id)
|
233
239
|
|
234
240
|
Get single favorite by ID
|
235
241
|
|
@@ -240,8 +246,10 @@ require 'time'
|
|
240
246
|
require 'spartera_api_sdk'
|
241
247
|
# setup authorization
|
242
248
|
SparteraApiSdk.configure do |config|
|
243
|
-
# Configure
|
244
|
-
config.
|
249
|
+
# Configure API key authorization: ApiKeyAuth
|
250
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
251
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
252
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
245
253
|
end
|
246
254
|
|
247
255
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
@@ -262,7 +270,7 @@ end
|
|
262
270
|
|
263
271
|
This returns an Array which contains the response data, status code and headers.
|
264
272
|
|
265
|
-
> <Array(
|
273
|
+
> <Array(<CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response>, Integer, Hash)> companies_company_id_users_user_id_favorites_favorite_id_get_with_http_info(company_id, user_id, favorite_id)
|
266
274
|
|
267
275
|
```ruby
|
268
276
|
begin
|
@@ -270,7 +278,7 @@ begin
|
|
270
278
|
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_favorite_id_get_with_http_info(company_id, user_id, favorite_id)
|
271
279
|
p status_code # => 2xx
|
272
280
|
p headers # => { ... }
|
273
|
-
p data # =>
|
281
|
+
p data # => <CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response>
|
274
282
|
rescue SparteraApiSdk::ApiError => e
|
275
283
|
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_favorite_id_get_with_http_info: #{e}"
|
276
284
|
end
|
@@ -286,11 +294,11 @@ end
|
|
286
294
|
|
287
295
|
### Return type
|
288
296
|
|
289
|
-
**
|
297
|
+
[**CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response**](CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response.md)
|
290
298
|
|
291
299
|
### Authorization
|
292
300
|
|
293
|
-
[
|
301
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
294
302
|
|
295
303
|
### HTTP request headers
|
296
304
|
|
@@ -300,9 +308,9 @@ end
|
|
300
308
|
|
301
309
|
## companies_company_id_users_user_id_favorites_favorite_id_patch
|
302
310
|
|
303
|
-
>
|
311
|
+
> <CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200Response> companies_company_id_users_user_id_favorites_favorite_id_patch(company_id, user_id, favorite_id, favorite)
|
304
312
|
|
305
|
-
Update an existing favorite by ID
|
313
|
+
Update an existing favorite by ID
|
306
314
|
|
307
315
|
### Examples
|
308
316
|
|
@@ -311,8 +319,10 @@ require 'time'
|
|
311
319
|
require 'spartera_api_sdk'
|
312
320
|
# setup authorization
|
313
321
|
SparteraApiSdk.configure do |config|
|
314
|
-
# Configure
|
315
|
-
config.
|
322
|
+
# Configure API key authorization: ApiKeyAuth
|
323
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
324
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
325
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
316
326
|
end
|
317
327
|
|
318
328
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
@@ -322,7 +332,7 @@ favorite_id = 'favorite_id_example' # String |
|
|
322
332
|
favorite = SparteraApiSdk::Favorite.new({asset_id: 'asset_id_example', company_id: 'company_id_example', priority: 'priority_example'}) # Favorite |
|
323
333
|
|
324
334
|
begin
|
325
|
-
# Update an existing favorite by ID
|
335
|
+
# Update an existing favorite by ID
|
326
336
|
result = api_instance.companies_company_id_users_user_id_favorites_favorite_id_patch(company_id, user_id, favorite_id, favorite)
|
327
337
|
p result
|
328
338
|
rescue SparteraApiSdk::ApiError => e
|
@@ -334,15 +344,15 @@ end
|
|
334
344
|
|
335
345
|
This returns an Array which contains the response data, status code and headers.
|
336
346
|
|
337
|
-
> <Array(
|
347
|
+
> <Array(<CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200Response>, Integer, Hash)> companies_company_id_users_user_id_favorites_favorite_id_patch_with_http_info(company_id, user_id, favorite_id, favorite)
|
338
348
|
|
339
349
|
```ruby
|
340
350
|
begin
|
341
|
-
# Update an existing favorite by ID
|
351
|
+
# Update an existing favorite by ID
|
342
352
|
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_favorite_id_patch_with_http_info(company_id, user_id, favorite_id, favorite)
|
343
353
|
p status_code # => 2xx
|
344
354
|
p headers # => { ... }
|
345
|
-
p data # =>
|
355
|
+
p data # => <CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200Response>
|
346
356
|
rescue SparteraApiSdk::ApiError => e
|
347
357
|
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_favorite_id_patch_with_http_info: #{e}"
|
348
358
|
end
|
@@ -359,11 +369,11 @@ end
|
|
359
369
|
|
360
370
|
### Return type
|
361
371
|
|
362
|
-
**
|
372
|
+
[**CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200Response**](CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200Response.md)
|
363
373
|
|
364
374
|
### Authorization
|
365
375
|
|
366
|
-
[
|
376
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
367
377
|
|
368
378
|
### HTTP request headers
|
369
379
|
|
@@ -373,9 +383,9 @@ end
|
|
373
383
|
|
374
384
|
## companies_company_id_users_user_id_favorites_get
|
375
385
|
|
376
|
-
>
|
386
|
+
> <CompaniesCompanyIdUsersUserIdFavoritesGet200Response> companies_company_id_users_user_id_favorites_get(company_id, user_id)
|
377
387
|
|
378
|
-
Get a list of all favorites for a specific user
|
388
|
+
Get a list of all favorites for a specific user
|
379
389
|
|
380
390
|
### Examples
|
381
391
|
|
@@ -384,8 +394,10 @@ require 'time'
|
|
384
394
|
require 'spartera_api_sdk'
|
385
395
|
# setup authorization
|
386
396
|
SparteraApiSdk.configure do |config|
|
387
|
-
# Configure
|
388
|
-
config.
|
397
|
+
# Configure API key authorization: ApiKeyAuth
|
398
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
399
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
400
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
389
401
|
end
|
390
402
|
|
391
403
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
@@ -393,7 +405,7 @@ company_id = 'company_id_example' # String |
|
|
393
405
|
user_id = 'user_id_example' # String |
|
394
406
|
|
395
407
|
begin
|
396
|
-
# Get a list of all favorites for a specific user
|
408
|
+
# Get a list of all favorites for a specific user
|
397
409
|
result = api_instance.companies_company_id_users_user_id_favorites_get(company_id, user_id)
|
398
410
|
p result
|
399
411
|
rescue SparteraApiSdk::ApiError => e
|
@@ -405,15 +417,15 @@ end
|
|
405
417
|
|
406
418
|
This returns an Array which contains the response data, status code and headers.
|
407
419
|
|
408
|
-
> <Array(
|
420
|
+
> <Array(<CompaniesCompanyIdUsersUserIdFavoritesGet200Response>, Integer, Hash)> companies_company_id_users_user_id_favorites_get_with_http_info(company_id, user_id)
|
409
421
|
|
410
422
|
```ruby
|
411
423
|
begin
|
412
|
-
# Get a list of all favorites for a specific user
|
424
|
+
# Get a list of all favorites for a specific user
|
413
425
|
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_get_with_http_info(company_id, user_id)
|
414
426
|
p status_code # => 2xx
|
415
427
|
p headers # => { ... }
|
416
|
-
p data # =>
|
428
|
+
p data # => <CompaniesCompanyIdUsersUserIdFavoritesGet200Response>
|
417
429
|
rescue SparteraApiSdk::ApiError => e
|
418
430
|
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_get_with_http_info: #{e}"
|
419
431
|
end
|
@@ -428,11 +440,11 @@ end
|
|
428
440
|
|
429
441
|
### Return type
|
430
442
|
|
431
|
-
**
|
443
|
+
[**CompaniesCompanyIdUsersUserIdFavoritesGet200Response**](CompaniesCompanyIdUsersUserIdFavoritesGet200Response.md)
|
432
444
|
|
433
445
|
### Authorization
|
434
446
|
|
435
|
-
[
|
447
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
436
448
|
|
437
449
|
### HTTP request headers
|
438
450
|
|
@@ -442,7 +454,7 @@ end
|
|
442
454
|
|
443
455
|
## companies_company_id_users_user_id_favorites_post
|
444
456
|
|
445
|
-
>
|
457
|
+
> <CompaniesCompanyIdUsersUserIdFavoritesPost200Response> companies_company_id_users_user_id_favorites_post(company_id, user_id, favorite)
|
446
458
|
|
447
459
|
POST /companies/{company_id}/users/{user_id}/favorites
|
448
460
|
|
@@ -453,8 +465,10 @@ require 'time'
|
|
453
465
|
require 'spartera_api_sdk'
|
454
466
|
# setup authorization
|
455
467
|
SparteraApiSdk.configure do |config|
|
456
|
-
# Configure
|
457
|
-
config.
|
468
|
+
# Configure API key authorization: ApiKeyAuth
|
469
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
470
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
471
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
458
472
|
end
|
459
473
|
|
460
474
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
@@ -475,7 +489,7 @@ end
|
|
475
489
|
|
476
490
|
This returns an Array which contains the response data, status code and headers.
|
477
491
|
|
478
|
-
> <Array(
|
492
|
+
> <Array(<CompaniesCompanyIdUsersUserIdFavoritesPost200Response>, Integer, Hash)> companies_company_id_users_user_id_favorites_post_with_http_info(company_id, user_id, favorite)
|
479
493
|
|
480
494
|
```ruby
|
481
495
|
begin
|
@@ -483,7 +497,7 @@ begin
|
|
483
497
|
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_post_with_http_info(company_id, user_id, favorite)
|
484
498
|
p status_code # => 2xx
|
485
499
|
p headers # => { ... }
|
486
|
-
p data # =>
|
500
|
+
p data # => <CompaniesCompanyIdUsersUserIdFavoritesPost200Response>
|
487
501
|
rescue SparteraApiSdk::ApiError => e
|
488
502
|
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_post_with_http_info: #{e}"
|
489
503
|
end
|
@@ -499,11 +513,11 @@ end
|
|
499
513
|
|
500
514
|
### Return type
|
501
515
|
|
502
|
-
**
|
516
|
+
[**CompaniesCompanyIdUsersUserIdFavoritesPost200Response**](CompaniesCompanyIdUsersUserIdFavoritesPost200Response.md)
|
503
517
|
|
504
518
|
### Authorization
|
505
519
|
|
506
|
-
[
|
520
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
507
521
|
|
508
522
|
### HTTP request headers
|
509
523
|
|
@@ -513,7 +527,7 @@ end
|
|
513
527
|
|
514
528
|
## companies_company_id_users_user_id_favorites_uncategorized_get
|
515
529
|
|
516
|
-
>
|
530
|
+
> <CompaniesCompanyIdUsersUserIdFavoritesGet200Response> companies_company_id_users_user_id_favorites_uncategorized_get(company_id, user_id)
|
517
531
|
|
518
532
|
Get all favorites for the specified user that don't have a category
|
519
533
|
|
@@ -524,8 +538,10 @@ require 'time'
|
|
524
538
|
require 'spartera_api_sdk'
|
525
539
|
# setup authorization
|
526
540
|
SparteraApiSdk.configure do |config|
|
527
|
-
# Configure
|
528
|
-
config.
|
541
|
+
# Configure API key authorization: ApiKeyAuth
|
542
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
543
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
544
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
529
545
|
end
|
530
546
|
|
531
547
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
@@ -545,7 +561,7 @@ end
|
|
545
561
|
|
546
562
|
This returns an Array which contains the response data, status code and headers.
|
547
563
|
|
548
|
-
> <Array(
|
564
|
+
> <Array(<CompaniesCompanyIdUsersUserIdFavoritesGet200Response>, Integer, Hash)> companies_company_id_users_user_id_favorites_uncategorized_get_with_http_info(company_id, user_id)
|
549
565
|
|
550
566
|
```ruby
|
551
567
|
begin
|
@@ -553,7 +569,7 @@ begin
|
|
553
569
|
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_uncategorized_get_with_http_info(company_id, user_id)
|
554
570
|
p status_code # => 2xx
|
555
571
|
p headers # => { ... }
|
556
|
-
p data # =>
|
572
|
+
p data # => <CompaniesCompanyIdUsersUserIdFavoritesGet200Response>
|
557
573
|
rescue SparteraApiSdk::ApiError => e
|
558
574
|
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_uncategorized_get_with_http_info: #{e}"
|
559
575
|
end
|
@@ -568,11 +584,11 @@ end
|
|
568
584
|
|
569
585
|
### Return type
|
570
586
|
|
571
|
-
**
|
587
|
+
[**CompaniesCompanyIdUsersUserIdFavoritesGet200Response**](CompaniesCompanyIdUsersUserIdFavoritesGet200Response.md)
|
572
588
|
|
573
589
|
### Authorization
|
574
590
|
|
575
|
-
[
|
591
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
576
592
|
|
577
593
|
### HTTP request headers
|
578
594
|
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# SparteraApiSdk::MeGet200Response
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **user_id** | **String** | Firebase user ID | |
|
8
|
+
| **email** | **String** | User email address | [optional] |
|
9
|
+
| **auth_method** | **String** | Authentication method used | |
|
10
|
+
| **platform** | **String** | Platform origin | [optional] |
|
11
|
+
| **origin_domain** | **String** | Request origin domain | [optional] |
|
12
|
+
| **profile** | [**MeGet200ResponseProfile**](MeGet200ResponseProfile.md) | | |
|
13
|
+
| **company_id** | **String** | Company ID from authentication claims | |
|
14
|
+
| **role_id** | **Integer** | Role ID from authentication claims | |
|
15
|
+
| **token_metadata** | [**MeGet200ResponseTokenMetadata**](MeGet200ResponseTokenMetadata.md) | | [optional] |
|
16
|
+
| **api_key_info** | [**MeGet200ResponseApiKeyInfo**](MeGet200ResponseApiKeyInfo.md) | | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'spartera_api_sdk'
|
22
|
+
|
23
|
+
instance = SparteraApiSdk::MeGet200Response.new(
|
24
|
+
user_id: null,
|
25
|
+
email: null,
|
26
|
+
auth_method: null,
|
27
|
+
platform: null,
|
28
|
+
origin_domain: null,
|
29
|
+
profile: null,
|
30
|
+
company_id: null,
|
31
|
+
role_id: null,
|
32
|
+
token_metadata: null,
|
33
|
+
api_key_info: null
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SparteraApiSdk::MeGet200ResponseApiKeyInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **api_key_id** | **String** | API key ID | [optional] |
|
8
|
+
| **api_key_name** | **String** | API key name | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'spartera_api_sdk'
|
14
|
+
|
15
|
+
instance = SparteraApiSdk::MeGet200ResponseApiKeyInfo.new(
|
16
|
+
api_key_id: null,
|
17
|
+
api_key_name: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# SparteraApiSdk::MeGet200ResponseProfile
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | User ID (primary key) | [optional] |
|
8
|
+
| **type** | **String** | Profile type | [optional] |
|
9
|
+
| **company_id** | **String** | Company ID | [optional] |
|
10
|
+
| **function_id** | **Integer** | User function/role ID | [optional] |
|
11
|
+
| **status** | **String** | User status | [optional] |
|
12
|
+
| **email_address** | **String** | User email address | [optional] |
|
13
|
+
| **timezone** | **String** | User timezone | [optional] |
|
14
|
+
| **date_created** | **Time** | Account creation date | [optional] |
|
15
|
+
| **last_updated** | **Time** | Last profile update | [optional] |
|
16
|
+
| **active** | **Boolean** | Account active status | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'spartera_api_sdk'
|
22
|
+
|
23
|
+
instance = SparteraApiSdk::MeGet200ResponseProfile.new(
|
24
|
+
id: null,
|
25
|
+
type: null,
|
26
|
+
company_id: null,
|
27
|
+
function_id: null,
|
28
|
+
status: null,
|
29
|
+
email_address: null,
|
30
|
+
timezone: null,
|
31
|
+
date_created: null,
|
32
|
+
last_updated: null,
|
33
|
+
active: null
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# SparteraApiSdk::MeGet200ResponseTokenMetadata
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **issuer** | **String** | Token issuer | [optional] |
|
8
|
+
| **auth_time** | **Integer** | Authentication time | [optional] |
|
9
|
+
| **issued_at** | **Integer** | Token issued timestamp | [optional] |
|
10
|
+
| **expires_at** | **Integer** | Token expiration timestamp | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'spartera_api_sdk'
|
16
|
+
|
17
|
+
instance = SparteraApiSdk::MeGet200ResponseTokenMetadata.new(
|
18
|
+
issuer: null,
|
19
|
+
auth_time: null,
|
20
|
+
issued_at: null,
|
21
|
+
expires_at: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|