cloudsmith-api 0.52.79 → 0.53.17

data/docs/QuotaHistory.md

@@ -0,0 +1,8 @@
+# CloudsmithApi::QuotaHistory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**history** | [**Array<QuotaHistoryHistory>**](QuotaHistoryHistory.md) |  | 
+
+

data/docs/QuotaHistoryHistory.md

@@ -0,0 +1,13 @@
+# CloudsmithApi::QuotaHistoryHistory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**days** | **Integer** |  | [optional] 
+**display** | **Object** |  | [optional] 
+**_end** | **String** |  | [optional] 
+**plan** | **String** |  | [optional] 
+**raw** | **Object** |  | [optional] 
+**start** | **String** |  | [optional] 
+
+

data/docs/RepositoryToken.md

@@ -3,14 +3,18 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**clients** | **Integer** |  | [optional] 
 **created_at** | **String** | The datetime the token was updated at. | [optional] 
 **created_by** | **String** |  | [optional] 
 **created_by_url** | **String** |  | [optional] 
 **default** | **BOOLEAN** | If selected this is the default token for this repository. | [optional] 
+**downloads** | **Integer** |  | [optional] 
 **has_limits** | **BOOLEAN** |  | [optional] 
 **identifier** | **Integer** |  | [optional] 
 **is_active** | **BOOLEAN** | If enabled, the token will allow downloads based on configured restrictions (if any). | [optional] 
 **is_limited** | **BOOLEAN** |  | [optional] 
+**limit_bandwidth** | **Integer** | The maximum download bandwidth allowed for the token. Values are expressed as the selected unit of bandwidth.Please note that since downloads are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point.  | [optional] 
+**limit_bandwidth_unit** | **String** |  | [optional] 
 **limit_date_range_from** | **String** | The starting date/time the token is allowed to be used from. | [optional] 
 **limit_date_range_to** | **String** | The ending date/time the token is allowed to be used until. | [optional] 
 **limit_num_clients** | **Integer** | The maximum number of unique clients allowed for the token. Please note that since clients are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point. | [optional] 
@@ -20,6 +24,8 @@ Name | Type | Description | Notes
 **metadata** | **Object** |  | [optional] 
 **name** | **String** |  | 
 **refresh_url** | **String** |  | [optional] 
+**scheduled_reset_at** | **String** | The time at which the scheduled reset period has elapsed and the token limits were automatically reset to zero. | [optional] 
+**scheduled_reset_period** | **String** |  | [optional] 
 **self_url** | **String** |  | [optional] 
 **slug_perm** | **String** |  | [optional] 
 **token** | **String** |  | [optional] 

data/docs/RepositoryTokenRefresh.md

@@ -3,14 +3,18 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**clients** | **Integer** |  | [optional] 
 **created_at** | **String** | The datetime the token was updated at. | [optional] 
 **created_by** | **String** |  | [optional] 
 **created_by_url** | **String** |  | [optional] 
 **default** | **BOOLEAN** | If selected this is the default token for this repository. | [optional] 
+**downloads** | **Integer** |  | [optional] 
 **has_limits** | **BOOLEAN** |  | [optional] 
 **identifier** | **Integer** |  | [optional] 
 **is_active** | **BOOLEAN** | If enabled, the token will allow downloads based on configured restrictions (if any). | [optional] 
 **is_limited** | **BOOLEAN** |  | [optional] 
+**limit_bandwidth** | **Integer** | The maximum download bandwidth allowed for the token. Values are expressed as the selected unit of bandwidth.Please note that since downloads are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point.  | [optional] 
+**limit_bandwidth_unit** | **String** |  | [optional] 
 **limit_date_range_from** | **String** | The starting date/time the token is allowed to be used from. | [optional] 
 **limit_date_range_to** | **String** | The ending date/time the token is allowed to be used until. | [optional] 
 **limit_num_clients** | **Integer** | The maximum number of unique clients allowed for the token. Please note that since clients are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point. | [optional] 
@@ -20,6 +24,8 @@ Name | Type | Description | Notes
 **metadata** | **Object** |  | [optional] 
 **name** | **String** |  | [optional] 
 **refresh_url** | **String** |  | [optional] 
+**scheduled_reset_at** | **String** | The time at which the scheduled reset period has elapsed and the token limits were automatically reset to zero. | [optional] 
+**scheduled_reset_period** | **String** |  | [optional] 
 **self_url** | **String** |  | [optional] 
 **slug_perm** | **String** |  | [optional] 
 **token** | **String** |  | [optional] 

data/docs/RepositoryTokenSyncTokens.md

