DealMakerAPI 0.82.1 → 0.83.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (92) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +12 -5
  3. data/docs/Add506cDocumentRequest.md +20 -0
  4. data/docs/CompanyApi.md +72 -1
  5. data/docs/CreateBulkUploadDetailRequest.md +22 -0
  6. data/docs/CreateBulkUploadRequest.md +0 -2
  7. data/docs/InvestorApi.md +139 -0
  8. data/docs/UpdateInvestorRequest.md +3 -1
  9. data/docs/UploadApi.md +9 -8
  10. data/docs/V1EntitiesBulkUploadDetail.md +30 -0
  11. data/docs/V1EntitiesPresignedUrlResult.md +20 -0
  12. data/lib/DealMakerAPI/api/company_api.rb +80 -0
  13. data/lib/DealMakerAPI/api/investor_api.rb +147 -0
  14. data/lib/DealMakerAPI/api/upload_api.rb +9 -7
  15. data/lib/DealMakerAPI/models/add506c_document_request.rb +232 -0
  16. data/lib/DealMakerAPI/models/add_document_request.rb +14 -17
  17. data/lib/DealMakerAPI/models/create_bulk_upload_detail_request.rb +249 -0
  18. data/lib/DealMakerAPI/models/create_bulk_upload_request.rb +17 -33
  19. data/lib/DealMakerAPI/models/create_company_request.rb +24 -17
  20. data/lib/DealMakerAPI/models/create_corporation_profile_request.rb +14 -17
  21. data/lib/DealMakerAPI/models/create_deal_setup_request.rb +18 -17
  22. data/lib/DealMakerAPI/models/create_individual_profile_request.rb +14 -17
  23. data/lib/DealMakerAPI/models/create_investor_request.rb +14 -17
  24. data/lib/DealMakerAPI/models/create_joint_profile_request.rb +14 -17
  25. data/lib/DealMakerAPI/models/create_trust_profile_request.rb +14 -17
  26. data/lib/DealMakerAPI/models/edit_investor_tags_request.rb +14 -17
  27. data/lib/DealMakerAPI/models/generate_url_request.rb +14 -17
  28. data/lib/DealMakerAPI/models/patch_corporation_profile_request.rb +12 -17
  29. data/lib/DealMakerAPI/models/patch_individual_profile_request.rb +12 -17
  30. data/lib/DealMakerAPI/models/patch_investor_request.rb +14 -17
  31. data/lib/DealMakerAPI/models/patch_joint_profile_request.rb +12 -17
  32. data/lib/DealMakerAPI/models/patch_trust_profile_request.rb +12 -17
  33. data/lib/DealMakerAPI/models/post_webhooks_request.rb +18 -17
  34. data/lib/DealMakerAPI/models/put_webhooks_id_request.rb +12 -17
  35. data/lib/DealMakerAPI/models/update_investor_request.rb +26 -21
  36. data/lib/DealMakerAPI/models/v1_entities_address.rb +12 -17
  37. data/lib/DealMakerAPI/models/v1_entities_addresses.rb +12 -17
  38. data/lib/DealMakerAPI/models/v1_entities_attachment.rb +12 -17
  39. data/lib/DealMakerAPI/models/v1_entities_background_check_search.rb +12 -17
  40. data/lib/DealMakerAPI/models/v1_entities_bulk_upload.rb +12 -17
  41. data/lib/DealMakerAPI/models/v1_entities_bulk_upload_detail.rb +276 -0
  42. data/lib/DealMakerAPI/models/v1_entities_company.rb +12 -17
  43. data/lib/DealMakerAPI/models/v1_entities_company_deal.rb +12 -17
  44. data/lib/DealMakerAPI/models/v1_entities_company_deals.rb +12 -17
  45. data/lib/DealMakerAPI/models/v1_entities_deal.rb +12 -17
  46. data/lib/DealMakerAPI/models/v1_entities_deal_enterprise.rb +12 -17
  47. data/lib/DealMakerAPI/models/v1_entities_deal_funding_metrics.rb +12 -17
  48. data/lib/DealMakerAPI/models/v1_entities_deal_investor_metrics.rb +12 -17
  49. data/lib/DealMakerAPI/models/v1_entities_deal_issuer.rb +12 -17
  50. data/lib/DealMakerAPI/models/v1_entities_deal_setup.rb +12 -17
  51. data/lib/DealMakerAPI/models/v1_entities_deal_setup_user.rb +12 -17
  52. data/lib/DealMakerAPI/models/v1_entities_deals.rb +12 -17
  53. data/lib/DealMakerAPI/models/v1_entities_express_wire_instruction.rb +12 -17
  54. data/lib/DealMakerAPI/models/v1_entities_express_wire_instructions.rb +12 -17
  55. data/lib/DealMakerAPI/models/v1_entities_investor.rb +12 -17
  56. data/lib/DealMakerAPI/models/v1_entities_investor_otp_access_link.rb +12 -17
  57. data/lib/DealMakerAPI/models/v1_entities_investor_profile_address.rb +12 -17
  58. data/lib/DealMakerAPI/models/v1_entities_investor_profile_corporation.rb +12 -17
  59. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_account_holder.rb +12 -17
  60. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_corporation.rb +12 -17
  61. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_primary_holder.rb +12 -17
  62. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_trust.rb +12 -17
  63. data/lib/DealMakerAPI/models/v1_entities_investor_profile_individual.rb +12 -17
  64. data/lib/DealMakerAPI/models/v1_entities_investor_profile_item.rb +12 -17
  65. data/lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb +12 -17
  66. data/lib/DealMakerAPI/models/v1_entities_investor_profile_owner.rb +12 -17
  67. data/lib/DealMakerAPI/models/v1_entities_investor_profile_trust.rb +12 -17
  68. data/lib/DealMakerAPI/models/v1_entities_investor_profiles.rb +12 -17
  69. data/lib/DealMakerAPI/models/v1_entities_investor_user.rb +12 -17
  70. data/lib/DealMakerAPI/models/v1_entities_investors.rb +12 -17
  71. data/lib/DealMakerAPI/models/v1_entities_presigned_url_result.rb +226 -0
  72. data/lib/DealMakerAPI/models/v1_entities_shareholder.rb +12 -17
  73. data/lib/DealMakerAPI/models/v1_entities_shareholders.rb +12 -17
  74. data/lib/DealMakerAPI/models/v1_entities_shareholders_tags.rb +12 -17
  75. data/lib/DealMakerAPI/models/v1_entities_subscription_agreement.rb +12 -17
  76. data/lib/DealMakerAPI/models/v1_entities_webhooks_deal.rb +12 -17
  77. data/lib/DealMakerAPI/models/v1_entities_webhooks_security_token.rb +12 -17
  78. data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription.rb +12 -17
  79. data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deal.rb +12 -17
  80. data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deals.rb +12 -17
  81. data/lib/DealMakerAPI/version.rb +1 -1
  82. data/lib/DealMakerAPI.rb +4 -0
  83. data/spec/api/company_api_spec.rb +14 -0
  84. data/spec/api/investor_api_spec.rb +27 -0
  85. data/spec/api/upload_api_spec.rb +2 -2
  86. data/spec/models/add506c_document_request_spec.rb +40 -0
  87. data/spec/models/create_bulk_upload_detail_request_spec.rb +46 -0
  88. data/spec/models/create_bulk_upload_request_spec.rb +0 -6
  89. data/spec/models/update_investor_request_spec.rb +6 -0
  90. data/spec/models/v1_entities_bulk_upload_detail_spec.rb +70 -0
  91. data/spec/models/v1_entities_presigned_url_result_spec.rb +40 -0
  92. metadata +18 -2
