DealMakerAPI 0.0.2 → 0.68.6

data/docs/CompanyApi.md

@@ -0,0 +1,214 @@
+# DealMakerAPI::CompanyApi
+
+All URIs are relative to *http://api.dealmaker.tech*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_company**](CompanyApi.md#create_company) | **POST** /companies | Create new company |
+| [**get_companies**](CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies |
+| [**get_company**](CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company |
+
+
+## create_company
+
+> <V1EntitiesCompany> create_company(create_company_request)
+
+Create new company
+
+Creates a new company.
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::CompanyApi.new
+create_company_request = DealMakerAPI::CreateCompanyRequest.new({name: 'name_example', country: 'country_example', street: 'street_example', city: 'city_example', state: 'state_example', postal_code: 'postal_code_example'}) # CreateCompanyRequest | 
+
+begin
+  # Create new company
+  result = api_instance.create_company(create_company_request)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling CompanyApi->create_company: #{e}"
+end
+```
+
+#### Using the create_company_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesCompany>, Integer, Hash)> create_company_with_http_info(create_company_request)
+
+```ruby
+begin
+  # Create new company
+  data, status_code, headers = api_instance.create_company_with_http_info(create_company_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesCompany>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling CompanyApi->create_company_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_company_request** | [**CreateCompanyRequest**](CreateCompanyRequest.md) |  |  |
+
+### Return type
+
+[**V1EntitiesCompany**](V1EntitiesCompany.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_companies
+
+> <V1EntitiesCompany> get_companies(opts)
+
+Get list of Companies
+
+Get companies
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::CompanyApi.new
+opts = {
+  page: 56, # Integer | Page offset to fetch.
+  per_page: 56, # Integer | Number of results to return per page.
+  offset: 56 # Integer | Pad a number of results.
+}
+
+begin
+  # Get list of Companies
+  result = api_instance.get_companies(opts)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling CompanyApi->get_companies: #{e}"
+end
+```
+
+#### Using the get_companies_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesCompany>, Integer, Hash)> get_companies_with_http_info(opts)
+
+```ruby
+begin
+  # Get list of Companies
+  data, status_code, headers = api_instance.get_companies_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesCompany>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling CompanyApi->get_companies_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page offset to fetch. | [optional][default to 1] |
+| **per_page** | **Integer** | Number of results to return per page. | [optional][default to 25] |
+| **offset** | **Integer** | Pad a number of results. | [optional][default to 0] |
+
+### Return type
+
+[**V1EntitiesCompany**](V1EntitiesCompany.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_company
+
+> <V1EntitiesCompany> get_company(id)
+
+Get a Company
+
+Get a Company.
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::CompanyApi.new
+id = 56 # Integer | 
+
+begin
+  # Get a Company
+  result = api_instance.get_company(id)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling CompanyApi->get_company: #{e}"
+end
+```
+
+#### Using the get_company_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesCompany>, Integer, Hash)> get_company_with_http_info(id)
+
+```ruby
+begin
+  # Get a Company
+  data, status_code, headers = api_instance.get_company_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesCompany>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling CompanyApi->get_company_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+[**V1EntitiesCompany**](V1EntitiesCompany.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CreateCompanyRequest.md

@@ -0,0 +1,32 @@
+# DealMakerAPI::CreateCompanyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The company name |  |
+| **country** | **String** | The country of the company |  |
+| **street** | **String** | The street of the company |  |
+| **line_2** | **String** | The second line of the address of the company | [optional] |
+| **city** | **String** | The city of the company |  |
+| **state** | **String** | The state of the company |  |
+| **postal_code** | **String** | The postal code/zip code of the company |  |
+| **primary_color** | **String** | The primary color of the company | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::CreateCompanyRequest.new(
+  name: null,
+  country: null,
+  street: null,
+  line_2: null,
+  city: null,
+  state: null,
+  postal_code: null,
+  primary_color: null
+)
+```
+

data/docs/CreateCorporationProfileRequest.md

@@ -0,0 +1,82 @@
+# DealMakerAPI::CreateCorporationProfileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | User email which is associated with investor profile (required). |  |
+| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
+| **name** | **String** | The name of the corporation (required). | [optional] |
+| **country** | **String** | The country of the corporation (required). | [optional] |
+| **street_address** | **String** | The street address of the corporation (required). | [optional] |
+| **unit2** | **String** | The street address line 2 of the corporation. | [optional] |
+| **city** | **String** | The city of the corporation (required). | [optional] |
+| **region** | **String** | The region or state of the corporation (required). | [optional] |
+| **postal_code** | **String** | The postal code or zipcode of the corporation (required). | [optional] |
+| **business_number** | **String** | The taxpayer identification number  of the corporation (required). | [optional] |
+| **phone_number** | **String** | The phone number o of the corporation (required). | [optional] |
+| **signing_officer_first_name** | **String** | The first name of the signing officer (required). | [optional] |
+| **signing_officer_last_name** | **String** | The last name of the signing officer (required). | [optional] |
+| **signing_officer_suffix** | **String** | The suffix of the signing officer. | [optional] |
+| **signing_officer_country** | **String** | The country of the signing officer (required). | [optional] |
+| **signing_officer_street_address** | **String** | The street address of the signing officer (required). | [optional] |
+| **signing_officer_unit2** | **String** | The street address line 2 of the signing officer. | [optional] |
+| **signing_officer_city** | **String** | The city of the signing officer (required). | [optional] |
+| **signing_officer_region** | **String** | The region or state of the signing officer (required). | [optional] |
+| **signing_officer_postal_code** | **String** | The postal code or zipcode of the signing officer (required). | [optional] |
+| **signing_officer_date_of_birth** | **String** | The date of birth of the signing officer (required). | [optional] |
+| **signing_officer_taxpayer_id** | **String** | The taxpayer identification number of the signing officer (required). | [optional] |
+| **beneficial_owners_first_name** | **Array<String>** | The list of first names for the beneficial owners (required for beneficial owner 1). | [optional] |
+| **beneficial_owners_last_name** | **Array<String>** | The list of last names for the beneficial owners (required for beneficial owner 1). | [optional] |
+| **beneficial_owners_suffix** | **Array<String>** | The list of suffixes for the beneficial owners. | [optional] |
+| **beneficial_owners_country** | **Array<String>** | The list of countries for the beneficial owners (required for beneficial owner 1). | [optional] |
+| **beneficial_owners_street_address** | **Array<String>** | The list of street addresses for the beneficial owners (required for beneficial owner 1). | [optional] |
+| **beneficial_owners_unit_2** | **Array<String>** | The list of street address line 2 for the beneficial owners. | [optional] |
+| **beneficial_owners_city** | **Array<String>** | The list of cities for the beneficial owners (required for beneficial owner 1). | [optional] |
+| **beneficial_owners_region** | **Array<String>** | The list of region or states for the beneficial owners (required for beneficial owner 1). | [optional] |
+| **beneficial_owners_postal_code** | **Array<String>** | The list of postal codes or zipcodes for the beneficial owners (required for beneficial owner 1). | [optional] |
+| **beneficial_owners_date_of_birth** | **Array<String>** | The list of dates of birth for the beneficial owners (required for beneficial owner 1). | [optional] |
+| **beneficial_owners_taxpayer_id** | **Array<String>** | The list of taxpayer identification numbers for the beneficial owners (required for beneficial owner 1). | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::CreateCorporationProfileRequest.new(
+  email: null,
+  us_accredited_category: null,
+  name: null,
+  country: null,
+  street_address: null,
+  unit2: null,
+  city: null,
+  region: null,
+  postal_code: null,
+  business_number: null,
+  phone_number: null,
+  signing_officer_first_name: null,
+  signing_officer_last_name: null,
+  signing_officer_suffix: null,
+  signing_officer_country: null,
+  signing_officer_street_address: null,
+  signing_officer_unit2: null,
+  signing_officer_city: null,
+  signing_officer_region: null,
+  signing_officer_postal_code: null,
+  signing_officer_date_of_birth: null,
+  signing_officer_taxpayer_id: null,
+  beneficial_owners_first_name: null,
+  beneficial_owners_last_name: null,
+  beneficial_owners_suffix: null,
+  beneficial_owners_country: null,
+  beneficial_owners_street_address: null,
+  beneficial_owners_unit_2: null,
+  beneficial_owners_city: null,
+  beneficial_owners_region: null,
+  beneficial_owners_postal_code: null,
+  beneficial_owners_date_of_birth: null,
+  beneficial_owners_taxpayer_id: null
+)
+```
+

data/docs/CreateDealSetupRequest.md

@@ -0,0 +1,30 @@
+# DealMakerAPI::CreateDealSetupRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoicing_email** | **String** | The invoice email address. |  |
+| **issuer_industry** | **String** | The industry. | [optional][default to 'other'] |
+| **prohibited_industry** | **String** | Determine if the deal is a high risk or not. | [optional][default to 'prohibited'] |
+| **offering_type** | **String** | The deal kind | [default to 'other'] |
+| **title** | **String** | The name of deal to setup. |  |
+| **company_id** | **Integer** | the company id. |  |
+| **representative** | **String** | The email of the representative. | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::CreateDealSetupRequest.new(
+  invoicing_email: null,
+  issuer_industry: null,
+  prohibited_industry: null,
+  offering_type: null,
+  title: null,
+  company_id: null,
+  representative: null
+)
+```
+

data/docs/CreateIndividualProfileRequest.md

@@ -0,0 +1,44 @@
+# DealMakerAPI::CreateIndividualProfileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | User email which is associated with individual investor profile. |  |
+| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
+| **first_name** | **String** | The first name of the individual investor profile (required). | [optional] |
+| **last_name** | **String** | The last name of the individual investor profile (required) | [optional] |
+| **suffix** | **String** | The suffix of the individual investor profile | [optional] |
+| **date_of_birth** | **String** | The date of birth of the investor profile (required) | [optional] |
+| **taxpayer_id** | **String** | The taxpayer identification number of the investor profile (required) | [optional] |
+| **phone_number** | **String** | The phone number of the investor profile (required) | [optional] |
+| **country** | **String** | The country of the individual investor profile (required) | [optional] |
+| **street_address** | **String** | The street address of the individual investor profile (required) | [optional] |
+| **unit2** | **String** | The street address line 2 of the individual investor profile | [optional] |
+| **city** | **String** | The city of the individual investor profile (required) | [optional] |
+| **region** | **String** | The region or state of the individual investor profile (required) | [optional] |
+| **postal_code** | **String** | The postal code or zipcode of the individual investor profile (required) | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::CreateIndividualProfileRequest.new(
+  email: null,
+  us_accredited_category: null,
+  first_name: null,
+  last_name: null,
+  suffix: null,
+  date_of_birth: null,
+  taxpayer_id: null,
+  phone_number: null,
+  country: null,
+  street_address: null,
+  unit2: null,
+  city: null,
+  region: null,
+  postal_code: null
+)
+```
+

data/docs/CreateInvestorRequest.md

@@ -0,0 +1,40 @@
+# DealMakerAPI::CreateInvestorRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | The investor email address. |  |
+| **investor_profile_id** | **Integer** | The Investor Profile id. | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **first_name** | **String** | The first name of the investor. | [optional] |
+| **last_name** | **String** | The last name of the investor. | [optional] |
+| **phone_number** | **String** | The phone number of the investor. | [optional] |
+| **message** | **String** | The reminder email text of the investor. | [optional] |
+| **warrant_expiry_date** | **Date** | The warrant expiry date of the investor. | [optional] |
+| **warrant_certificate_number** | **Integer** | The certificate number of the investor. | [optional] |
+| **allocated_amount** | **Float** | The allocation amount of the investor. | [optional] |
+| **allocation_unit** | **String** | The allocation unit of the investor. | [optional][default to 'securities'] |
+| **state** | **String** | The initial state of the investor. | [optional][default to 'invited'] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::CreateInvestorRequest.new(
+  email: null,
+  investor_profile_id: null,
+  tags: null,
+  first_name: null,
+  last_name: null,
+  phone_number: null,
+  message: null,
+  warrant_expiry_date: null,
+  warrant_certificate_number: null,
+  allocated_amount: null,
+  allocation_unit: null,
+  state: null
+)
+```
+

data/docs/CreateJointProfileRequest.md

@@ -0,0 +1,68 @@
+# DealMakerAPI::CreateJointProfileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | User email which is associated with investor profile. |  |
+| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
+| **joint_type** | **String** | The types of joint investor. | [optional] |
+| **first_name** | **String** | The first name of the primary holder (required). | [optional] |
+| **last_name** | **String** | The last name of the primary holder (required). | [optional] |
+| **suffix** | **String** | The suffix of the primary holder. | [optional] |
+| **country** | **String** | The country the primary holder (required). | [optional] |
+| **street_address** | **String** | The street address of the primary holder (required). | [optional] |
+| **unit2** | **String** | The street address line 2 of the primary holder. | [optional] |
+| **city** | **String** | The city of the primary holder (required). | [optional] |
+| **region** | **String** | The region or State of the primary holder (required). | [optional] |
+| **postal_code** | **String** | The postal code or zipcode of the primary holder (required). | [optional] |
+| **date_of_birth** | **String** | The date of birth of the primary holder (required). | [optional] |
+| **taxpayer_id** | **String** | The taxpayer identification number of the primary holder (required). | [optional] |
+| **phone_number** | **String** | The phone number of the primary holder (required). | [optional] |
+| **joint_holder_first_name** | **String** | The first name of the joint holder (required). | [optional] |
+| **joint_holder_last_name** | **String** | The last name of the joint holder (required). | [optional] |
+| **joint_holder_suffix** | **String** | The suffix of the joint holder. | [optional] |
+| **joint_holder_country** | **String** | The country of the joint holder (required). | [optional] |
+| **joint_holder_street_address** | **String** | The street address of the joint holder (required). | [optional] |
+| **joint_holder_unit2** | **String** | The street address line 2 of the joint holder. | [optional] |
+| **joint_holder_city** | **String** | The city of the joint holder (required). | [optional] |
+| **joint_holder_region** | **String** | The region or state of the joint holder (required). | [optional] |
+| **joint_holder_postal_code** | **String** | The postal code or zipcode of the joint holder (required). | [optional] |
+| **joint_holder_date_of_birth** | **String** | The date of birth of the joint holder (required). | [optional] |
+| **joint_holder_taxpayer_id** | **String** | The taxpayer identification number of the joint holder (required). | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::CreateJointProfileRequest.new(
+  email: null,
+  us_accredited_category: null,
+  joint_type: null,
+  first_name: null,
+  last_name: null,
+  suffix: null,
+  country: null,
+  street_address: null,
+  unit2: null,
+  city: null,
+  region: null,
+  postal_code: null,
+  date_of_birth: null,
+  taxpayer_id: null,
+  phone_number: null,
+  joint_holder_first_name: null,
+  joint_holder_last_name: null,
+  joint_holder_suffix: null,
+  joint_holder_country: null,
+  joint_holder_street_address: null,
+  joint_holder_unit2: null,
+  joint_holder_city: null,
+  joint_holder_region: null,
+  joint_holder_postal_code: null,
+  joint_holder_date_of_birth: null,
+  joint_holder_taxpayer_id: null
+)
+```
+

data/docs/CreateTrustProfileRequest.md

@@ -0,0 +1,60 @@
+# DealMakerAPI::CreateTrustProfileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | User email which is associated with investor profile (required). |  |
+| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
+| **name** | **String** | The name of the trust (required). | [optional] |
+| **date** | **String** | The creation date of the trust (required). | [optional] |
+| **country** | **String** | The country of the trust (required). | [optional] |
+| **street_address** | **String** | Trust street address of the trust (required). | [optional] |
+| **unit2** | **String** | The street address line 2 of the trust. | [optional] |
+| **city** | **String** | The city of the trust (required). | [optional] |
+| **region** | **String** | The region or state of the trust (required). | [optional] |
+| **postal_code** | **String** | The postal code or zipcode of the trust (required). | [optional] |
+| **phone_number** | **String** | The phone number of the trust (required). | [optional] |
+| **trustees_first_name** | **Array<String>** | The list of first names for the trustees (required for trustee 1). | [optional] |
+| **trustees_last_name** | **Array<String>** | The list of last names for the trustees (required for trustee 1). | [optional] |
+| **trustees_suffix** | **Array<String>** | The list of suffixes for the trustees. | [optional] |
+| **trustees_country** | **Array<String>** | The list of countries for the trustees (required for trustee 1). | [optional] |
+| **trustees_street_address** | **Array<String>** | The list of street addresses for the trustees (required for trustee 1). | [optional] |
+| **trustees_unit_2** | **Array<String>** | The list of street address line 2 for the trustees. | [optional] |
+| **trustees_city** | **Array<String>** | The list of cities for the trustees (required for trustee 1). | [optional] |
+| **trustees_region** | **Array<String>** | The list of regions or states for the trustees (required for trustee 1). | [optional] |
+| **trustees_postal_code** | **Array<String>** | The list of postal codes or zipcodes for the trustees (required) for trustee 1. | [optional] |
+| **trustees_date_of_birth** | **Array<String>** | The list of dates of birth for the trustees (required for trustee 1). | [optional] |
+| **trustees_taxpayer_id** | **Array<String>** | The list of taxpayer identification numbers for the trustees (required for trustee 1). | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::CreateTrustProfileRequest.new(
+  email: null,
+  us_accredited_category: null,
+  name: null,
+  date: null,
+  country: null,
+  street_address: null,
+  unit2: null,
+  city: null,
+  region: null,
+  postal_code: null,
+  phone_number: null,
+  trustees_first_name: null,
+  trustees_last_name: null,
+  trustees_suffix: null,
+  trustees_country: null,
+  trustees_street_address: null,
+  trustees_unit_2: null,
+  trustees_city: null,
+  trustees_region: null,
+  trustees_postal_code: null,
+  trustees_date_of_birth: null,
+  trustees_taxpayer_id: null
+)
+```
+