DealMakerAPI 0.87.0 → 0.88.1

data/lib/DealMakerAPI/api/deal_api.rb

@@ -19,72 +19,6 @@ module DealMakerAPI
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Get Analytics Dashboard Info
-    # Get Analytics Dashboard Info
-    # @param id [Integer] The deal id.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :dashboard_key The dashboard key.
-    # @return [Object]
-    def get_analytics_dashboard_info(id, opts = {})
-      data, _status_code, _headers = get_analytics_dashboard_info_with_http_info(id, opts)
-      data
-    end
-
-    # Get Analytics Dashboard Info
-    # Get Analytics Dashboard Info
-    # @param id [Integer] The deal id.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :dashboard_key The dashboard key.
-    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
-    def get_analytics_dashboard_info_with_http_info(id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: DealApi.get_analytics_dashboard_info ...'
-      end
-      # verify the required parameter 'id' is set
-      if @api_client.config.client_side_validation && id.nil?
-        fail ArgumentError, "Missing the required parameter 'id' when calling DealApi.get_analytics_dashboard_info"
-      end
-      # resource path
-      local_var_path = '/deals/{id}/analytics_dashboard_info'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'dashboard_key'] = opts[:'dashboard_key'] if !opts[:'dashboard_key'].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] || 'Object'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || []
-
-      new_options = opts.merge(
-        :operation => :"DealApi.get_analytics_dashboard_info",
-        :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: DealApi#get_analytics_dashboard_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Get deal by Deal ID
     # Gets a single deal using the Deal ID
     # @param id [Integer] The deal id.

data/lib/DealMakerAPI/api/investor_api.rb

@@ -256,21 +256,21 @@ module DealMakerAPI
     # Create a deal investor
     # Create a single deal investor.
     # @param id [Integer] The deal id.
-    # @param create_investor_request [CreateInvestorRequest] 
+    # @param deals_id_investors [PostDealsIdInvestors] 
     # @param [Hash] opts the optional parameters
     # @return [V1EntitiesInvestor]
-    def create_investor(id, create_investor_request, opts = {})
-      data, _status_code, _headers = create_investor_with_http_info(id, create_investor_request, opts)
+    def create_investor(id, deals_id_investors, opts = {})
+      data, _status_code, _headers = create_investor_with_http_info(id, deals_id_investors, opts)
       data
     end
 
     # Create a deal investor
     # Create a single deal investor.
     # @param id [Integer] The deal id.
-    # @param create_investor_request [CreateInvestorRequest] 
+    # @param deals_id_investors [PostDealsIdInvestors] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(V1EntitiesInvestor, Integer, Hash)>] V1EntitiesInvestor data, response status code and response headers
-    def create_investor_with_http_info(id, create_investor_request, opts = {})
+    def create_investor_with_http_info(id, deals_id_investors, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: InvestorApi.create_investor ...'
       end
@@ -278,9 +278,9 @@ module DealMakerAPI
       if @api_client.config.client_side_validation && id.nil?
         fail ArgumentError, "Missing the required parameter 'id' when calling InvestorApi.create_investor"
       end
-      # verify the required parameter 'create_investor_request' is set
-      if @api_client.config.client_side_validation && create_investor_request.nil?
-        fail ArgumentError, "Missing the required parameter 'create_investor_request' when calling InvestorApi.create_investor"
+      # verify the required parameter 'deals_id_investors' is set
+      if @api_client.config.client_side_validation && deals_id_investors.nil?
+        fail ArgumentError, "Missing the required parameter 'deals_id_investors' when calling InvestorApi.create_investor"
       end
       # resource path
       local_var_path = '/deals/{id}/investors'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
@@ -302,7 +302,7 @@ module DealMakerAPI
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_investor_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(deals_id_investors)
 
       # return_type
       return_type = opts[:debug_return_type] || 'V1EntitiesInvestor'
@@ -547,6 +547,81 @@ module DealMakerAPI
       return data, status_code, headers
     end
 
+    # Get enforcements for a background search
+    # Get enforcements for a background search
+    # @param id [Integer] 
+    # @param investor_id [Integer] 
+    # @param search_entity_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [V1EntitiesInvestor]
+    def get_enforcements(id, investor_id, search_entity_id, opts = {})
+      data, _status_code, _headers = get_enforcements_with_http_info(id, investor_id, search_entity_id, opts)
+      data
+    end
+
+    # Get enforcements for a background search
+    # Get enforcements for a background search
+    # @param id [Integer] 
+    # @param investor_id [Integer] 
+    # @param search_entity_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(V1EntitiesInvestor, Integer, Hash)>] V1EntitiesInvestor data, response status code and response headers
+    def get_enforcements_with_http_info(id, investor_id, search_entity_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InvestorApi.get_enforcements ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling InvestorApi.get_enforcements"
+      end
+      # verify the required parameter 'investor_id' is set
+      if @api_client.config.client_side_validation && investor_id.nil?
+        fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.get_enforcements"
+      end
+      # verify the required parameter 'search_entity_id' is set
+      if @api_client.config.client_side_validation && search_entity_id.nil?
+        fail ArgumentError, "Missing the required parameter 'search_entity_id' when calling InvestorApi.get_enforcements"
+      end
+      # resource path
+      local_var_path = '/deals/{id}/investors/{investor_id}/background_checks/{search_entity_id}/enforcements'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_id.to_s)).sub('{' + 'search_entity_id' + '}', CGI.escape(search_entity_id.to_s))
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'V1EntitiesInvestor'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"InvestorApi.get_enforcements",
+        :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: InvestorApi#get_enforcements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a deal investor by id
     # Gets a single investor by the id.
     # @param id [Integer] The deal id.
@@ -847,11 +922,11 @@ module DealMakerAPI
     # Update deal investor
     # @param id [Integer] The deal id.
     # @param investor_id [Integer] The investor id.
+    # @param deals_id_investors [PutDealsIdInvestors] 
     # @param [Hash] opts the optional parameters
-    # @option opts [UpdateInvestorRequest] :update_investor_request 
     # @return [V1EntitiesInvestor]
-    def update_investor(id, investor_id, opts = {})
-      data, _status_code, _headers = update_investor_with_http_info(id, investor_id, opts)
+    def update_investor(id, investor_id, deals_id_investors, opts = {})
+      data, _status_code, _headers = update_investor_with_http_info(id, investor_id, deals_id_investors, opts)
       data
     end
 
@@ -859,10 +934,10 @@ module DealMakerAPI
     # Update deal investor
     # @param id [Integer] The deal id.
     # @param investor_id [Integer] The investor id.
+    # @param deals_id_investors [PutDealsIdInvestors] 
     # @param [Hash] opts the optional parameters
-    # @option opts [UpdateInvestorRequest] :update_investor_request 
     # @return [Array<(V1EntitiesInvestor, Integer, Hash)>] V1EntitiesInvestor data, response status code and response headers
-    def update_investor_with_http_info(id, investor_id, opts = {})
+    def update_investor_with_http_info(id, investor_id, deals_id_investors, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: InvestorApi.update_investor ...'
       end
@@ -874,6 +949,10 @@ module DealMakerAPI
       if @api_client.config.client_side_validation && investor_id.nil?
         fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.update_investor"
       end
+      # verify the required parameter 'deals_id_investors' is set
+      if @api_client.config.client_side_validation && deals_id_investors.nil?
+        fail ArgumentError, "Missing the required parameter 'deals_id_investors' when calling InvestorApi.update_investor"
+      end
       # resource path
       local_var_path = '/deals/{id}/investors/{investor_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_id.to_s))
 
@@ -894,7 +973,7 @@ module DealMakerAPI
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'update_investor_request'])
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(deals_id_investors)
 
       # return_type
       return_type = opts[:debug_return_type] || 'V1EntitiesInvestor'

