akeyless 5.0.12 → 5.0.13

data/lib/akeyless/api/v2_api.rb

@@ -19,6 +19,338 @@ module Akeyless
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Create a new custom field.
+    # @param account_custom_field_create [AccountCustomFieldCreate] 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountCustomFieldCreateOutput]
+    def account_custom_field_create(account_custom_field_create, opts = {})
+      data, _status_code, _headers = account_custom_field_create_with_http_info(account_custom_field_create, opts)
+      data
+    end
+
+    # Create a new custom field.
+    # @param account_custom_field_create [AccountCustomFieldCreate] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountCustomFieldCreateOutput, Integer, Hash)>] AccountCustomFieldCreateOutput data, response status code and response headers
+    def account_custom_field_create_with_http_info(account_custom_field_create, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: V2Api.account_custom_field_create ...'
+      end
+      # verify the required parameter 'account_custom_field_create' is set
+      if @api_client.config.client_side_validation && account_custom_field_create.nil?
+        fail ArgumentError, "Missing the required parameter 'account_custom_field_create' when calling V2Api.account_custom_field_create"
+      end
+      # resource path
+      local_var_path = '/account-custom-field-create'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(account_custom_field_create)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountCustomFieldCreateOutput'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"V2Api.account_custom_field_create",
+        :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: V2Api#account_custom_field_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a custom field.
+    # @param account_custom_field_delete [AccountCustomFieldDelete] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def account_custom_field_delete(account_custom_field_delete, opts = {})
+      data, _status_code, _headers = account_custom_field_delete_with_http_info(account_custom_field_delete, opts)
+      data
+    end
+
+    # Delete a custom field.
+    # @param account_custom_field_delete [AccountCustomFieldDelete] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def account_custom_field_delete_with_http_info(account_custom_field_delete, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: V2Api.account_custom_field_delete ...'
+      end
+      # verify the required parameter 'account_custom_field_delete' is set
+      if @api_client.config.client_side_validation && account_custom_field_delete.nil?
+        fail ArgumentError, "Missing the required parameter 'account_custom_field_delete' when calling V2Api.account_custom_field_delete"
+      end
+      # resource path
+      local_var_path = '/account-custom-field-delete'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(account_custom_field_delete)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"V2Api.account_custom_field_delete",
+        :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: V2Api#account_custom_field_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get an account custom field by ID.
+    # @param account_custom_field_get [AccountCustomFieldGet] 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountCustomFieldGetOutput]
+    def account_custom_field_get(account_custom_field_get, opts = {})
+      data, _status_code, _headers = account_custom_field_get_with_http_info(account_custom_field_get, opts)
+      data
+    end
+
+    # Get an account custom field by ID.
+    # @param account_custom_field_get [AccountCustomFieldGet] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountCustomFieldGetOutput, Integer, Hash)>] AccountCustomFieldGetOutput data, response status code and response headers
+    def account_custom_field_get_with_http_info(account_custom_field_get, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: V2Api.account_custom_field_get ...'
+      end
+      # verify the required parameter 'account_custom_field_get' is set
+      if @api_client.config.client_side_validation && account_custom_field_get.nil?
+        fail ArgumentError, "Missing the required parameter 'account_custom_field_get' when calling V2Api.account_custom_field_get"
+      end
+      # resource path
+      local_var_path = '/account-custom-field-get'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(account_custom_field_get)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountCustomFieldGetOutput'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"V2Api.account_custom_field_get",
+        :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: V2Api#account_custom_field_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List all account custom fields.
+    # Returns a list of all custom fields configured for the account, optionally filtered by object and object type.
+    # @param account_custom_field_list [AccountCustomFieldList] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def account_custom_field_list(account_custom_field_list, opts = {})
+      data, _status_code, _headers = account_custom_field_list_with_http_info(account_custom_field_list, opts)
+      data
+    end
+
+    # List all account custom fields.
+    # Returns a list of all custom fields configured for the account, optionally filtered by object and object type.
+    # @param account_custom_field_list [AccountCustomFieldList] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def account_custom_field_list_with_http_info(account_custom_field_list, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: V2Api.account_custom_field_list ...'
+      end
+      # verify the required parameter 'account_custom_field_list' is set
+      if @api_client.config.client_side_validation && account_custom_field_list.nil?
+        fail ArgumentError, "Missing the required parameter 'account_custom_field_list' when calling V2Api.account_custom_field_list"
+      end
+      # resource path
+      local_var_path = '/account-custom-field-list'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(account_custom_field_list)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"V2Api.account_custom_field_list",
+        :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: V2Api#account_custom_field_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a custom field.
+    # @param account_custom_field_update [AccountCustomFieldUpdate] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def account_custom_field_update(account_custom_field_update, opts = {})
+      data, _status_code, _headers = account_custom_field_update_with_http_info(account_custom_field_update, opts)
+      data
+    end
+
+    # Update a custom field.
+    # @param account_custom_field_update [AccountCustomFieldUpdate] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def account_custom_field_update_with_http_info(account_custom_field_update, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: V2Api.account_custom_field_update ...'
+      end
+      # verify the required parameter 'account_custom_field_update' is set
+      if @api_client.config.client_side_validation && account_custom_field_update.nil?
+        fail ArgumentError, "Missing the required parameter 'account_custom_field_update' when calling V2Api.account_custom_field_update"
+      end
+      # resource path
+      local_var_path = '/account-custom-field-update'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(account_custom_field_update)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"V2Api.account_custom_field_update",
+        :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: V2Api#account_custom_field_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # @param alias_details [AliasDetails] 
     # @param [Hash] opts the optional parameters
     # @return [Object]

data/lib/akeyless/models/account_custom_field_create.rb

@@ -0,0 +1,301 @@
+=begin
+#Akeyless API
+
+#The purpose of this application is to provide access to Akeyless API.
+
+The version of the OpenAPI document: 3.0
+Contact: support@akeyless.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Akeyless
+  # accountCustomFieldCreate is a command that creates a new custom field in the account settings
+  class AccountCustomFieldCreate
+    # Set output format to JSON
+    attr_accessor :json
+
+    # The name of the custom field
+    attr_accessor :name
+
+    # The object to create the custom field
+    attr_accessor :object
+
+    # The object type to create the custom field [e.g. STATIC_SECRET,DYNAMIC_SECRET,ROTATED_SECRET]
+    attr_accessor :object_type
+
+    # Specify whether the custom field is mandatory
+    attr_accessor :required
+
+    # Authentication token (see `/auth` and `/configure`)
+    attr_accessor :token
+
+    # The universal identity token, Required only for universal_identity authentication
+    attr_accessor :uid_token
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'json' => :'json',
+        :'name' => :'name',
+        :'object' => :'object',
+        :'object_type' => :'object-type',
+        :'required' => :'required',
+        :'token' => :'token',
+        :'uid_token' => :'uid-token'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'json' => :'Boolean',
+        :'name' => :'String',
+        :'object' => :'String',
+        :'object_type' => :'String',
+        :'required' => :'Boolean',
+        :'token' => :'String',
+        :'uid_token' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::AccountCustomFieldCreate` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Akeyless::AccountCustomFieldCreate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'json')
+        self.json = attributes[:'json']
+      else
+        self.json = false
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'object')
+        self.object = attributes[:'object']
+      else
+        self.object = 'ITEM'
+      end
+
+      if attributes.key?(:'object_type')
+        self.object_type = attributes[:'object_type']
+      else
+        self.object_type = nil
+      end
+
+      if attributes.key?(:'required')
+        self.required = attributes[:'required']
+      else
+        self.required = false
+      end
+
+      if attributes.key?(:'token')
+        self.token = attributes[:'token']
+      end
+
+      if attributes.key?(:'uid_token')
+        self.uid_token = attributes[:'uid_token']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @object.nil?
+        invalid_properties.push('invalid value for "object", object cannot be nil.')
+      end
+
+      if @object_type.nil?
+        invalid_properties.push('invalid value for "object_type", object_type cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @name.nil?
+      return false if @object.nil?
+      return false if @object_type.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          json == o.json &&
+          name == o.name &&
+          object == o.object &&
+          object_type == o.object_type &&
+          required == o.required &&
+          token == o.token &&
+          uid_token == o.uid_token
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [json, name, object, object_type, required, token, uid_token].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Akeyless.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end