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.
Files changed (172) hide show
  1. checksums.yaml +4 -4
  2. data/config.json +1 -1
  3. data/docs/APIKeysApi.md +45 -35
  4. data/docs/AlertsApi.md +71 -57
  5. data/docs/AssetPriceHistoryApi.md +80 -64
  6. data/docs/AssetsApi.md +116 -378
  7. data/docs/CloudProvidersApi.md +18 -215
  8. data/docs/CompaniesApi.md +81 -63
  9. data/docs/CompaniesCompanyIdApiKeysGet200Response.md +20 -0
  10. data/docs/CompaniesCompanyIdAssetsAssetIdDelete200Response.md +20 -0
  11. data/docs/CompaniesCompanyIdAssetsAssetIdDelete200ResponseData.md +18 -0
  12. data/docs/CompaniesCompanyIdAssetsAssetIdGet200Response.md +20 -0
  13. data/docs/CompaniesCompanyIdAssetsAssetIdPatch200Response.md +20 -0
  14. data/docs/CompaniesCompanyIdAssetsAssetIdPatch200ResponseData.md +18 -0
  15. data/docs/CompaniesCompanyIdAssetsGet200Response.md +20 -0
  16. data/docs/CompaniesCompanyIdAssetsPost200Response.md +20 -0
  17. data/docs/CompaniesCompanyIdAssetsPost200ResponseData.md +18 -0
  18. data/docs/CompaniesCompanyIdConnectionsConnectionIdDelete200Response.md +20 -0
  19. data/docs/CompaniesCompanyIdConnectionsConnectionIdDelete200ResponseData.md +18 -0
  20. data/docs/CompaniesCompanyIdConnectionsConnectionIdGet200Response.md +20 -0
  21. data/docs/CompaniesCompanyIdConnectionsConnectionIdPatch200Response.md +20 -0
  22. data/docs/CompaniesCompanyIdConnectionsConnectionIdPatch200ResponseData.md +18 -0
  23. data/docs/CompaniesCompanyIdConnectionsGet200Response.md +20 -0
  24. data/docs/CompaniesCompanyIdConnectionsPost200Response.md +20 -0
  25. data/docs/CompaniesCompanyIdConnectionsPost200ResponseData.md +18 -0
  26. data/docs/CompaniesCompanyIdUsersGet200Response.md +20 -0
  27. data/docs/CompaniesCompanyIdUsersPost200Response.md +20 -0
  28. data/docs/CompaniesCompanyIdUsersPost200ResponseData.md +18 -0
  29. data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200Response.md +20 -0
  30. data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200ResponseData.md +18 -0
  31. data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response.md +20 -0
  32. data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200Response.md +20 -0
  33. data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200ResponseData.md +18 -0
  34. data/docs/CompaniesCompanyIdUsersUserIdAlertsGet200Response.md +20 -0
  35. data/docs/CompaniesCompanyIdUsersUserIdAlertsPost200Response.md +20 -0
  36. data/docs/CompaniesCompanyIdUsersUserIdAlertsPost200ResponseData.md +18 -0
  37. data/docs/CompaniesCompanyIdUsersUserIdDelete200Response.md +20 -0
  38. data/docs/CompaniesCompanyIdUsersUserIdDelete200ResponseData.md +18 -0
  39. data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200Response.md +20 -0
  40. data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200ResponseData.md +18 -0
  41. data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response.md +20 -0
  42. data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200Response.md +20 -0
  43. data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200ResponseData.md +18 -0
  44. data/docs/CompaniesCompanyIdUsersUserIdFavoritesGet200Response.md +20 -0
  45. data/docs/CompaniesCompanyIdUsersUserIdFavoritesPost200Response.md +20 -0
  46. data/docs/CompaniesCompanyIdUsersUserIdFavoritesPost200ResponseData.md +18 -0
  47. data/docs/CompaniesCompanyIdUsersUserIdGet200Response.md +20 -0
  48. data/docs/CompaniesCompanyIdUsersUserIdPatch200Response.md +20 -0
  49. data/docs/CompaniesCompanyIdUsersUserIdPatch200ResponseData.md +18 -0
  50. data/docs/ConnectionsApi.md +67 -53
  51. data/docs/FavoritesApi.md +84 -68
  52. data/docs/MeGet200Response.md +36 -0
  53. data/docs/MeGet200ResponseApiKeyInfo.md +20 -0
  54. data/docs/MeGet200ResponseProfile.md +36 -0
  55. data/docs/MeGet200ResponseTokenMetadata.md +24 -0
  56. data/docs/StorageEnginesApi.md +149 -0
  57. data/docs/UsersApi.md +116 -39
  58. data/lib/spartera_api_sdk/api/alerts_api.rb +32 -32
  59. data/lib/spartera_api_sdk/api/api_keys_api.rb +20 -20
  60. data/lib/spartera_api_sdk/api/asset_price_history_api.rb +36 -36
  61. data/lib/spartera_api_sdk/api/assets_api.rb +52 -328
  62. data/lib/spartera_api_sdk/api/cloud_providers_api.rb +8 -185
  63. data/lib/spartera_api_sdk/api/companies_api.rb +36 -36
  64. data/lib/spartera_api_sdk/api/connections_api.rb +30 -30
  65. data/lib/spartera_api_sdk/api/favorites_api.rb +38 -38
  66. data/lib/spartera_api_sdk/api/storage_engines_api.rb +150 -0
  67. data/lib/spartera_api_sdk/api/users_api.rb +77 -22
  68. data/lib/spartera_api_sdk/configuration.rb +2 -10
  69. data/lib/spartera_api_sdk/models/companies_company_id_api_keys_get200_response.rb +248 -0
  70. data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_delete200_response.rb +264 -0
  71. data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_delete200_response_data.rb +238 -0
  72. data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_get200_response.rb +264 -0
  73. data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_patch200_response.rb +264 -0
  74. data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_patch200_response_data.rb +238 -0
  75. data/lib/spartera_api_sdk/models/companies_company_id_assets_get200_response.rb +266 -0
  76. data/lib/spartera_api_sdk/models/companies_company_id_assets_post200_response.rb +264 -0
  77. data/lib/spartera_api_sdk/models/companies_company_id_assets_post200_response_data.rb +238 -0
  78. data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_delete200_response.rb +264 -0
  79. data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_delete200_response_data.rb +238 -0
  80. data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_get200_response.rb +264 -0
  81. data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_patch200_response.rb +264 -0
  82. data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_patch200_response_data.rb +238 -0
  83. data/lib/spartera_api_sdk/models/companies_company_id_connections_get200_response.rb +266 -0
  84. data/lib/spartera_api_sdk/models/companies_company_id_connections_post200_response.rb +264 -0
  85. data/lib/spartera_api_sdk/models/companies_company_id_connections_post200_response_data.rb +238 -0
  86. data/lib/spartera_api_sdk/models/companies_company_id_users_get200_response.rb +266 -0
  87. data/lib/spartera_api_sdk/models/companies_company_id_users_post200_response.rb +264 -0
  88. data/lib/spartera_api_sdk/models/companies_company_id_users_post200_response_data.rb +238 -0
  89. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response.rb +264 -0
  90. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_data.rb +238 -0
  91. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_get200_response.rb +264 -0
  92. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response.rb +264 -0
  93. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_data.rb +238 -0
  94. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_get200_response.rb +266 -0
  95. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_post200_response.rb +264 -0
  96. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_post200_response_data.rb +238 -0
  97. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_delete200_response.rb +264 -0
  98. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_delete200_response_data.rb +238 -0
  99. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response.rb +264 -0
  100. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_data.rb +238 -0
  101. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_get200_response.rb +264 -0
  102. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response.rb +264 -0
  103. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_data.rb +238 -0
  104. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_get200_response.rb +266 -0
  105. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_post200_response.rb +264 -0
  106. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_post200_response_data.rb +238 -0
  107. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_get200_response.rb +264 -0
  108. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_patch200_response.rb +264 -0
  109. data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_patch200_response_data.rb +238 -0
  110. data/lib/spartera_api_sdk/models/me_get200_response.rb +417 -0
  111. data/lib/spartera_api_sdk/models/me_get200_response_api_key_info.rb +232 -0
  112. data/lib/spartera_api_sdk/models/me_get200_response_profile.rb +345 -0
  113. data/lib/spartera_api_sdk/models/me_get200_response_token_metadata.rb +252 -0
  114. data/lib/spartera_api_sdk/version.rb +1 -1
  115. data/lib/spartera_api_sdk.rb +46 -0
  116. data/spec/api/alerts_api_spec.rb +9 -9
  117. data/spec/api/api_keys_api_spec.rb +5 -5
  118. data/spec/api/asset_price_history_api_spec.rb +10 -10
  119. data/spec/api/assets_api_spec.rb +14 -64
  120. data/spec/api/cloud_providers_api_spec.rb +2 -34
  121. data/spec/api/companies_api_spec.rb +9 -9
  122. data/spec/api/connections_api_spec.rb +8 -8
  123. data/spec/api/favorites_api_spec.rb +11 -11
  124. data/spec/api/storage_engines_api_spec.rb +58 -0
  125. data/spec/api/users_api_spec.rb +16 -6
  126. data/spec/models/companies_company_id_api_keys_get200_response_spec.rb +42 -0
  127. data/spec/models/companies_company_id_assets_asset_id_delete200_response_data_spec.rb +36 -0
  128. data/spec/models/companies_company_id_assets_asset_id_delete200_response_spec.rb +42 -0
  129. data/spec/models/companies_company_id_assets_asset_id_get200_response_spec.rb +42 -0
  130. data/spec/models/companies_company_id_assets_asset_id_patch200_response_data_spec.rb +36 -0
  131. data/spec/models/companies_company_id_assets_asset_id_patch200_response_spec.rb +42 -0
  132. data/spec/models/companies_company_id_assets_get200_response_spec.rb +42 -0
  133. data/spec/models/companies_company_id_assets_post200_response_data_spec.rb +36 -0
  134. data/spec/models/companies_company_id_assets_post200_response_spec.rb +42 -0
  135. data/spec/models/companies_company_id_connections_connection_id_delete200_response_data_spec.rb +36 -0
  136. data/spec/models/companies_company_id_connections_connection_id_delete200_response_spec.rb +42 -0
  137. data/spec/models/companies_company_id_connections_connection_id_get200_response_spec.rb +42 -0
  138. data/spec/models/companies_company_id_connections_connection_id_patch200_response_data_spec.rb +36 -0
  139. data/spec/models/companies_company_id_connections_connection_id_patch200_response_spec.rb +42 -0
  140. data/spec/models/companies_company_id_connections_get200_response_spec.rb +42 -0
  141. data/spec/models/companies_company_id_connections_post200_response_data_spec.rb +36 -0
  142. data/spec/models/companies_company_id_connections_post200_response_spec.rb +42 -0
  143. data/spec/models/companies_company_id_users_get200_response_spec.rb +42 -0
  144. data/spec/models/companies_company_id_users_post200_response_data_spec.rb +36 -0
  145. data/spec/models/companies_company_id_users_post200_response_spec.rb +42 -0
  146. data/spec/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_data_spec.rb +36 -0
  147. data/spec/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_spec.rb +42 -0
  148. data/spec/models/companies_company_id_users_user_id_alerts_alert_id_get200_response_spec.rb +42 -0
  149. data/spec/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_data_spec.rb +36 -0
  150. data/spec/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_spec.rb +42 -0
  151. data/spec/models/companies_company_id_users_user_id_alerts_get200_response_spec.rb +42 -0
  152. data/spec/models/companies_company_id_users_user_id_alerts_post200_response_data_spec.rb +36 -0
  153. data/spec/models/companies_company_id_users_user_id_alerts_post200_response_spec.rb +42 -0
  154. data/spec/models/companies_company_id_users_user_id_delete200_response_data_spec.rb +36 -0
  155. data/spec/models/companies_company_id_users_user_id_delete200_response_spec.rb +42 -0
  156. data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_data_spec.rb +36 -0
  157. data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_spec.rb +42 -0
  158. data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_get200_response_spec.rb +42 -0
  159. data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_data_spec.rb +36 -0
  160. data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_spec.rb +42 -0
  161. data/spec/models/companies_company_id_users_user_id_favorites_get200_response_spec.rb +42 -0
  162. data/spec/models/companies_company_id_users_user_id_favorites_post200_response_data_spec.rb +36 -0
  163. data/spec/models/companies_company_id_users_user_id_favorites_post200_response_spec.rb +42 -0
  164. data/spec/models/companies_company_id_users_user_id_get200_response_spec.rb +42 -0
  165. data/spec/models/companies_company_id_users_user_id_patch200_response_data_spec.rb +36 -0
  166. data/spec/models/companies_company_id_users_user_id_patch200_response_spec.rb +42 -0
  167. data/spec/models/me_get200_response_api_key_info_spec.rb +42 -0
  168. data/spec/models/me_get200_response_profile_spec.rb +94 -0
  169. data/spec/models/me_get200_response_spec.rb +94 -0
  170. data/spec/models/me_get200_response_token_metadata_spec.rb +54 -0
  171. metadata +208 -22
  172. data/Gemfile.lock +0 -69