@@ -0,0 +1,249 @@
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.0.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module DealMakerAPI
17
+ class CreateBulkUploadDetailRequest
18
+ # The file ID
19
+ attr_accessor :file_key
20
+
21
+ # The name of the file
22
+ attr_accessor :file_name
23
+
24
+ # The status of the bulk upload detail
25
+ attr_accessor :status
26
+
27
+ # Attribute mapping from ruby-style variable name to JSON key.
28
+ def self.attribute_map
29
+ {
30
+ :'file_key' => :'file_key',
31
+ :'file_name' => :'file_name',
32
+ :'status' => :'status'
33
+ }
34
+ end
35
+
36
+ # Returns all the JSON keys this model knows about
37
+ def self.acceptable_attributes
38
+ attribute_map.values
39
+ end
40
+
41
+ # Attribute type mapping.
42
+ def self.openapi_types
43
+ {
44
+ :'file_key' => :'String',
45
+ :'file_name' => :'String',
46
+ :'status' => :'Integer'
47
+ }
48
+ end
49
+
50
+ # List of attributes with nullable: true
51
+ def self.openapi_nullable
52
+ Set.new([
53
+ ])
54
+ end
55
+
56
+ # Initializes the object
57
+ # @param [Hash] attributes Model attributes in the form of hash
58
+ def initialize(attributes = {})
59
+ if (!attributes.is_a?(Hash))
60
+ fail ArgumentError, "The input argument (attributes) must be a hash in `DealMakerAPI::CreateBulkUploadDetailRequest` initialize method"
61
+ end
62
+
63
+ # check to see if the attribute exists and convert string to symbol for hash key
64
+ attributes = attributes.each_with_object({}) { |(k, v), h|
65
+ if (!self.class.attribute_map.key?(k.to_sym))
66
+ fail ArgumentError, "`#{k}` is not a valid attribute in `DealMakerAPI::CreateBulkUploadDetailRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
67
+ end
68
+ h[k.to_sym] = v
69
+ }
70
+
71
+ if attributes.key?(:'file_key')
72
+ self.file_key = attributes[:'file_key']
73
+ else
74
+ self.file_key = nil
75
+ end
76
+
77
+ if attributes.key?(:'file_name')
78
+ self.file_name = attributes[:'file_name']
79
+ else
80
+ self.file_name = nil
81
+ end
82
+
83
+ if attributes.key?(:'status')
84
+ self.status = attributes[:'status']
85
+ end
86
+ end
87
+
88
+ # Show invalid properties with the reasons. Usually used together with valid?
89
+ # @return Array for valid properties with the reasons
90
+ def list_invalid_properties
91
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
92
+ invalid_properties = Array.new
93
+ if @file_key.nil?
94
+ invalid_properties.push('invalid value for "file_key", file_key cannot be nil.')
95
+ end
96
+
97
+ if @file_name.nil?
98
+ invalid_properties.push('invalid value for "file_name", file_name cannot be nil.')
99
+ end
100
+
101
+ invalid_properties
102
+ end
103
+
104
+ # Check to see if the all the properties in the model are valid
105
+ # @return true if the model is valid
106
+ def valid?
107
+ warn '[DEPRECATED] the `valid?` method is obsolete'
108
+ return false if @file_key.nil?
109
+ return false if @file_name.nil?
110
+ true
111
+ end
112
+
113
+ # Checks equality by comparing each attribute.
114
+ # @param [Object] Object to be compared
115
+ def ==(o)
116
+ return true if self.equal?(o)
117
+ self.class == o.class &&
118
+ file_key == o.file_key &&
119
+ file_name == o.file_name &&
120
+ status == o.status
121
+ end
122
+
123
+ # @see the `==` method
124
+ # @param [Object] Object to be compared
125
+ def eql?(o)
126
+ self == o
127
+ end
128
+
129
+ # Calculates hash code according to all attributes.
130
+ # @return [Integer] Hash code
131
+ def hash
132
+ [file_key, file_name, status].hash
133
+ end
134
+
135
+ # Builds the object from hash
136
+ # @param [Hash] attributes Model attributes in the form of hash
137
+ # @return [Object] Returns the model itself
138
+ def self.build_from_hash(attributes)
139
+ return nil unless attributes.is_a?(Hash)
140
+ attributes = attributes.transform_keys(&:to_sym)
141
+ transformed_hash = {}
142
+ openapi_types.each_pair do |key, type|
143
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
144
+ transformed_hash["#{key}"] = nil
145
+ elsif type =~ /\AArray<(.*)>/i
146
+ # check to ensure the input is an array given that the attribute
147
+ # is documented as an array but the input is not
148
+ if attributes[attribute_map[key]].is_a?(Array)
149
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
150
+ end
151
+ elsif !attributes[attribute_map[key]].nil?
152
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
153
+ end
154
+ end
155
+ new(transformed_hash)
156
+ end
157
+
158
+ # Deserializes the data based on type
159
+ # @param string type Data type
160
+ # @param string value Value to be deserialized
161
+ # @return [Object] Deserialized data
162
+ def self._deserialize(type, value)
163
+ case type.to_sym
164
+ when :Time
165
+ Time.parse(value)
166
+ when :Date
167
+ Date.parse(value)
168
+ when :String
169
+ value.to_s
170
+ when :Integer
171
+ value.to_i
172
+ when :Float
173
+ value.to_f
174
+ when :Boolean
175
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
176
+ true
177
+ else
178
+ false
179
+ end
180
+ when :Object
181
+ # generic object (usually a Hash), return directly
182
+ value
183
+ when /\AArray<(?<inner_type>.+)>\z/
184
+ inner_type = Regexp.last_match[:inner_type]
185
+ value.map { |v| _deserialize(inner_type, v) }
186
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
187
+ k_type = Regexp.last_match[:k_type]
188
+ v_type = Regexp.last_match[:v_type]
189
+ {}.tap do |hash|
190
+ value.each do |k, v|
191
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
192
+ end
193
+ end
194
+ else # model
195
+ # models (e.g. Pet) or oneOf
196
+ klass = DealMakerAPI.const_get(type)
197
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
198
+ end
199
+ end
200
+
201
+ # Returns the string representation of the object
202
+ # @return [String] String presentation of the object
203
+ def to_s
204
+ to_hash.to_s
205
+ end
206
+
207
+ # to_body is an alias to to_hash (backward compatibility)
208
+ # @return [Hash] Returns the object in the form of hash
209
+ def to_body
210
+ to_hash
211
+ end
212
+
213
+ # Returns the object in the form of hash
214
+ # @return [Hash] Returns the object in the form of hash
215
+ def to_hash
216
+ hash = {}
217
+ self.class.attribute_map.each_pair do |attr, param|
218
+ value = self.send(attr)
219
+ if value.nil?
220
+ is_nullable = self.class.openapi_nullable.include?(attr)
221
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
222
+ end
223
+
224
+ hash[param] = _to_hash(value)
225
+ end
226
+ hash
227
+ end
228
+
229
+ # Outputs non-array value in the form of hash
230
+ # For object, use to_hash. Otherwise, just return the value
231
+ # @param [Object] value Any valid value
232
+ # @return [Hash] Returns the value in the form of hash
233
+ def _to_hash(value)
234
+ if value.is_a?(Array)
235
+ value.compact.map { |v| _to_hash(v) }
236
+ elsif value.is_a?(Hash)
237
+ {}.tap do |hash|
238
+ value.each { |k, v| hash[k] = _to_hash(v) }
239
+ end
240
+ elsif value.respond_to? :to_hash
241
+ value.to_hash
242
+ else
243
+ value
244
+ end
245
+ end
246
+
247
+ end
248
+
249
+ end
@@ -15,9 +15,6 @@ require 'time'
15
15
 
