DealMakerAPI 0.91.2 → 0.91.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (33) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +9 -4
  3. data/docs/InvestorProfileApi.md +67 -0
  4. data/docs/PostInvestorProfilesManaged.md +68 -0
  5. data/docs/V1EntitiesInvestorPriceDetails.md +10 -0
  6. data/docs/V1EntitiesInvestorProfileFieldsBeneficiary.md +32 -0
  7. data/docs/V1EntitiesInvestorProfileFieldsProvider.md +30 -0
  8. data/docs/V1EntitiesInvestorProfileItem.md +1 -1
  9. data/docs/V1EntitiesInvestorProfileManaged.md +38 -0
  10. data/lib/DealMakerAPI/api/investor_profile_api.rb +68 -0
  11. data/lib/DealMakerAPI/models/post_investor_profiles_managed.rb +519 -0
  12. data/lib/DealMakerAPI/models/v1_entities_investor_price_details.rb +51 -1
  13. data/lib/DealMakerAPI/models/v1_entities_investor_profile_corporation.rb +2 -2
  14. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_beneficiary.rb +284 -0
  15. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_provider.rb +274 -0
  16. data/lib/DealMakerAPI/models/v1_entities_investor_profile_individual.rb +2 -2
  17. data/lib/DealMakerAPI/models/v1_entities_investor_profile_item.rb +1 -1
  18. data/lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb +2 -2
  19. data/lib/DealMakerAPI/models/v1_entities_investor_profile_managed.rb +347 -0
  20. data/lib/DealMakerAPI/models/v1_entities_investor_profile_trust.rb +2 -2
  21. data/lib/DealMakerAPI/version.rb +1 -1
  22. data/lib/DealMakerAPI.rb +4 -0
  23. data/spec/api/investor_profile_api_spec.rb +12 -0
  24. data/spec/models/post_investor_profiles_managed_spec.rb +194 -0
  25. data/spec/models/v1_entities_investor_price_details_spec.rb +30 -0
  26. data/spec/models/v1_entities_investor_profile_corporation_spec.rb +1 -1
  27. data/spec/models/v1_entities_investor_profile_fields_beneficiary_spec.rb +78 -0
  28. data/spec/models/v1_entities_investor_profile_fields_provider_spec.rb +72 -0
  29. data/spec/models/v1_entities_investor_profile_individual_spec.rb +1 -1
  30. data/spec/models/v1_entities_investor_profile_joint_spec.rb +1 -1
  31. data/spec/models/v1_entities_investor_profile_managed_spec.rb +100 -0
  32. data/spec/models/v1_entities_investor_profile_trust_spec.rb +1 -1
  33. metadata +106 -90
@@ -194,7 +194,7 @@ module DealMakerAPI
194
194
  # @return true if the model is valid
195
195
  def valid?
196
196
  warn '[DEPRECATED] the `valid?` method is obsolete'
197
- type_validator = EnumAttributeValidator.new('String', ["individual", "joint", "corporation", "trust"])
197
+ type_validator = EnumAttributeValidator.new('String', ["individual", "joint", "corporation", "trust", "managed"])
198
198
  return false unless type_validator.valid?(@type)
199
199
  true
200
200
  end
@@ -202,7 +202,7 @@ module DealMakerAPI
202
202
  # Custom attribute writer method checking allowed values (enum).
203
203
  # @param [Object] type Object to be assigned
204
204
  def type=(type)
205
- validator = EnumAttributeValidator.new('String', ["individual", "joint", "corporation", "trust"])
205
+ validator = EnumAttributeValidator.new('String', ["individual", "joint", "corporation", "trust", "managed"])
206
206
  unless validator.valid?(type)
207
207
  fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
208
208
  end