data/docs/CompaniesApi.md CHANGED
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.spartera.com*
17
17
 
18
18
  ## companies_company_id_analytics_assets_get
19
19
 
20
- > Object companies_company_id_analytics_assets_get(company_id)
20
+ > <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_analytics_assets_get(company_id)
21
21
 
22
22
  Get asset performance analytics Query params: start_date, end_date, limit, sort_by, include
23
23
 
@@ -28,8 +28,10 @@ require 'time'
28
28
  require 'spartera_api_sdk'
29
29
  # setup authorization
30
30
  SparteraApiSdk.configure do |config|
31
- # Configure Bearer authorization (JWT): bearerAuth
32
- config.access_token = 'YOUR_BEARER_TOKEN'
31
+ # Configure API key authorization: ApiKeyAuth
32
+ config.api_key['x-api-key'] = 'YOUR API KEY'
33
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
34
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
33
35
  end
34
36
 
35
37
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -48,7 +50,7 @@ end
48
50
 
49
51
  This returns an Array which contains the response data, status code and headers.
50
52
 
51
- > <Array(Object, Integer, Hash)> companies_company_id_analytics_assets_get_with_http_info(company_id)
53
+ > <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_analytics_assets_get_with_http_info(company_id)
52
54
 
53
55
  ```ruby
54
56
  begin
@@ -56,7 +58,7 @@ begin
56
58
  data, status_code, headers = api_instance.companies_company_id_analytics_assets_get_with_http_info(company_id)
57
59
  p status_code # => 2xx
58
60
  p headers # => { ... }
59
- p data # => Object
61
+ p data # => <CompaniesCompanyIdApiKeysGet200Response>
60
62
  rescue SparteraApiSdk::ApiError => e
61
63
  puts "Error when calling CompaniesApi->companies_company_id_analytics_assets_get_with_http_info: #{e}"
62
64
  end
@@ -70,11 +72,11 @@ end
70
72
 
71
73
  ### Return type
72
74
 
73
- **Object**
75
+ [**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
74
76
 
75
77
  ### Authorization
76
78
 
77
- [bearerAuth](../README.md#bearerAuth)
79
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
78
80
 
79
81
  ### HTTP request headers
80
82
 
@@ -84,7 +86,7 @@ end
84
86
 
85
87
  ## companies_company_id_analytics_customers_get
86
88
 
87
- > Object companies_company_id_analytics_customers_get(company_id)
89
+ > <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_analytics_customers_get(company_id)
88
90
 
89
91
  Get customer analytics including growth and segmentation Query params: start_date, end_date, group_by, segment_by
90
92
 
@@ -95,8 +97,10 @@ require 'time'
95
97
  require 'spartera_api_sdk'
96
98
  # setup authorization
97
99
  SparteraApiSdk.configure do |config|
98
- # Configure Bearer authorization (JWT): bearerAuth
99
- config.access_token = 'YOUR_BEARER_TOKEN'
100
+ # Configure API key authorization: ApiKeyAuth
101
+ config.api_key['x-api-key'] = 'YOUR API KEY'
102
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
103
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
100
104
  end
101
105
 
102
106
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -115,7 +119,7 @@ end
115
119
 
116
120
  This returns an Array which contains the response data, status code and headers.
117
121
 
118
- > <Array(Object, Integer, Hash)> companies_company_id_analytics_customers_get_with_http_info(company_id)
122
+ > <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_analytics_customers_get_with_http_info(company_id)
119
123
 
120
124
  ```ruby