16
16
  module DealMakerAPI
17
17
  class CreateBulkUploadRequest
18
- # The ZIP file.
19
- attr_accessor :file
20
-
21
18
  # The file identifier
22
19
  attr_accessor :file_identifier
23
20
 
@@ -27,7 +24,6 @@ module DealMakerAPI
27
24
  # Attribute mapping from ruby-style variable name to JSON key.
28
25
  def self.attribute_map
29
26
  {
30
- :'file' => :'file',
31
27
  :'file_identifier' => :'file_identifier',
32
28
  :'document_type' => :'document_type'
33
29
  }
@@ -41,7 +37,6 @@ module DealMakerAPI
41
37
  # Attribute type mapping.
42
38
  def self.openapi_types
43
39
  {
44
- :'file' => :'File',
45
40
  :'file_identifier' => :'String',
46
41
  :'document_type' => :'String'
47
42
  }
@@ -68,27 +63,24 @@ module DealMakerAPI
68
63
  h[k.to_sym] = v
69
64
  }
70
65
 
71
- if attributes.key?(:'file')
72
- self.file = attributes[:'file']
73
- end
74
-
75
66
  if attributes.key?(:'file_identifier')
76
67
  self.file_identifier = attributes[:'file_identifier']
68
+ else
69
+ self.file_identifier = nil
77
70
  end
