DealMakerAPI 0.90.0 → 0.90.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb92d124d385e24970df9936695ecb92591692f2ac4e11e457e8eab82c96f68b
-  data.tar.gz: 36e97971ff8ac0e724b2ad4dd08474f25be1c596e6cb1cbab227185ef6a676c7
+  metadata.gz: eef65ab76c842d742b22d68316eb7bdc4f4547fd72203625cc9f65cbeb8979f8
+  data.tar.gz: 77067db4f04aa8e132c969c35b1155d17d22dc1617107a7b323b7b1222c48783
 SHA512:
-  metadata.gz: 38863eb19f8fbccab2637f7f691f740f909a96bc8ccfafba8adee26116fd1a688769ea0a0ec41b455d6a072c370d467ce4902b0d32d0d2d4ba50aeb2f7f025a1
-  data.tar.gz: f8144b715e9018eeec7f3bf3c9e3d9231fb7257a0bb45d8105ae2172feb020d5b436deece94181001fecc9347138b395e9eb165e67b4706520aa1c22e9049fd1
+  metadata.gz: 6479f29c9548a1f6af6a1cafdca443d3448aee1f3f4b7606b5255d211684a06c8b66f4d6a5674ceb65337af3942fa3efbfc798762a0a4f28a131f5d574f4641f
+  data.tar.gz: 6c26dcc0eef7ec93d086fc1ca90f9c98bd21e7c76d29d78417b607f5efa112d9cf0be50e53593235a01baff820c1de8b5e68f12d6b39eae80fd6a6dfe6f258ce

data/README.md

@@ -338,7 +338,7 @@ Given the high number of updates our platform performs on any investor, we’ve
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.75.0
-- Package version: 0.90.0
+- Package version: 0.90.1
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -354,16 +354,16 @@ gem build DealMakerAPI.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./DealMakerAPI-0.90.0.gem
+gem install ./DealMakerAPI-0.90.1.gem
 ```
 
-(for development, run `gem install --dev ./DealMakerAPI-0.90.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./DealMakerAPI-0.90.1.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'DealMakerAPI', '~> 0.90.0'
+    gem 'DealMakerAPI', '~> 0.90.1'
 
 ### Install from Git
 