@@ -3,14 +3,18 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**clients** | **Integer** |  | [optional] 
 **created_at** | **String** | The datetime the token was updated at. | [optional] 
 **created_by** | **String** |  | [optional] 
 **created_by_url** | **String** |  | [optional] 
 **default** | **BOOLEAN** | If selected this is the default token for this repository. | [optional] 
+**downloads** | **Integer** |  | [optional] 
 **has_limits** | **BOOLEAN** |  | [optional] 
 **identifier** | **Integer** |  | [optional] 
 **is_active** | **BOOLEAN** | If enabled, the token will allow downloads based on configured restrictions (if any). | [optional] 
 **is_limited** | **BOOLEAN** |  | [optional] 
+**limit_bandwidth** | **Integer** | The maximum download bandwidth allowed for the token. Values are expressed as the selected unit of bandwidth.Please note that since downloads are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point.  | [optional] 
+**limit_bandwidth_unit** | **String** |  | [optional] 
 **limit_date_range_from** | **String** | The starting date/time the token is allowed to be used from. | [optional] 
 **limit_date_range_to** | **String** | The ending date/time the token is allowed to be used until. | [optional] 
 **limit_num_clients** | **Integer** | The maximum number of unique clients allowed for the token. Please note that since clients are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point. | [optional] 
@@ -20,6 +24,8 @@ Name | Type | Description | Notes
 **metadata** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
 **refresh_url** | **String** |  | [optional] 
+**scheduled_reset_at** | **String** | The time at which the scheduled reset period has elapsed and the token limits were automatically reset to zero. | [optional] 
+**scheduled_reset_period** | **String** |  | [optional] 
 **self_url** | **String** |  | [optional] 
 **slug_perm** | **String** |  | [optional] 
 **token** | **String** |  | [optional] 

data/lib/cloudsmith-api.rb

@@ -21,11 +21,11 @@ require 'cloudsmith-api/models/alpine_package_upload'
 require 'cloudsmith-api/models/conan_package_upload'
 require 'cloudsmith-api/models/distribution'
 require 'cloudsmith-api/models/distros_versions'
+require 'cloudsmith-api/models/entitlement_token_metric'
 require 'cloudsmith-api/models/entitlements_create'
 require 'cloudsmith-api/models/entitlements_partial_update'
 require 'cloudsmith-api/models/entitlements_refresh'
 require 'cloudsmith-api/models/entitlements_sync'
-require 'cloudsmith-api/models/entitlment_token_metric'
 require 'cloudsmith-api/models/files_abort'
 require 'cloudsmith-api/models/files_complete'
 require 'cloudsmith-api/models/files_create'
@@ -33,6 +33,7 @@ require 'cloudsmith-api/models/files_validate'
 require 'cloudsmith-api/models/format'
 require 'cloudsmith-api/models/formats_distributions'
 require 'cloudsmith-api/models/maven_package_upload'
+require 'cloudsmith-api/models/metricsownerrepopackagesusage_active_packages'
 require 'cloudsmith-api/models/namespace'
 require 'cloudsmith-api/models/organization'
 require 'cloudsmith-api/models/package'
@@ -41,6 +42,7 @@ require 'cloudsmith-api/models/package_file_parts_upload'
 require 'cloudsmith-api/models/package_file_upload'
 require 'cloudsmith-api/models/package_move'
 require 'cloudsmith-api/models/package_status'
+require 'cloudsmith-api/models/package_usage_metric'
 require 'cloudsmith-api/models/packages_copy'
 require 'cloudsmith-api/models/packages_move'
 require 'cloudsmith-api/models/packages_tag'
@@ -88,6 +90,9 @@ require 'cloudsmith-api/models/packages_validateupload_terraform'
 require 'cloudsmith-api/models/packages_validateupload_vagrant'
 require 'cloudsmith-api/models/packagesownerrepo_architectures'
 require 'cloudsmith-api/models/packagesownerrepo_files'
+require 'cloudsmith-api/models/quota'
+require 'cloudsmith-api/models/quota_history'
+require 'cloudsmith-api/models/quota_history_history'
 require 'cloudsmith-api/models/raw_package_upload'
 require 'cloudsmith-api/models/repos_create'
 require 'cloudsmith-api/models/repos_gpg_keys'
@@ -121,6 +126,7 @@ require 'cloudsmith-api/api/metrics_api'
 require 'cloudsmith-api/api/namespaces_api'
 require 'cloudsmith-api/api/orgs_api'
 require 'cloudsmith-api/api/packages_api'
+require 'cloudsmith-api/api/quota_api'
 require 'cloudsmith-api/api/rates_api'
 require 'cloudsmith-api/api/repos_api'
 require 'cloudsmith-api/api/status_api'

data/lib/cloudsmith-api/api/metrics_api.rb

@@ -27,10 +27,10 @@ module CloudsmithApi
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page A page number within the paginated result set.
     # @option opts [Integer] :page_size Number of results to return per page.
