hubspot-api-client 9.4.0 → 9.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -0
  3. data/Gemfile.lock +1 -1
  4. data/lib/hubspot/codegen/conversations/visitor-identification/api/generate_api.rb +90 -0
  5. data/lib/hubspot/codegen/conversations/visitor-identification/api_client.rb +392 -0
  6. data/lib/hubspot/codegen/conversations/visitor-identification/api_error.rb +61 -0
  7. data/lib/hubspot/codegen/conversations/visitor-identification/configuration.rb +263 -0
  8. data/lib/hubspot/codegen/conversations/visitor-identification/models/error.rb +292 -0
  9. data/lib/hubspot/codegen/conversations/visitor-identification/models/error_detail.rb +258 -0
  10. data/lib/hubspot/codegen/conversations/visitor-identification/models/identification_token_generation_request.rb +236 -0
  11. data/lib/hubspot/codegen/conversations/visitor-identification/models/identification_token_response.rb +215 -0
  12. data/lib/hubspot/codegen/events/api/events_api.rb +105 -0
  13. data/lib/hubspot/codegen/events/api_client.rb +390 -0
  14. data/lib/hubspot/codegen/events/api_error.rb +59 -0
  15. data/lib/hubspot/codegen/events/configuration.rb +261 -0
  16. data/lib/hubspot/codegen/events/models/collection_response_external_unified_event.rb +224 -0
  17. data/lib/hubspot/codegen/events/models/error.rb +290 -0
  18. data/lib/hubspot/codegen/events/models/error_detail.rb +256 -0
  19. data/lib/hubspot/codegen/events/models/external_unified_event.rb +290 -0
  20. data/lib/hubspot/codegen/events/models/next_page.rb +222 -0
  21. data/lib/hubspot/codegen/events/models/paging.rb +208 -0
  22. data/lib/hubspot/version.rb +1 -1
  23. data/spec/codegen/conversations/visitor-identification/api/generate_api_spec.rb +47 -0
  24. data/spec/codegen/conversations/visitor-identification/models/error_detail_spec.rb +65 -0
  25. data/spec/codegen/conversations/visitor-identification/models/error_spec.rb +77 -0
  26. data/spec/codegen/conversations/visitor-identification/models/identification_token_generation_request_spec.rb +53 -0
  27. data/spec/codegen/conversations/visitor-identification/models/identification_token_response_spec.rb +41 -0
  28. data/spec/codegen/events/api/events_api_spec.rb +54 -0
  29. data/spec/codegen/events/models/collection_response_external_unified_event_spec.rb +47 -0
  30. data/spec/codegen/events/models/error_detail_spec.rb +65 -0
  31. data/spec/codegen/events/models/error_spec.rb +77 -0
  32. data/spec/codegen/events/models/external_unified_event_spec.rb +71 -0
  33. data/spec/codegen/events/models/next_page_spec.rb +47 -0
  34. data/spec/codegen/events/models/paging_spec.rb +41 -0
  35. data/spec/features/conversations/visitor-identification/generate_api_spec.rb +7 -0
  36. data/spec/features/events/events_api_spec.rb +7 -0
  37. metadata +48 -2