@@ -421,6 +421,7 @@ Class | Method | HTTP request | Description
 *DealMakerAPI::CompanyApi* | [**get_company**](docs/CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company
 *DealMakerAPI::CompanyApi* | [**get_details_errors_grouped**](docs/CompanyApi.md#get_details_errors_grouped) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/grouped_errors | Return bulk upload details grouped by status
 *DealMakerAPI::CompanyApi* | [**get_dividends**](docs/CompanyApi.md#get_dividends) | **GET** /companies/{company_id}/portal/dividends | Return dividends
+*DealMakerAPI::CompanyApi* | [**send_portal_invite**](docs/CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder
 *DealMakerAPI::CountryApi* | [**get_country_states**](docs/CountryApi.md#get_country_states) | **GET** /country/states | Returns a list of all valid countries and it states
 *DealMakerAPI::DealApi* | [**create_deal_setup**](docs/DealApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup
 *DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
@@ -498,6 +499,7 @@ Class | Method | HTTP request | Description
  - [DealMakerAPI::PutDealsIdInvestors](docs/PutDealsIdInvestors.md)
  - [DealMakerAPI::PutDealsIdScriptTagEnvironmentRequest](docs/PutDealsIdScriptTagEnvironmentRequest.md)
  - [DealMakerAPI::PutWebhooksIdRequest](docs/PutWebhooksIdRequest.md)
+ - [DealMakerAPI::SendPortalInviteRequest](docs/SendPortalInviteRequest.md)
  - [DealMakerAPI::V1EntitiesAddress](docs/V1EntitiesAddress.md)
  - [DealMakerAPI::V1EntitiesAddresses](docs/V1EntitiesAddresses.md)
  - [DealMakerAPI::V1EntitiesAttachment](docs/V1EntitiesAttachment.md)
@@ -534,6 +536,7 @@ Class | Method | HTTP request | Description
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsPrimaryHolder](docs/V1EntitiesInvestorProfileFieldsPrimaryHolder.md)
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsSigningOfficer](docs/V1EntitiesInvestorProfileFieldsSigningOfficer.md)
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsTrust](docs/V1EntitiesInvestorProfileFieldsTrust.md)
+ - [DealMakerAPI::V1EntitiesInvestorProfileFieldsTrustee](docs/V1EntitiesInvestorProfileFieldsTrustee.md)
  - [DealMakerAPI::V1EntitiesInvestorProfileIndividual](docs/V1EntitiesInvestorProfileIndividual.md)
  - [DealMakerAPI::V1EntitiesInvestorProfileItem](docs/V1EntitiesInvestorProfileItem.md)
  - [DealMakerAPI::V1EntitiesInvestorProfileJoint](docs/V1EntitiesInvestorProfileJoint.md)

data/docs/CompanyApi.md

@@ -15,6 +15,7 @@ All URIs are relative to *http://api.dealmaker.tech*
 | [**get_company**](CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company |
 | [**get_details_errors_grouped**](CompanyApi.md#get_details_errors_grouped) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/grouped_errors | Return bulk upload details grouped by status |
 | [**get_dividends**](CompanyApi.md#get_dividends) | **GET** /companies/{company_id}/portal/dividends | Return dividends |
+| [**send_portal_invite**](CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder |
 
 
 ## create_bulk_upload
@@ -780,3 +781,74 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## send_portal_invite
+
+> send_portal_invite(id, shareholder_id, opts)
+
+Send portal invite to shareholder
+
+Send portal invite to shareholder.
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::CompanyApi.new
+id = 56 # Integer | 
+shareholder_id = 56 # Integer | 
+opts = {
+  send_portal_invite_request: DealMakerAPI::SendPortalInviteRequest.new # SendPortalInviteRequest | 
+}
+
+begin
+  # Send portal invite to shareholder
+  api_instance.send_portal_invite(id, shareholder_id, opts)
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling CompanyApi->send_portal_invite: #{e}"
+end
+```
+
+#### Using the send_portal_invite_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> send_portal_invite_with_http_info(id, shareholder_id, opts)
+
+```ruby
+begin
+  # Send portal invite to shareholder
+  data, status_code, headers = api_instance.send_portal_invite_with_http_info(id, shareholder_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling CompanyApi->send_portal_invite_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **shareholder_id** | **Integer** |  |  |
+| **send_portal_invite_request** | [**SendPortalInviteRequest**](SendPortalInviteRequest.md) |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+

data/docs/PatchInvestorProfilesTrustsTrusteesInner.md

@@ -16,6 +16,7 @@
 | **postal_code** | **String** | The list of postal codes or zipcodes for the trustees (required for trustee 1). | [optional] |
 | **date_of_birth** | **String** | The list of dates of birth for the trustees (required for trustee 1). | [optional] |
 | **taxpayer_id** | **String** | The list of taxpayer identification numbers for the trustees (required for trustee 1). | [optional] |
+| **phone_number** | **String** | The list of phone numbers for the trustees (required for trustee 1). | [optional] |
 
 ## Example
 
@@ -34,7 +35,8 @@ instance = DealMakerAPI::PatchInvestorProfilesTrustsTrusteesInner.new(
   region: null,
   postal_code: null,
   date_of_birth: null,
-  taxpayer_id: null
+  taxpayer_id: null,
+  phone_number: null
 )
 ```
 

data/docs/PostInvestorProfilesTrustsTrusteesInner.md

@@ -14,6 +14,7 @@
 | **postal_code** | **String** | The list of postal codes or zipcodes for the trustees (required for trustee 1). | [optional] |
 | **date_of_birth** | **String** | The list of dates of birth for the trustees (required for trustee 1). | [optional] |
 | **taxpayer_id** | **String** | The list of taxpayer identification numbers for the trustees (required for trustee 1). | [optional] |
+| **phone_number** | **String** | The list of phone numbers for the trustees (required for trustee 1). | [optional] |
 
 ## Example
 
@@ -30,7 +31,8 @@ instance = DealMakerAPI::PostInvestorProfilesTrustsTrusteesInner.new(
   region: null,
   postal_code: null,
   date_of_birth: null,
-  taxpayer_id: null
+  taxpayer_id: null,
+  phone_number: null
 )
 ```
 

data/docs/SendPortalInviteRequest.md

@@ -0,0 +1,20 @@
+# DealMakerAPI::SendPortalInviteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject** | **String** | The custom subject of the invite email | [optional] |
+| **email_content** | **String** | The custom email content of the invite email | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::SendPortalInviteRequest.new(
+  subject: null,
+  email_content: null
+)
+```
+

data/docs/V1EntitiesInvestorProfileFieldsTrustee.md

@@ -0,0 +1,30 @@
+# DealMakerAPI::V1EntitiesInvestorProfileFieldsTrustee
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** | Investor profile first name | [optional] |
+| **last_name** | **String** | Investor profile last name | [optional] |
+| **suffix** | **String** | Investor profile suffix | [optional] |
+| **date_of_birth** | **String** | The date of birth | [optional] |
+| **taxpayer_id** | **String** | The taxpayer identification number | [optional] |
+| **address** | [**V1EntitiesInvestorProfileAddress**](V1EntitiesInvestorProfileAddress.md) |  | [optional] |
+| **phone_number** | **String** | Trustee phone number | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesInvestorProfileFieldsTrustee.new(
+  first_name: null,
+  last_name: null,
+  suffix: null,
+  date_of_birth: null,
+  taxpayer_id: null,
+  address: null,
+  phone_number: null
+)
+```
+

data/docs/V1EntitiesInvestorProfileTrust.md

@@ -14,7 +14,7 @@
 | **owner_type** | **String** | Type of the investor profile owner | [optional] |
 | **owner** | [**V1EntitiesInvestorProfileOwner**](V1EntitiesInvestorProfileOwner.md) |  | [optional] |
 | **trust_holder** | [**V1EntitiesInvestorProfileFieldsTrust**](V1EntitiesInvestorProfileFieldsTrust.md) |  | [optional] |
-| **trustees** | [**V1EntitiesInvestorProfileFieldsAccountHolder**](V1EntitiesInvestorProfileFieldsAccountHolder.md) |  | [optional] |
+| **trustees** | [**V1EntitiesInvestorProfileFieldsTrustee**](V1EntitiesInvestorProfileFieldsTrustee.md) |  | [optional] |
 
 ## Example
 

data/lib/DealMakerAPI/api/company_api.rb

@@ -800,5 +800,79 @@ module DealMakerAPI
       end
       return data, status_code, headers
     end
+
+    # Send portal invite to shareholder
+    # Send portal invite to shareholder.
+    # @param id [Integer] 
+    # @param shareholder_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [SendPortalInviteRequest] :send_portal_invite_request 
+    # @return [nil]
+    def send_portal_invite(id, shareholder_id, opts = {})
+      send_portal_invite_with_http_info(id, shareholder_id, opts)
+      nil
+    end
+
+    # Send portal invite to shareholder
+    # Send portal invite to shareholder.
+    # @param id [Integer] 
+    # @param shareholder_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [SendPortalInviteRequest] :send_portal_invite_request 
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def send_portal_invite_with_http_info(id, shareholder_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompanyApi.send_portal_invite ...'
+      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 CompanyApi.send_portal_invite"
+      end
+      # verify the required parameter 'shareholder_id' is set
+      if @api_client.config.client_side_validation && shareholder_id.nil?
+        fail ArgumentError, "Missing the required parameter 'shareholder_id' when calling CompanyApi.send_portal_invite"
+      end
+      # resource path
+      local_var_path = '/companies/{id}/shareholders/{shareholder_id}/send_portal_invite'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'shareholder_id' + '}', CGI.escape(shareholder_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # 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(opts[:'send_portal_invite_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"CompanyApi.send_portal_invite",
+        :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: CompanyApi#send_portal_invite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/DealMakerAPI/api_client.rb

@@ -46,9 +46,10 @@ module DealMakerAPI
     # Call an API with given options.
     #
     # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
-    #   the data deserialized from response body (could be nil), response status code and response headers.
+    #   the data deserialized from response body (may be a Tempfile or nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
       request = build_request(http_method, path, opts)
+      tempfile = download_file(request) if opts[:return_type] == 'File'
       response = request.run
 
       if @config.debugging
@@ -70,7 +71,9 @@ module DealMakerAPI
         end
       end
 
-      if opts[:return_type]
+      if opts[:return_type] == 'File'
+        data = tempfile
+      elsif opts[:return_type]
         data = deserialize(response, opts[:return_type])
       else
         data = nil
@@ -125,9 +128,7 @@ module DealMakerAPI
         end
       end
 
-      request = Typhoeus::Request.new(url, req_opts)
-      download_file(request) if opts[:return_type] == 'File'
-      request
+      Typhoeus::Request.new(url, req_opts)
     end
 
     # Builds the HTTP request body
@@ -165,6 +166,8 @@ module DealMakerAPI
     # process can use.
     #
     # @see Configuration#temp_folder_path
+    #
+    # @return [Tempfile] the tempfile generated
     def download_file(request)
       tempfile = nil
       encoding = nil
@@ -179,7 +182,6 @@ module DealMakerAPI
         prefix = prefix + '-' unless prefix.end_with?('-')
         encoding = response.body.encoding
         tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-        @tempfile = tempfile
       end
       request.on_body do |chunk|
         chunk.force_encoding(encoding)
@@ -194,6 +196,8 @@ module DealMakerAPI
                               "explicitly with `tempfile.delete`"
         end
       end
+
+      tempfile
     end
 
     # Check if the given MIME is a JSON MIME.
@@ -214,11 +218,6 @@ module DealMakerAPI
     # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
     def deserialize(response, return_type)
       body = response.body
-
-      # handle file downloading - return the File instance processed in request callbacks
-      # note that response body is empty when the file is written in chunks in request on_body callback
-      return @tempfile if return_type == 'File'
-
       return nil if body.nil? || body.empty?
 
       # return response body directly for String return type

data/lib/DealMakerAPI/models/patch_investor_profiles_trusts_trustees_inner.rb

@@ -51,6 +51,9 @@ module DealMakerAPI
     # The list of taxpayer identification numbers for the trustees (required for trustee 1).
     attr_accessor :taxpayer_id
 
+    # The list of phone numbers for the trustees (required for trustee 1).
+    attr_accessor :phone_number
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -65,7 +68,8 @@ module DealMakerAPI
         :'region' => :'region',
         :'postal_code' => :'postal_code',
         :'date_of_birth' => :'date_of_birth',
-        :'taxpayer_id' => :'taxpayer_id'
+        :'taxpayer_id' => :'taxpayer_id',
+        :'phone_number' => :'phone_number'
       }
     end
 
@@ -88,7 +92,8 @@ module DealMakerAPI
         :'region' => :'String',
         :'postal_code' => :'String',
         :'date_of_birth' => :'String',
-        :'taxpayer_id' => :'String'
+        :'taxpayer_id' => :'String',
+        :'phone_number' => :'String'
       }
     end
 
@@ -162,6 +167,10 @@ module DealMakerAPI
       if attributes.key?(:'taxpayer_id')
         self.taxpayer_id = attributes[:'taxpayer_id']
       end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -200,7 +209,8 @@ module DealMakerAPI
           region == o.region &&
           postal_code == o.postal_code &&
           date_of_birth == o.date_of_birth &&
-          taxpayer_id == o.taxpayer_id
+          taxpayer_id == o.taxpayer_id &&
+          phone_number == o.phone_number
     end
 
     # @see the `==` method
@@ -212,7 +222,7 @@ module DealMakerAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [index, _delete, first_name, last_name, suffix, street_address, unit2, city, region, postal_code, date_of_birth, taxpayer_id].hash
+      [index, _delete, first_name, last_name, suffix, street_address, unit2, city, region, postal_code, date_of_birth, taxpayer_id, phone_number].hash
     end
 
     # Builds the object from hash

data/lib/DealMakerAPI/models/post_investor_profiles_trusts_trustees_inner.rb

@@ -45,6 +45,9 @@ module DealMakerAPI
     # The list of taxpayer identification numbers for the trustees (required for trustee 1).
     attr_accessor :taxpayer_id
 
+    # The list of phone numbers for the trustees (required for trustee 1).
+    attr_accessor :phone_number
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -57,7 +60,8 @@ module DealMakerAPI
         :'region' => :'region',
         :'postal_code' => :'postal_code',
         :'date_of_birth' => :'date_of_birth',
-        :'taxpayer_id' => :'taxpayer_id'
+        :'taxpayer_id' => :'taxpayer_id',
+        :'phone_number' => :'phone_number'
       }
     end
 
@@ -78,7 +82,8 @@ module DealMakerAPI
         :'region' => :'String',
         :'postal_code' => :'String',
         :'date_of_birth' => :'String',
-        :'taxpayer_id' => :'String'
+        :'taxpayer_id' => :'String',
+        :'phone_number' => :'String'
       }
     end
 
@@ -142,6 +147,10 @@ module DealMakerAPI
       if attributes.key?(:'taxpayer_id')
         self.taxpayer_id = attributes[:'taxpayer_id']
       end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -173,7 +182,8 @@ module DealMakerAPI
           region == o.region &&
           postal_code == o.postal_code &&
           date_of_birth == o.date_of_birth &&
-          taxpayer_id == o.taxpayer_id
+          taxpayer_id == o.taxpayer_id &&
+          phone_number == o.phone_number
     end
 
     # @see the `==` method
@@ -185,7 +195,7 @@ module DealMakerAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [first_name, last_name, suffix, street_address, unit2, city, region, postal_code, date_of_birth, taxpayer_id].hash
+      [first_name, last_name, suffix, street_address, unit2, city, region, postal_code, date_of_birth, taxpayer_id, phone_number].hash
     end
 
     # Builds the object from hash