DealMakerAPI 0.0.1

data/docs/DealApi.md

@@ -0,0 +1,289 @@
+# DealMakerAPI::DealApi
+
+All URIs are relative to *http://api.dealmaker.tech*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_investor**](DealApi.md#create_investor) | **POST** /deals/{id}/investors | Create a deal investor |
+| [**get_deal**](DealApi.md#get_deal) | **GET** /deals/{id} | Get a deal by id |
+| [**get_investor**](DealApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id |
+| [**list_investors**](DealApi.md#list_investors) | **GET** /deals/{id}/investors | List deal investors |
+
+
+## create_investor
+
+> <V1EntitiesInvestor> create_investor(id, unknown_base_type)
+
+Create a deal investor
+
+Create a single deal investor.
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::DealApi.new
+id = 56 # Integer | The deal id.
+unknown_base_type = TODO # UNKNOWN_BASE_TYPE | 
+
+begin
+  # Create a deal investor
+  result = api_instance.create_investor(id, unknown_base_type)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DealApi->create_investor: #{e}"
+end
+```
+
+#### Using the create_investor_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesInvestor>, Integer, Hash)> create_investor_with_http_info(id, unknown_base_type)
+
+```ruby
+begin
+  # Create a deal investor
+  data, status_code, headers = api_instance.create_investor_with_http_info(id, unknown_base_type)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesInvestor>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DealApi->create_investor_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The deal id. |  |
+| **unknown_base_type** | [**UNKNOWN_BASE_TYPE**](UNKNOWN_BASE_TYPE.md) |  |  |
+
+### Return type
+
+[**V1EntitiesInvestor**](V1EntitiesInvestor.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_deal
+
+> <V1EntitiesDeal> get_deal(id)
+
+Get a deal by id
+
+Get a deal
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::DealApi.new
+id = 56 # Integer | The deal id.
+
+begin
+  # Get a deal by id
+  result = api_instance.get_deal(id)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DealApi->get_deal: #{e}"
+end
+```
+
+#### Using the get_deal_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesDeal>, Integer, Hash)> get_deal_with_http_info(id)
+
+```ruby
+begin
+  # Get a deal by id
+  data, status_code, headers = api_instance.get_deal_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesDeal>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DealApi->get_deal_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The deal id. |  |
+
+### Return type
+
+[**V1EntitiesDeal**](V1EntitiesDeal.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_investor
+
+> <V1EntitiesInvestor> get_investor(id, investor_id)
+
+Get a deal investor by id
+
+Gets a single investor by the id.
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::DealApi.new
+id = 56 # Integer | The deal id.
+investor_id = 56 # Integer | The investor id.
+
+begin
+  # Get a deal investor by id
+  result = api_instance.get_investor(id, investor_id)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DealApi->get_investor: #{e}"
+end
+```
+
+#### Using the get_investor_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesInvestor>, Integer, Hash)> get_investor_with_http_info(id, investor_id)
+
+```ruby
+begin
+  # Get a deal investor by id
+  data, status_code, headers = api_instance.get_investor_with_http_info(id, investor_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesInvestor>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DealApi->get_investor_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The deal id. |  |
+| **investor_id** | **Integer** | The investor id. |  |
+
+### Return type
+
+[**V1EntitiesInvestor**](V1EntitiesInvestor.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_investors
+
+> <V1EntitiesInvestors> list_investors(id, opts)
+
+List deal investors
+
+List deal investors according to the specified search criteria.
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::DealApi.new
+id = 56 # Integer | The deal id.
+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.
+  investor_ids: [37] # Array<Integer> | An array of investor ids.
+}
+
+begin
+  # List deal investors
+  result = api_instance.list_investors(id, opts)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DealApi->list_investors: #{e}"
+end
+```
+
+#### Using the list_investors_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesInvestors>, Integer, Hash)> list_investors_with_http_info(id, opts)
+
+```ruby
+begin
+  # List deal investors
+  data, status_code, headers = api_instance.list_investors_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesInvestors>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DealApi->list_investors_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The deal id. |  |
+| **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] |
+| **investor_ids** | [**Array&lt;Integer&gt;**](Integer.md) | An array of investor ids. | [optional] |
+
+### Return type
+
+[**V1EntitiesInvestors**](V1EntitiesInvestors.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/V1EntitiesAttachment.md

@@ -0,0 +1,22 @@
+# DealMakerAPI::V1EntitiesAttachment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The attachment id. | [optional] |
+| **url** | **String** | The attachment url. | [optional] |
+| **file_name** | **String** | The attachment filename. | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesAttachment.new(
+  id: null,
+  url: null,
+  file_name: null
+)
+```
+

data/docs/V1EntitiesBackgroundCheckSearch.md

@@ -0,0 +1,18 @@
+# DealMakerAPI::V1EntitiesBackgroundCheckSearch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The background check search id. | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesBackgroundCheckSearch.new(
+  id: null
+)
+```
+

data/docs/V1EntitiesDeal.md

@@ -0,0 +1,20 @@
+# DealMakerAPI::V1EntitiesDeal
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Deal id. | [optional] |
+| **title** | **String** | Deal title. | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesDeal.new(
+  id: null,
+  title: null
+)
+```
+

data/docs/V1EntitiesInvestor.md

@@ -0,0 +1,58 @@
+# DealMakerAPI::V1EntitiesInvestor
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Investor id. | [optional] |
+| **created_at** | **Time** | The creation time. | [optional] |
+| **updated_at** | **Time** | The last update time. | [optional] |
+| **name** | **String** | The full name of the investor. | [optional] |
+| **allocation_unit** | **String** | The allocation unit. | [optional] |
+| **state** | **String** | The state. | [optional] |
+| **funds_state** | **String** | The funding state. | [optional] |
+| **funds_pending** | **Boolean** | True if any funds are pending; false otherwise. | [optional] |
+| **beneficial_address** | **String** | The address. | [optional] |
+| **investor_currency** | **String** | The investor currency. | [optional] |
+| **investment_value** | **Float** | The current investment value. | [optional] |
+| **number_of_securities** | **Integer** | The number of securities. | [optional] |
+| **allocated_amount** | **Float** | The amount allocated. | [optional] |
+| **funds_value** | **Float** | The current amount that has been funded. | [optional] |
+| **access_link** | **String** | The access link for the investor. | [optional] |
+| **subscription_agreement** | [**V1EntitiesSubscriptionAgreement**](V1EntitiesSubscriptionAgreement.md) |  | [optional] |
+| **attachments** | [**V1EntitiesAttachment**](V1EntitiesAttachment.md) |  | [optional] |
+| **background_check_searches** | [**V1EntitiesBackgroundCheckSearch**](V1EntitiesBackgroundCheckSearch.md) |  | [optional] |
+| **verification_status** | **String** | The current 506c verification state. | [optional] |
+| **warrant_expiry_date** | **Date** | The warrant expiry date. | [optional] |
+| **warrant_certificate_number** | **Integer** | The warrant certificate number. | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesInvestor.new(
+  id: null,
+  created_at: null,
+  updated_at: null,
+  name: null,
+  allocation_unit: null,
+  state: null,
+  funds_state: null,
+  funds_pending: null,
+  beneficial_address: null,
+  investor_currency: null,
+  investment_value: null,
+  number_of_securities: null,
+  allocated_amount: null,
+  funds_value: null,
+  access_link: null,
+  subscription_agreement: null,
+  attachments: null,
+  background_check_searches: null,
+  verification_status: null,
+  warrant_expiry_date: null,
+  warrant_certificate_number: null
+)
+```
+

data/docs/V1EntitiesInvestors.md

@@ -0,0 +1,18 @@
+# DealMakerAPI::V1EntitiesInvestors
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**V1EntitiesInvestor**](V1EntitiesInvestor.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesInvestors.new(
+  items: null
+)
+```
+

data/docs/V1EntitiesSubscriptionAgreement.md

@@ -0,0 +1,20 @@
+# DealMakerAPI::V1EntitiesSubscriptionAgreement
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The subscription agreement id. | [optional] |
+| **url** | **String** | The subscription agreement url. | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesSubscriptionAgreement.new(
+  id: null,
+  url: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'