DealMakerAPI 0.0.2 → 0.68.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (170) hide show
  1. checksums.yaml +4 -4
  2. data/DealMakerAPI.gemspec +4 -4
  3. data/README.md +221 -127
  4. data/docs/CompanyApi.md +214 -0
  5. data/docs/CreateCompanyRequest.md +32 -0
  6. data/docs/CreateCorporationProfileRequest.md +82 -0
  7. data/docs/CreateDealSetupRequest.md +30 -0
  8. data/docs/CreateIndividualProfileRequest.md +44 -0
  9. data/docs/CreateInvestorRequest.md +40 -0
  10. data/docs/CreateJointProfileRequest.md +68 -0
  11. data/docs/CreateTrustProfileRequest.md +60 -0
  12. data/docs/DealApi.md +21 -165
  13. data/docs/DealSetupApi.md +74 -0
  14. data/docs/DefaultApi.md +413 -0
  15. data/docs/InvestorApi.md +368 -0
  16. data/docs/InvestorProfileApi.md +573 -15
  17. data/docs/PatchCorporationProfileRequest.md +58 -0
  18. data/docs/PatchIndividualProfileRequest.md +42 -0
  19. data/docs/PatchInvestorRequest.md +18 -0
  20. data/docs/PatchJointProfileRequest.md +66 -0
  21. data/docs/PatchTrustProfileRequest.md +58 -0
  22. data/docs/PostWebhooksRequest.md +26 -0
  23. data/docs/PutWebhooksIdRequest.md +30 -0
  24. data/docs/UpdateInvestorRequest.md +24 -0
  25. data/docs/V1EntitiesAddress.md +28 -0
  26. data/docs/V1EntitiesAddresses.md +18 -0
  27. data/docs/V1EntitiesCompany.md +34 -0
  28. data/docs/V1EntitiesCompanyDeal.md +20 -0
  29. data/docs/V1EntitiesCompanyDeals.md +18 -0
  30. data/docs/V1EntitiesDealSetup.md +34 -0
  31. data/docs/V1EntitiesDealSetupUser.md +20 -0
  32. data/docs/V1EntitiesDeals.md +18 -0
  33. data/docs/V1EntitiesInvestor.md +10 -4
  34. data/docs/V1EntitiesInvestorProfileAddress.md +28 -0
  35. data/docs/V1EntitiesInvestorProfileCorporation.md +34 -0
  36. data/docs/V1EntitiesInvestorProfileFieldsAccountHolder.md +28 -0
  37. data/docs/V1EntitiesInvestorProfileFieldsCorporation.md +24 -0
  38. data/docs/V1EntitiesInvestorProfileFieldsPrimaryHolder.md +30 -0
  39. data/docs/V1EntitiesInvestorProfileFieldsTrust.md +24 -0
  40. data/docs/V1EntitiesInvestorProfileIndividual.md +6 -16
  41. data/docs/V1EntitiesInvestorProfileItem.md +18 -0
  42. data/docs/V1EntitiesInvestorProfileJoint.md +34 -0
  43. data/docs/V1EntitiesInvestorProfileTrust.md +32 -0
  44. data/docs/V1EntitiesInvestorProfiles.md +18 -0
  45. data/docs/V1EntitiesWebhooksDeal.md +22 -0
  46. data/docs/V1EntitiesWebhooksSecurityToken.md +18 -0
  47. data/docs/V1EntitiesWebhooksSubscription.md +28 -0
  48. data/docs/V1EntitiesWebhooksSubscriptionDeal.md +24 -0
  49. data/docs/V1EntitiesWebhooksSubscriptionDeals.md +18 -0
  50. data/lib/DealMakerAPI/api/company_api.rb +219 -0
  51. data/lib/DealMakerAPI/api/deal_api.rb +23 -174
  52. data/lib/DealMakerAPI/api/deal_setup_api.rb +90 -0
  53. data/lib/DealMakerAPI/api/default_api.rb +403 -0
  54. data/lib/DealMakerAPI/api/investor_api.rb +399 -0
  55. data/lib/DealMakerAPI/api/investor_profile_api.rb +570 -16
  56. data/lib/DealMakerAPI/api_client.rb +5 -3
  57. data/lib/DealMakerAPI/api_error.rb +3 -2
  58. data/lib/DealMakerAPI/configuration.rb +4 -3
  59. data/lib/DealMakerAPI/models/create_company_request.rb +320 -0
  60. data/lib/DealMakerAPI/models/create_corporation_profile_request.rb +601 -0
  61. data/lib/DealMakerAPI/models/create_deal_setup_request.rb +364 -0
  62. data/lib/DealMakerAPI/models/create_individual_profile_request.rb +389 -0
  63. data/lib/DealMakerAPI/models/create_investor_request.rb +386 -0
  64. data/lib/DealMakerAPI/models/create_joint_profile_request.rb +521 -0
  65. data/lib/DealMakerAPI/models/create_trust_profile_request.rb +491 -0
  66. data/lib/DealMakerAPI/models/patch_corporation_profile_request.rb +454 -0
  67. data/lib/DealMakerAPI/models/patch_individual_profile_request.rb +374 -0
  68. data/lib/DealMakerAPI/models/patch_investor_request.rb +225 -0
  69. data/lib/DealMakerAPI/models/patch_joint_profile_request.rb +506 -0
  70. data/lib/DealMakerAPI/models/patch_trust_profile_request.rb +454 -0
  71. data/lib/DealMakerAPI/models/post_webhooks_request.rb +277 -0
  72. data/lib/DealMakerAPI/models/put_webhooks_id_request.rb +286 -0
  73. data/lib/DealMakerAPI/models/update_investor_request.rb +286 -0
  74. data/lib/DealMakerAPI/models/v1_entities_address.rb +270 -0
  75. data/lib/DealMakerAPI/models/v1_entities_addresses.rb +219 -0
  76. data/lib/DealMakerAPI/models/v1_entities_attachment.rb +3 -2
  77. data/lib/DealMakerAPI/models/v1_entities_background_check_search.rb +3 -2
  78. data/lib/DealMakerAPI/models/v1_entities_company.rb +299 -0
  79. data/lib/DealMakerAPI/models/v1_entities_company_deal.rb +230 -0
  80. data/lib/DealMakerAPI/models/v1_entities_company_deals.rb +219 -0
  81. data/lib/DealMakerAPI/models/v1_entities_deal.rb +5 -4
  82. data/lib/DealMakerAPI/models/v1_entities_deal_enterprise.rb +3 -2
  83. data/lib/DealMakerAPI/models/v1_entities_deal_funding_metrics.rb +3 -2
  84. data/lib/DealMakerAPI/models/v1_entities_deal_investor_metrics.rb +3 -2
  85. data/lib/DealMakerAPI/models/v1_entities_deal_issuer.rb +3 -2
  86. data/lib/DealMakerAPI/models/v1_entities_deal_setup.rb +300 -0
  87. data/lib/DealMakerAPI/models/v1_entities_deal_setup_user.rb +230 -0
  88. data/lib/DealMakerAPI/models/v1_entities_deals.rb +220 -0
  89. data/lib/DealMakerAPI/models/v1_entities_investor.rb +50 -20
  90. data/lib/DealMakerAPI/models/v1_entities_investor_profile_address.rb +270 -0
  91. data/lib/DealMakerAPI/models/v1_entities_investor_profile_corporation.rb +332 -0
  92. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_account_holder.rb +269 -0
  93. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_corporation.rb +249 -0
  94. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_primary_holder.rb +279 -0
  95. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_trust.rb +249 -0
  96. data/lib/DealMakerAPI/models/v1_entities_investor_profile_individual.rb +26 -76
  97. data/lib/DealMakerAPI/models/v1_entities_investor_profile_item.rb +219 -0
  98. data/lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb +333 -0
  99. data/lib/DealMakerAPI/models/v1_entities_investor_profile_trust.rb +323 -0
  100. data/lib/DealMakerAPI/models/v1_entities_investor_profiles.rb +220 -0
  101. data/lib/DealMakerAPI/models/v1_entities_investor_user.rb +3 -2
  102. data/lib/DealMakerAPI/models/v1_entities_investors.rb +3 -2
  103. data/lib/DealMakerAPI/models/v1_entities_subscription_agreement.rb +3 -2
  104. data/lib/DealMakerAPI/models/v1_entities_webhooks_deal.rb +241 -0
  105. data/lib/DealMakerAPI/models/v1_entities_webhooks_security_token.rb +221 -0
  106. data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription.rb +270 -0
  107. data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deal.rb +250 -0
  108. data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deals.rb +219 -0
  109. data/lib/DealMakerAPI/version.rb +3 -3
  110. data/lib/DealMakerAPI.rb +44 -2
  111. data/spec/api/company_api_spec.rb +73 -0
  112. data/spec/api/deal_api_spec.rb +9 -37
  113. data/spec/api/deal_setup_api_spec.rb +47 -0
  114. data/spec/api/default_api_spec.rb +108 -0
  115. data/spec/api/investor_api_spec.rb +106 -0
  116. data/spec/api/investor_profile_api_spec.rb +109 -7
  117. data/spec/api_client_spec.rb +2 -2
  118. data/spec/configuration_spec.rb +2 -2
  119. data/spec/models/create_company_request_spec.rb +76 -0
  120. data/spec/models/create_corporation_profile_request_spec.rb +230 -0
  121. data/spec/models/create_deal_setup_request_spec.rb +82 -0
  122. data/spec/models/create_individual_profile_request_spec.rb +116 -0
  123. data/spec/models/create_investor_request_spec.rb +108 -0
  124. data/spec/models/create_joint_profile_request_spec.rb +192 -0
  125. data/spec/models/create_trust_profile_request_spec.rb +164 -0
  126. data/spec/models/patch_corporation_profile_request_spec.rb +158 -0
  127. data/spec/models/patch_individual_profile_request_spec.rb +110 -0
  128. data/spec/models/patch_investor_request_spec.rb +34 -0
  129. data/spec/models/patch_joint_profile_request_spec.rb +186 -0
  130. data/spec/models/patch_trust_profile_request_spec.rb +158 -0
  131. data/spec/models/post_webhooks_request_spec.rb +58 -0
  132. data/spec/models/put_webhooks_id_request_spec.rb +70 -0
  133. data/spec/models/update_investor_request_spec.rb +56 -0
  134. data/spec/models/v1_entities_address_spec.rb +64 -0
  135. data/spec/models/v1_entities_addresses_spec.rb +34 -0
  136. data/spec/models/v1_entities_attachment_spec.rb +2 -2
  137. data/spec/models/v1_entities_background_check_search_spec.rb +2 -2
  138. data/spec/models/v1_entities_company_deal_spec.rb +40 -0
  139. data/spec/models/v1_entities_company_deals_spec.rb +34 -0
  140. data/spec/models/v1_entities_company_spec.rb +82 -0
  141. data/spec/models/v1_entities_deal_enterprise_spec.rb +2 -2
  142. data/spec/models/v1_entities_deal_funding_metrics_spec.rb +2 -2
  143. data/spec/models/v1_entities_deal_investor_metrics_spec.rb +2 -2
  144. data/spec/models/v1_entities_deal_issuer_spec.rb +2 -2
  145. data/spec/models/v1_entities_deal_setup_spec.rb +82 -0
  146. data/spec/models/v1_entities_deal_setup_user_spec.rb +40 -0
  147. data/spec/models/v1_entities_deal_spec.rb +76 -2
  148. data/spec/models/v1_entities_deals_spec.rb +34 -0
  149. data/spec/models/v1_entities_investor_profile_address_spec.rb +64 -0
  150. data/spec/models/v1_entities_investor_profile_corporation_spec.rb +86 -0
  151. data/spec/models/v1_entities_investor_profile_fields_account_holder_spec.rb +64 -0
  152. data/spec/models/v1_entities_investor_profile_fields_corporation_spec.rb +52 -0
  153. data/spec/models/v1_entities_investor_profile_fields_primary_holder_spec.rb +70 -0
  154. data/spec/models/v1_entities_investor_profile_fields_trust_spec.rb +52 -0
  155. data/spec/models/v1_entities_investor_profile_individual_spec.rb +6 -36
  156. data/spec/models/v1_entities_investor_profile_item_spec.rb +34 -0
  157. data/spec/models/v1_entities_investor_profile_joint_spec.rb +86 -0
  158. data/spec/models/v1_entities_investor_profile_trust_spec.rb +80 -0
  159. data/spec/models/v1_entities_investor_profiles_spec.rb +34 -0
  160. data/spec/models/v1_entities_investor_spec.rb +29 -5
  161. data/spec/models/v1_entities_investor_user_spec.rb +2 -2
  162. data/spec/models/v1_entities_investors_spec.rb +2 -2
  163. data/spec/models/v1_entities_subscription_agreement_spec.rb +2 -2
  164. data/spec/models/v1_entities_webhooks_deal_spec.rb +46 -0
  165. data/spec/models/v1_entities_webhooks_security_token_spec.rb +34 -0
  166. data/spec/models/v1_entities_webhooks_subscription_deal_spec.rb +52 -0
  167. data/spec/models/v1_entities_webhooks_subscription_deals_spec.rb +34 -0
  168. data/spec/models/v1_entities_webhooks_subscription_spec.rb +64 -0
  169. data/spec/spec_helper.rb +2 -2
  170. metadata +180 -12
