cloudsmith-api 0.52.5 → 0.53.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/README.md +16 -4
- data/build.json +1 -1
- data/docs/EntitlementTokenMetric.md +9 -0
- data/docs/MetricsApi.md +158 -0
- data/docs/MetricsownerrepopackagesusageActivePackages.md +10 -0
- data/docs/PackageUsageMetric.md +11 -0
- data/docs/Quota.md +8 -0
- data/docs/QuotaApi.md +248 -0
- data/docs/QuotaHistory.md +8 -0
- data/docs/QuotaHistoryHistory.md +13 -0
- data/docs/RepositoryToken.md +3 -0
- data/docs/RepositoryTokenRefresh.md +3 -0
- data/docs/RepositoryTokenSyncTokens.md +3 -0
- data/lib/cloudsmith-api.rb +8 -0
- data/lib/cloudsmith-api/api/metrics_api.rb +167 -0
- data/lib/cloudsmith-api/api/quota_api.rb +227 -0
- data/lib/cloudsmith-api/models/entitlement_token_metric.rb +209 -0
- data/lib/cloudsmith-api/models/metricsownerrepopackagesusage_active_packages.rb +209 -0
- data/lib/cloudsmith-api/models/package_usage_metric.rb +243 -0
- data/lib/cloudsmith-api/models/quota.rb +194 -0
- data/lib/cloudsmith-api/models/quota_history.rb +196 -0
- data/lib/cloudsmith-api/models/quota_history_history.rb +239 -0
- data/lib/cloudsmith-api/models/repository_token.rb +31 -1
- data/lib/cloudsmith-api/models/repository_token_refresh.rb +31 -1
- data/lib/cloudsmith-api/models/repository_token_sync_tokens.rb +31 -1
- data/lib/cloudsmith-api/version.rb +1 -1
- data/spec/api/metrics_api_spec.rb +71 -0
- data/spec/api/quota_api_spec.rb +83 -0
- data/spec/models/entitlement_token_metric_spec.rb +48 -0
- data/spec/models/metricsownerrepopackagesusage_active_packages_spec.rb +54 -0
- data/spec/models/package_usage_metric_spec.rb +60 -0
- data/spec/models/quota_history_history_spec.rb +72 -0
- data/spec/models/quota_history_spec.rb +42 -0
- data/spec/models/quota_spec.rb +42 -0
- data/spec/models/repository_token_refresh_spec.rb +18 -0
- data/spec/models/repository_token_spec.rb +18 -0
- data/spec/models/repository_token_sync_tokens_spec.rb +18 -0
- data/vendor/bundle/ruby/2.6.0/cache/public_suffix-4.0.6.gem +0 -0
- data/vendor/bundle/ruby/2.6.0/extensions/x86_64-linux/2.6.0/autotest-fsevent-0.2.17/gem_make.out +1 -1
- data/vendor/bundle/ruby/2.6.0/extensions/x86_64-linux/2.6.0/ffi-1.13.1/gem_make.out +2 -2
- data/vendor/bundle/ruby/2.6.0/extensions/x86_64-linux/2.6.0/json-2.3.1/gem_make.out +1 -1
- data/vendor/bundle/ruby/2.6.0/gems/ffi-1.13.1/ext/ffi_c/Makefile +3 -3
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/.github/FUNDING.yml +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/.github/workflows/tests.yml +1 -1
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/.gitignore +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/.rubocop.yml +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/.rubocop_opinionated.yml +1 -18
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/.travis.yml +1 -1
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/.yardopts +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/2.0-Upgrade.md +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/CHANGELOG.md +7 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/Gemfile +1 -1
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/LICENSE.txt +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/README.md +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/Rakefile +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/SECURITY.md +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/bin/console +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/codecov.yml +0 -2
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/data/list.txt +312 -78
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/lib/public_suffix.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/lib/public_suffix/domain.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/lib/public_suffix/errors.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/lib/public_suffix/list.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/lib/public_suffix/rule.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/lib/public_suffix/version.rb +1 -1
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/public_suffix.gemspec +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/.empty +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/acceptance_test.rb +2 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/benchmarks/bm_find.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/benchmarks/bm_find_all.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/benchmarks/bm_names.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/benchmarks/bm_select.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/benchmarks/bm_select_incremental.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/benchmarks/bm_valid.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/profilers/domain_profiler.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/profilers/find_profiler.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/profilers/find_profiler_jp.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/profilers/initialization_profiler.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/profilers/list_profsize.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/profilers/object_binsize.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/psl_test.rb +1 -1
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/test_helper.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/tests.txt +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/unit/domain_test.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/unit/errors_test.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/unit/list_test.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/unit/public_suffix_test.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/gems/{public_suffix-4.0.5 → public_suffix-4.0.6}/test/unit/rule_test.rb +0 -0
- data/vendor/bundle/ruby/2.6.0/specifications/{public_suffix-4.0.5.gemspec → public_suffix-4.0.6.gemspec} +4 -4
- data/vendor/bundle/ruby/2.6.0/specifications/sys-uname-1.2.1.gemspec +1 -1
- metadata +167 -135
- data/vendor/bundle/ruby/2.6.0/cache/public_suffix-4.0.5.gem +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f996e5d0ec7be4e13c9f3016ed1c90b9662aaa3fcbf6e17faa7509a53e0af5eb
|
4
|
+
data.tar.gz: 3318eeb1beb67d059495c331a153d09a37927ddaf03e57b6e4f5fc46fd54bcd8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 574ffdd8e566b23b8f83647e5b5d1873cc1af328fe633bc2aa35e8610c6c71659a3a6ffd895f7f7fbd74cdddf426b8c2829f0f7256eedd72947238314ebc0ef7
|
7
|
+
data.tar.gz: 7162da48657aefcb777756b18c73bf42b4bb6cb4c26670c56f4f57af5b4ed20eb2e613f96da80d30036c27c11ba5ffbcef8396927d7e5a60f068a310aa115c58
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
cloudsmith-api (0.
|
4
|
+
cloudsmith-api (0.53.3)
|
5
5
|
json (~> 2.1, >= 2.1.0)
|
6
6
|
typhoeus (~> 1.0, >= 1.0.1)
|
7
7
|
|
@@ -25,7 +25,7 @@ GEM
|
|
25
25
|
ffi (1.13.1)
|
26
26
|
hashdiff (1.0.1)
|
27
27
|
json (2.3.1)
|
28
|
-
public_suffix (4.0.
|
28
|
+
public_suffix (4.0.6)
|
29
29
|
rake (12.0.0)
|
30
30
|
rspec (3.9.0)
|
31
31
|
rspec-core (~> 3.9.0)
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The API to the Cloudsmith Service
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: v1
|
10
|
-
- Package version: 0.
|
10
|
+
- Package version: 0.53.3
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://help.cloudsmith.io](https://help.cloudsmith.io)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build cloudsmith-api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./cloudsmith-api-0.
|
27
|
+
gem install ./cloudsmith-api-0.53.3.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./cloudsmith-api-0.
|
29
|
+
(for development, run `gem install --dev ./cloudsmith-api-0.53.3.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'cloudsmith-api', '~> 0.
|
35
|
+
gem 'cloudsmith-api', '~> 0.53.3'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -122,6 +122,8 @@ Class | Method | HTTP request | Description
|
|
122
122
|
*CloudsmithApi::FilesApi* | [**files_validate**](docs/FilesApi.md#files_validate) | **POST** /files/{owner}/{repo}/validate/ | Validate parameters used for create.
|
123
123
|
*CloudsmithApi::FormatsApi* | [**formats_list**](docs/FormatsApi.md#formats_list) | **GET** /formats/ | Get a list of all supported package formats.
|
124
124
|
*CloudsmithApi::FormatsApi* | [**formats_read**](docs/FormatsApi.md#formats_read) | **GET** /formats/{slug}/ | Get a specific supported package format.
|
125
|
+
*CloudsmithApi::MetricsApi* | [**metrics_entitlements_usage_list**](docs/MetricsApi.md#metrics_entitlements_usage_list) | **GET** /metrics/{owner}/{repo}/entitlements/usage/ | View for listing entitlement token usage as a metric.
|
126
|
+
*CloudsmithApi::MetricsApi* | [**metrics_packages_usage_list**](docs/MetricsApi.md#metrics_packages_usage_list) | **GET** /metrics/{owner}/{repo}/packages/usage/ | View for listing package usage metrics by user.
|
125
127
|
*CloudsmithApi::NamespacesApi* | [**namespaces_list**](docs/NamespacesApi.md#namespaces_list) | **GET** /namespaces/ | Get a list of all namespaces the user belongs to.
|
126
128
|
*CloudsmithApi::NamespacesApi* | [**namespaces_read**](docs/NamespacesApi.md#namespaces_read) | **GET** /namespaces/{slug}/ | Views for working with namespaces.
|
127
129
|
*CloudsmithApi::OrgsApi* | [**orgs_list**](docs/OrgsApi.md#orgs_list) | **GET** /orgs/ | Get a list of all the organizations you are associated with.
|
@@ -176,6 +178,10 @@ Class | Method | HTTP request | Description
|
|
176
178
|
*CloudsmithApi::PackagesApi* | [**packages_validate_upload_ruby**](docs/PackagesApi.md#packages_validate_upload_ruby) | **POST** /packages/{owner}/{repo}/validate-upload/ruby/ | Validate parameters for create Ruby package
|
177
179
|
*CloudsmithApi::PackagesApi* | [**packages_validate_upload_terraform**](docs/PackagesApi.md#packages_validate_upload_terraform) | **POST** /packages/{owner}/{repo}/validate-upload/terraform/ | Validate parameters for create Terraform package
|
178
180
|
*CloudsmithApi::PackagesApi* | [**packages_validate_upload_vagrant**](docs/PackagesApi.md#packages_validate_upload_vagrant) | **POST** /packages/{owner}/{repo}/validate-upload/vagrant/ | Validate parameters for create Vagrant package
|
181
|
+
*CloudsmithApi::QuotaApi* | [**quota_history_read**](docs/QuotaApi.md#quota_history_read) | **GET** /quota/history/{owner}/ | Quota history for a given namespace.
|
182
|
+
*CloudsmithApi::QuotaApi* | [**quota_oss_history_read**](docs/QuotaApi.md#quota_oss_history_read) | **GET** /quota/oss/history/{owner}/ | Open-source Quota history for a given namespace.
|
183
|
+
*CloudsmithApi::QuotaApi* | [**quota_oss_read**](docs/QuotaApi.md#quota_oss_read) | **GET** /quota/oss/{owner}/ | Open-source Quota usage for a given namespace.
|
184
|
+
*CloudsmithApi::QuotaApi* | [**quota_read**](docs/QuotaApi.md#quota_read) | **GET** /quota/{owner}/ | Quota usage for a given namespace.
|
179
185
|
*CloudsmithApi::RatesApi* | [**rates_limits_list**](docs/RatesApi.md#rates_limits_list) | **GET** /rates/limits/ | Endpoint to check rate limits for current user.
|
180
186
|
*CloudsmithApi::ReposApi* | [**repos_all_list**](docs/ReposApi.md#repos_all_list) | **GET** /repos/ | Get a list of all repositories associated with current user.
|
181
187
|
*CloudsmithApi::ReposApi* | [**repos_create**](docs/ReposApi.md#repos_create) | **POST** /repos/{owner}/ | Create a new repository in a given namespace.
|
@@ -202,6 +208,7 @@ Class | Method | HTTP request | Description
|
|
202
208
|
- [CloudsmithApi::ConanPackageUpload](docs/ConanPackageUpload.md)
|
203
209
|
- [CloudsmithApi::Distribution](docs/Distribution.md)
|
204
210
|
- [CloudsmithApi::DistrosVersions](docs/DistrosVersions.md)
|
211
|
+
- [CloudsmithApi::EntitlementTokenMetric](docs/EntitlementTokenMetric.md)
|
205
212
|
- [CloudsmithApi::EntitlementsCreate](docs/EntitlementsCreate.md)
|
206
213
|
- [CloudsmithApi::EntitlementsPartialUpdate](docs/EntitlementsPartialUpdate.md)
|
207
214
|
- [CloudsmithApi::EntitlementsRefresh](docs/EntitlementsRefresh.md)
|
@@ -213,6 +220,7 @@ Class | Method | HTTP request | Description
|
|
213
220
|
- [CloudsmithApi::Format](docs/Format.md)
|
214
221
|
- [CloudsmithApi::FormatsDistributions](docs/FormatsDistributions.md)
|
215
222
|
- [CloudsmithApi::MavenPackageUpload](docs/MavenPackageUpload.md)
|
223
|
+
- [CloudsmithApi::MetricsownerrepopackagesusageActivePackages](docs/MetricsownerrepopackagesusageActivePackages.md)
|
216
224
|
- [CloudsmithApi::Namespace](docs/Namespace.md)
|
217
225
|
- [CloudsmithApi::Organization](docs/Organization.md)
|
218
226
|
- [CloudsmithApi::Package](docs/Package.md)
|
@@ -221,6 +229,7 @@ Class | Method | HTTP request | Description
|
|
221
229
|
- [CloudsmithApi::PackageFileUpload](docs/PackageFileUpload.md)
|
222
230
|
- [CloudsmithApi::PackageMove](docs/PackageMove.md)
|
223
231
|
- [CloudsmithApi::PackageStatus](docs/PackageStatus.md)
|
232
|
+
- [CloudsmithApi::PackageUsageMetric](docs/PackageUsageMetric.md)
|
224
233
|
- [CloudsmithApi::PackagesCopy](docs/PackagesCopy.md)
|
225
234
|
- [CloudsmithApi::PackagesMove](docs/PackagesMove.md)
|
226
235
|
- [CloudsmithApi::PackagesTag](docs/PackagesTag.md)
|
@@ -268,6 +277,9 @@ Class | Method | HTTP request | Description
|
|
268
277
|
- [CloudsmithApi::PackagesValidateuploadVagrant](docs/PackagesValidateuploadVagrant.md)
|
269
278
|
- [CloudsmithApi::PackagesownerrepoArchitectures](docs/PackagesownerrepoArchitectures.md)
|
270
279
|
- [CloudsmithApi::PackagesownerrepoFiles](docs/PackagesownerrepoFiles.md)
|
280
|
+
- [CloudsmithApi::Quota](docs/Quota.md)
|
281
|
+
- [CloudsmithApi::QuotaHistory](docs/QuotaHistory.md)
|
282
|
+
- [CloudsmithApi::QuotaHistoryHistory](docs/QuotaHistoryHistory.md)
|
271
283
|
- [CloudsmithApi::RawPackageUpload](docs/RawPackageUpload.md)
|
272
284
|
- [CloudsmithApi::ReposCreate](docs/ReposCreate.md)
|
273
285
|
- [CloudsmithApi::ReposGpgKeys](docs/ReposGpgKeys.md)
|
data/build.json
CHANGED
data/docs/MetricsApi.md
ADDED
@@ -0,0 +1,158 @@
|
|
1
|
+
# CloudsmithApi::MetricsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloudsmith.io*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**metrics_entitlements_usage_list**](MetricsApi.md#metrics_entitlements_usage_list) | **GET** /metrics/{owner}/{repo}/entitlements/usage/ | View for listing entitlement token usage as a metric.
|
8
|
+
[**metrics_packages_usage_list**](MetricsApi.md#metrics_packages_usage_list) | **GET** /metrics/{owner}/{repo}/packages/usage/ | View for listing package usage metrics by user.
|
9
|
+
|
10
|
+
|
11
|
+
# **metrics_entitlements_usage_list**
|
12
|
+
> Array<EntitlementTokenMetric> metrics_entitlements_usage_list(owner, repo, opts)
|
13
|
+
|
14
|
+
View for listing entitlement token usage as a metric.
|
15
|
+
|
16
|
+
View for listing entitlement token usage as a metric.
|
17
|
+
|
18
|
+
### Example
|
19
|
+
```ruby
|
20
|
+
# load the gem
|
21
|
+
require 'cloudsmith-api'
|
22
|
+
# setup authorization
|
23
|
+
CloudsmithApi.configure do |config|
|
24
|
+
# Configure API key authorization: apikey
|
25
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
26
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
27
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
28
|
+
|
29
|
+
# Configure API key authorization: csrf_token
|
30
|
+
config.api_key['X-CSRFToken'] = 'YOUR API KEY'
|
31
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
32
|
+
#config.api_key_prefix['X-CSRFToken'] = 'Bearer'
|
33
|
+
end
|
34
|
+
|
35
|
+
api_instance = CloudsmithApi::MetricsApi.new
|
36
|
+
|
37
|
+
owner = "owner_example" # String |
|
38
|
+
|
39
|
+
repo = "repo_example" # String |
|
40
|
+
|
41
|
+
opts = {
|
42
|
+
page: 56, # Integer | A page number within the paginated result set.
|
43
|
+
page_size: 56, # Integer | Number of results to return per page.
|
44
|
+
finish: 56, # Integer | Filter token usage ending before this datetime (UTC by default unless otherwise specified). Defaults to now if not supplied.
|
45
|
+
start: 56, # Integer | Filter token usage starting from this datetime (UTC by default unless otherwise specified)).
|
46
|
+
tokens: "tokens_example" # String | A comma seperated list of tokens (slug perm) to include in the results.
|
47
|
+
}
|
48
|
+
|
49
|
+
begin
|
50
|
+
#View for listing entitlement token usage as a metric.
|
51
|
+
result = api_instance.metrics_entitlements_usage_list(owner, repo, opts)
|
52
|
+
p result
|
53
|
+
rescue CloudsmithApi::ApiError => e
|
54
|
+
puts "Exception when calling MetricsApi->metrics_entitlements_usage_list: #{e}"
|
55
|
+
end
|
56
|
+
```
|
57
|
+
|
58
|
+
### Parameters
|
59
|
+
|
60
|
+
Name | Type | Description | Notes
|
61
|
+
------------- | ------------- | ------------- | -------------
|
62
|
+
**owner** | **String**| |
|
63
|
+
**repo** | **String**| |
|
64
|
+
**page** | **Integer**| A page number within the paginated result set. | [optional]
|
65
|
+
**page_size** | **Integer**| Number of results to return per page. | [optional]
|
66
|
+
**finish** | **Integer**| Filter token usage ending before this datetime (UTC by default unless otherwise specified). Defaults to now if not supplied. | [optional]
|
67
|
+
**start** | **Integer**| Filter token usage starting from this datetime (UTC by default unless otherwise specified)). | [optional]
|
68
|
+
**tokens** | **String**| A comma seperated list of tokens (slug perm) to include in the results. | [optional]
|
69
|
+
|
70
|
+
### Return type
|
71
|
+
|
72
|
+
[**Array<EntitlementTokenMetric>**](EntitlementTokenMetric.md)
|
73
|
+
|
74
|
+
### Authorization
|
75
|
+
|
76
|
+
[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
|
77
|
+
|
78
|
+
### HTTP request headers
|
79
|
+
|
80
|
+
- **Content-Type**: Not defined
|
81
|
+
- **Accept**: Not defined
|
82
|
+
|
83
|
+
|
84
|
+
|
85
|
+
# **metrics_packages_usage_list**
|
86
|
+
> Array<PackageUsageMetric> metrics_packages_usage_list(owner, repo, opts)
|
87
|
+
|
88
|
+
View for listing package usage metrics by user.
|
89
|
+
|
90
|
+
View for listing package usage metrics by user.
|
91
|
+
|
92
|
+
### Example
|
93
|
+
```ruby
|
94
|
+
# load the gem
|
95
|
+
require 'cloudsmith-api'
|
96
|
+
# setup authorization
|
97
|
+
CloudsmithApi.configure do |config|
|
98
|
+
# Configure API key authorization: apikey
|
99
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
100
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
101
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
102
|
+
|
103
|
+
# Configure API key authorization: csrf_token
|
104
|
+
config.api_key['X-CSRFToken'] = '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-CSRFToken'] = 'Bearer'
|
107
|
+
end
|
108
|
+
|
109
|
+
api_instance = CloudsmithApi::MetricsApi.new
|
110
|
+
|
111
|
+
owner = "owner_example" # String |
|
112
|
+
|
113
|
+
repo = "repo_example" # String |
|
114
|
+
|
115
|
+
opts = {
|
116
|
+
page: 56, # Integer | A page number within the paginated result set.
|
117
|
+
page_size: 56, # Integer | Number of results to return per page.
|
118
|
+
finish: 56, # Integer | Filter token usage ending before this datetime (UTC). Defaults to now if not supplied.
|
119
|
+
packages: "packages_example", # String | A comma seperated list of packages (slug perm) to include in the results.
|
120
|
+
start: 56 # Integer | Filter token usage starting from this datetime (UTC)).
|
121
|
+
}
|
122
|
+
|
123
|
+
begin
|
124
|
+
#View for listing package usage metrics by user.
|
125
|
+
result = api_instance.metrics_packages_usage_list(owner, repo, opts)
|
126
|
+
p result
|
127
|
+
rescue CloudsmithApi::ApiError => e
|
128
|
+
puts "Exception when calling MetricsApi->metrics_packages_usage_list: #{e}"
|
129
|
+
end
|
130
|
+
```
|
131
|
+
|
132
|
+
### Parameters
|
133
|
+
|
134
|
+
Name | Type | Description | Notes
|
135
|
+
------------- | ------------- | ------------- | -------------
|
136
|
+
**owner** | **String**| |
|
137
|
+
**repo** | **String**| |
|
138
|
+
**page** | **Integer**| A page number within the paginated result set. | [optional]
|
139
|
+
**page_size** | **Integer**| Number of results to return per page. | [optional]
|
140
|
+
**finish** | **Integer**| Filter token usage ending before this datetime (UTC). Defaults to now if not supplied. | [optional]
|
141
|
+
**packages** | **String**| A comma seperated list of packages (slug perm) to include in the results. | [optional]
|
142
|
+
**start** | **Integer**| Filter token usage starting from this datetime (UTC)). | [optional]
|
143
|
+
|
144
|
+
### Return type
|
145
|
+
|
146
|
+
[**Array<PackageUsageMetric>**](PackageUsageMetric.md)
|
147
|
+
|
148
|
+
### Authorization
|
149
|
+
|
150
|
+
[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
|
151
|
+
|
152
|
+
### HTTP request headers
|
153
|
+
|
154
|
+
- **Content-Type**: Not defined
|
155
|
+
- **Accept**: Not defined
|
156
|
+
|
157
|
+
|
158
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CloudsmithApi::MetricsownerrepopackagesusageActivePackages
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | | [optional]
|
7
|
+
**slug** | **String** | | [optional]
|
8
|
+
**version** | **String** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# CloudsmithApi::PackageUsageMetric
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**active_packages** | [**Array<MetricsownerrepopackagesusageActivePackages>**](MetricsownerrepopackagesusageActivePackages.md) | |
|
7
|
+
**downloads_per_package** | **Object** | |
|
8
|
+
**inactive_packages** | [**Array<MetricsownerrepopackagesusageActivePackages>**](MetricsownerrepopackagesusageActivePackages.md) | |
|
9
|
+
**totals** | **Object** | |
|
10
|
+
|
11
|
+
|
data/docs/Quota.md
ADDED
data/docs/QuotaApi.md
ADDED
@@ -0,0 +1,248 @@
|
|
1
|
+
# CloudsmithApi::QuotaApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloudsmith.io*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**quota_history_read**](QuotaApi.md#quota_history_read) | **GET** /quota/history/{owner}/ | Quota history for a given namespace.
|
8
|
+
[**quota_oss_history_read**](QuotaApi.md#quota_oss_history_read) | **GET** /quota/oss/history/{owner}/ | Open-source Quota history for a given namespace.
|
9
|
+
[**quota_oss_read**](QuotaApi.md#quota_oss_read) | **GET** /quota/oss/{owner}/ | Open-source Quota usage for a given namespace.
|
10
|
+
[**quota_read**](QuotaApi.md#quota_read) | **GET** /quota/{owner}/ | Quota usage for a given namespace.
|
11
|
+
|
12
|
+
|
13
|
+
# **quota_history_read**
|
14
|
+
> QuotaHistory quota_history_read(owner)
|
15
|
+
|
16
|
+
Quota history for a given namespace.
|
17
|
+
|
18
|
+
Quota history for a given namespace.
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'cloudsmith-api'
|
24
|
+
# setup authorization
|
25
|
+
CloudsmithApi.configure do |config|
|
26
|
+
# Configure API key authorization: apikey
|
27
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
30
|
+
|
31
|
+
# Configure API key authorization: csrf_token
|
32
|
+
config.api_key['X-CSRFToken'] = '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-CSRFToken'] = 'Bearer'
|
35
|
+
end
|
36
|
+
|
37
|
+
api_instance = CloudsmithApi::QuotaApi.new
|
38
|
+
|
39
|
+
owner = "owner_example" # String |
|
40
|
+
|
41
|
+
|
42
|
+
begin
|
43
|
+
#Quota history for a given namespace.
|
44
|
+
result = api_instance.quota_history_read(owner)
|
45
|
+
p result
|
46
|
+
rescue CloudsmithApi::ApiError => e
|
47
|
+
puts "Exception when calling QuotaApi->quota_history_read: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
### Parameters
|
52
|
+
|
53
|
+
Name | Type | Description | Notes
|
54
|
+
------------- | ------------- | ------------- | -------------
|
55
|
+
**owner** | **String**| |
|
56
|
+
|
57
|
+
### Return type
|
58
|
+
|
59
|
+
[**QuotaHistory**](QuotaHistory.md)
|
60
|
+
|
61
|
+
### Authorization
|
62
|
+
|
63
|
+
[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
|
64
|
+
|
65
|
+
### HTTP request headers
|
66
|
+
|
67
|
+
- **Content-Type**: Not defined
|
68
|
+
- **Accept**: Not defined
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
# **quota_oss_history_read**
|
73
|
+
> QuotaHistory quota_oss_history_read(owner)
|
74
|
+
|
75
|
+
Open-source Quota history for a given namespace.
|
76
|
+
|
77
|
+
Open-source Quota history for a given namespace.
|
78
|
+
|
79
|
+
### Example
|
80
|
+
```ruby
|
81
|
+
# load the gem
|
82
|
+
require 'cloudsmith-api'
|
83
|
+
# setup authorization
|
84
|
+
CloudsmithApi.configure do |config|
|
85
|
+
# Configure API key authorization: apikey
|
86
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
87
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
88
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
89
|
+
|
90
|
+
# Configure API key authorization: csrf_token
|
91
|
+
config.api_key['X-CSRFToken'] = 'YOUR API KEY'
|
92
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
93
|
+
#config.api_key_prefix['X-CSRFToken'] = 'Bearer'
|
94
|
+
end
|
95
|
+
|
96
|
+
api_instance = CloudsmithApi::QuotaApi.new
|
97
|
+
|
98
|
+
owner = "owner_example" # String |
|
99
|
+
|
100
|
+
|
101
|
+
begin
|
102
|
+
#Open-source Quota history for a given namespace.
|
103
|
+
result = api_instance.quota_oss_history_read(owner)
|
104
|
+
p result
|
105
|
+
rescue CloudsmithApi::ApiError => e
|
106
|
+
puts "Exception when calling QuotaApi->quota_oss_history_read: #{e}"
|
107
|
+
end
|
108
|
+
```
|
109
|
+
|
110
|
+
### Parameters
|
111
|
+
|
112
|
+
Name | Type | Description | Notes
|
113
|
+
------------- | ------------- | ------------- | -------------
|
114
|
+
**owner** | **String**| |
|
115
|
+
|
116
|
+
### Return type
|
117
|
+
|
118
|
+
[**QuotaHistory**](QuotaHistory.md)
|
119
|
+
|
120
|
+
### Authorization
|
121
|
+
|
122
|
+
[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
|
123
|
+
|
124
|
+
### HTTP request headers
|
125
|
+
|
126
|
+
- **Content-Type**: Not defined
|
127
|
+
- **Accept**: Not defined
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
# **quota_oss_read**
|
132
|
+
> Quota quota_oss_read(owner)
|
133
|
+
|
134
|
+
Open-source Quota usage for a given namespace.
|
135
|
+
|
136
|
+
Open-source Quota usage for a given namespace.
|
137
|
+
|
138
|
+
### Example
|
139
|
+
```ruby
|
140
|
+
# load the gem
|
141
|
+
require 'cloudsmith-api'
|
142
|
+
# setup authorization
|
143
|
+
CloudsmithApi.configure do |config|
|
144
|
+
# Configure API key authorization: apikey
|
145
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
146
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
147
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
148
|
+
|
149
|
+
# Configure API key authorization: csrf_token
|
150
|
+
config.api_key['X-CSRFToken'] = 'YOUR API KEY'
|
151
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
152
|
+
#config.api_key_prefix['X-CSRFToken'] = 'Bearer'
|
153
|
+
end
|
154
|
+
|
155
|
+
api_instance = CloudsmithApi::QuotaApi.new
|
156
|
+
|
157
|
+
owner = "owner_example" # String |
|
158
|
+
|
159
|
+
|
160
|
+
begin
|
161
|
+
#Open-source Quota usage for a given namespace.
|
162
|
+
result = api_instance.quota_oss_read(owner)
|
163
|
+
p result
|
164
|
+
rescue CloudsmithApi::ApiError => e
|
165
|
+
puts "Exception when calling QuotaApi->quota_oss_read: #{e}"
|
166
|
+
end
|
167
|
+
```
|
168
|
+
|
169
|
+
### Parameters
|
170
|
+
|
171
|
+
Name | Type | Description | Notes
|
172
|
+
------------- | ------------- | ------------- | -------------
|
173
|
+
**owner** | **String**| |
|
174
|
+
|
175
|
+
### Return type
|
176
|
+
|
177
|
+
[**Quota**](Quota.md)
|
178
|
+
|
179
|
+
### Authorization
|
180
|
+
|
181
|
+
[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
|
182
|
+
|
183
|
+
### HTTP request headers
|
184
|
+
|
185
|
+
- **Content-Type**: Not defined
|
186
|
+
- **Accept**: Not defined
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
# **quota_read**
|
191
|
+
> Quota quota_read(owner)
|
192
|
+
|
193
|
+
Quota usage for a given namespace.
|
194
|
+
|
195
|
+
Quota usage for a given namespace.
|
196
|
+
|
197
|
+
### Example
|
198
|
+
```ruby
|
199
|
+
# load the gem
|
200
|
+
require 'cloudsmith-api'
|
201
|
+
# setup authorization
|
202
|
+
CloudsmithApi.configure do |config|
|
203
|
+
# Configure API key authorization: apikey
|
204
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
205
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
206
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
207
|
+
|
208
|
+
# Configure API key authorization: csrf_token
|
209
|
+
config.api_key['X-CSRFToken'] = 'YOUR API KEY'
|
210
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
211
|
+
#config.api_key_prefix['X-CSRFToken'] = 'Bearer'
|
212
|
+
end
|
213
|
+
|
214
|
+
api_instance = CloudsmithApi::QuotaApi.new
|
215
|
+
|
216
|
+
owner = "owner_example" # String |
|
217
|
+
|
218
|
+
|
219
|
+
begin
|
220
|
+
#Quota usage for a given namespace.
|
221
|
+
result = api_instance.quota_read(owner)
|
222
|
+
p result
|
223
|
+
rescue CloudsmithApi::ApiError => e
|
224
|
+
puts "Exception when calling QuotaApi->quota_read: #{e}"
|
225
|
+
end
|
226
|
+
```
|
227
|
+
|
228
|
+
### Parameters
|
229
|
+
|
230
|
+
Name | Type | Description | Notes
|
231
|
+
------------- | ------------- | ------------- | -------------
|
232
|
+
**owner** | **String**| |
|
233
|
+
|
234
|
+
### Return type
|
235
|
+
|
236
|
+
[**Quota**](Quota.md)
|
237
|
+
|
238
|
+
### Authorization
|
239
|
+
|
240
|
+
[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
|
241
|
+
|
242
|
+
### HTTP request headers
|
243
|
+
|
244
|
+
- **Content-Type**: Not defined
|
245
|
+
- **Accept**: Not defined
|
246
|
+
|
247
|
+
|
248
|
+
|