@@ -0,0 +1,347 @@
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. Some of the data that the webhooks include: - Investor Name - Date created - Email - Phone - Allocation - Attachments - Accredited investor status - Accredited investor category - State (Draft, Invited, Signed, Accepted, Waiting, Inactive) 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 has signed their agreement - Invertor fully funded their investment - Investor has been accepted - 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. - The Deal(s) to include in the webhook subscription - 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: - Status - Name - Email - (this is a user field so we trigger event for all investors with webhook subscription) - Allocated Amount - Investment Amount - Accredited investor fields - Adding or removing attachments - 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.signed` - Triggers when the investor signs their subscription agreement (terms and conditions) - When this happens the investor.state becomes `signed` - This event includes the same fields as the `investor.updated` event 4. `investor.funded` - Triggers when the investor becomes fully funded - This happens when the investor.funded_state becomes `funded` - This event includes the same fields as the `investor.updated` event 5. `investor.accepted` - Triggers when the investor is countersigned - When this happens the investor.state becomes `accepted` - This event includes the same fields as the `investor.updated` event 6. `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. please see below for an example on the deal object<sup>\\*\\*</sup> | <sup>\\*</sup>This field is not included when deleting a resource <sup>\\*\\*</sup> Sample Deal Object in the webhook payload ```json \"deal\": { \"id\": 0, \"title\": \"string\", \"created_at\": \"2022-12-06T18:14:44.000Z\", \"updated_at\": \"2022-12-08T12:46:48.000Z\", \"state\": \"string\", \"currency\": \"string\", \"security_type\": \"string\", \"price_per_security\": 0.00, \"deal_type\": \"string\", \"minimum_investment\": 0, \"maximum_investment\": 0, \"issuer\": { \"id\": 0, \"name\": \"string\" }, \"enterprise\": { \"id\": 0, \"name\": \"string\" } } ``` #### Common Properties (investor scope) By design, we have incorporated on the webhooks payload the same investor-related fields included in the Investor model, for reference on the included fields, their types and values please click [here](https://docs.dealmaker.tech/#tag/investor_model). This will allow you to get all the necessary information you need about a particular investor without having to call the Get Investor by ID endpoint. | #### Investor State 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 - **Inactive** the investor is no longer eligible to participate in the offering. This may be because their warrant expired, they requested a refund, or they opted out of the offering #### 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.75.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 7.2.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module DealMakerAPI
17
+ # V1_Entities_InvestorProfile_Managed model
18
+ class V1EntitiesInvestorProfileManaged
19
+ # Investor Profile id
20
+ attr_accessor :id
21
+
22
+ # User id
23
+ attr_accessor :user_id
24
+
25
+ # User email
26
+ attr_accessor :email
27
+
28
+ # Investor Profile type
29
+ attr_accessor :type
30
+
31
+ # The United States accredited investor information
32
+ attr_accessor :us_accredited_category
33
+
34
+ # The Canadian accredited investor information
35
+ attr_accessor :ca_accredited_investor
36
+
37
+ # To check if the profile is complete or not
38
+ attr_accessor :complete
39
+
40
+ # Type of the investor profile owner
41
+ attr_accessor :owner_type
42
+
43
+ attr_accessor :owner
44
+
45
+ attr_accessor :provider
46
+
47
+ attr_accessor :beneficiary
48
+
49
+ class EnumAttributeValidator
50
+ attr_reader :datatype
51
+ attr_reader :allowable_values
52
+
53
+ def initialize(datatype, allowable_values)
54
+ @allowable_values = allowable_values.map do |value|
55
+ case datatype.to_s
56
+ when /Integer/i
57
+ value.to_i
58
+ when /Float/i
59
+ value.to_f
60
+ else
61
+ value
62
+ end
63
+ end
64
+ end
65
+
66
+ def valid?(value)
67
+ !value || allowable_values.include?(value)
68
+ end
69
+ end
70
+
71
+ # Attribute mapping from ruby-style variable name to JSON key.
72
+ def self.attribute_map
73
+ {
74
+ :'id' => :'id',
75
+ :'user_id' => :'user_id',
76
+ :'email' => :'email',
77
+ :'type' => :'type',
78
+ :'us_accredited_category' => :'us_accredited_category',
79
+ :'ca_accredited_investor' => :'ca_accredited_investor',
80
+ :'complete' => :'complete',
81
+ :'owner_type' => :'owner_type',
82
+ :'owner' => :'owner',
83
+ :'provider' => :'provider',
84
+ :'beneficiary' => :'beneficiary'
85
+ }
86
+ end
87
+
88
+ # Returns all the JSON keys this model knows about
89
+ def self.acceptable_attributes
90
+ attribute_map.values
91
+ end
92
+
93
+ # Attribute type mapping.
94
+ def self.openapi_types
95
+ {
96
+ :'id' => :'Integer',
97
+ :'user_id' => :'Integer',
98
+ :'email' => :'String',
99
+ :'type' => :'String',
100
+ :'us_accredited_category' => :'String',
101
+ :'ca_accredited_investor' => :'String',
102
+ :'complete' => :'Boolean',
103
+ :'owner_type' => :'String',
104
+ :'owner' => :'V1EntitiesInvestorProfileOwner',
105
+ :'provider' => :'V1EntitiesInvestorProfileFieldsProvider',
106
+ :'beneficiary' => :'V1EntitiesInvestorProfileFieldsBeneficiary'
107
+ }
108
+ end
109
+
110
+ # List of attributes with nullable: true
111
+ def self.openapi_nullable
112
+ Set.new([
113
+ ])
114
+ end
115
+
116
+ # Initializes the object
117
+ # @param [Hash] attributes Model attributes in the form of hash
118
+ def initialize(attributes = {})
119
+ if (!attributes.is_a?(Hash))
120
+ fail ArgumentError, "The input argument (attributes) must be a hash in `DealMakerAPI::V1EntitiesInvestorProfileManaged` initialize method"
121
+ end
122
+
123
+ # check to see if the attribute exists and convert string to symbol for hash key
124
+ attributes = attributes.each_with_object({}) { |(k, v), h|
125
+ if (!self.class.attribute_map.key?(k.to_sym))
126
+ fail ArgumentError, "`#{k}` is not a valid attribute in `DealMakerAPI::V1EntitiesInvestorProfileManaged`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
127
+ end
128
+ h[k.to_sym] = v
129
+ }
130
+
131
+ if attributes.key?(:'id')
132
+ self.id = attributes[:'id']
133
+ end
134
+
135
+ if attributes.key?(:'user_id')
136
+ self.user_id = attributes[:'user_id']
137
+ end
138
+
139
+ if attributes.key?(:'email')
140
+ self.email = attributes[:'email']
141
+ end
142
+
143
+ if attributes.key?(:'type')
144
+ self.type = attributes[:'type']
145
+ end
146
+
147
+ if attributes.key?(:'us_accredited_category')
148
+ self.us_accredited_category = attributes[:'us_accredited_category']
149
+ end
150
+
151
+ if attributes.key?(:'ca_accredited_investor')
152
+ self.ca_accredited_investor = attributes[:'ca_accredited_investor']
153
+ end
154
+
155
+ if attributes.key?(:'complete')
156
+ self.complete = attributes[:'complete']
157
+ end
158
+
159
+ if attributes.key?(:'owner_type')
160
+ self.owner_type = attributes[:'owner_type']
161
+ end
162
+
163
+ if attributes.key?(:'owner')
164
+ self.owner = attributes[:'owner']
165
+ end
166
+
167
+ if attributes.key?(:'provider')
168
+ self.provider = attributes[:'provider']
169
+ end
170
+
171
+ if attributes.key?(:'beneficiary')
172
+ self.beneficiary = attributes[:'beneficiary']
173
+ end
174
+ end
175
+
176
+ # Show invalid properties with the reasons. Usually used together with valid?
177
+ # @return Array for valid properties with the reasons
178
+ def list_invalid_properties
179
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
180
+ invalid_properties = Array.new
181
+ invalid_properties
182
+ end
183
+
184
+ # Check to see if the all the properties in the model are valid
185
+ # @return true if the model is valid
186
+ def valid?
187
+ warn '[DEPRECATED] the `valid?` method is obsolete'
188
+ type_validator = EnumAttributeValidator.new('String', ["individual", "joint", "corporation", "trust", "managed"])
189
+ return false unless type_validator.valid?(@type)
190
+ true
191
+ end
192
+
193
+ # Custom attribute writer method checking allowed values (enum).
194
+ # @param [Object] type Object to be assigned
195
+ def type=(type)
196
+ validator = EnumAttributeValidator.new('String', ["individual", "joint", "corporation", "trust", "managed"])
197
+ unless validator.valid?(type)
198
+ fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
199
+ end
200
+ @type = type
201
+ end
202
+
203
+ # Checks equality by comparing each attribute.
204
+ # @param [Object] Object to be compared
205
+ def ==(o)
206
+ return true if self.equal?(o)
207
+ self.class == o.class &&
208
+ id == o.id &&
209
+ user_id == o.user_id &&
210
+ email == o.email &&
211
+ type == o.type &&
212
+ us_accredited_category == o.us_accredited_category &&
213
+ ca_accredited_investor == o.ca_accredited_investor &&
214
+ complete == o.complete &&
215
+ owner_type == o.owner_type &&
216
+ owner == o.owner &&
217
+ provider == o.provider &&
218
+ beneficiary == o.beneficiary
219
+ end
220
+
221
+ # @see the `==` method
222
+ # @param [Object] Object to be compared
223
+ def eql?(o)
224
+ self == o
225
+ end
226
+
227
+ # Calculates hash code according to all attributes.
228
+ # @return [Integer] Hash code
229
+ def hash
230
+ [id, user_id, email, type, us_accredited_category, ca_accredited_investor, complete, owner_type, owner, provider, beneficiary].hash
231
+ end
232
+
233
+ # Builds the object from hash
234
+ # @param [Hash] attributes Model attributes in the form of hash
235
+ # @return [Object] Returns the model itself
236
+ def self.build_from_hash(attributes)
237
+ return nil unless attributes.is_a?(Hash)
238
+ attributes = attributes.transform_keys(&:to_sym)
239
+ transformed_hash = {}
240
+ openapi_types.each_pair do |key, type|
241
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
242
+ transformed_hash["#{key}"] = nil
243
+ elsif type =~ /\AArray<(.*)>/i
244
+ # check to ensure the input is an array given that the attribute
245
+ # is documented as an array but the input is not
246
+ if attributes[attribute_map[key]].is_a?(Array)
247
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
248
+ end
249
+ elsif !attributes[attribute_map[key]].nil?
250
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
251
+ end
252
+ end
253
+ new(transformed_hash)
254
+ end
255
+
256
+ # Deserializes the data based on type
257
+ # @param string type Data type
258
+ # @param string value Value to be deserialized
259
+ # @return [Object] Deserialized data
260
+ def self._deserialize(type, value)
261
+ case type.to_sym
262
+ when :Time
263
+ Time.parse(value)
264
+ when :Date
265
+ Date.parse(value)
266
+ when :String
267
+ value.to_s
268
+ when :Integer
269
+ value.to_i
270
+ when :Float
271
+ value.to_f
272
+ when :Boolean
273
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
274
+ true
275
+ else
276
+ false
277
+ end
278
+ when :Object
279
+ # generic object (usually a Hash), return directly
280
+ value
281
+ when /\AArray<(?<inner_type>.+)>\z/
282
+ inner_type = Regexp.last_match[:inner_type]
283
+ value.map { |v| _deserialize(inner_type, v) }
284
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
285
+ k_type = Regexp.last_match[:k_type]
286
+ v_type = Regexp.last_match[:v_type]
287
+ {}.tap do |hash|
288
+ value.each do |k, v|
289
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
290
+ end
291
+ end
292
+ else # model
293
+ # models (e.g. Pet) or oneOf
294
+ klass = DealMakerAPI.const_get(type)
295
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
296
+ end
297
+ end
298
+
299
+ # Returns the string representation of the object
300
+ # @return [String] String presentation of the object
301
+ def to_s
302
+ to_hash.to_s
303
+ end
304
+
305
+ # to_body is an alias to to_hash (backward compatibility)
306
+ # @return [Hash] Returns the object in the form of hash
307
+ def to_body
308
+ to_hash
309
+ end
310
+
311
+ # Returns the object in the form of hash
312
+ # @return [Hash] Returns the object in the form of hash
313
+ def to_hash
314
+ hash = {}
315
+ self.class.attribute_map.each_pair do |attr, param|
316
+ value = self.send(attr)
317
+ if value.nil?
318
+ is_nullable = self.class.openapi_nullable.include?(attr)
319
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
320
+ end
321
+
322
+ hash[param] = _to_hash(value)
323
+ end
324
+ hash
325
+ end
326
+
327
+ # Outputs non-array value in the form of hash
328
+ # For object, use to_hash. Otherwise, just return the value
329
+ # @param [Object] value Any valid value
330
+ # @return [Hash] Returns the value in the form of hash
331
+ def _to_hash(value)
332
+ if value.is_a?(Array)
333
+ value.compact.map { |v| _to_hash(v) }
334
+ elsif value.is_a?(Hash)
335
+ {}.tap do |hash|
336
+ value.each { |k, v| hash[k] = _to_hash(v) }
337
+ end
338
+ elsif value.respond_to? :to_hash
339
+ value.to_hash
340
+ else
341
+ value
342
+ end
343
+ end
344
+
345
+ end
346
+
347
+ end
@@ -185,7 +185,7 @@ module DealMakerAPI
185
185
  # @return true if the model is valid
