ff-ruby-server-sdk 1.2.1 → 1.3.0

data/lib/ff/ruby/server/generated/lib/openapi_client/api/client_api.rb

@@ -84,6 +84,8 @@ module OpenapiClient
     # Used to retrieve all segments for certain account id.
     # @param environment_uuid [String] Unique identifier for the environment object in the API.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
+    # @option opts [String] :rules When set to rules=v2 will return AND rule compatible serving_rules field. When not set or set to any other value will return old rules field only compatible with OR rules.
     # @return [Array<Segment>]
     def get_all_segments(environment_uuid, opts = {})
       data, _status_code, _headers = get_all_segments_with_http_info(environment_uuid, opts)
@@ -94,6 +96,8 @@ module OpenapiClient
     # Used to retrieve all segments for certain account id.
     # @param environment_uuid [String] Unique identifier for the environment object in the API.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
+    # @option opts [String] :rules When set to rules&#x3D;v2 will return AND rule compatible serving_rules field. When not set or set to any other value will return old rules field only compatible with OR rules.
     # @return [Array<(Array<Segment>, Integer, Hash)>] Array<Segment> data, response status code and response headers
     def get_all_segments_with_http_info(environment_uuid, opts = {})
       if @api_client.config.debugging
@@ -108,6 +112,8 @@ module OpenapiClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'cluster'] = opts[:'cluster'] if !opts[:'cluster'].nil?
+      query_params[:'rules'] = opts[:'rules'] if !opts[:'rules'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -148,6 +154,7 @@ module OpenapiClient
     # @param feature [String] Unique identifier for the flag object in the API.
     # @param target [String] Unique identifier for the target object in the API.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
     # @return [Evaluation]
     def get_evaluation_by_identifier(environment_uuid, feature, target, opts = {})
       data, _status_code, _headers = get_evaluation_by_identifier_with_http_info(environment_uuid, feature, target, opts)
@@ -159,6 +166,7 @@ module OpenapiClient
     # @param feature [String] Unique identifier for the flag object in the API.
     # @param target [String] Unique identifier for the target object in the API.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
     # @return [Array<(Evaluation, Integer, Hash)>] Evaluation data, response status code and response headers
     def get_evaluation_by_identifier_with_http_info(environment_uuid, feature, target, opts = {})
       if @api_client.config.debugging
@@ -181,6 +189,7 @@ module OpenapiClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'cluster'] = opts[:'cluster'] if !opts[:'cluster'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -220,6 +229,7 @@ module OpenapiClient
     # @param environment_uuid [String] Unique identifier for the environment object in the API.
     # @param target [String] Unique identifier for the target object in the API.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
     # @return [Pagination]
     def get_evaluations(environment_uuid, target, opts = {})
       data, _status_code, _headers = get_evaluations_with_http_info(environment_uuid, target, opts)
@@ -230,6 +240,7 @@ module OpenapiClient
     # @param environment_uuid [String] Unique identifier for the environment object in the API.
     # @param target [String] Unique identifier for the target object in the API.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
     # @return [Array<(Pagination, Integer, Hash)>] Pagination data, response status code and response headers
     def get_evaluations_with_http_info(environment_uuid, target, opts = {})
       if @api_client.config.debugging
@@ -248,6 +259,7 @@ module OpenapiClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'cluster'] = opts[:'cluster'] if !opts[:'cluster'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -287,6 +299,7 @@ module OpenapiClient
     # All feature flags with activations in project environment
     # @param environment_uuid [String] Unique identifier for the environment object in the API.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
     # @return [Array<FeatureConfig>]
     def get_feature_config(environment_uuid, opts = {})
       data, _status_code, _headers = get_feature_config_with_http_info(environment_uuid, opts)
@@ -297,6 +310,7 @@ module OpenapiClient
     # All feature flags with activations in project environment
     # @param environment_uuid [String] Unique identifier for the environment object in the API.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
     # @return [Array<(Array<FeatureConfig>, Integer, Hash)>] Array<FeatureConfig> data, response status code and response headers
     def get_feature_config_with_http_info(environment_uuid, opts = {})
       if @api_client.config.debugging
@@ -311,6 +325,7 @@ module OpenapiClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'cluster'] = opts[:'cluster'] if !opts[:'cluster'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -350,6 +365,7 @@ module OpenapiClient
     # @param identifier [String] Unique identifier for the flag object in the API.
     # @param environment_uuid [String] Unique identifier for the environment object in the API.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
     # @return [FeatureConfig]
     def get_feature_config_by_identifier(identifier, environment_uuid, opts = {})
       data, _status_code, _headers = get_feature_config_by_identifier_with_http_info(identifier, environment_uuid, opts)
@@ -360,6 +376,7 @@ module OpenapiClient
     # @param identifier [String] Unique identifier for the flag object in the API.
     # @param environment_uuid [String] Unique identifier for the environment object in the API.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
     # @return [Array<(FeatureConfig, Integer, Hash)>] FeatureConfig data, response status code and response headers
     def get_feature_config_by_identifier_with_http_info(identifier, environment_uuid, opts = {})
       if @api_client.config.debugging
@@ -378,6 +395,7 @@ module OpenapiClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'cluster'] = opts[:'cluster'] if !opts[:'cluster'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -418,6 +436,8 @@ module OpenapiClient
     # @param identifier [String] Unique identifier for the segment object in the API
     # @param environment_uuid [String] Unique identifier for the environment object in the API
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
+    # @option opts [String] :rules When set to rules&#x3D;v2 will return AND rule compatible serving_rules field. When not set or set to any other value will return old rules field only compatible with OR rules.
     # @return [Segment]
     def get_segment_by_identifier(identifier, environment_uuid, opts = {})
       data, _status_code, _headers = get_segment_by_identifier_with_http_info(identifier, environment_uuid, opts)
@@ -429,6 +449,8 @@ module OpenapiClient
     # @param identifier [String] Unique identifier for the segment object in the API
     # @param environment_uuid [String] Unique identifier for the environment object in the API
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
+    # @option opts [String] :rules When set to rules&#x3D;v2 will return AND rule compatible serving_rules field. When not set or set to any other value will return old rules field only compatible with OR rules.
     # @return [Array<(Segment, Integer, Hash)>] Segment data, response status code and response headers
     def get_segment_by_identifier_with_http_info(identifier, environment_uuid, opts = {})
       if @api_client.config.debugging
@@ -447,6 +469,8 @@ module OpenapiClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'cluster'] = opts[:'cluster'] if !opts[:'cluster'].nil?
+      query_params[:'rules'] = opts[:'rules'] if !opts[:'rules'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -485,6 +509,7 @@ module OpenapiClient
     # Stream endpoint.
     # @param api_key [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
     # @return [nil]
     def stream(api_key, opts = {})
       stream_with_http_info(api_key, opts)
@@ -494,6 +519,7 @@ module OpenapiClient
     # Stream endpoint.
     # @param api_key [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def stream_with_http_info(api_key, opts = {})
       if @api_client.config.debugging
@@ -508,6 +534,7 @@ module OpenapiClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'cluster'] = opts[:'cluster'] if !opts[:'cluster'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/ff/ruby/server/generated/lib/openapi_client/api/metrics_api.rb

@@ -21,34 +21,37 @@ module OpenapiClient
     end
     # Send metrics to the Analytics server.
     # Send metrics to Analytics server
-    # @param environment [String] environment parameter in query.
+    # @param environment_uuid [String] environment parameter in query.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
     # @option opts [Metrics] :metrics 
     # @return [nil]
-    def post_metrics(environment, opts = {})
-      post_metrics_with_http_info(environment, opts)
+    def post_metrics(environment_uuid, opts = {})
+      post_metrics_with_http_info(environment_uuid, opts)
       nil
     end
 
     # Send metrics to the Analytics server.
     # Send metrics to Analytics server
-    # @param environment [String] environment parameter in query.
+    # @param environment_uuid [String] environment parameter in query.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
     # @option opts [Metrics] :metrics 
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def post_metrics_with_http_info(environment, opts = {})
+    def post_metrics_with_http_info(environment_uuid, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MetricsApi.post_metrics ...'
       end
-      # verify the required parameter 'environment' is set
-      if @api_client.config.client_side_validation && environment.nil?
-        fail ArgumentError, "Missing the required parameter 'environment' when calling MetricsApi.post_metrics"
+      # verify the required parameter 'environment_uuid' is set
+      if @api_client.config.client_side_validation && environment_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'environment_uuid' when calling MetricsApi.post_metrics"
       end
       # resource path
-      local_var_path = '/metrics/{environment}'.sub('{' + 'environment' + '}', CGI.escape(environment.to_s))
+      local_var_path = '/metrics/{environmentUUID}'.sub('{' + 'environmentUUID' + '}', CGI.escape(environment_uuid.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'cluster'] = opts[:'cluster'] if !opts[:'cluster'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -67,7 +70,7 @@ module OpenapiClient
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
 
       new_options = opts.merge(
         :operation => :"MetricsApi.post_metrics",

data/lib/ff/ruby/server/generated/lib/openapi_client/api/proxy_api.rb

@@ -0,0 +1,159 @@
+=begin
+#Harness feature flag service client apis
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+Contact: cf@harness.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.1
+
+=end
+
+require 'cgi'
+
+module OpenapiClient
+  class ProxyApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Endpoint that the Proxy can use to authenticate with the client server
+    # Endpoint that the Proxy can use to authenticate with the client server
+    # @param [Hash] opts the optional parameters
+    # @option opts [InlineObject] :inline_object 
+    # @return [AuthenticationResponse]
+    def authenticate_proxy_key(opts = {})
+      data, _status_code, _headers = authenticate_proxy_key_with_http_info(opts)
+      data
+    end
+
+    # Endpoint that the Proxy can use to authenticate with the client server
+    # Endpoint that the Proxy can use to authenticate with the client server
+    # @param [Hash] opts the optional parameters
+    # @option opts [InlineObject] :inline_object 
+    # @return [Array<(AuthenticationResponse, Integer, Hash)>] AuthenticationResponse data, response status code and response headers
+    def authenticate_proxy_key_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProxyApi.authenticate_proxy_key ...'
+      end
+      # resource path
+      local_var_path = '/proxy/auth'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'inline_object'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AuthenticationResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ProxyApi.authenticate_proxy_key",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProxyApi#authenticate_proxy_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Gets Proxy config for multiple environments
+    # Gets Proxy config for multiple environments if the Key query param is provided or gets config for a single environment if an environment query param is provided
+    # @param key [String] Accpets a Proxy Key.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_number PageNumber
+    # @option opts [Integer] :page_size PageSize
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
+    # @option opts [String] :environment Accepts an EnvironmentID. If this is provided then the endpoint will only return config for this environment. If this is left empty then the Proxy will return config for all environments associated with the Proxy Key.
+    # @return [ProxyConfig]
+    def get_proxy_config(key, opts = {})
+      data, _status_code, _headers = get_proxy_config_with_http_info(key, opts)
+      data
+    end
+
+    # Gets Proxy config for multiple environments
+    # Gets Proxy config for multiple environments if the Key query param is provided or gets config for a single environment if an environment query param is provided
+    # @param key [String] Accpets a Proxy Key.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_number PageNumber
+    # @option opts [Integer] :page_size PageSize
+    # @option opts [String] :cluster Unique identifier for the cluster for the account
+    # @option opts [String] :environment Accepts an EnvironmentID. If this is provided then the endpoint will only return config for this environment. If this is left empty then the Proxy will return config for all environments associated with the Proxy Key.
+    # @return [Array<(ProxyConfig, Integer, Hash)>] ProxyConfig data, response status code and response headers
+    def get_proxy_config_with_http_info(key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProxyApi.get_proxy_config ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling ProxyApi.get_proxy_config"
+      end
+      # resource path
+      local_var_path = '/proxy/config'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'key'] = key
+      query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].nil?
+      query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'cluster'] = opts[:'cluster'] if !opts[:'cluster'].nil?
+      query_params[:'environment'] = opts[:'environment'] if !opts[:'environment'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ProxyConfig'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProxyApi.get_proxy_config",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProxyApi#get_proxy_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ff/ruby/server/generated/lib/openapi_client/configuration.rb

@@ -215,6 +215,13 @@ module OpenapiClient
     # Returns Auth Settings hash for api client.
     def auth_settings
       {
+        'ApiKeyAuth' =>
+          {
+            type: 'api_key',
+            in: 'header',
+            key: 'api-key',
+            value: api_key_with_prefix('ApiKeyAuth')
+          },
         'BearerAuth' =>
           {
             type: 'bearer',

data/lib/ff/ruby/server/generated/lib/openapi_client/models/clause.rb

@@ -14,15 +14,21 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # A clause describes what conditions are used to evaluate a flag
   class Clause
+    # The unique ID for the clause
     attr_accessor :id
 
+    # The attribute to use in the clause.  This can be any target attribute
     attr_accessor :attribute
 
+    # The type of operation such as equals, starts_with, contains
     attr_accessor :op
 
+    # The values that are compared against the operator
     attr_accessor :values
 
+    # Is the operation negated?
     attr_accessor :negate
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -100,10 +106,6 @@ module OpenapiClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @id.nil?
-        invalid_properties.push('invalid value for "id", id cannot be nil.')
-      end
-
       if @attribute.nil?
         invalid_properties.push('invalid value for "attribute", attribute cannot be nil.')
       end
@@ -126,7 +128,6 @@ module OpenapiClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @id.nil?
       return false if @attribute.nil?
       return false if @op.nil?
       return false if @values.nil?

data/lib/ff/ruby/server/generated/lib/openapi_client/models/distribution.rb

@@ -14,9 +14,12 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # Describes a distribution rule
   class Distribution
+    # The attribute to use when distributing targets across buckets
     attr_accessor :bucket_by
 
+    # A list of variations and the weight that should be given to each
     attr_accessor :variations
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/ff/ruby/server/generated/lib/openapi_client/models/error.rb

@@ -15,15 +15,21 @@ require 'time'
 
 module OpenapiClient
   class Error
+    # The http error code
     attr_accessor :code
 
+    # The reason the request failed
     attr_accessor :message
 
+    # Additional details about the error
+    attr_accessor :details
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'code' => :'code',
-        :'message' => :'message'
+        :'message' => :'message',
+        :'details' => :'details'
       }
     end
 
@@ -36,7 +42,8 @@ module OpenapiClient
     def self.openapi_types
       {
         :'code' => :'String',
-        :'message' => :'String'
+        :'message' => :'String',
+        :'details' => :'Object'
       }
     end
 
@@ -68,6 +75,10 @@ module OpenapiClient
       if attributes.key?(:'message')
         self.message = attributes[:'message']
       end
+
+      if attributes.key?(:'details')
+        self.details = attributes[:'details']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -99,7 +110,8 @@ module OpenapiClient
       return true if self.equal?(o)
       self.class == o.class &&
           code == o.code &&
-          message == o.message
+          message == o.message &&
+          details == o.details
     end
 
     # @see the `==` method
@@ -111,7 +123,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [code, message].hash
+      [code, message, details].hash
     end
 
     # Builds the object from hash