121
125
  begin
@@ -123,7 +127,7 @@ begin
123
127
  data, status_code, headers = api_instance.companies_company_id_analytics_customers_get_with_http_info(company_id)
124
128
  p status_code # => 2xx
125
129
  p headers # => { ... }
126
- p data # => Object
130
+ p data # => <CompaniesCompanyIdApiKeysGet200Response>
127
131
  rescue SparteraApiSdk::ApiError => e
128
132
  puts "Error when calling CompaniesApi->companies_company_id_analytics_customers_get_with_http_info: #{e}"
129
133
  end
@@ -137,11 +141,11 @@ end
137
141
 
138
142
  ### Return type
139
143
 
140
- **Object**
144
+ [**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
141
145
 
142
146
  ### Authorization
143
147
 
144
- [bearerAuth](../README.md#bearerAuth)
148
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
145
149
 
146
150
  ### HTTP request headers
147
151
 
@@ -151,7 +155,7 @@ end
151
155
 
152
156
  ## companies_company_id_analytics_dashboard_get
153
157
 
154
- > Object companies_company_id_analytics_dashboard_get(company_id)
158
+ > <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_analytics_dashboard_get(company_id)
155
159
 
156
160
  Get comprehensive dashboard analytics for seller dashboard Includes all metrics needed for dashboard charts in one call Query params: start_date, end_date, period (day/week/month/quarter)
157
161
 
@@ -162,8 +166,10 @@ require 'time'
162
166
  require 'spartera_api_sdk'
163
167
  # setup authorization
164
168
  SparteraApiSdk.configure do |config|
165
- # Configure Bearer authorization (JWT): bearerAuth
166
- config.access_token = 'YOUR_BEARER_TOKEN'
169
+ # Configure API key authorization: ApiKeyAuth
170
+ config.api_key['x-api-key'] = 'YOUR API KEY'
171
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
172
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
167
173
  end
168
174
 
169
175
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -182,7 +188,7 @@ end
182
188
 
183
189
  This returns an Array which contains the response data, status code and headers.
184
190
 
185
- > <Array(Object, Integer, Hash)> companies_company_id_analytics_dashboard_get_with_http_info(company_id)
191
+ > <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_analytics_dashboard_get_with_http_info(company_id)
186
192
 
187
193
  ```ruby
188
194
  begin
@@ -190,7 +196,7 @@ begin
190
196
  data, status_code, headers = api_instance.companies_company_id_analytics_dashboard_get_with_http_info(company_id)
191
197
  p status_code # => 2xx
192
198
  p headers # => { ... }
193
- p data # => Object
199
+ p data # => <CompaniesCompanyIdApiKeysGet200Response>
194
200
  rescue SparteraApiSdk::ApiError => e
195
201
  puts "Error when calling CompaniesApi->companies_company_id_analytics_dashboard_get_with_http_info: #{e}"
196
202
  end
@@ -204,11 +210,11 @@ end
204
210
 
205
211
  ### Return type
206
212
 
207
- **Object**
213
+ [**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
208
214
 
209
215
  ### Authorization
210
216
 
211
- [bearerAuth](../README.md#bearerAuth)
217
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
212
218
 
213
219
  ### HTTP request headers
214
220
 
@@ -218,7 +224,7 @@ end
218
224
 
219
225
  ## companies_company_id_analytics_sales_get
220
226
 
221
- > Object companies_company_id_analytics_sales_get(company_id)
227
+ > <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_analytics_sales_get(company_id)
222
228
 
223
229
  Get sales over time analytics Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
224
230
 
@@ -229,8 +235,10 @@ require 'time'
229
235
  require 'spartera_api_sdk'
230
236
  # setup authorization
231
237
  SparteraApiSdk.configure do |config|
232
- # Configure Bearer authorization (JWT): bearerAuth
233
- config.access_token = 'YOUR_BEARER_TOKEN'
238
+ # Configure API key authorization: ApiKeyAuth
239
+ config.api_key['x-api-key'] = 'YOUR API KEY'
240
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
241
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
234
242
  end
235
243
 
236
244
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -249,7 +257,7 @@ end
249
257
 
250
258
  This returns an Array which contains the response data, status code and headers.
251
259
 
252
- > <Array(Object, Integer, Hash)> companies_company_id_analytics_sales_get_with_http_info(company_id)
260
+ > <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_analytics_sales_get_with_http_info(company_id)
253
261
 
254
262
  ```ruby
255
263
  begin
@@ -257,7 +265,7 @@ begin
257
265
  data, status_code, headers = api_instance.companies_company_id_analytics_sales_get_with_http_info(company_id)
258
266
  p status_code # => 2xx
259
267
  p headers # => { ... }
260
- p data # => Object
268
+ p data # => <CompaniesCompanyIdApiKeysGet200Response>
261
269
  rescue SparteraApiSdk::ApiError => e
262
270
  puts "Error when calling CompaniesApi->companies_company_id_analytics_sales_get_with_http_info: #{e}"
263
271
  end
@@ -271,11 +279,11 @@ end
271
279
 
272
280
  ### Return type
273
281
 
274
- **Object**
282
+ [**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
275
283
 
276
284
  ### Authorization
277
285
 
278
- [bearerAuth](../README.md#bearerAuth)
286
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
279
287
 
280
288
  ### HTTP request headers
281
289
 
@@ -285,7 +293,7 @@ end
285
293
 
286
294
  ## companies_company_id_get
287
295
 
288
- > Object companies_company_id_get(company_id)
296
+ > <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_get(company_id)
289
297
 
290
298
  Get details of the requestor's own company
291
299
 
@@ -296,8 +304,10 @@ require 'time'
296
304
  require 'spartera_api_sdk'
297
305
  # setup authorization
298
306
  SparteraApiSdk.configure do |config|
299
- # Configure Bearer authorization (JWT): bearerAuth
300
- config.access_token = 'YOUR_BEARER_TOKEN'
307
+ # Configure API key authorization: ApiKeyAuth
308
+ config.api_key['x-api-key'] = 'YOUR API KEY'
309
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
310
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
301
311
  end
302
312
 
303
313
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -316,7 +326,7 @@ end
316
326
 
317
327
  This returns an Array which contains the response data, status code and headers.
318
328
 
319
- > <Array(Object, Integer, Hash)> companies_company_id_get_with_http_info(company_id)
329
+ > <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_get_with_http_info(company_id)
320
330
 
321
331
  ```ruby
322
332
  begin
@@ -324,7 +334,7 @@ begin
324
334
  data, status_code, headers = api_instance.companies_company_id_get_with_http_info(company_id)
325
335
  p status_code # => 2xx
326
336
  p headers # => { ... }
327
- p data # => Object
337
+ p data # => <CompaniesCompanyIdApiKeysGet200Response>
328
338
  rescue SparteraApiSdk::ApiError => e
329
339
  puts "Error when calling CompaniesApi->companies_company_id_get_with_http_info: #{e}"
330
340
  end
@@ -338,11 +348,11 @@ end
338
348
 
339
349
  ### Return type
340
350
 
341
- **Object**
351
+ [**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
342
352
 
343
353
  ### Authorization
344
354
 
345
- [bearerAuth](../README.md#bearerAuth)
355
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
346
356
 
347
357
  ### HTTP request headers
348
358
 
@@ -352,7 +362,7 @@ end
352
362
 
353
363
  ## companies_company_id_objects_get
354
364
 
355
- > Object companies_company_id_objects_get(company_id)
365
+ > <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_objects_get(company_id)
356
366
 
357
367
  Get all objects (connections, assets) of a single company
358
368
 
@@ -363,8 +373,10 @@ require 'time'
363
373
  require 'spartera_api_sdk'
364
374
  # setup authorization
365
375
  SparteraApiSdk.configure do |config|
366
- # Configure Bearer authorization (JWT): bearerAuth
367
- config.access_token = 'YOUR_BEARER_TOKEN'
376
+ # Configure API key authorization: ApiKeyAuth
377
+ config.api_key['x-api-key'] = 'YOUR API KEY'
378
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
379
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
368
380
  end
369
381
 
370
382
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -383,7 +395,7 @@ end
383
395
 
384
396
  This returns an Array which contains the response data, status code and headers.
385
397
 
386
- > <Array(Object, Integer, Hash)> companies_company_id_objects_get_with_http_info(company_id)
398
+ > <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_objects_get_with_http_info(company_id)
387
399
 
388
400
  ```ruby
389
401
  begin
@@ -391,7 +403,7 @@ begin
391
403
  data, status_code, headers = api_instance.companies_company_id_objects_get_with_http_info(company_id)
392
404
  p status_code # => 2xx
393
405
  p headers # => { ... }
394
- p data # => Object
406
+ p data # => <CompaniesCompanyIdApiKeysGet200Response>
395
407
  rescue SparteraApiSdk::ApiError => e
396
408
  puts "Error when calling CompaniesApi->companies_company_id_objects_get_with_http_info: #{e}"
397
409
  end
@@ -405,11 +417,11 @@ end
405
417
 
406
418
  ### Return type
407
419
 
408
- **Object**
420
+ [**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
409
421
 
410
422
  ### Authorization
411
423
 
412
- [bearerAuth](../README.md#bearerAuth)
424
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
413
425
 
414
426
  ### HTTP request headers
415
427
 
@@ -419,7 +431,7 @@ end
419
431
 
420
432
  ## companies_company_id_patch
421
433
 
422
- > Object companies_company_id_patch(company_id)
434
+ > <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_patch(company_id)
423
435
 
424
436
  Update an existing company by ID
425
437
 
@@ -430,8 +442,10 @@ require 'time'
430
442
  require 'spartera_api_sdk'
431
443
  # setup authorization
432
444
  SparteraApiSdk.configure do |config|
433
- # Configure Bearer authorization (JWT): bearerAuth
434
- config.access_token = 'YOUR_BEARER_TOKEN'
445
+ # Configure API key authorization: ApiKeyAuth
446
+ config.api_key['x-api-key'] = 'YOUR API KEY'
447
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
448
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
435
449
  end
436
450
 
437
451
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -450,7 +464,7 @@ end
450
464
 
451
465
  This returns an Array which contains the response data, status code and headers.
452
466
 
453
- > <Array(Object, Integer, Hash)> companies_company_id_patch_with_http_info(company_id)
467
+ > <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_patch_with_http_info(company_id)
454
468
 
455
469
  ```ruby
456
470
  begin
@@ -458,7 +472,7 @@ begin
458
472
  data, status_code, headers = api_instance.companies_company_id_patch_with_http_info(company_id)
459
473
  p status_code # => 2xx
460
474
  p headers # => { ... }
461
- p data # => Object
475
+ p data # => <CompaniesCompanyIdApiKeysGet200Response>
462
476
  rescue SparteraApiSdk::ApiError => e
463
477
  puts "Error when calling CompaniesApi->companies_company_id_patch_with_http_info: #{e}"
464
478
  end
@@ -472,11 +486,11 @@ end
472
486
 
473
487
  ### Return type
474
488
 
475
- **Object**
489
+ [**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
476
490
 
477
491
  ### Authorization
478
492
 
479
- [bearerAuth](../README.md#bearerAuth)
493
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
480
494
 
481
495
  ### HTTP request headers
482
496
 
@@ -486,7 +500,7 @@ end
486
500
 
487
501
  ## companies_company_id_requests_plan_get
488
502
 
489
- > Object companies_company_id_requests_plan_get(company_id)
503
+ > <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_requests_plan_get(company_id)
490
504
 
491
505
  Get the total number of requests allocated in the company's current subscription plan.
492
506
 
@@ -497,8 +511,10 @@ require 'time'
497
511
  require 'spartera_api_sdk'
498
512
  # setup authorization
499
513
  SparteraApiSdk.configure do |config|
500
- # Configure Bearer authorization (JWT): bearerAuth
501
- config.access_token = 'YOUR_BEARER_TOKEN'
514
+ # Configure API key authorization: ApiKeyAuth
515
+ config.api_key['x-api-key'] = 'YOUR API KEY'
516
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
517
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
502
518
  end
503
519
 
504
520
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -517,7 +533,7 @@ end
517
533
 
518
534
  This returns an Array which contains the response data, status code and headers.
519
535
 
520
- > <Array(Object, Integer, Hash)> companies_company_id_requests_plan_get_with_http_info(company_id)
536
+ > <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_requests_plan_get_with_http_info(company_id)
521
537
 
522
538
  ```ruby
523
539
  begin
@@ -525,7 +541,7 @@ begin
525
541
  data, status_code, headers = api_instance.companies_company_id_requests_plan_get_with_http_info(company_id)
526
542
  p status_code # => 2xx
527
543
  p headers # => { ... }
528
- p data # => Object
544
+ p data # => <CompaniesCompanyIdApiKeysGet200Response>
529
545
  rescue SparteraApiSdk::ApiError => e
530
546
  puts "Error when calling CompaniesApi->companies_company_id_requests_plan_get_with_http_info: #{e}"
531
547
  end
@@ -539,11 +555,11 @@ end
539
555
 
540
556
  ### Return type
541
557
 
542
- **Object**
558
+ [**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
543
559
 
544
560
  ### Authorization
545
561
 
546
- [bearerAuth](../README.md#bearerAuth)
562
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
547
563
 
548
564
  ### HTTP request headers
549
565
 
@@ -553,7 +569,7 @@ end
553
569
 
554
570
  ## companies_company_id_requests_usage_get
555
571
 
556
- > Object companies_company_id_requests_usage_get(company_id)
572
+ > <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_requests_usage_get(company_id)
557
573
 
558
574
  Get company request usage data for a specific month. Returns JSON metrics by default or CSV logs when download parameter is included.
559
575
 
@@ -564,8 +580,10 @@ require 'time'
564
580
  require 'spartera_api_sdk'
565
581
  # setup authorization
566
582
  SparteraApiSdk.configure do |config|
567
- # Configure Bearer authorization (JWT): bearerAuth
568
- config.access_token = 'YOUR_BEARER_TOKEN'
583
+ # Configure API key authorization: ApiKeyAuth
584
+ config.api_key['x-api-key'] = 'YOUR API KEY'
585
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
586
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
569
587
  end
570
588
 
571
589
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -584,7 +602,7 @@ end
584
602
 
585
603
  This returns an Array which contains the response data, status code and headers.
586
604
 
587
- > <Array(Object, Integer, Hash)> companies_company_id_requests_usage_get_with_http_info(company_id)
605
+ > <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_requests_usage_get_with_http_info(company_id)
588
606
 
589
607
  ```ruby
590
608
  begin
@@ -592,7 +610,7 @@ begin
592
610
  data, status_code, headers = api_instance.companies_company_id_requests_usage_get_with_http_info(company_id)
593
611
  p status_code # => 2xx
594
612
  p headers # => { ... }
595
- p data # => Object
613
+ p data # => <CompaniesCompanyIdApiKeysGet200Response>
596
614
  rescue SparteraApiSdk::ApiError => e
597
615
  puts "Error when calling CompaniesApi->companies_company_id_requests_usage_get_with_http_info: #{e}"
598
616
  end
@@ -606,11 +624,11 @@ end
606
624
 
607
625
  ### Return type
608
626
 
609
- **Object**
627
+ [**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
610
628
 
611
629
  ### Authorization
612
630
 
613
- [bearerAuth](../README.md#bearerAuth)
631
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
614
632
 
615
633
  ### HTTP request headers
616
634
 
@@ -0,0 +1,20 @@
1
+ # SparteraApiSdk::CompaniesCompanyIdApiKeysGet200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | Response status message | |
8
+ | **data** | **Object** | Response data | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'spartera_api_sdk'
14
+
15
+ instance = SparteraApiSdk::CompaniesCompanyIdApiKeysGet200Response.new(
16
+ message: success,
17
+ data: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdDelete200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | Response status message | |
8
+ | **data** | [**CompaniesCompanyIdAssetsAssetIdDelete200ResponseData**](CompaniesCompanyIdAssetsAssetIdDelete200ResponseData.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'spartera_api_sdk'
14
+
15
+ instance = SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdDelete200Response.new(
16
+ message: success,
17
+ data: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdDelete200ResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **asset_id** | **String** | ID of the deleted assets | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'spartera_api_sdk'
13
+
14
+ instance = SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdDelete200ResponseData.new(
15
+ asset_id: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdGet200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | Response status message | |
8
+ | **data** | [**Asset**](Asset.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'spartera_api_sdk'
14
+
15
+ instance = SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdGet200Response.new(
16
+ message: success,
17
+ data: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdPatch200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | Response status message | |
8
+ | **data** | [**CompaniesCompanyIdAssetsAssetIdPatch200ResponseData**](CompaniesCompanyIdAssetsAssetIdPatch200ResponseData.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'spartera_api_sdk'
14
+
15
+ instance = SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdPatch200Response.new(
16
+ message: success,
17
+ data: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdPatch200ResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **asset_id** | **String** | ID of the updated assets | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'spartera_api_sdk'
13
+
14
+ instance = SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdPatch200ResponseData.new(
15
+ asset_id: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # SparteraApiSdk::CompaniesCompanyIdAssetsGet200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | Response status message | |
8
+ | **data** | [**Array&lt;Asset&gt;**](Asset.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'spartera_api_sdk'
14
+
15
+ instance = SparteraApiSdk::CompaniesCompanyIdAssetsGet200Response.new(
16
+ message: success,
17
+ data: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # SparteraApiSdk::CompaniesCompanyIdAssetsPost200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | Response status message | |
8
+ | **data** | [**CompaniesCompanyIdAssetsPost200ResponseData**](CompaniesCompanyIdAssetsPost200ResponseData.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'spartera_api_sdk'
14
+
15
+ instance = SparteraApiSdk::CompaniesCompanyIdAssetsPost200Response.new(
16
+ message: success,
17
+ data: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # SparteraApiSdk::CompaniesCompanyIdAssetsPost200ResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **asset_id** | **String** | ID of the created assets | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'spartera_api_sdk'
13
+
14
+ instance = SparteraApiSdk::CompaniesCompanyIdAssetsPost200ResponseData.new(
15
+ asset_id: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # SparteraApiSdk::CompaniesCompanyIdConnectionsConnectionIdDelete200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | Response status message | |
8
+ | **data** | [**CompaniesCompanyIdConnectionsConnectionIdDelete200ResponseData**](CompaniesCompanyIdConnectionsConnectionIdDelete200ResponseData.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'spartera_api_sdk'
14
+
15
+ instance = SparteraApiSdk::CompaniesCompanyIdConnectionsConnectionIdDelete200Response.new(
16
+ message: success,
17
+ data: null
18
+ )
19
+ ```
20
+