78
71
 
79
72
  if attributes.key?(:'document_type')
80
73
  self.document_type = attributes[:'document_type']
74
+ else
75
+ self.document_type = nil
81
76
  end
82
77
  end
83
78
 
84
79
  # Show invalid properties with the reasons. Usually used together with valid?
85
80
  # @return Array for valid properties with the reasons
86
81
  def list_invalid_properties
82
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
87
83
  invalid_properties = Array.new
88
- if @file.nil?
89
- invalid_properties.push('invalid value for "file", file cannot be nil.')
90
- end
91
-
92
84
  if @file_identifier.nil?
93
85
  invalid_properties.push('invalid value for "file_identifier", file_identifier cannot be nil.')
94
86
  end
@@ -103,7 +95,7 @@ module DealMakerAPI
103
95
  # Check to see if the all the properties in the model are valid
104
96
  # @return true if the model is valid
105
97
  def valid?
106
- return false if @file.nil?
98
+ warn '[DEPRECATED] the `valid?` method is obsolete'
107
99
  return false if @file_identifier.nil?
108
100
  return false if @document_type.nil?
109
101
  true
@@ -114,7 +106,6 @@ module DealMakerAPI
114
106
  def ==(o)
115
107
  return true if self.equal?(o)
116
108
  self.class == o.class &&
