DealMakerAPI 0.102.0 → 0.102.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4d7aef3a8c82aa73dde6dbe6545fd0e7e7d807271e79589ef86cfac79a589f2
-  data.tar.gz: b478f0acb43a7eb3a41162de259775fce6ed84bd10dd0d5e447a3a40a425852d
+  metadata.gz: 85b79231a4ed5c35f31f1154744b73537aba775e9125263943cf7a3be76d53e2
+  data.tar.gz: e11c77a85ca7019d342f00bf25deaee0bbc8270fd301781853d17be191ac4bfc
 SHA512:
-  metadata.gz: c78788e930bff3d10fc586f6ecfe2a502c1b1377794aed37171717664766d9c73479d865c6f2171fd5f7955168f4f901d34f69195748d5ca3701c7ae9addaf66
-  data.tar.gz: c47685a037006de9dee44eae3e19d0191eb821ee1c3bf9fa0d0a3ce7a51bd7d513e151021de52eb757c4d42ef576e181e213b7fd06ce84fd3d4bf77c3632b98c
+  metadata.gz: 79194b5d910f29abffd80784f5d9e9d06bef76aeaddd69053b34dd0d8a18e50de9387e0f0de6178e532b000833fae34ed203355278cb60b44df2a1a4ae22331e
+  data.tar.gz: 67f167089994c983c288b88d8f81c945c192da3124f58e790968e5864d59bed240658d732604c697cbe9f315580c78ca5aad476b0ad48b897076ea8e7e9ec265

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.102.0
+- Package version: 0.102.1
 - Generator version: 7.6.0-SNAPSHOT
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
@@ -355,16 +355,16 @@ gem build DealMakerAPI.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./DealMakerAPI-0.102.0.gem
+gem install ./DealMakerAPI-0.102.1.gem
 ```
 
-(for development, run `gem install --dev ./DealMakerAPI-0.102.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./DealMakerAPI-0.102.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.102.0'
+    gem 'DealMakerAPI', '~> 0.102.1'
 
 ### Install from Git
 