@@ -0,0 +1,215 @@
1
+ =begin
2
+ #Visitor Identification
3
+
4
+ #The Visitor Identification API allows you to pass identification information to the HubSpot chat widget for otherwise unknown visitors that were verified by your own authentication system.
5
+
6
+ The version of the OpenAPI document: v3
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module Hubspot
16
+ module Conversations
17
+ module VisitorIdentification
18
+ class IdentificationTokenResponse
19
+ attr_accessor :token
20
+
21
+ # Attribute mapping from ruby-style variable name to JSON key.
22
+ def self.attribute_map
23
+ {
24
+ :'token' => :'token'
25
+ }
26
+ end
27
+
28
+ # Attribute type mapping.
29
+ def self.openapi_types
30
+ {
31
+ :'token' => :'String'
32
+ }
33
+ end
34
+
35
+ # List of attributes with nullable: true
36
+ def self.openapi_nullable
37
+ Set.new([
38
+ ])
39
+ end
40
+
41
+ # Initializes the object
42
+ # @param [Hash] attributes Model attributes in the form of hash
43
+ def initialize(attributes = {})
44
+ if (!attributes.is_a?(Hash))
45
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Conversations::VisitorIdentification::IdentificationTokenResponse` initialize method"
46
+ end
47
+
48
+ # check to see if the attribute exists and convert string to symbol for hash key
49
+ attributes = attributes.each_with_object({}) { |(k, v), h|
50
+ if (!self.class.attribute_map.key?(k.to_sym))
51
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Conversations::VisitorIdentification::IdentificationTokenResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
52
+ end
53
+ h[k.to_sym] = v
54
+ }
55
+
56
+ if attributes.key?(:'token')
57
+ self.token = attributes[:'token']
58
+ end
59
+ end
60
+
61
+ # Show invalid properties with the reasons. Usually used together with valid?
62
+ # @return Array for valid properties with the reasons
63
+ def list_invalid_properties
64
+ invalid_properties = Array.new
65
+ if @token.nil?
66
+ invalid_properties.push('invalid value for "token", token cannot be nil.')
67
+ end
68
+
69
+ invalid_properties
70
+ end
71
+
72
+ # Check to see if the all the properties in the model are valid
73
+ # @return true if the model is valid
74
+ def valid?
75
+ return false if @token.nil?
76
+ true
77
+ end
78
+
79
+ # Checks equality by comparing each attribute.
80
+ # @param [Object] Object to be compared
81
+ def ==(o)
82
+ return true if self.equal?(o)
83
+ self.class == o.class &&
84
+ token == o.token
85
+ end
86
+
87
+ # @see the `==` method
88
+ # @param [Object] Object to be compared
89
+ def eql?(o)
90
+ self == o
91
+ end
92
+
93
+ # Calculates hash code according to all attributes.
94
+ # @return [Integer] Hash code
95
+ def hash
96
+ [token].hash
97
+ end
98
+
99
+ # Builds the object from hash
100
+ # @param [Hash] attributes Model attributes in the form of hash
101
+ # @return [Object] Returns the model itself
102
+ def self.build_from_hash(attributes)
103
+ new.build_from_hash(attributes)
104
+ end
105
+
106
+ # Builds the object from hash
107
+ # @param [Hash] attributes Model attributes in the form of hash
108
+ # @return [Object] Returns the model itself
109
+ def build_from_hash(attributes)
110
+ return nil unless attributes.is_a?(Hash)
111
+ self.class.openapi_types.each_pair do |key, type|
112
+ if type =~ /\AArray<(.*)>/i
113
+ # check to ensure the input is an array given that the attribute
114
+ # is documented as an array but the input is not
115
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
116
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
117
+ end
118
+ elsif !attributes[self.class.attribute_map[key]].nil?
119
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
120
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
121
+ end
122
+
123
+ self
124
+ end
125
+
126
+ # Deserializes the data based on type
127
+ # @param string type Data type
128
+ # @param string value Value to be deserialized
129
+ # @return [Object] Deserialized data
130
+ def _deserialize(type, value)
131
+ case type.to_sym
132
+ when :DateTime
133
+ DateTime.parse(value)
134
+ when :Date
135
+ Date.parse(value)
136
+ when :String
137
+ value.to_s
138
+ when :Integer
139
+ value.to_i
140
+ when :Float
141
+ value.to_f
142
+ when :Boolean
143
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
144
+ true
145
+ else
146
+ false
147
+ end
148
+ when :Object
149
+ # generic object (usually a Hash), return directly
150
+ value
151
+ when /\AArray<(?<inner_type>.+)>\z/
152
+ inner_type = Regexp.last_match[:inner_type]
153
+ value.map { |v| _deserialize(inner_type, v) }
154
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
155
+ k_type = Regexp.last_match[:k_type]
156
+ v_type = Regexp.last_match[:v_type]
157
+ {}.tap do |hash|
158
+ value.each do |k, v|
159
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
160
+ end
161
+ end
162
+ else # model
163
+ Hubspot::Conversations::VisitorIdentification.const_get(type).build_from_hash(value)
164
+ end
165
+ end
166
+
167
+ # Returns the string representation of the object
168
+ # @return [String] String presentation of the object
169
+ def to_s
170
+ to_hash.to_s
171
+ end
172
+
173
+ # to_body is an alias to to_hash (backward compatibility)
174
+ # @return [Hash] Returns the object in the form of hash
175
+ def to_body
176
+ to_hash
177
+ end
178
+
179
+ # Returns the object in the form of hash
180
+ # @return [Hash] Returns the object in the form of hash
181
+ def to_hash
182
+ hash = {}
183
+ self.class.attribute_map.each_pair do |attr, param|
184
+ value = self.send(attr)
185
+ if value.nil?
186
+ is_nullable = self.class.openapi_nullable.include?(attr)
187
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
188
+ end
189
+
190
+ hash[param] = _to_hash(value)
191
+ end
192
+ hash
193
+ end
194
+
195
+ # Outputs non-array value in the form of hash
196
+ # For object, use to_hash. Otherwise, just return the value
197
+ # @param [Object] value Any valid value
198
+ # @return [Hash] Returns the value in the form of hash
199
+ def _to_hash(value)
200
+ if value.is_a?(Array)
201
+ value.compact.map { |v| _to_hash(v) }
202
+ elsif value.is_a?(Hash)
203
+ {}.tap do |hash|
204
+ value.each { |k, v| hash[k] = _to_hash(v) }
205
+ end
206
+ elsif value.respond_to? :to_hash
207
+ value.to_hash
208
+ else
209
+ value
210
+ end
211
+ end
212
+ end
213
+ end
214
+ end
215
+ end
@@ -0,0 +1,105 @@
1
+ =begin
2
+ #HubSpot Events API
3
+
4
+ #API for accessing CRM object events.
5
+
6
+ The version of the OpenAPI document: v3
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Hubspot
16
+ module Events
17
+ class EventsApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client = ApiClient.default)
21
+ @api_client = api_client
22
+ end
23
+ # Returns a collection of events matching a query.
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [DateTime] :occurred_after The starting time as an ISO 8601 timestamp.
26
+ # @option opts [DateTime] :occurred_before The ending time as an ISO 8601 timestamp.
27
+ # @option opts [String] :object_type The type of object being selected. Valid values are hubspot named object types (e.g. &#x60;contact&#x60;).
28
+ # @option opts [Integer] :object_id The id of the selected object. If not present, then the &#x60;objectProperty&#x60; parameter is required.
29
+ # @option opts [String] :event_type Limits the response to the specified event type. For example &#x60;&amp;eventType&#x3D;e_visited_page&#x60; returns only &#x60;e_visited_page&#x60; events. If not present all event types are returned.
30
+ # @option opts [String] :after An additional parameter that may be used to get the next &#x60;limit&#x60; set of results.
31
+ # @option opts [String] :before
32
+ # @option opts [Integer] :limit The maximum number of events to return, defaults to 20.
33
+ # @option opts [Array<String>] :sort Selects the sort field and order. Defaults to ascending, prefix with &#x60;-&#x60; for descending order. &#x60;occurredAt&#x60; is the only field supported for sorting.
34
+ # @return [CollectionResponseExternalUnifiedEvent]
35
+ def get_page(opts = {})
36
+ data, _status_code, _headers = get_page_with_http_info(opts)
37
+ data
38
+ end
39
+
40
+ # Returns a collection of events matching a query.
41
+ # @param [Hash] opts the optional parameters
42
+ # @option opts [DateTime] :occurred_after The starting time as an ISO 8601 timestamp.
43
+ # @option opts [DateTime] :occurred_before The ending time as an ISO 8601 timestamp.
44
+ # @option opts [String] :object_type The type of object being selected. Valid values are hubspot named object types (e.g. &#x60;contact&#x60;).
45
+ # @option opts [Integer] :object_id The id of the selected object. If not present, then the &#x60;objectProperty&#x60; parameter is required.
46
+ # @option opts [String] :event_type Limits the response to the specified event type. For example &#x60;&amp;eventType&#x3D;e_visited_page&#x60; returns only &#x60;e_visited_page&#x60; events. If not present all event types are returned.
47
+ # @option opts [String] :after An additional parameter that may be used to get the next &#x60;limit&#x60; set of results.
48
+ # @option opts [String] :before
49
+ # @option opts [Integer] :limit The maximum number of events to return, defaults to 20.
50
+ # @option opts [Array<String>] :sort Selects the sort field and order. Defaults to ascending, prefix with &#x60;-&#x60; for descending order. &#x60;occurredAt&#x60; is the only field supported for sorting.
51
+ # @return [Array<(CollectionResponseExternalUnifiedEvent, Integer, Hash)>] CollectionResponseExternalUnifiedEvent data, response status code and response headers
52
+ def get_page_with_http_info(opts = {})
53
+ if @api_client.config.debugging
54
+ @api_client.config.logger.debug 'Calling API: EventsApi.get_page ...'
55
+ end
56
+ # resource path
57
+ local_var_path = '/events/v3/events'
58
+
59
+ # query parameters
60
+ query_params = opts[:query_params] || {}
61
+ query_params[:'occurredAfter'] = opts[:'occurred_after'] if !opts[:'occurred_after'].nil?
62
+ query_params[:'occurredBefore'] = opts[:'occurred_before'] if !opts[:'occurred_before'].nil?
63
+ query_params[:'objectType'] = opts[:'object_type'] if !opts[:'object_type'].nil?
64
+ query_params[:'objectId'] = opts[:'object_id'] if !opts[:'object_id'].nil?
65
+ query_params[:'eventType'] = opts[:'event_type'] if !opts[:'event_type'].nil?
66
+ query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
67
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
68
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
69
+ query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil?
70
+
71
+ # header parameters
72
+ header_params = opts[:header_params] || {}
73
+ # HTTP header 'Accept' (if needed)
74
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
75
+
76
+ # form parameters
77
+ form_params = opts[:form_params] || {}
78
+
79
+ # http body (model)
80
+ post_body = opts[:body]
81
+
82
+ # return_type
83
+ return_type = opts[:return_type] || 'CollectionResponseExternalUnifiedEvent'
84
+
85
+ # auth_names
86
+ auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
87
+
88
+ new_options = opts.merge(
89
+ :header_params => header_params,
90
+ :query_params => query_params,
91
+ :form_params => form_params,
92
+ :body => post_body,
93
+ :auth_names => auth_names,
94
+ :return_type => return_type
95
+ )
96
+
97
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
98
+ if @api_client.config.debugging
99
+ @api_client.config.logger.debug "API called: EventsApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
100
+ end
101
+ return data, status_code, headers
102
+ end
103
+ end
104
+ end
105
+ end
@@ -0,0 +1,390 @@
1
+ =begin
2
+ #HubSpot Events API
3
+
4
+ #API for accessing CRM object events.
5
+
6
+ The version of the OpenAPI document: v3
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'json'
15
+ require 'logger'
16
+ require 'tempfile'
17
+ require 'typhoeus'
18
+
19
+ module Hubspot
20
+ module Events
21
+ class ApiClient
22
+ # The Configuration object holding settings to be used in the API client.
23
+ attr_accessor :config
24
+
25
+ # Defines the headers to be used in HTTP requests of all API calls by default.
26
+ #
27
+ # @return [Hash]
28
+ attr_accessor :default_headers
29
+
30
+ # Initializes the ApiClient
31
+ # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
32
+ def initialize(config = Configuration.default)
33
+ @config = config
34
+ @user_agent = "hubspot-api-client-ruby; #{VERSION}"
35
+ @default_headers = {
36
+ 'Content-Type' => 'application/json',
37
+ 'User-Agent' => @user_agent
38
+ }
39
+ end
40
+
41
+ def self.default
42
+ @@default ||= ApiClient.new
43
+ end
44
+
45
+ # Call an API with given options.
46
+ #
47
+ # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
48
+ # the data deserialized from response body (could be nil), response status code and response headers.
49
+ def call_api(http_method, path, opts = {})
50
+ request = build_request(http_method, path, opts)
51
+ response = request.run
52
+
53
+ if @config.debugging
54
+ @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
55
+ end
56
+
57
+ unless response.success?
58
+ if response.timed_out?
59
+ fail ApiError.new('Connection timed out')
60
+ elsif response.code == 0
61
+ # Errors from libcurl will be made visible here
62
+ fail ApiError.new(:code => 0,
63
+ :message => response.return_message)
64
+ else
65
+ fail ApiError.new(:code => response.code,
66
+ :response_headers => response.headers,
67
+ :response_body => response.body),
68
+ response.status_message
69
+ end
70
+ end
71
+
72
+ if opts[:return_type]
73
+ data = deserialize(response, opts[:return_type])
74
+ else
75
+ data = nil
76
+ end
77
+ return data, response.code, response.headers
78
+ end
79
+
80
+ # Builds the HTTP request
81
+ #
82
+ # @param [String] http_method HTTP method/verb (e.g. POST)
83
+ # @param [String] path URL path (e.g. /account/new)
84
+ # @option opts [Hash] :header_params Header parameters
85
+ # @option opts [Hash] :query_params Query parameters
86
+ # @option opts [Hash] :form_params Query parameters
87
+ # @option opts [Object] :body HTTP body (JSON/XML)
88
+ # @return [Typhoeus::Request] A Typhoeus Request
89
+ def build_request(http_method, path, opts = {})
90
+ url = build_request_url(path)
91
+ http_method = http_method.to_sym.downcase
92
+
93
+ header_params = @default_headers.merge(opts[:header_params] || {})
94
+ query_params = opts[:query_params] || {}
95
+ form_params = opts[:form_params] || {}
96
+
97
+ update_params_for_auth! header_params, query_params, opts[:auth_names]
98
+
99
+ # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
100
+ _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
101
+
102
+ req_opts = {
103
+ :method => http_method,
104
+ :headers => header_params,
105
+ :params => query_params,
106
+ :params_encoding => @config.params_encoding,
107
+ :timeout => @config.timeout,
108
+ :ssl_verifypeer => @config.verify_ssl,
109
+ :ssl_verifyhost => _verify_ssl_host,
110
+ :sslcert => @config.cert_file,
111
+ :sslkey => @config.key_file,
112
+ :verbose => @config.debugging
113
+ }
114
+
115
+ # set custom cert, if provided
116
+ req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
117
+
118
+ if [:post, :patch, :put, :delete].include?(http_method)
119
+ req_body = build_request_body(header_params, form_params, opts[:body])
120
+ req_opts.update :body => req_body
121
+ if @config.debugging
122
+ @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
123
+ end
124
+ end
125
+
126
+ request = Typhoeus::Request.new(url, req_opts)
127
+ download_file(request) if opts[:return_type] == 'File'
128
+ request
129
+ end
130
+
131
+ # Builds the HTTP request body
132
+ #
133
+ # @param [Hash] header_params Header parameters
134
+ # @param [Hash] form_params Query parameters
135
+ # @param [Object] body HTTP body (JSON/XML)
136
+ # @return [String] HTTP body data in the form of string
137
+ def build_request_body(header_params, form_params, body)
138
+ # http form
139
+ if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
140
+ header_params['Content-Type'] == 'multipart/form-data'
141
+ data = {}
142
+ form_params.each do |key, value|
143
+ case value
144
+ when ::File, ::Array, nil
145
+ # let typhoeus handle File, Array and nil parameters
146
+ data[key] = value
147
+ else
148
+ data[key] = value.to_s
149
+ end
150
+ end
151
+ elsif body
152
+ data = body.is_a?(String) ? body : body.to_json
153
+ else
154
+ data = nil
155
+ end
156
+ data
157
+ end
158
+
159
+ # Check if the given MIME is a JSON MIME.
160
+ # JSON MIME examples:
161
+ # application/json
162
+ # application/json; charset=UTF8
163
+ # APPLICATION/JSON
164
+ # */*
165
+ # @param [String] mime MIME
166
+ # @return [Boolean] True if the MIME is application/json
167
+ def json_mime?(mime)
168
+ (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
169
+ end
170
+
171
+ # Deserialize the response to the given return type.
172
+ #
173
+ # @param [Response] response HTTP response
174
+ # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
175
+ def deserialize(response, return_type)
176
+ body = response.body
177
+
178
+ # handle file downloading - return the File instance processed in request callbacks
179
+ # note that response body is empty when the file is written in chunks in request on_body callback
180
+ return @tempfile if return_type == 'File'
181
+
182
+ return nil if body.nil? || body.empty?
183
+
184
+ # return response body directly for String return type
185
+ return body if return_type == 'String'
186
+
187
+ # ensuring a default content type
188
+ content_type = response.headers['Content-Type'] || 'application/json'
189
+
190
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
191
+
192
+ begin
193
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
194
+ rescue JSON::ParserError => e
195
+ if %w(String Date DateTime).include?(return_type)
196
+ data = body
197
+ else
198
+ raise e
199
+ end
200
+ end
201
+
202
+ convert_to_type data, return_type
203
+ end
204
+
205
+ # Convert data to the given return type.
206
+ # @param [Object] data Data to be converted
207
+ # @param [String] return_type Return type
208
+ # @return [Mixed] Data in a particular type
209
+ def convert_to_type(data, return_type)
210
+ return nil if data.nil?
211
+ case return_type
212
+ when 'String'
213
+ data.to_s
214
+ when 'Integer'
215
+ data.to_i
216
+ when 'Float'
217
+ data.to_f
218
+ when 'Boolean'
219
+ data == true
220
+ when 'DateTime'
221
+ # parse date time (expecting ISO 8601 format)
222
+ DateTime.parse data
223
+ when 'Date'
224
+ # parse date time (expecting ISO 8601 format)
225
+ Date.parse data
226
+ when 'Object'
227
+ # generic object (usually a Hash), return directly
228
+ data
229
+ when /\AArray<(.+)>\z/
230
+ # e.g. Array<Pet>
231
+ sub_type = $1
232
+ data.map { |item| convert_to_type(item, sub_type) }
233
+ when /\AHash\<String, (.+)\>\z/
234
+ # e.g. Hash<String, Integer>
235
+ sub_type = $1
236
+ {}.tap do |hash|
237
+ data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
238
+ end
239
+ else
240
+ # models, e.g. Pet
241
+ Hubspot::Events.const_get(return_type).build_from_hash(data)
242
+ end
243
+ end
244
+
245
+ # Save response body into a file in (the defined) temporary folder, using the filename
246
+ # from the "Content-Disposition" header if provided, otherwise a random filename.
247
+ # The response body is written to the file in chunks in order to handle files which
248
+ # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
249
+ # process can use.
250
+ #
251
+ # @see Configuration#temp_folder_path
252
+ def download_file(request)
253
+ tempfile = nil
254
+ encoding = nil
255
+ request.on_headers do |response|
256
+ content_disposition = response.headers['Content-Disposition']
257
+ if content_disposition && content_disposition =~ /filename=/i
258
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
259
+ prefix = sanitize_filename(filename)
260
+ else
261
+ prefix = 'download-'
262
+ end
263
+ prefix = prefix + '-' unless prefix.end_with?('-')
264
+ encoding = response.body.encoding
265
+ tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
266
+ @tempfile = tempfile
267
+ end
268
+ request.on_body do |chunk|
269
+ chunk.force_encoding(encoding)
270
+ tempfile.write(chunk)
271
+ end
272
+ request.on_complete do |response|
273
+ if tempfile
274
+ tempfile.close
275
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
276
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
277
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
278
+ "explicitly with `tempfile.delete`"
279
+ end
280
+ end
281
+ end
282
+
283
+ # Sanitize filename by removing path.
284
+ # e.g. ../../sun.gif becomes sun.gif
285
+ #
286
+ # @param [String] filename the filename to be sanitized
287
+ # @return [String] the sanitized filename
288
+ def sanitize_filename(filename)
289
+ filename.gsub(/.*[\/\\]/, '')
290
+ end
291
+
292
+ def build_request_url(path)
293
+ # Add leading and trailing slashes to path
294
+ path = "/#{path}".gsub(/\/+/, '/')
295
+ @config.base_url + path
296
+ end
297
+
298
+ # Update hearder and query params based on authentication settings.
299
+ #
300
+ # @param [Hash] header_params Header parameters
301
+ # @param [Hash] query_params Query parameters
302
+ # @param [String] auth_names Authentication scheme name
303
+ def update_params_for_auth!(header_params, query_params, auth_names)
304
+ Array(auth_names).each do |auth_name|
305
+ auth_setting = @config.auth_settings[auth_name]
306
+ next unless auth_setting
307
+ case auth_setting[:in]
308
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
309
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
310
+ else fail ArgumentError, 'Authentication token must be in `query` of `header`'
311
+ end
312
+ end
313
+ end
314
+
315
+ # Sets user agent in HTTP header
316
+ #
317
+ # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
318
+ def user_agent=(user_agent)
319
+ @user_agent = user_agent
320
+ @default_headers['User-Agent'] = @user_agent
321
+ end
322
+
323
+ # Return Accept header based on an array of accepts provided.
324
+ # @param [Array] accepts array for Accept
325
+ # @return [String] the Accept header (e.g. application/json)
326
+ def select_header_accept(accepts)
327
+ return nil if accepts.nil? || accepts.empty?
328
+ # use JSON when present, otherwise use all of the provided
329
+ json_accept = accepts.find { |s| json_mime?(s) }
330
+ json_accept || accepts.join(',')
331
+ end
332
+
333
+ # Return Content-Type header based on an array of content types provided.
334
+ # @param [Array] content_types array for Content-Type
335
+ # @return [String] the Content-Type header (e.g. application/json)
336
+ def select_header_content_type(content_types)
337
+ # use application/json by default
338
+ return 'application/json' if content_types.nil? || content_types.empty?
339
+ # use JSON when present, otherwise use the first one
340
+ json_content_type = content_types.find { |s| json_mime?(s) }
341
+ json_content_type || content_types.first
342
+ end
343
+
344
+ # Convert object (array, hash, object, etc) to JSON string.
345
+ # @param [Object] model object to be converted into JSON string
346
+ # @return [String] JSON string representation of the object
347
+ def object_to_http_body(model)
348
+ return model if model.nil? || model.is_a?(String)
349
+ local_body = nil
350
+ if model.is_a?(Array)
351
+ local_body = model.map { |m| object_to_hash(m) }
352
+ else
353
+ local_body = object_to_hash(model)
354
+ end
355
+ local_body.to_json
356
+ end
357
+
358
+ # Convert object(non-array) to hash.
359
+ # @param [Object] obj object to be converted into JSON string
360
+ # @return [String] JSON string representation of the object
361
+ def object_to_hash(obj)
362
+ if obj.respond_to?(:to_hash)
363
+ obj.to_hash
364
+ else
365
+ obj
366
+ end
367
+ end
368
+
369
+ # Build parameter value according to the given collection format.
370
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
371
+ def build_collection_param(param, collection_format)
372
+ case collection_format
373
+ when :csv
374
+ param.join(',')
375
+ when :ssv
376
+ param.join(' ')
377
+ when :tsv
378
+ param.join("\t")
379
+ when :pipes
380
+ param.join('|')
381
+ when :multi
382
+ # return the array directly as typhoeus will handle it as expected
383
+ param
384
+ else
385
+ fail "unknown collection format: #{collection_format.inspect}"
386
+ end
387
+ end
388
+ end
389
+ end
390
+ end