@@ -0,0 +1,506 @@
1
+ =begin
2
+ #DealMaker API
3
+
4
+ ## Introduction Welcome to DealMaker’s Web API v1! This API is RESTful, easy to integrate with, and offers support in 2 different languages. This is the technical documentation for our API. There are tutorials and examples of integrations with our API available on our [knowledge centre](https://help.dealmaker.tech/training-centre) as well. # Libraries - Javascript - Ruby # Authentication To authenticate, add an Authorization header to your API request that contains an access token. Before you [generate an access token](#how-to-generate-an-access-token) your must first [create an application](#create-an-application) on your portal and retrieve the your client ID and secret ## Create an Application DealMaker’s Web API v1 supports the use of OAuth applications. Applications can be generated in your [account](https://app.dealmaker.tech/developer/applications). To create an API Application, click on your user name in the top right corner to open a dropdown menu, and select \"Integrations\". Under the API settings tab, click the `Create New Application` button ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-1.png) Name your application and assign the level of permissions for this application ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-2.png) Once your application is created, save in a secure space your client ID and secret. **WARNING**: The secret key will not be visible after you click the close button ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-3.png) From the developer tab, you will be able to view and manage all the available applications ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-4.png) Each Application consists of a client id, secret and set of scopes. The scopes define what resources you want to have access to. The client ID and secret are used to generate an access token. You will need to create an application to use API endpoints. ## How to generate an access token After creating an application, you must make a call to obtain a bearer token using the Generate an OAuth token operation. This operation requires the following parameters: `token endpoint` - https://app.dealmaker.tech/oauth/token `grant_type` - must be set to `client_credentials` `client_id` - the Client ID displayed when you created the OAuth application in the previous step `client_secret` - the Client Secret displayed when you created the OAuth application in the previous step `scope` - the scope is established when you created the OAuth application in the previous step Note: The Generate an OAuth token response specifies how long the bearer token is valid for. You should reuse the bearer token until it is expired. When the token is expired, call Generate an OAuth token again to generate a new one. To use the access token, you must set a plain text header named `Authorization` with the contents of the header being “Bearer XXX” where XXX is your generated access token. ### Example #### Postman Here's an example on how to generate the access token with Postman, where `{{CLIENT_ID}}` and `{{CLIENT_SECRET}}` are the values generated after following the steps on [Create an Application](#create-an-application) ![Get access token postman example](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/token-postman.png) # Status Codes ## Content-Type Header All responses are returned in JSON format. We specify this by sending the Content-Type header. ## Status Codes Below is a table containing descriptions of the various status codes we currently support against various resources. Sometimes your API call will generate an error. Here you will find additional information about what to expect if you don’t format your request properly, or we fail to properly process your request. | Status Code | Description | | ----------- | ----------- | | `200` | Success | | `403` | Forbidden | | `404` | Not found | # Pagination Pagination is used to divide large responses is smaller portions (pages). By default, all endpoints return a maximum of 25 records per page. You can change the number of records on a per request basis by passing a `per_page` parameter in the request header parameters. The largest supported `per_page` parameter is 100. When the response exceeds the `per_page` parameter, you can paginate through the records by increasing the `offset` parameter. Example: `offset=25` will return 25 records starting from 26th record. You may also paginate using the `page` parameter to indicate the page number you would like to show on the response. Please review the table below for the input parameters ## Inputs | Parameter | Description | | ---------- | ------------------------------------------------------------------------------- | | `per_page` | Amount of records included on each page (Default is 25) | | `page` | Page number | | `offset` | Amount of records offset on the API request where 0 represents the first record | ## Response Headers | Response Header | Description | | --------------- | -------------------------------------------- | | `X-Total` | Total number of records of response | | `X-Total-Pages` | Total number of pages of response | | `X-Per-Page` | Total number of records per page of response | | `X-Page` | Number of current page | | `X-Next-Page` | Number of next page | | `X-Prev-Page` | Number of previous page | | `X-Offset` | Total number of records offset | # Search and Filtering (The q parameter) The q optional parameter accepts a string as input and allows you to filter the request based on that string. Please note that search strings must be encoded according to ASCII. For example, \"john+investor&#64;dealmaker.tech\" should be passed as “john%2Binvestor%40dealmaker.tech”. There are two main ways to filter with it. ## Keyword filtering Some keywords allow you to filter investors based on a specific “scope” of the investors, for example using the string “Invited” will filter all investors with the status invited, and the keyword “Has attachments” will filter investors with attachments. Here’s a list of possible keywords and the “scope” each one of the keywords filters by: | Keywords | Scope | Decoded Example | Encoded Example | | ---------------------------------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | Signed on \\(date range\\) | Investors who signed in the provided date range | Signed on (date range) [2020-07-01:2020-07-31] | `Signed%20on%20%28date%20range%29%20%5B2020-07-01%3A2020-07-31%5D` | | Enabled for countersignature on \\(date range\\) | Investors who were enabled for counter signature in the provided date range | Enabled for countersignature on (date range) [2022-05-24:2022-05-25] | `Enabled%20for%20countersignature%20on%20(date%20range)%20%5B2022-05-24%3A2022-05-25%5D` | | Accepted on \\(date range\\) | Investors accepted in the provided date rage | Accepted on (date range) [2022-05-24:2022-05-25] | `Accepted%20on%20(date%20range)%20%5B2022-05-24%3A2022-05-25%5D` | | Offline | Investors added to the deal offline | Offline | `Offline` | | Online | Investors added to the deal online | Online | `Online` | | Signed | Investors who signed their agreement | Signed | `Signed` | | Waiting for countersignature | Investors who have signed and are waiting for counter signature | Waiting for countersignature | `Waiting%20for%20countersignature` | | Invited | Investors on the Invited Status | Invited | `Invited` | | Accepted | Investors in the Accepted Status | Accepted | `Accepted` | | Questionnaire in progress | All Investors who have not finished completing the questionnaire | Questionnaire in progress | `Questionnaire%20in%20progress` | | Has attachments | All Investors with attachments | Has attachments | `Has%20attachments` | | Has notes | All Investors with notes | Has notes | `Has%20notes` | | Waiting for co-signature | Investors who have signed and are waiting for co-signature | Waiting for co-signature | `Waiting%20for%20co-signature` | | Background Check Approved | Investors with approved background check | Background Check Approved | `Background%20Check%20Approved` | | Document Review Pending | Investors with pending review | Document Review Pending | `Document%20Review%20Pending` | | Document Upload Pending | Investors with pending documents to upload | Document Upload Pending | `Document%20Upload%20Pending` | | Required adjudicator review | Investors who are required to be review by the adjudicator | Required adjudicator review | `Required%20adjudicator%20review` | --- **NOTE** Filtering keywords are case sensitive and need to be encoded --- ## Search String Any value for the parameter which does not match one of the keywords listed above, will use fields like `first name`, `last name`, `email`, `tags` to search for the investor. For example, if you search “Robert”, because this does not match one of the keywords listed above, it will then return any investors who have the string “Robert” in their name, email, or tags fields. # Versioning The latest version is v1. The version can be updated on the `Accept` header, just set the version as stated on the following example: ``` Accept:application/vnd.dealmaker-v1+json ``` | Version | Accept Header | | ------- | ----------------------------------- | | `v1` | application/vnd.dealmaker-`v1`+json | # SDK’s For instruction on installing SDKs, please view the following links - [Javascript](https://github.com/DealMakerTech/api/tree/main/v1/clients/javascript) - [Ruby](https://github.com/DealMakerTech/api/tree/main/v1/clients/ruby) # Webhooks Our webhooks functionality allows clients to automatically receive updates on a deal's investor data. The type of data that the webhooks include: - Investor Name - Date created - Email - Phone - Allocation - Attachments - Accredited investor status - Accredited investor category - Status (Draft, Invited, Accepted, Waiting) Via webhooks clients can subscribe to the following events as they happen on Dealmaker: - Investor is created - Investor details are updated (any of the investor details above change or are updated) - Investor is deleted A URL supplied by the client will receive all the events with the information as part of the payload. Clients are able to add and update the URL within DealMaker. ## Configuration For a comprehensive guide on how to configure Webhooks please visit our support article: [Configuring Webhooks on DealMaker – DealMaker Support](https://help.dealmaker.tech/configuring-webhooks-on-dealmaker). As a developer user on DealMaker, you are able to configure webhooks by following the steps below: 1. Sign into Dealmaker 2. Go to **“Your profile”** in the top right corner 3. Access an **“Integrations”** configuration via the left menu 4. The developer configures webhooks by including: - The HTTPS URL where the request will be sent - Optionally, a security token that we would use to build a SHA1 hash that would be included in the request headers. The name of the header is `X-DealMaker-Signature`. If the secret is not specified, the hash won’t be included in the headers. - An email address that will be used to notify about errors. 5. The developers can disable webhooks temporarily if needed ## Specification ### Events The initial set of events will be related to the investor. The events are: 1. `investor.created` - Triggers every time a new investor is added to a deal 2. `investor.updated` - Triggers on updates to any of the following fields: 1. Status 2. Name 3. Email - (this is a user field so we trigger event for all investors with webhook subscription) 4. Allocated Amount 5. Investment Amount 6. Accredited investor fields 7. Adding or removing attachments 8. Tags - When the investor status is signed, the payload also includes a link to the signed document; the link expires after 30 minutes 3. `investor.deleted` - Triggers when the investor is removed from the deal - The investor key of the payload only includes investor ID - The deal is not included in the payload. Due to our implementation it’s impossible to retrieve the deal the investor was part of ### Requests - The request is a `POST` - The payload’s `content-type` is `application/json` - Only `2XX` responses are considered successful. In the event of a different response, we consider it failed and queue the event for retry - We retry the request five times, after the initial attempt. Doubling the waiting time between intervals with each try. The first retry happens after 30 seconds, then 60 seconds, 2 mins, 4 minutes, and 8 minutes. This timing scheme gives the receiver about 1 hour if all the requests fail - If an event fails all the attempts to be delivered, we send an email to the address that the user configured ### Payload #### Common Properties There will be some properties that are common to all the events on the system. | Key | Type | Description | | ----------------- | ------ | -------------------------------------------------------------------------------------- | | event | String | The event that triggered the call | | event_id | String | A unique identifier for the event | | deal<sup>\\*</sup> | Object | The deal in which the event occurred. It includes id, title, created_at and updated_at | <sup>\\*</sup>This field is not included when deleting a resource #### Common Properties (investor scope) Every event on this scope must contain an investor object, here are some properties that are common to this object on all events in the investor scope: | Key | Type | Description | | ------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------ | | id | Integer | The unique ID of the Investor | | name | String | Investor’s Name | | status | String | Current status of the investor<br />Possible states are: <br />draft<br />invited<br />signed<br />waiting<br />accepted | | email | String | | | phone_number | String | | | investment_amount | Double | | | allocated_amount | Double | | | accredited_investor | Object | See format in respective ticket | | attachments | Array of Objects | List of supporting documents uploaded to the investor, including URL (expire after 30 minutes) and title (caption) | | funding_state | String | Investor’s current funding state (unfunded, underfunded, funded, overfunded) | | funds_pending | Boolean | True if there are pending transactions, False otherwise | | created_at | Date | | | updated_at | Date | | | tags | Array of Strings | a list of the investor's tags, separated by comma. | ### investor.status >= signed Specific Properties | Key | Type | Description | | ---------------------- | ------ | ---------------------- | | subscription_agreement | object | id, url (expiring URL) | #### Investor Status Here is a brief description of each investor state: - **Draft:** the investor is added to the platform but hasn't been invited yet and cannot access the portal - **Invited:** the investor was added to the platform but hasn’t completed the questionnaire - **Signed:** the investor signed the document (needs approval from Lawyer or Reviewer before countersignature) - **Waiting:** the investor was approved for countersignature by any of the Lawyers or Reviewers in the deal - **Accepted:** the investor's agreement was countersigned by the Signatory #### Update Delay Given the high number of updates our platform performs on any investor, we’ve added a cool down period on update events that allows us to “group” updates and trigger only one every minute. In consequence, update events will be delivered 1 minute after the initial request was made and will include the latest version of the investor data at delivery time.
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.3.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module DealMakerAPI
17
+ class PatchJointProfileRequest
18
+ # The accredited investor information.
19
+ attr_accessor :us_accredited_category
20
+
21
+ # The kind of joint investor.
22
+ attr_accessor :joint_type
23
+
24
+ # The first name of the investor profile.
25
+ attr_accessor :first_name
26
+
27
+ # The last name of the investor profile.
28
+ attr_accessor :last_name
29
+
30
+ # The suffix of the investor profile.
31
+ attr_accessor :suffix
32
+
33
+ # The country the investor profile.
34
+ attr_accessor :country
35
+
36
+ # The street address of the investor profile.
37
+ attr_accessor :street_address
38
+
39
+ # The street address line 2 of the investor profile.
40
+ attr_accessor :unit2
41
+
42
+ # The city of the investor profile.
43
+ attr_accessor :city
44
+
45
+ # The region or State of the investor profile.
46
+ attr_accessor :region
47
+
48
+ # The postal code or zipcode of the investor profile.
49
+ attr_accessor :postal_code
50
+
51
+ # The date of birth of the investor profile.
52
+ attr_accessor :date_of_birth
53
+
54
+ # The taxpayer identification number of the investor profile.
55
+ attr_accessor :taxpayer_id
56
+
57
+ # The phone number of the investor profile.
58
+ attr_accessor :phone_number
59
+
60
+ # The joint holder first name of the investor profile.
61
+ attr_accessor :joint_holder_first_name
62
+
63
+ # The joint holder last name of the investor profile.
64
+ attr_accessor :joint_holder_last_name
65
+
66
+ # The suffix of the individual investor profile.
67
+ attr_accessor :joint_holder_suffix
68
+
69
+ # The joint holder country of the investor profile.
70
+ attr_accessor :joint_holder_country
71
+
72
+ # The joint holder street address of the investor profile.
73
+ attr_accessor :joint_holder_street_address
74
+
75
+ # The Joint holder street address line 2 of the investor profile.
76
+ attr_accessor :joint_holder_unit2
77
+
78
+ # The Joint holder city of the investor profile.
79
+ attr_accessor :joint_holder_city
80
+
81
+ # The joint holder region or state of the investor profile.
82
+ attr_accessor :joint_holder_region
83
+
84
+ # The joint holder postal code or zipcode of the investor profile.
85
+ attr_accessor :joint_holder_postal_code
86
+
87
+ # The joint holder date of birth of the investor profile.
88
+ attr_accessor :joint_holder_date_of_birth
89
+
90
+ # The joint holder taxpayer identification number of the investor profile.
91
+ attr_accessor :joint_holder_taxpayer_id
92
+
93
+ class EnumAttributeValidator
94
+ attr_reader :datatype
95
+ attr_reader :allowable_values
96
+
97
+ def initialize(datatype, allowable_values)
98
+ @allowable_values = allowable_values.map do |value|
99
+ case datatype.to_s
100
+ when /Integer/i
101
+ value.to_i
102
+ when /Float/i
103
+ value.to_f
104
+ else
105
+ value
106
+ end
107
+ end
108
+ end
109
+
110
+ def valid?(value)
111
+ !value || allowable_values.include?(value)
112
+ end
113
+ end
114
+
115
+ # Attribute mapping from ruby-style variable name to JSON key.
116
+ def self.attribute_map
117
+ {
118
+ :'us_accredited_category' => :'us_accredited_category',
119
+ :'joint_type' => :'joint_type',
120
+ :'first_name' => :'first_name',
121
+ :'last_name' => :'last_name',
122
+ :'suffix' => :'suffix',
123
+ :'country' => :'country',
124
+ :'street_address' => :'street_address',
125
+ :'unit2' => :'unit2',
126
+ :'city' => :'city',
127
+ :'region' => :'region',
128
+ :'postal_code' => :'postal_code',
129
+ :'date_of_birth' => :'date_of_birth',
130
+ :'taxpayer_id' => :'taxpayer_id',
131
+ :'phone_number' => :'phone_number',
132
+ :'joint_holder_first_name' => :'joint_holder_first_name',
133
+ :'joint_holder_last_name' => :'joint_holder_last_name',
134
+ :'joint_holder_suffix' => :'joint_holder_suffix',
135
+ :'joint_holder_country' => :'joint_holder_country',
136
+ :'joint_holder_street_address' => :'joint_holder_street_address',
137
+ :'joint_holder_unit2' => :'joint_holder_unit2',
138
+ :'joint_holder_city' => :'joint_holder_city',
139
+ :'joint_holder_region' => :'joint_holder_region',
140
+ :'joint_holder_postal_code' => :'joint_holder_postal_code',
141
+ :'joint_holder_date_of_birth' => :'joint_holder_date_of_birth',
142
+ :'joint_holder_taxpayer_id' => :'joint_holder_taxpayer_id'
143
+ }
144
+ end
145
+
146
+ # Returns all the JSON keys this model knows about
147
+ def self.acceptable_attributes
148
+ attribute_map.values
149
+ end
150
+
151
+ # Attribute type mapping.
152
+ def self.openapi_types
153
+ {
154
+ :'us_accredited_category' => :'String',
155
+ :'joint_type' => :'String',
156
+ :'first_name' => :'String',
157
+ :'last_name' => :'String',
158
+ :'suffix' => :'String',
159
+ :'country' => :'String',
160
+ :'street_address' => :'String',
161
+ :'unit2' => :'String',
162
+ :'city' => :'String',
163
+ :'region' => :'String',
164
+ :'postal_code' => :'String',
165
+ :'date_of_birth' => :'String',
166
+ :'taxpayer_id' => :'String',
167
+ :'phone_number' => :'String',
168
+ :'joint_holder_first_name' => :'String',
169
+ :'joint_holder_last_name' => :'String',
170
+ :'joint_holder_suffix' => :'String',
171
+ :'joint_holder_country' => :'String',
172
+ :'joint_holder_street_address' => :'String',
173
+ :'joint_holder_unit2' => :'String',
174
+ :'joint_holder_city' => :'String',
175
+ :'joint_holder_region' => :'String',
176
+ :'joint_holder_postal_code' => :'String',
177
+ :'joint_holder_date_of_birth' => :'String',
178
+ :'joint_holder_taxpayer_id' => :'String'
179
+ }
180
+ end
181
+
182
+ # List of attributes with nullable: true
183
+ def self.openapi_nullable
184
+ Set.new([
185
+ ])
186
+ end
187
+
188
+ # Initializes the object
189
+ # @param [Hash] attributes Model attributes in the form of hash
190
+ def initialize(attributes = {})
191
+ if (!attributes.is_a?(Hash))
192
+ fail ArgumentError, "The input argument (attributes) must be a hash in `DealMakerAPI::PatchJointProfileRequest` initialize method"
193
+ end
194
+
195
+ # check to see if the attribute exists and convert string to symbol for hash key
196
+ attributes = attributes.each_with_object({}) { |(k, v), h|
197
+ if (!self.class.attribute_map.key?(k.to_sym))
198
+ fail ArgumentError, "`#{k}` is not a valid attribute in `DealMakerAPI::PatchJointProfileRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
199
+ end
200
+ h[k.to_sym] = v
201
+ }
202
+
203
+ if attributes.key?(:'us_accredited_category')
204
+ self.us_accredited_category = attributes[:'us_accredited_category']
205
+ end
206
+
207
+ if attributes.key?(:'joint_type')
208
+ self.joint_type = attributes[:'joint_type']
209
+ end
210
+
211
+ if attributes.key?(:'first_name')
212
+ self.first_name = attributes[:'first_name']
213
+ end
214
+
215
+ if attributes.key?(:'last_name')
216
+ self.last_name = attributes[:'last_name']
217
+ end
218
+
219
+ if attributes.key?(:'suffix')
220
+ self.suffix = attributes[:'suffix']
221
+ end
222
+
223
+ if attributes.key?(:'country')
224
+ self.country = attributes[:'country']
225
+ end
226
+
227
+ if attributes.key?(:'street_address')
228
+ self.street_address = attributes[:'street_address']
229
+ end
230
+
231
+ if attributes.key?(:'unit2')
232
+ self.unit2 = attributes[:'unit2']
233
+ end
234
+
235
+ if attributes.key?(:'city')
236
+ self.city = attributes[:'city']
237
+ end
238
+
239
+ if attributes.key?(:'region')
240
+ self.region = attributes[:'region']
241
+ end
242
+
243
+ if attributes.key?(:'postal_code')
244
+ self.postal_code = attributes[:'postal_code']
245
+ end
246
+
247
+ if attributes.key?(:'date_of_birth')
248
+ self.date_of_birth = attributes[:'date_of_birth']
249
+ end
250
+
251
+ if attributes.key?(:'taxpayer_id')
252
+ self.taxpayer_id = attributes[:'taxpayer_id']
253
+ end
254
+
255
+ if attributes.key?(:'phone_number')
256
+ self.phone_number = attributes[:'phone_number']
257
+ end
258
+
259
+ if attributes.key?(:'joint_holder_first_name')
260
+ self.joint_holder_first_name = attributes[:'joint_holder_first_name']
261
+ end
262
+
263
+ if attributes.key?(:'joint_holder_last_name')
264
+ self.joint_holder_last_name = attributes[:'joint_holder_last_name']
265
+ end
266
+
267
+ if attributes.key?(:'joint_holder_suffix')
268
+ self.joint_holder_suffix = attributes[:'joint_holder_suffix']
269
+ end
270
+
271
+ if attributes.key?(:'joint_holder_country')
272
+ self.joint_holder_country = attributes[:'joint_holder_country']
273
+ end
274
+
275
+ if attributes.key?(:'joint_holder_street_address')
276
+ self.joint_holder_street_address = attributes[:'joint_holder_street_address']
277
+ end
278
+
279
+ if attributes.key?(:'joint_holder_unit2')
280
+ self.joint_holder_unit2 = attributes[:'joint_holder_unit2']
281
+ end
282
+
283
+ if attributes.key?(:'joint_holder_city')
284
+ self.joint_holder_city = attributes[:'joint_holder_city']
285
+ end
286
+
287
+ if attributes.key?(:'joint_holder_region')
288
+ self.joint_holder_region = attributes[:'joint_holder_region']
289
+ end
290
+
291
+ if attributes.key?(:'joint_holder_postal_code')
292
+ self.joint_holder_postal_code = attributes[:'joint_holder_postal_code']
293
+ end
294
+
295
+ if attributes.key?(:'joint_holder_date_of_birth')
296
+ self.joint_holder_date_of_birth = attributes[:'joint_holder_date_of_birth']
297
+ end
298
+
299
+ if attributes.key?(:'joint_holder_taxpayer_id')
300
+ self.joint_holder_taxpayer_id = attributes[:'joint_holder_taxpayer_id']
301
+ end
302
+ end
303
+
304
+ # Show invalid properties with the reasons. Usually used together with valid?
305
+ # @return Array for valid properties with the reasons
306
+ def list_invalid_properties
307
+ invalid_properties = Array.new
308
+ invalid_properties
309
+ end
310
+
311
+ # Check to see if the all the properties in the model are valid
312
+ # @return true if the model is valid
313
+ def valid?
314
+ us_accredited_category_validator = EnumAttributeValidator.new('String', ["income_individual", "assets_individual", "director", "knowledgable_employee", "broker_or_dealer", "investment_advisor_registered", "investment_advisor_relying", "designated_accredited_investor", "not_accredited"])
315
+ return false unless us_accredited_category_validator.valid?(@us_accredited_category)
316
+ joint_type_validator = EnumAttributeValidator.new('String', ["joint_tenant", "tenants_in_common", "community_property"])
317
+ return false unless joint_type_validator.valid?(@joint_type)
318
+ true
319
+ end
320
+
321
+ # Custom attribute writer method checking allowed values (enum).
322
+ # @param [Object] us_accredited_category Object to be assigned
323
+ def us_accredited_category=(us_accredited_category)
324
+ validator = EnumAttributeValidator.new('String', ["income_individual", "assets_individual", "director", "knowledgable_employee", "broker_or_dealer", "investment_advisor_registered", "investment_advisor_relying", "designated_accredited_investor", "not_accredited"])
325
+ unless validator.valid?(us_accredited_category)
326
+ fail ArgumentError, "invalid value for \"us_accredited_category\", must be one of #{validator.allowable_values}."
327
+ end
328
+ @us_accredited_category = us_accredited_category
329
+ end
330
+
331
+ # Custom attribute writer method checking allowed values (enum).
332
+ # @param [Object] joint_type Object to be assigned
333
+ def joint_type=(joint_type)
334
+ validator = EnumAttributeValidator.new('String', ["joint_tenant", "tenants_in_common", "community_property"])
335
+ unless validator.valid?(joint_type)
336
+ fail ArgumentError, "invalid value for \"joint_type\", must be one of #{validator.allowable_values}."
337
+ end
338
+ @joint_type = joint_type
339
+ end
340
+
341
+ # Checks equality by comparing each attribute.
342
+ # @param [Object] Object to be compared
343
+ def ==(o)
344
+ return true if self.equal?(o)
345
+ self.class == o.class &&
346
+ us_accredited_category == o.us_accredited_category &&
347
+ joint_type == o.joint_type &&
348
+ first_name == o.first_name &&
349
+ last_name == o.last_name &&
350
+ suffix == o.suffix &&
351
+ country == o.country &&
352
+ street_address == o.street_address &&
353
+ unit2 == o.unit2 &&
354
+ city == o.city &&
355
+ region == o.region &&
356
+ postal_code == o.postal_code &&
357
+ date_of_birth == o.date_of_birth &&
358
+ taxpayer_id == o.taxpayer_id &&
359
+ phone_number == o.phone_number &&
360
+ joint_holder_first_name == o.joint_holder_first_name &&
361
+ joint_holder_last_name == o.joint_holder_last_name &&
362
+ joint_holder_suffix == o.joint_holder_suffix &&
363
+ joint_holder_country == o.joint_holder_country &&
364
+ joint_holder_street_address == o.joint_holder_street_address &&
365
+ joint_holder_unit2 == o.joint_holder_unit2 &&
366
+ joint_holder_city == o.joint_holder_city &&
367
+ joint_holder_region == o.joint_holder_region &&
368
+ joint_holder_postal_code == o.joint_holder_postal_code &&
369
+ joint_holder_date_of_birth == o.joint_holder_date_of_birth &&
370
+ joint_holder_taxpayer_id == o.joint_holder_taxpayer_id
371
+ end
372
+
373
+ # @see the `==` method
374
+ # @param [Object] Object to be compared
375
+ def eql?(o)
376
+ self == o
377
+ end
378
+
379
+ # Calculates hash code according to all attributes.
380
+ # @return [Integer] Hash code
381
+ def hash
382
+ [us_accredited_category, joint_type, first_name, last_name, suffix, country, street_address, unit2, city, region, postal_code, date_of_birth, taxpayer_id, phone_number, joint_holder_first_name, joint_holder_last_name, joint_holder_suffix, joint_holder_country, joint_holder_street_address, joint_holder_unit2, joint_holder_city, joint_holder_region, joint_holder_postal_code, joint_holder_date_of_birth, joint_holder_taxpayer_id].hash
383
+ end
384
+
385
+ # Builds the object from hash
386
+ # @param [Hash] attributes Model attributes in the form of hash
387
+ # @return [Object] Returns the model itself
388
+ def self.build_from_hash(attributes)
389
+ new.build_from_hash(attributes)
390
+ end
391
+
392
+ # Builds the object from hash
393
+ # @param [Hash] attributes Model attributes in the form of hash
394
+ # @return [Object] Returns the model itself
395
+ def build_from_hash(attributes)
396
+ return nil unless attributes.is_a?(Hash)
397
+ attributes = attributes.transform_keys(&:to_sym)
398
+ self.class.openapi_types.each_pair do |key, type|
399
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
400
+ self.send("#{key}=", nil)
401
+ elsif type =~ /\AArray<(.*)>/i
402
+ # check to ensure the input is an array given that the attribute
403
+ # is documented as an array but the input is not
404
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
405
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
406
+ end
407
+ elsif !attributes[self.class.attribute_map[key]].nil?
408
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
409
+ end
410
+ end
411
+
412
+ self
413
+ end
414
+
415
+ # Deserializes the data based on type
416
+ # @param string type Data type
417
+ # @param string value Value to be deserialized
418
+ # @return [Object] Deserialized data
419
+ def _deserialize(type, value)
420
+ case type.to_sym
421
+ when :Time
422
+ Time.parse(value)
423
+ when :Date
424
+ Date.parse(value)
425
+ when :String
426
+ value.to_s
427
+ when :Integer
428
+ value.to_i
429
+ when :Float
430
+ value.to_f
431
+ when :Boolean
432
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
433
+ true
434
+ else
435
+ false
436
+ end
437
+ when :Object
438
+ # generic object (usually a Hash), return directly
439
+ value
440
+ when /\AArray<(?<inner_type>.+)>\z/
441
+ inner_type = Regexp.last_match[:inner_type]
442
+ value.map { |v| _deserialize(inner_type, v) }
443
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
444
+ k_type = Regexp.last_match[:k_type]
445
+ v_type = Regexp.last_match[:v_type]
446
+ {}.tap do |hash|
447
+ value.each do |k, v|
448
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
449
+ end
450
+ end
451
+ else # model
452
+ # models (e.g. Pet) or oneOf
453
+ klass = DealMakerAPI.const_get(type)
454
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
455
+ end
456
+ end
457
+
458
+ # Returns the string representation of the object
459
+ # @return [String] String presentation of the object
460
+ def to_s
461
+ to_hash.to_s
462
+ end
463
+
464
+ # to_body is an alias to to_hash (backward compatibility)
465
+ # @return [Hash] Returns the object in the form of hash
466
+ def to_body
467
+ to_hash
468
+ end
469
+
470
+ # Returns the object in the form of hash
471
+ # @return [Hash] Returns the object in the form of hash
472
+ def to_hash
473
+ hash = {}
474
+ self.class.attribute_map.each_pair do |attr, param|
475
+ value = self.send(attr)
476
+ if value.nil?
477
+ is_nullable = self.class.openapi_nullable.include?(attr)
478
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
479
+ end
480
+
481
+ hash[param] = _to_hash(value)
482
+ end
483
+ hash
484
+ end
485
+
486
+ # Outputs non-array value in the form of hash
487
+ # For object, use to_hash. Otherwise, just return the value
488
+ # @param [Object] value Any valid value
489
+ # @return [Hash] Returns the value in the form of hash
490
+ def _to_hash(value)
491
+ if value.is_a?(Array)
492
+ value.compact.map { |v| _to_hash(v) }
493
+ elsif value.is_a?(Hash)
494
+ {}.tap do |hash|
495
+ value.each { |k, v| hash[k] = _to_hash(v) }
496
+ end
497
+ elsif value.respond_to? :to_hash
498
+ value.to_hash
499
+ else
500
+ value
501
+ end
502
+ end
503
+
504
+ end
505
+
506
+ end