-    # @option opts [Integer] :finish Filter token usage ending before this timestamp. Defaults to now if not supplied.
-    # @option opts [Integer] :start Filter token usage starting from this timestamp (seconds since Jan 01 1970. (UTC)).
+    # @option opts [Integer] :finish Filter token usage ending before this datetime (UTC by default unless otherwise specified). Defaults to now if not supplied.
+    # @option opts [Integer] :start Filter token usage starting from this datetime (UTC by default unless otherwise specified)).
     # @option opts [String] :tokens A comma seperated list of tokens (slug perm) to include in the results.
-    # @return [Array<EntitlmentTokenMetric>]
+    # @return [Array<EntitlementTokenMetric>]
     def metrics_entitlements_usage_list(owner, repo, opts = {})
       data, _status_code, _headers = metrics_entitlements_usage_list_with_http_info(owner, repo, opts)
       return data
@@ -43,10 +43,10 @@ module CloudsmithApi
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page A page number within the paginated result set.
     # @option opts [Integer] :page_size Number of results to return per page.
-    # @option opts [Integer] :finish Filter token usage ending before this timestamp. Defaults to now if not supplied.
-    # @option opts [Integer] :start Filter token usage starting from this timestamp (seconds since Jan 01 1970. (UTC)).
+    # @option opts [Integer] :finish Filter token usage ending before this datetime (UTC by default unless otherwise specified). Defaults to now if not supplied.
+    # @option opts [Integer] :start Filter token usage starting from this datetime (UTC by default unless otherwise specified)).
     # @option opts [String] :tokens A comma seperated list of tokens (slug perm) to include in the results.
-    # @return [Array<(Array<EntitlmentTokenMetric>, Fixnum, Hash)>] Array<EntitlmentTokenMetric> data, response status code and response headers
+    # @return [Array<(Array<EntitlementTokenMetric>, Fixnum, Hash)>] Array<EntitlementTokenMetric> data, response status code and response headers
     def metrics_entitlements_usage_list_with_http_info(owner, repo, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: MetricsApi.metrics_entitlements_usage_list ..."
@@ -85,11 +85,83 @@ module CloudsmithApi
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Array<EntitlmentTokenMetric>')
+        :return_type => 'Array<EntitlementTokenMetric>')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: MetricsApi#metrics_entitlements_usage_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+
+    # View for listing package usage metrics by user.
+    # View for listing package usage metrics by user.
+    # @param owner 
+    # @param repo 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page A page number within the paginated result set.
+    # @option opts [Integer] :page_size Number of results to return per page.
+    # @option opts [Integer] :finish Filter token usage ending before this datetime (UTC). Defaults to now if not supplied.
+    # @option opts [String] :packages A comma seperated list of packages (slug perm) to include in the results.
+    # @option opts [Integer] :start Filter token usage starting from this datetime (UTC)).
+    # @return [Array<PackageUsageMetric>]
+    def metrics_packages_usage_list(owner, repo, opts = {})
+      data, _status_code, _headers = metrics_packages_usage_list_with_http_info(owner, repo, opts)
+      return data
+    end
+
+    # View for listing package usage metrics by user.
+    # View for listing package usage metrics by user.
+    # @param owner 
+    # @param repo 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page A page number within the paginated result set.
+    # @option opts [Integer] :page_size Number of results to return per page.
+    # @option opts [Integer] :finish Filter token usage ending before this datetime (UTC). Defaults to now if not supplied.
+    # @option opts [String] :packages A comma seperated list of packages (slug perm) to include in the results.
+    # @option opts [Integer] :start Filter token usage starting from this datetime (UTC)).
+    # @return [Array<(Array<PackageUsageMetric>, Fixnum, Hash)>] Array<PackageUsageMetric> data, response status code and response headers
+    def metrics_packages_usage_list_with_http_info(owner, repo, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: MetricsApi.metrics_packages_usage_list ..."
+      end
+      # verify the required parameter 'owner' is set
+      if @api_client.config.client_side_validation && owner.nil?
+        fail ArgumentError, "Missing the required parameter 'owner' when calling MetricsApi.metrics_packages_usage_list"
+      end
+      # verify the required parameter 'repo' is set
+      if @api_client.config.client_side_validation && repo.nil?
+        fail ArgumentError, "Missing the required parameter 'repo' when calling MetricsApi.metrics_packages_usage_list"
+      end
+      # resource path
+      local_var_path = "/metrics/{owner}/{repo}/packages/usage/".sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'finish'] = opts[:'finish'] if !opts[:'finish'].nil?
+      query_params[:'packages'] = opts[:'packages'] if !opts[:'packages'].nil?
+      query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
+
+      # header parameters
+      header_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['apikey', 'csrf_token']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<PackageUsageMetric>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MetricsApi#metrics_packages_usage_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/cloudsmith-api/api/quota_api.rb