117
- file == o.file &&
118
109
  file_identifier == o.file_identifier &&
119
110
  document_type == o.document_type
120
111
  end
@@ -128,44 +119,37 @@ module DealMakerAPI
128
119
  # Calculates hash code according to all attributes.
129
120
  # @return [Integer] Hash code
130
121
  def hash
131
- [file, file_identifier, document_type].hash
122
+ [file_identifier, document_type].hash
132
123
  end
133
124
 
134
125
  # Builds the object from hash
135
126
  # @param [Hash] attributes Model attributes in the form of hash
136
127
  # @return [Object] Returns the model itself
137
128
  def self.build_from_hash(attributes)
138
- new.build_from_hash(attributes)
139
- end
140
-
141
- # Builds the object from hash
142
- # @param [Hash] attributes Model attributes in the form of hash
143
- # @return [Object] Returns the model itself
144
- def build_from_hash(attributes)
145
129
  return nil unless attributes.is_a?(Hash)
146
130
  attributes = attributes.transform_keys(&:to_sym)
147
- self.class.openapi_types.each_pair do |key, type|
148
- if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
149
- self.send("#{key}=", nil)
131
+ transformed_hash = {}
132
+ openapi_types.each_pair do |key, type|
133
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
134
+ transformed_hash["#{key}"] = nil
150
135
  elsif type =~ /\AArray<(.*)>/i
151
136
  # check to ensure the input is an array given that the attribute
152
137
  # is documented as an array but the input is not
153
- if attributes[self.class.attribute_map[key]].is_a?(Array)
154
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
138
+ if attributes[attribute_map[key]].is_a?(Array)
139
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
155
140
  end
