braze_api_client 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE.md +9 -0
- data/README.md +191 -0
- data/Rakefile +10 -0
- data/braze_api_client.gemspec +38 -0
- data/docs/Attributes.md +58 -0
- data/docs/AttributesArray.md +18 -0
- data/docs/AttributesCurrentLocation.md +20 -0
- data/docs/AttributesFacebook.md +22 -0
- data/docs/AttributesPushTokens.md +22 -0
- data/docs/AttributesTwitter.md +26 -0
- data/docs/Event.md +26 -0
- data/docs/EventsArray.md +18 -0
- data/docs/GeneralError.md +20 -0
- data/docs/Identifier.md +51 -0
- data/docs/IdentifierOneOf.md +18 -0
- data/docs/IdentifierOneOf1.md +18 -0
- data/docs/IdentifierOneOf2.md +18 -0
- data/docs/RestApi.md +427 -0
- data/docs/UsersTrackRequest.md +18 -0
- data/docs/UsersTrackResponse.md +24 -0
- data/git_push.sh +16 -0
- data/lib/braze_api_client/api/rest_api.rb +400 -0
- data/lib/braze_api_client/api_client.rb +390 -0
- data/lib/braze_api_client/api_error.rb +57 -0
- data/lib/braze_api_client/configuration.rb +294 -0
- data/lib/braze_api_client/models/attributes.rb +458 -0
- data/lib/braze_api_client/models/attributes_array.rb +225 -0
- data/lib/braze_api_client/models/attributes_current_location.rb +227 -0
- data/lib/braze_api_client/models/attributes_facebook.rb +238 -0
- data/lib/braze_api_client/models/attributes_push_tokens.rb +246 -0
- data/lib/braze_api_client/models/attributes_twitter.rb +254 -0
- data/lib/braze_api_client/models/event.rb +264 -0
- data/lib/braze_api_client/models/events_array.rb +220 -0
- data/lib/braze_api_client/models/general_error.rb +227 -0
- data/lib/braze_api_client/models/identifier.rb +106 -0
- data/lib/braze_api_client/models/identifier_one_of.rb +223 -0
- data/lib/braze_api_client/models/identifier_one_of1.rb +223 -0
- data/lib/braze_api_client/models/identifier_one_of2.rb +223 -0
- data/lib/braze_api_client/models/users_track_request.rb +245 -0
- data/lib/braze_api_client/models/users_track_response.rb +245 -0
- data/lib/braze_api_client/version.rb +15 -0
- data/lib/braze_api_client.rb +55 -0
- data/spec/api/rest_api_spec.rb +101 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/attributes_array_spec.rb +34 -0
- data/spec/models/attributes_current_location_spec.rb +40 -0
- data/spec/models/attributes_facebook_spec.rb +46 -0
- data/spec/models/attributes_push_tokens_spec.rb +46 -0
- data/spec/models/attributes_spec.rb +166 -0
- data/spec/models/attributes_twitter_spec.rb +58 -0
- data/spec/models/event_spec.rb +58 -0
- data/spec/models/events_array_spec.rb +34 -0
- data/spec/models/general_error_spec.rb +40 -0
- data/spec/models/identifier_one_of1_spec.rb +34 -0
- data/spec/models/identifier_one_of2_spec.rb +34 -0
- data/spec/models/identifier_one_of_spec.rb +34 -0
- data/spec/models/identifier_spec.rb +31 -0
- data/spec/models/users_track_request_spec.rb +34 -0
- data/spec/models/users_track_response_spec.rb +52 -0
- data/spec/spec_helper.rb +111 -0
- metadata +164 -0
@@ -0,0 +1,294 @@
|
|
1
|
+
=begin
|
2
|
+
#Braze
|
3
|
+
|
4
|
+
#Track users, send messages, export data, and more
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 0.1.0
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.2.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
module BrazeClient
|
14
|
+
class Configuration
|
15
|
+
# Defines url scheme
|
16
|
+
attr_accessor :scheme
|
17
|
+
|
18
|
+
# Defines url host
|
19
|
+
attr_accessor :host
|
20
|
+
|
21
|
+
# Defines url base path
|
22
|
+
attr_accessor :base_path
|
23
|
+
|
24
|
+
# Define server configuration index
|
25
|
+
attr_accessor :server_index
|
26
|
+
|
27
|
+
# Define server operation configuration index
|
28
|
+
attr_accessor :server_operation_index
|
29
|
+
|
30
|
+
# Default server variables
|
31
|
+
attr_accessor :server_variables
|
32
|
+
|
33
|
+
# Default server operation variables
|
34
|
+
attr_accessor :server_operation_variables
|
35
|
+
|
36
|
+
# Defines API keys used with API Key authentications.
|
37
|
+
#
|
38
|
+
# @return [Hash] key: parameter name, value: parameter value (API key)
|
39
|
+
#
|
40
|
+
# @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
|
41
|
+
# config.api_key['api_key'] = 'xxx'
|
42
|
+
attr_accessor :api_key
|
43
|
+
|
44
|
+
# Defines API key prefixes used with API Key authentications.
|
45
|
+
#
|
46
|
+
# @return [Hash] key: parameter name, value: API key prefix
|
47
|
+
#
|
48
|
+
# @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
|
49
|
+
# config.api_key_prefix['api_key'] = 'Token'
|
50
|
+
attr_accessor :api_key_prefix
|
51
|
+
|
52
|
+
# Defines the username used with HTTP basic authentication.
|
53
|
+
#
|
54
|
+
# @return [String]
|
55
|
+
attr_accessor :username
|
56
|
+
|
57
|
+
# Defines the password used with HTTP basic authentication.
|
58
|
+
#
|
59
|
+
# @return [String]
|
60
|
+
attr_accessor :password
|
61
|
+
|
62
|
+
# Defines the access token (Bearer) used with OAuth2.
|
63
|
+
attr_accessor :access_token
|
64
|
+
|
65
|
+
# Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
|
66
|
+
# details will be logged with `logger.debug` (see the `logger` attribute).
|
67
|
+
# Default to false.
|
68
|
+
#
|
69
|
+
# @return [true, false]
|
70
|
+
attr_accessor :debugging
|
71
|
+
|
72
|
+
# Defines the logger used for debugging.
|
73
|
+
# Default to `Rails.logger` (when in Rails) or logging to STDOUT.
|
74
|
+
#
|
75
|
+
# @return [#debug]
|
76
|
+
attr_accessor :logger
|
77
|
+
|
78
|
+
# Defines the temporary folder to store downloaded files
|
79
|
+
# (for API endpoints that have file response).
|
80
|
+
# Default to use `Tempfile`.
|
81
|
+
#
|
82
|
+
# @return [String]
|
83
|
+
attr_accessor :temp_folder_path
|
84
|
+
|
85
|
+
# The time limit for HTTP request in seconds.
|
86
|
+
# Default to 0 (never times out).
|
87
|
+
attr_accessor :timeout
|
88
|
+
|
89
|
+
# Set this to false to skip client side validation in the operation.
|
90
|
+
# Default to true.
|
91
|
+
# @return [true, false]
|
92
|
+
attr_accessor :client_side_validation
|
93
|
+
|
94
|
+
### TLS/SSL setting
|
95
|
+
# Set this to false to skip verifying SSL certificate when calling API from https server.
|
96
|
+
# Default to true.
|
97
|
+
#
|
98
|
+
# @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
|
99
|
+
#
|
100
|
+
# @return [true, false]
|
101
|
+
attr_accessor :verify_ssl
|
102
|
+
|
103
|
+
### TLS/SSL setting
|
104
|
+
# Set this to false to skip verifying SSL host name
|
105
|
+
# Default to true.
|
106
|
+
#
|
107
|
+
# @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
|
108
|
+
#
|
109
|
+
# @return [true, false]
|
110
|
+
attr_accessor :verify_ssl_host
|
111
|
+
|
112
|
+
### TLS/SSL setting
|
113
|
+
# Set this to customize the certificate file to verify the peer.
|
114
|
+
#
|
115
|
+
# @return [String] the path to the certificate file
|
116
|
+
#
|
117
|
+
# @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
|
118
|
+
# https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
|
119
|
+
attr_accessor :ssl_ca_cert
|
120
|
+
|
121
|
+
### TLS/SSL setting
|
122
|
+
# Client certificate file (for client certificate)
|
123
|
+
attr_accessor :cert_file
|
124
|
+
|
125
|
+
### TLS/SSL setting
|
126
|
+
# Client private key file (for client certificate)
|
127
|
+
attr_accessor :key_file
|
128
|
+
|
129
|
+
# Set this to customize parameters encoding of array parameter with multi collectionFormat.
|
130
|
+
# Default to nil.
|
131
|
+
#
|
132
|
+
# @see The params_encoding option of Ethon. Related source code:
|
133
|
+
# https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
|
134
|
+
attr_accessor :params_encoding
|
135
|
+
|
136
|
+
attr_accessor :inject_format
|
137
|
+
|
138
|
+
attr_accessor :force_ending_format
|
139
|
+
|
140
|
+
def initialize
|
141
|
+
@scheme = 'https'
|
142
|
+
@host = 'rest.iad-01.braze.com'
|
143
|
+
@base_path = ''
|
144
|
+
@server_index = 0
|
145
|
+
@server_operation_index = {}
|
146
|
+
@server_variables = {}
|
147
|
+
@server_operation_variables = {}
|
148
|
+
@api_key = {}
|
149
|
+
@api_key_prefix = {}
|
150
|
+
@timeout = 0
|
151
|
+
@client_side_validation = true
|
152
|
+
@verify_ssl = true
|
153
|
+
@verify_ssl_host = true
|
154
|
+
@params_encoding = nil
|
155
|
+
@cert_file = nil
|
156
|
+
@key_file = nil
|
157
|
+
@debugging = false
|
158
|
+
@inject_format = false
|
159
|
+
@force_ending_format = false
|
160
|
+
@logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
|
161
|
+
|
162
|
+
yield(self) if block_given?
|
163
|
+
end
|
164
|
+
|
165
|
+
# The default Configuration object.
|
166
|
+
def self.default
|
167
|
+
@@default ||= Configuration.new
|
168
|
+
end
|
169
|
+
|
170
|
+
def configure
|
171
|
+
yield(self) if block_given?
|
172
|
+
end
|
173
|
+
|
174
|
+
def scheme=(scheme)
|
175
|
+
# remove :// from scheme
|
176
|
+
@scheme = scheme.sub(/:\/\//, '')
|
177
|
+
end
|
178
|
+
|
179
|
+
def host=(host)
|
180
|
+
# remove http(s):// and anything after a slash
|
181
|
+
@host = host.sub(/https?:\/\//, '').split('/').first
|
182
|
+
end
|
183
|
+
|
184
|
+
def base_path=(base_path)
|
185
|
+
# Add leading and trailing slashes to base_path
|
186
|
+
@base_path = "/#{base_path}".gsub(/\/+/, '/')
|
187
|
+
@base_path = '' if @base_path == '/'
|
188
|
+
end
|
189
|
+
|
190
|
+
# Returns base URL for specified operation based on server settings
|
191
|
+
def base_url(operation = nil)
|
192
|
+
index = server_operation_index.fetch(operation, server_index)
|
193
|
+
return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil
|
194
|
+
|
195
|
+
server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
|
196
|
+
end
|
197
|
+
|
198
|
+
# Gets API key (with prefix if set).
|
199
|
+
# @param [String] param_name the parameter name of API key auth
|
200
|
+
def api_key_with_prefix(param_name, param_alias = nil)
|
201
|
+
key = @api_key[param_name]
|
202
|
+
key = @api_key.fetch(param_alias, key) unless param_alias.nil?
|
203
|
+
if @api_key_prefix[param_name]
|
204
|
+
"#{@api_key_prefix[param_name]} #{key}"
|
205
|
+
else
|
206
|
+
key
|
207
|
+
end
|
208
|
+
end
|
209
|
+
|
210
|
+
# Gets Basic Auth token string
|
211
|
+
def basic_auth_token
|
212
|
+
'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
|
213
|
+
end
|
214
|
+
|
215
|
+
# Returns Auth Settings hash for api client.
|
216
|
+
def auth_settings
|
217
|
+
{
|
218
|
+
'bearerAuth' =>
|
219
|
+
{
|
220
|
+
type: 'bearer',
|
221
|
+
in: 'header',
|
222
|
+
key: 'Authorization',
|
223
|
+
value: "Bearer #{access_token}"
|
224
|
+
},
|
225
|
+
}
|
226
|
+
end
|
227
|
+
|
228
|
+
# Returns an array of Server setting
|
229
|
+
def server_settings
|
230
|
+
[
|
231
|
+
{
|
232
|
+
url: "https://{host}",
|
233
|
+
description: "Braze API server",
|
234
|
+
variables: {
|
235
|
+
host: {
|
236
|
+
description: "No description provided",
|
237
|
+
default_value: "rest.iad-01.braze.com",
|
238
|
+
enum_values: [
|
239
|
+
"rest.iad-01.braze.com",
|
240
|
+
"rest.iad-02.braze.com",
|
241
|
+
"rest.iad-03.braze.com",
|
242
|
+
"rest.iad-04.braze.com",
|
243
|
+
"rest.iad-05.braze.com",
|
244
|
+
"rest.iad-06.braze.com",
|
245
|
+
"rest.iad-08.braze.com",
|
246
|
+
"rest.fra-01.braze.eu",
|
247
|
+
"rest.fra-02.braze.eu"
|
248
|
+
]
|
249
|
+
}
|
250
|
+
}
|
251
|
+
}
|
252
|
+
]
|
253
|
+
end
|
254
|
+
|
255
|
+
def operation_server_settings
|
256
|
+
{
|
257
|
+
}
|
258
|
+
end
|
259
|
+
|
260
|
+
# Returns URL based on server settings
|
261
|
+
#
|
262
|
+
# @param index array index of the server settings
|
263
|
+
# @param variables hash of variable and the corresponding value
|
264
|
+
def server_url(index, variables = {}, servers = nil)
|
265
|
+
servers = server_settings if servers == nil
|
266
|
+
|
267
|
+
# check array index out of bound
|
268
|
+
if (index < 0 || index >= servers.size)
|
269
|
+
fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
|
270
|
+
end
|
271
|
+
|
272
|
+
server = servers[index]
|
273
|
+
url = server[:url]
|
274
|
+
|
275
|
+
return url unless server.key? :variables
|
276
|
+
|
277
|
+
# go through variable and assign a value
|
278
|
+
server[:variables].each do |name, variable|
|
279
|
+
if variables.key?(name)
|
280
|
+
if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
|
281
|
+
url.gsub! "{" + name.to_s + "}", variables[name]
|
282
|
+
else
|
283
|
+
fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
|
284
|
+
end
|
285
|
+
else
|
286
|
+
# use default value
|
287
|
+
url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
|
288
|
+
end
|
289
|
+
end
|
290
|
+
|
291
|
+
url
|
292
|
+
end
|
293
|
+
end
|
294
|
+
end
|