@@ -0,0 +1,227 @@
+=begin
+#Cloudsmith API
+
+#The API to the Cloudsmith Service
+
+OpenAPI spec version: v1
+Contact: support@cloudsmith.io
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+require "uri"
+
+module CloudsmithApi
+  class QuotaApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Quota history for a given namespace.
+    # Quota history for a given namespace.
+    # @param owner 
+    # @param [Hash] opts the optional parameters
+    # @return [QuotaHistory]
+    def quota_history_read(owner, opts = {})
+      data, _status_code, _headers = quota_history_read_with_http_info(owner, opts)
+      return data
+    end
+
+    # Quota history for a given namespace.
+    # Quota history for a given namespace.
+    # @param owner 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(QuotaHistory, Fixnum, Hash)>] QuotaHistory data, response status code and response headers
+    def quota_history_read_with_http_info(owner, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: QuotaApi.quota_history_read ..."
+      end
+      # verify the required parameter 'owner' is set
+      if @api_client.config.client_side_validation && owner.nil?
+        fail ArgumentError, "Missing the required parameter 'owner' when calling QuotaApi.quota_history_read"
+      end
+      # resource path
+      local_var_path = "/quota/history/{owner}/".sub('{' + 'owner' + '}', owner.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['apikey', 'csrf_token']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'QuotaHistory')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QuotaApi#quota_history_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Open-source Quota history for a given namespace.
+    # Open-source Quota history for a given namespace.
+    # @param owner 
+    # @param [Hash] opts the optional parameters
+    # @return [QuotaHistory]
+    def quota_oss_history_read(owner, opts = {})
+      data, _status_code, _headers = quota_oss_history_read_with_http_info(owner, opts)
+      return data
+    end
+
+    # Open-source Quota history for a given namespace.
+    # Open-source Quota history for a given namespace.
+    # @param owner 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(QuotaHistory, Fixnum, Hash)>] QuotaHistory data, response status code and response headers
+    def quota_oss_history_read_with_http_info(owner, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: QuotaApi.quota_oss_history_read ..."
+      end
+      # verify the required parameter 'owner' is set
+      if @api_client.config.client_side_validation && owner.nil?
+        fail ArgumentError, "Missing the required parameter 'owner' when calling QuotaApi.quota_oss_history_read"
+      end
+      # resource path
+      local_var_path = "/quota/oss/history/{owner}/".sub('{' + 'owner' + '}', owner.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['apikey', 'csrf_token']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'QuotaHistory')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QuotaApi#quota_oss_history_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Open-source Quota usage for a given namespace.
+    # Open-source Quota usage for a given namespace.
+    # @param owner 
+    # @param [Hash] opts the optional parameters
+    # @return [Quota]
+    def quota_oss_read(owner, opts = {})
+      data, _status_code, _headers = quota_oss_read_with_http_info(owner, opts)
+      return data
+    end
+
+    # Open-source Quota usage for a given namespace.
+    # Open-source Quota usage for a given namespace.
+    # @param owner 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Quota, Fixnum, Hash)>] Quota data, response status code and response headers
+    def quota_oss_read_with_http_info(owner, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: QuotaApi.quota_oss_read ..."
+      end
+      # verify the required parameter 'owner' is set
+      if @api_client.config.client_side_validation && owner.nil?
+        fail ArgumentError, "Missing the required parameter 'owner' when calling QuotaApi.quota_oss_read"
+      end
+      # resource path
+      local_var_path = "/quota/oss/{owner}/".sub('{' + 'owner' + '}', owner.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['apikey', 'csrf_token']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Quota')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QuotaApi#quota_oss_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Quota usage for a given namespace.
+    # Quota usage for a given namespace.
+    # @param owner 
+    # @param [Hash] opts the optional parameters
+    # @return [Quota]
+    def quota_read(owner, opts = {})
+      data, _status_code, _headers = quota_read_with_http_info(owner, opts)
+      return data
+    end
+
+    # Quota usage for a given namespace.
+    # Quota usage for a given namespace.
+    # @param owner 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Quota, Fixnum, Hash)>] Quota data, response status code and response headers
+    def quota_read_with_http_info(owner, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: QuotaApi.quota_read ..."
+      end
+      # verify the required parameter 'owner' is set
+      if @api_client.config.client_side_validation && owner.nil?
+        fail ArgumentError, "Missing the required parameter 'owner' when calling QuotaApi.quota_read"
+      end
+      # resource path
+      local_var_path = "/quota/{owner}/".sub('{' + 'owner' + '}', owner.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['apikey', 'csrf_token']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Quota')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QuotaApi#quota_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end