156
- elsif !attributes[self.class.attribute_map[key]].nil?
157
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
141
+ elsif !attributes[attribute_map[key]].nil?
142
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
158
143
  end
159
144
  end
160
-
161
- self
145
+ new(transformed_hash)
162
146
  end
163
147
 
164
148
  # Deserializes the data based on type
165
149
  # @param string type Data type
166
150
  # @param string value Value to be deserialized
167
151
  # @return [Object] Deserialized data
168
- def _deserialize(type, value)
152
+ def self._deserialize(type, value)
169
153
  case type.to_sym
170
154
  when :Time
171
155
  Time.parse(value)
@@ -95,14 +95,20 @@ module DealMakerAPI
95
95
 
96
96
  if attributes.key?(:'name')
97
97
  self.name = attributes[:'name']
98
+ else
99
+ self.name = nil
98
100
  end
99
101
 
100
102
  if attributes.key?(:'country')
101
103
  self.country = attributes[:'country']
104
+ else
105
+ self.country = nil
102
106
  end
103
107
 
104
108
  if attributes.key?(:'street')
105
109
  self.street = attributes[:'street']
110
+ else
111
+ self.street = nil
106
112
  end
107
113
 
108
114
  if attributes.key?(:'line_2')
@@ -111,14 +117,20 @@ module DealMakerAPI
111
117
 
112
118
  if attributes.key?(:'city')
113
119
  self.city = attributes[:'city']
120
+ else
121
+ self.city = nil
114
122
  end
115
123
 
116
124
  if attributes.key?(:'state')
117
125
  self.state = attributes[:'state']
126
+ else
127
+ self.state = nil
118
128
  end
119
129
 
120
130
  if attributes.key?(:'postal_code')
121
131
  self.postal_code = attributes[:'postal_code']
132
+ else
133
+ self.postal_code = nil
122
134
  end
123
135
 
124
136
  if attributes.key?(:'primary_color')
@@ -129,6 +141,7 @@ module DealMakerAPI
129
141
  # Show invalid properties with the reasons. Usually used together with valid?
130
142
  # @return Array for valid properties with the reasons
131
143
  def list_invalid_properties
144
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
132
145
  invalid_properties = Array.new
133
146
  if @name.nil?
134
147
  invalid_properties.push('invalid value for "name", name cannot be nil.')
@@ -160,6 +173,7 @@ module DealMakerAPI
160
173
  # Check to see if the all the properties in the model are valid
161
174
  # @return true if the model is valid
162
175
  def valid?
176
+ warn '[DEPRECATED] the `valid?` method is obsolete'
163
177
  return false if @name.nil?
164
178
  return false if @country.nil?
165
179
  return false if @street.nil?
@@ -200,37 +214,30 @@ module DealMakerAPI
200
214
  # @param [Hash] attributes Model attributes in the form of hash
201
215
  # @return [Object] Returns the model itself
202
216
  def self.build_from_hash(attributes)
203
- new.build_from_hash(attributes)
204
- end
205
-
206
- # Builds the object from hash
207
- # @param [Hash] attributes Model attributes in the form of hash
208
- # @return [Object] Returns the model itself
209
- def build_from_hash(attributes)
210
217
  return nil unless attributes.is_a?(Hash)
211
218
  attributes = attributes.transform_keys(&:to_sym)
212
- self.class.openapi_types.each_pair do |key, type|
213
- if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
214
- self.send("#{key}=", nil)
219
+ transformed_hash = {}
220
+ openapi_types.each_pair do |key, type|
221
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
222
+ transformed_hash["#{key}"] = nil
215
223
  elsif type =~ /\AArray<(.*)>/i
216
224
  # check to ensure the input is an array given that the attribute
217
225
  # is documented as an array but the input is not
218
- if attributes[self.class.attribute_map[key]].is_a?(Array)
219
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
226
+ if attributes[attribute_map[key]].is_a?(Array)
227
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
220
228
  end