data/lib/DealMakerAPI/models/{create_investor_request.rb → post_deals_id_investors.rb}

@@ -14,7 +14,8 @@ require 'date'
 require 'time'
 
 module DealMakerAPI
-  class CreateInvestorRequest
+  # Create deal investor
+  class PostDealsIdInvestors
     # The investor email address.
     attr_accessor :email
 
@@ -44,9 +45,6 @@ module DealMakerAPI
     # The allocation amount of the investor.
     attr_accessor :allocated_amount
 
-    # The investment value of the investor.
-    attr_accessor :investment_value
-
     # The allocation unit of the investor.
     attr_accessor :allocation_unit
 
@@ -88,7 +86,6 @@ module DealMakerAPI
         :'warrant_expiry_date' => :'warrant_expiry_date',
         :'warrant_certificate_number' => :'warrant_certificate_number',
         :'allocated_amount' => :'allocated_amount',
-        :'investment_value' => :'investment_value',
         :'allocation_unit' => :'allocation_unit',
         :'state' => :'state'
       }
@@ -112,7 +109,6 @@ module DealMakerAPI
         :'warrant_expiry_date' => :'Date',
         :'warrant_certificate_number' => :'Integer',
         :'allocated_amount' => :'Float',
-        :'investment_value' => :'Float',
         :'allocation_unit' => :'String',
         :'state' => :'String'
       }
@@ -128,13 +124,13 @@ module DealMakerAPI
     # @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 `DealMakerAPI::CreateInvestorRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DealMakerAPI::PostDealsIdInvestors` 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 `DealMakerAPI::CreateInvestorRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DealMakerAPI::PostDealsIdInvestors`. 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
       }
@@ -183,10 +179,6 @@ module DealMakerAPI
         self.allocated_amount = attributes[:'allocated_amount']
       end
 