186
186
  def valid?
187
187
  warn '[DEPRECATED] the `valid?` method is obsolete'
188
- type_validator = EnumAttributeValidator.new('String', ["individual", "joint", "corporation", "trust"])
188
+ type_validator = EnumAttributeValidator.new('String', ["individual", "joint", "corporation", "trust", "managed"])
189
189
  return false unless type_validator.valid?(@type)
190
190
  true
191
191
  end
@@ -193,7 +193,7 @@ module DealMakerAPI
193
193
  # Custom attribute writer method checking allowed values (enum).
194
194
  # @param [Object] type Object to be assigned
195
195
  def type=(type)
196
- validator = EnumAttributeValidator.new('String', ["individual", "joint", "corporation", "trust"])
196
+ validator = EnumAttributeValidator.new('String', ["individual", "joint", "corporation", "trust", "managed"])
197
197
  unless validator.valid?(type)
198
198
  fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
199
199
  end
@@ -11,5 +11,5 @@ OpenAPI Generator version: 7.2.0-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module DealMakerAPI
14
- VERSION = '0.91.2'
14
+ VERSION = '0.91.3'
15
15
  end
data/lib/DealMakerAPI.rb CHANGED
@@ -39,6 +39,7 @@ require 'DealMakerAPI/models/post_investor_profiles_corporations'
39
39
  require 'DealMakerAPI/models/post_investor_profiles_corporations_beneficial_owners_inner'
40
40
  require 'DealMakerAPI/models/post_investor_profiles_individuals'
41
41
  require 'DealMakerAPI/models/post_investor_profiles_joints'
42
+ require 'DealMakerAPI/models/post_investor_profiles_managed'
42
43
  require 'DealMakerAPI/models/post_investor_profiles_trusts'
43
44
  require 'DealMakerAPI/models/post_investor_profiles_trusts_trustees_inner'
44
45
  require 'DealMakerAPI/models/post_webhooks_request'
@@ -83,14 +84,17 @@ require 'DealMakerAPI/models/v1_entities_investor_profile_address'
83
84
  require 'DealMakerAPI/models/v1_entities_investor_profile_corporation'
84
85
  require 'DealMakerAPI/models/v1_entities_investor_profile_fields_account_holder'
85
86
  require 'DealMakerAPI/models/v1_entities_investor_profile_fields_beneficial_owner'
87
+ require 'DealMakerAPI/models/v1_entities_investor_profile_fields_beneficiary'
86
88
  require 'DealMakerAPI/models/v1_entities_investor_profile_fields_corporation'
87
89
  require 'DealMakerAPI/models/v1_entities_investor_profile_fields_primary_holder'
90
+ require 'DealMakerAPI/models/v1_entities_investor_profile_fields_provider'
88
91
  require 'DealMakerAPI/models/v1_entities_investor_profile_fields_signing_officer'
89
92
  require 'DealMakerAPI/models/v1_entities_investor_profile_fields_trust'
90
93
  require 'DealMakerAPI/models/v1_entities_investor_profile_fields_trustee'
91
94
  require 'DealMakerAPI/models/v1_entities_investor_profile_individual'
92
95
  require 'DealMakerAPI/models/v1_entities_investor_profile_item'
93
96
  require 'DealMakerAPI/models/v1_entities_investor_profile_joint'
97
+ require 'DealMakerAPI/models/v1_entities_investor_profile_managed'
94
98
  require 'DealMakerAPI/models/v1_entities_investor_profile_owner'
95
99
  require 'DealMakerAPI/models/v1_entities_investor_profile_trust'
96
100
  require 'DealMakerAPI/models/v1_entities_investor_profiles'
@@ -68,6 +68,18 @@ describe 'InvestorProfileApi' do
68
68
  end
69
69
  end
70
70
 
71
+ # unit tests for create_managed_profile
72
+ # Create new managed investor profile.
73
+ # Create new managed investor profile associated to the user by email.
74
+ # @param investor_profiles_managed
75
+ # @param [Hash] opts the optional parameters
76
+ # @return [V1EntitiesInvestorProfileManaged]
77
+ describe 'create_managed_profile test' do
78
+ it 'should work' do
79
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
80
+ end
81
+ end
82
+
71
83
  # unit tests for create_trust_profile
72
84
  # Create new trust investor profile.
73
85
  # Create new trust investor profile associated to the user by email.