221
- elsif !attributes[self.class.attribute_map[key]].nil?
222
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
229
+ elsif !attributes[attribute_map[key]].nil?
230
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
223
231
  end
224
232
  end
225
-
226
- self
233
+ new(transformed_hash)
227
234
  end
228
235
 
229
236
  # Deserializes the data based on type
230
237
  # @param string type Data type
231
238
  # @param string value Value to be deserialized
232
239
  # @return [Object] Deserialized data
233
- def _deserialize(type, value)
240
+ def self._deserialize(type, value)
234
241
  case type.to_sym
235
242
  when :Time
236
243
  Time.parse(value)
@@ -262,6 +262,8 @@ module DealMakerAPI
262
262
 
263
263
  if attributes.key?(:'email')
264
264
  self.email = attributes[:'email']
265
+ else
266
+ self.email = nil
265
267
  end
266
268
 
267
269
  if attributes.key?(:'us_accredited_category')
@@ -434,6 +436,7 @@ module DealMakerAPI
434
436
  # Show invalid properties with the reasons. Usually used together with valid?
435
437
  # @return Array for valid properties with the reasons
436
438
  def list_invalid_properties
439
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
437
440
  invalid_properties = Array.new
438
441
  if @email.nil?
439
442
  invalid_properties.push('invalid value for "email", email cannot be nil.')
@@ -445,6 +448,7 @@ module DealMakerAPI
445
448
  # Check to see if the all the properties in the model are valid
446
449
  # @return true if the model is valid
447
450
  def valid?
451
+ warn '[DEPRECATED] the `valid?` method is obsolete'
448
452
  return false if @email.nil?
449
453
  us_accredited_category_validator = EnumAttributeValidator.new('String', ["entity_owned_by_accredited_investors", "assets_other", "assets_family_office", "assets_benefit_plan", "assets_state_plan", "assets_501_c_3", "assets_corporation", "broker_or_dealer", "bank_3_a_2", "business_development_company", "private_business_development_company", "investment_company", "rural_business_investment_company", "insurance_company", "family_client", "not_accredited"])
450
454
  return false unless us_accredited_category_validator.valid?(@us_accredited_category)
@@ -533,37 +537,30 @@ module DealMakerAPI
533
537
  # @param [Hash] attributes Model attributes in the form of hash
534
538
  # @return [Object] Returns the model itself
535
539
  def self.build_from_hash(attributes)
536
- new.build_from_hash(attributes)
537
- end
538
-
539
- # Builds the object from hash
540
- # @param [Hash] attributes Model attributes in the form of hash
541
- # @return [Object] Returns the model itself
542
- def build_from_hash(attributes)
543
540
  return nil unless attributes.is_a?(Hash)
544
541
  attributes = attributes.transform_keys(&:to_sym)
545
- self.class.openapi_types.each_pair do |key, type|
546
- if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
547
- self.send("#{key}=", nil)
542
+ transformed_hash = {}
543
+ openapi_types.each_pair do |key, type|
544
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
545
+ transformed_hash["#{key}"] = nil
548
546
  elsif type =~ /\AArray<(.*)>/i
549
547
  # check to ensure the input is an array given that the attribute
550
548
  # is documented as an array but the input is not
551
- if attributes[self.class.attribute_map[key]].is_a?(Array)
552
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
549
+ if attributes[attribute_map[key]].is_a?(Array)
550
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
553
551
  end
554
- elsif !attributes[self.class.attribute_map[key]].nil?
555
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
552
+ elsif !attributes[attribute_map[key]].nil?
553
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
556
554
  end
557
555
  end
558
-
559
- self
556
+ new(transformed_hash)
560
557
  end
561
558
 
562
559
  # Deserializes the data based on type
563
560
  # @param string type Data type
564
561
  # @param string value Value to be deserialized
565
562
  # @return [Object] Deserialized data
566
- def _deserialize(type, value)
563
+ def self._deserialize(type, value)
567
564
  case type.to_sym
568
565
  when :Time
569
566
  Time.parse(value)