-      if attributes.key?(:'investment_value')
-        self.investment_value = attributes[:'investment_value']
-      end
-
       if attributes.key?(:'allocation_unit')
         self.allocation_unit = attributes[:'allocation_unit']
       else
@@ -259,7 +251,6 @@ module DealMakerAPI
           warrant_expiry_date == o.warrant_expiry_date &&
           warrant_certificate_number == o.warrant_certificate_number &&
           allocated_amount == o.allocated_amount &&
-          investment_value == o.investment_value &&
           allocation_unit == o.allocation_unit &&
           state == o.state
     end
@@ -273,7 +264,7 @@ module DealMakerAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email, investor_profile_id, tags, first_name, last_name, phone_number, message, warrant_expiry_date, warrant_certificate_number, allocated_amount, investment_value, allocation_unit, state].hash
+      [email, investor_profile_id, tags, first_name, last_name, phone_number, message, warrant_expiry_date, warrant_certificate_number, allocated_amount, allocation_unit, state].hash
     end
 
     # Builds the object from hash

data/lib/DealMakerAPI/models/{update_investor_request.rb → put_deals_id_investors.rb}

@@ -14,7 +14,8 @@ require 'date'
 require 'time'
 
 module DealMakerAPI
-  class UpdateInvestorRequest
+  # Update deal investor
+  class PutDealsIdInvestors
     # The warrant expiry date of the investor.
     attr_accessor :warrant_expiry_date
 
@@ -27,9 +28,6 @@ module DealMakerAPI
     # The allocation unit of the investor.
     attr_accessor :allocation_unit
 
-    # The investment value of the investor.
-    attr_accessor :investment_value
-
     # The notes of the investor.
     attr_accessor :notes
 
@@ -62,7 +60,6 @@ module DealMakerAPI
         :'warrant_certificate_number' => :'warrant_certificate_number',
         :'allocated_amount' => :'allocated_amount',
         :'allocation_unit' => :'allocation_unit',
-        :'investment_value' => :'investment_value',
         :'notes' => :'notes'
       }
     end
@@ -79,7 +76,6 @@ module DealMakerAPI
         :'warrant_certificate_number' => :'Integer',
         :'allocated_amount' => :'Float',
         :'allocation_unit' => :'String',
-        :'investment_value' => :'Float',
         :'notes' => :'String'
       }
     end
@@ -94,13 +90,13 @@ module DealMakerAPI
     # @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 `DealMakerAPI::UpdateInvestorRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DealMakerAPI::PutDealsIdInvestors` 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 `DealMakerAPI::UpdateInvestorRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DealMakerAPI::PutDealsIdInvestors`. 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
       }
@@ -123,10 +119,6 @@ module DealMakerAPI
         self.allocation_unit = 'securities'
       end
 
-      if attributes.key?(:'investment_value')
-        self.investment_value = attributes[:'investment_value']
-      end
-
       if attributes.key?(:'notes')
         self.notes = attributes[:'notes']
       end
@@ -168,7 +160,6 @@ module DealMakerAPI
           warrant_certificate_number == o.warrant_certificate_number &&
           allocated_amount == o.allocated_amount &&
           allocation_unit == o.allocation_unit &&
-          investment_value == o.investment_value &&
           notes == o.notes
     end
 
@@ -181,7 +172,7 @@ module DealMakerAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [warrant_expiry_date, warrant_certificate_number, allocated_amount, allocation_unit, investment_value, notes].hash
+      [warrant_expiry_date, warrant_certificate_number, allocated_amount, allocation_unit, notes].hash
     end
 
     # Builds the object from hash

data/lib/DealMakerAPI/models/v1_entities_bulk_upload.rb

@@ -25,7 +25,7 @@ module DealMakerAPI
     # The file identifier [shareholder, investor]
     attr_accessor :file_identifier
 
-    # The document type [drs_statement, shareholder_statement, book_entry_statement]
+    # The document type 
     attr_accessor :document_type
 
     # The bulk upload name
@@ -49,6 +49,28 @@ module DealMakerAPI
     # The updated at timestamp
     attr_accessor :updated_at
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -166,9 +188,21 @@ module DealMakerAPI
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      document_type_validator = EnumAttributeValidator.new('String', ["drs_statement", "shareholder_statement", "book_entry_statement", "dividend_statement"])
+      return false unless document_type_validator.valid?(@document_type)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] document_type Object to be assigned
+    def document_type=(document_type)
+      validator = EnumAttributeValidator.new('String', ["drs_statement", "shareholder_statement", "book_entry_statement", "dividend_statement"])
+      unless validator.valid?(document_type)
+        fail ArgumentError, "invalid value for \"document_type\", must be one of #{validator.allowable_values}."
+      end
+      @document_type = document_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)