@@ -414,9 +414,10 @@ Class | Method | HTTP request | Description
 *DealMakerAPI::CompanyApi* | [**create_bulk_upload**](docs/CompanyApi.md#create_bulk_upload) | **POST** /companies/{id}/documents/bulk_uploads | Create bulk upload record
 *DealMakerAPI::CompanyApi* | [**create_bulk_upload_detail**](docs/CompanyApi.md#create_bulk_upload_detail) | **POST** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details | Create a BulkUploadDetail class record
 *DealMakerAPI::CompanyApi* | [**create_company**](docs/CompanyApi.md#create_company) | **POST** /companies | Create new company
-*DealMakerAPI::CompanyApi* | [**create_email_template**](docs/CompanyApi.md#create_email_template) | **POST** /companies/{id}/news_releases/email_template | Creates an email template
+*DealMakerAPI::CompanyApi* | [**create_email_template**](docs/CompanyApi.md#create_email_template) | **POST** /companies/{id}/news_releases/email_templates | Creates an email template
 *DealMakerAPI::CompanyApi* | [**create_members_bulk_upload**](docs/CompanyApi.md#create_members_bulk_upload) | **POST** /companies/{id}/members/bulk_uploads | Create bulk upload record
 *DealMakerAPI::CompanyApi* | [**create_shareholder_action**](docs/CompanyApi.md#create_shareholder_action) | **POST** /companies/{company_id}/shareholders/{shareholder_id}/actions | Create a shareholder action
+*DealMakerAPI::CompanyApi* | [**delete_email_template**](docs/CompanyApi.md#delete_email_template) | **DELETE** /companies/{id}/news_releases/email_templates/{template_id} | Deletes an email template
 *DealMakerAPI::CompanyApi* | [**get_bulk_upload**](docs/CompanyApi.md#get_bulk_upload) | **GET** /companies/{id}/documents/bulk_uploads/{bulk_upload_id} | Return a given bulk upload by id
 *DealMakerAPI::CompanyApi* | [**get_bulk_upload_details_errors**](docs/CompanyApi.md#get_bulk_upload_details_errors) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/errors | Returns a full list of details with errors of the given bulk upload ordered by status desc and id asc
 *DealMakerAPI::CompanyApi* | [**get_bulk_uploads**](docs/CompanyApi.md#get_bulk_uploads) | **GET** /companies/{id}/documents/bulk_uploads | Return bulk uploads
@@ -425,7 +426,7 @@ Class | Method | HTTP request | Description
 *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* | [**get_email_events**](docs/CompanyApi.md#get_email_events) | **GET** /companies/{company_communication_id}/email_events | Get a list of email events for a company communication
-*DealMakerAPI::CompanyApi* | [**get_email_template**](docs/CompanyApi.md#get_email_template) | **GET** /companies/{id}/news_releases/email_template/{template_id} | Get a email template
+*DealMakerAPI::CompanyApi* | [**get_email_template**](docs/CompanyApi.md#get_email_template) | **GET** /companies/{id}/news_releases/email_templates/{template_id} | Get an email template
 *DealMakerAPI::CompanyApi* | [**get_email_templates**](docs/CompanyApi.md#get_email_templates) | **GET** /companies/{id}/news_releases/email_templates | Get list of email template
 *DealMakerAPI::CompanyApi* | [**get_members_bulk_upload**](docs/CompanyApi.md#get_members_bulk_upload) | **GET** /companies/{id}/members/bulk_uploads/{id_members_bulk_upload} | Get bulk upload record
 *DealMakerAPI::CompanyApi* | [**get_members_bulk_uploads**](docs/CompanyApi.md#get_members_bulk_uploads) | **GET** /companies/{id}/members/bulk_uploads | Get bulk uploads records

data/docs/CompanyApi.md

@@ -7,9 +7,10 @@ All URIs are relative to *http://api.dealmaker.tech*
 | [**create_bulk_upload**](CompanyApi.md#create_bulk_upload) | **POST** /companies/{id}/documents/bulk_uploads | Create bulk upload record |
 | [**create_bulk_upload_detail**](CompanyApi.md#create_bulk_upload_detail) | **POST** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details | Create a BulkUploadDetail class record |
 | [**create_company**](CompanyApi.md#create_company) | **POST** /companies | Create new company |
-| [**create_email_template**](CompanyApi.md#create_email_template) | **POST** /companies/{id}/news_releases/email_template | Creates an email template |
+| [**create_email_template**](CompanyApi.md#create_email_template) | **POST** /companies/{id}/news_releases/email_templates | Creates an email template |
 | [**create_members_bulk_upload**](CompanyApi.md#create_members_bulk_upload) | **POST** /companies/{id}/members/bulk_uploads | Create bulk upload record |
 | [**create_shareholder_action**](CompanyApi.md#create_shareholder_action) | **POST** /companies/{company_id}/shareholders/{shareholder_id}/actions | Create a shareholder action |
+| [**delete_email_template**](CompanyApi.md#delete_email_template) | **DELETE** /companies/{id}/news_releases/email_templates/{template_id} | Deletes an email template |
 | [**get_bulk_upload**](CompanyApi.md#get_bulk_upload) | **GET** /companies/{id}/documents/bulk_uploads/{bulk_upload_id} | Return a given bulk upload by id |
 | [**get_bulk_upload_details_errors**](CompanyApi.md#get_bulk_upload_details_errors) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/errors | Returns a full list of details with errors of the given bulk upload ordered by status desc and id asc |
 | [**get_bulk_uploads**](CompanyApi.md#get_bulk_uploads) | **GET** /companies/{id}/documents/bulk_uploads | Return bulk uploads |
@@ -18,7 +19,7 @@ All URIs are relative to *http://api.dealmaker.tech*
 | [**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 |
 | [**get_email_events**](CompanyApi.md#get_email_events) | **GET** /companies/{company_communication_id}/email_events | Get a list of email events for a company communication |
-| [**get_email_template**](CompanyApi.md#get_email_template) | **GET** /companies/{id}/news_releases/email_template/{template_id} | Get a email template |
+| [**get_email_template**](CompanyApi.md#get_email_template) | **GET** /companies/{id}/news_releases/email_templates/{template_id} | Get an email template |
 | [**get_email_templates**](CompanyApi.md#get_email_templates) | **GET** /companies/{id}/news_releases/email_templates | Get list of email template |
 | [**get_members_bulk_upload**](CompanyApi.md#get_members_bulk_upload) | **GET** /companies/{id}/members/bulk_uploads/{id_members_bulk_upload} | Get bulk upload record |
 | [**get_members_bulk_uploads**](CompanyApi.md#get_members_bulk_uploads) | **GET** /companies/{id}/members/bulk_uploads | Get bulk uploads records |
@@ -437,6 +438,73 @@ No authorization required
 - **Accept**: application/json
 
 
+## delete_email_template
+
+> delete_email_template(id, template_id)
+
+Deletes an email template
+
+Delete an email template
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::CompanyApi.new
+id = 56 # Integer | The company id
+template_id = 56 # Integer | The email template id
+
+begin
+  # Deletes an email template
+  api_instance.delete_email_template(id, template_id)
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling CompanyApi->delete_email_template: #{e}"
+end
+```
+
+#### Using the delete_email_template_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)> delete_email_template_with_http_info(id, template_id)
+
+```ruby
+begin
+  # Deletes an email template
+  data, status_code, headers = api_instance.delete_email_template_with_http_info(id, template_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling CompanyApi->delete_email_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The company id |  |
+| **template_id** | **Integer** | The email template id |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
 ## get_bulk_upload
 
 > <V1EntitiesBulkUpload> get_bulk_upload(id, bulk_upload_id, opts)
@@ -997,9 +1065,9 @@ No authorization required
 
 > <V1EntitiesEmailTemplate> get_email_template(id, template_id)
 
-Get a email template
+Get an email template
 
-Get a email template
+Get an email template
 
 ### Examples
 
@@ -1014,7 +1082,7 @@ id = 56 # Integer | The company id
 template_id = 56 # Integer | The email template id
 
 begin
-  # Get a email template
+  # Get an email template
   result = api_instance.get_email_template(id, template_id)
   p result
 rescue DealMakerAPI::ApiError => e
@@ -1030,7 +1098,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Get a email template
+  # Get an email template
   data, status_code, headers = api_instance.get_email_template_with_http_info(id, template_id)
   p status_code # => 2xx
   p headers # => { ... }

data/lib/DealMakerAPI/api/company_api.rb

@@ -271,7 +271,7 @@ module DealMakerAPI
         fail ArgumentError, "Missing the required parameter 'create_email_template_request' when calling CompanyApi.create_email_template"
       end
       # resource path
-      local_var_path = '/companies/{id}/news_releases/email_template'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+      local_var_path = '/companies/{id}/news_releases/email_templates'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -469,6 +469,73 @@ module DealMakerAPI
       return data, status_code, headers
     end
 
+    # Deletes an email template
+    # Delete an email template
+    # @param id [Integer] The company id
+    # @param template_id [Integer] The email template id
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_email_template(id, template_id, opts = {})
+      delete_email_template_with_http_info(id, template_id, opts)
+      nil
+    end
+
+    # Deletes an email template
+    # Delete an email template
+    # @param id [Integer] The company id
+    # @param template_id [Integer] The email template id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_email_template_with_http_info(id, template_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompanyApi.delete_email_template ...'
+      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.delete_email_template"
+      end
+      # verify the required parameter 'template_id' is set
+      if @api_client.config.client_side_validation && template_id.nil?
+        fail ArgumentError, "Missing the required parameter 'template_id' when calling CompanyApi.delete_email_template"
+      end
+      # resource path
+      local_var_path = '/companies/{id}/news_releases/email_templates/{template_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"CompanyApi.delete_email_template",
+        :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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompanyApi#delete_email_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Return a given bulk upload by id
     # Return a given bulk upload by id
     # @param id [Integer] 
@@ -1012,8 +1079,8 @@ module DealMakerAPI
       return data, status_code, headers
     end
 
-    # Get a email template
-    # Get a email template
+    # Get an email template
+    # Get an email template
     # @param id [Integer] The company id
     # @param template_id [Integer] The email template id
     # @param [Hash] opts the optional parameters
@@ -1023,8 +1090,8 @@ module DealMakerAPI
       data
     end
 
-    # Get a email template
-    # Get a email template
+    # Get an email template
+    # Get an email template
     # @param id [Integer] The company id
     # @param template_id [Integer] The email template id
     # @param [Hash] opts the optional parameters
@@ -1042,7 +1109,7 @@ module DealMakerAPI
         fail ArgumentError, "Missing the required parameter 'template_id' when calling CompanyApi.get_email_template"
       end
       # resource path
-      local_var_path = '/companies/{id}/news_releases/email_template/{template_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
+      local_var_path = '/companies/{id}/news_releases/email_templates/{template_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}

data/lib/DealMakerAPI/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.6.0-SNAPSHOT
 =end
 
 module DealMakerAPI
-  VERSION = '0.102.0'
+  VERSION = '0.102.1'
 end

data/spec/api/company_api_spec.rb

@@ -111,6 +111,19 @@ describe 'CompanyApi' do
     end
   end
 
+  # unit tests for delete_email_template
+  # Deletes an email template
+  # Delete an email template
+  # @param id The company id
+  # @param template_id The email template id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_email_template test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for get_bulk_upload
   # Return a given bulk upload by id
   # Return a given bulk upload by id
@@ -219,8 +232,8 @@ describe 'CompanyApi' do
   end
 
   # unit tests for get_email_template
-  # Get a email template
-  # Get a email template
+  # Get an email template
+  # Get an email template
   # @param id The company id
   # @param template_id The email template id
   # @param [Hash] opts the optional parameters

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: DealMakerAPI
 version: !ruby/object:Gem::Version
-  version: 0.102.0
+  version: 0.102.1
 platform: ruby
 authors:
 - DealMaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-24 00:00:00.000000000 Z
+date: 2024-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus