flat_api 0.1.0 → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/README.md +5 -4
- data/docs/ScoreRights.md +1 -0
- data/flat_api.gemspec +1 -1
- data/git_push.sh +1 -1
- data/lib/flat_api.rb +1 -1
- data/lib/flat_api/api/account_api.rb +1 -1
- data/lib/flat_api/api/class_api.rb +1 -1
- data/lib/flat_api/api/group_api.rb +1 -1
- data/lib/flat_api/api/organization_api.rb +1 -1
- data/lib/flat_api/api/score_api.rb +1 -1
- data/lib/flat_api/api/user_api.rb +1 -1
- data/lib/flat_api/api_client.rb +2 -2
- data/lib/flat_api/api_error.rb +1 -1
- data/lib/flat_api/configuration.rb +1 -1
- data/lib/flat_api/models/assignment.rb +2 -2
- data/lib/flat_api/models/assignment_copy.rb +2 -2
- data/lib/flat_api/models/assignment_creation.rb +2 -2
- data/lib/flat_api/models/assignment_submission.rb +2 -2
- data/lib/flat_api/models/assignment_submission_update.rb +2 -2
- data/lib/flat_api/models/class_attachment_creation.rb +2 -2
- data/lib/flat_api/models/class_creation.rb +2 -2
- data/lib/flat_api/models/class_details.rb +2 -2
- data/lib/flat_api/models/class_details_canvas.rb +2 -2
- data/lib/flat_api/models/class_details_clever.rb +2 -2
- data/lib/flat_api/models/class_details_google_classroom.rb +2 -2
- data/lib/flat_api/models/class_details_google_drive.rb +2 -2
- data/lib/flat_api/models/class_details_lti.rb +2 -2
- data/lib/flat_api/models/class_roles.rb +10 -1
- data/lib/flat_api/models/class_state.rb +10 -1
- data/lib/flat_api/models/class_update.rb +2 -2
- data/lib/flat_api/models/flat_error_response.rb +2 -2
- data/lib/flat_api/models/flat_locales.rb +10 -1
- data/lib/flat_api/models/google_classroom_coursework.rb +2 -2
- data/lib/flat_api/models/google_classroom_submission.rb +2 -2
- data/lib/flat_api/models/group.rb +2 -2
- data/lib/flat_api/models/group_details.rb +2 -2
- data/lib/flat_api/models/group_type.rb +10 -1
- data/lib/flat_api/models/license_mode.rb +10 -1
- data/lib/flat_api/models/license_sources.rb +10 -1
- data/lib/flat_api/models/lms_name.rb +10 -1
- data/lib/flat_api/models/lti_credentials.rb +2 -2
- data/lib/flat_api/models/lti_credentials_creation.rb +2 -2
- data/lib/flat_api/models/media_attachment.rb +2 -2
- data/lib/flat_api/models/media_score_sharing_mode.rb +10 -1
- data/lib/flat_api/models/organization_invitation.rb +2 -2
- data/lib/flat_api/models/organization_invitation_creation.rb +2 -2
- data/lib/flat_api/models/organization_roles.rb +10 -1
- data/lib/flat_api/models/score_collaborator.rb +2 -2
- data/lib/flat_api/models/score_collaborator_creation.rb +2 -2
- data/lib/flat_api/models/score_comment.rb +2 -2
- data/lib/flat_api/models/score_comment_context.rb +2 -2
- data/lib/flat_api/models/score_comment_creation.rb +2 -2
- data/lib/flat_api/models/score_comment_update.rb +2 -2
- data/lib/flat_api/models/score_comments_counts.rb +2 -2
- data/lib/flat_api/models/score_creation.rb +2 -2
- data/lib/flat_api/models/score_creation_type.rb +10 -1
- data/lib/flat_api/models/score_data.rb +2 -2
- data/lib/flat_api/models/score_data_encoding.rb +10 -1
- data/lib/flat_api/models/score_details.rb +2 -2
- data/lib/flat_api/models/score_fork.rb +2 -2
- data/lib/flat_api/models/score_license.rb +10 -1
- data/lib/flat_api/models/score_likes_counts.rb +2 -2
- data/lib/flat_api/models/score_modification.rb +2 -2
- data/lib/flat_api/models/score_privacy.rb +10 -1
- data/lib/flat_api/models/score_revision.rb +2 -2
- data/lib/flat_api/models/score_revision_creation.rb +2 -2
- data/lib/flat_api/models/score_revision_statistics.rb +2 -2
- data/lib/flat_api/models/score_rights.rb +13 -3
- data/lib/flat_api/models/score_source.rb +2 -2
- data/lib/flat_api/models/score_summary.rb +2 -2
- data/lib/flat_api/models/score_track.rb +2 -2
- data/lib/flat_api/models/score_track_creation.rb +2 -2
- data/lib/flat_api/models/score_track_point.rb +2 -2
- data/lib/flat_api/models/score_track_state.rb +10 -1
- data/lib/flat_api/models/score_track_type.rb +10 -1
- data/lib/flat_api/models/score_track_update.rb +2 -2
- data/lib/flat_api/models/score_views_counts.rb +2 -2
- data/lib/flat_api/models/user_admin_update.rb +2 -2
- data/lib/flat_api/models/user_basics.rb +2 -2
- data/lib/flat_api/models/user_creation.rb +7 -7
- data/lib/flat_api/models/user_details.rb +2 -2
- data/lib/flat_api/models/user_details_admin.rb +2 -2
- data/lib/flat_api/models/user_details_admin_license.rb +2 -2
- data/lib/flat_api/models/user_instruments.rb +2 -2
- data/lib/flat_api/models/user_public.rb +2 -2
- data/lib/flat_api/models/user_public_summary.rb +2 -2
- data/lib/flat_api/version.rb +2 -2
- metadata +2 -85
- data/lib/swagger_client.rb +0 -117
- data/lib/swagger_client/api/account_api.rb +0 -72
- data/lib/swagger_client/api/class_api.rb +0 -1148
- data/lib/swagger_client/api/group_api.rb +0 -191
- data/lib/swagger_client/api/organization_api.rb +0 -599
- data/lib/swagger_client/api/score_api.rb +0 -1737
- data/lib/swagger_client/api/user_api.rb +0 -194
- data/lib/swagger_client/api_client.rb +0 -389
- data/lib/swagger_client/api_error.rb +0 -38
- data/lib/swagger_client/configuration.rb +0 -209
- data/lib/swagger_client/models/assignment.rb +0 -323
- data/lib/swagger_client/models/assignment_copy.rb +0 -194
- data/lib/swagger_client/models/assignment_creation.rb +0 -230
- data/lib/swagger_client/models/assignment_submission.rb +0 -299
- data/lib/swagger_client/models/assignment_submission_update.rb +0 -220
- data/lib/swagger_client/models/class_attachment_creation.rb +0 -242
- data/lib/swagger_client/models/class_creation.rb +0 -239
- data/lib/swagger_client/models/class_details.rb +0 -351
- data/lib/swagger_client/models/class_details_canvas.rb +0 -199
- data/lib/swagger_client/models/class_details_clever.rb +0 -282
- data/lib/swagger_client/models/class_details_google_classroom.rb +0 -219
- data/lib/swagger_client/models/class_details_google_drive.rb +0 -199
- data/lib/swagger_client/models/class_details_lti.rb +0 -209
- data/lib/swagger_client/models/class_roles.rb +0 -22
- data/lib/swagger_client/models/class_state.rb +0 -23
- data/lib/swagger_client/models/class_update.rb +0 -231
- data/lib/swagger_client/models/flat_error_response.rb +0 -219
- data/lib/swagger_client/models/flat_locales.rb +0 -27
- data/lib/swagger_client/models/google_classroom_coursework.rb +0 -209
- data/lib/swagger_client/models/google_classroom_submission.rb +0 -209
- data/lib/swagger_client/models/group.rb +0 -282
- data/lib/swagger_client/models/group_details.rb +0 -248
- data/lib/swagger_client/models/group_type.rb +0 -23
- data/lib/swagger_client/models/license_mode.rb +0 -22
- data/lib/swagger_client/models/license_sources.rb +0 -25
- data/lib/swagger_client/models/lms_name.rb +0 -27
- data/lib/swagger_client/models/lti_credentials.rb +0 -268
- data/lib/swagger_client/models/lti_credentials_creation.rb +0 -227
- data/lib/swagger_client/models/media_attachment.rb +0 -371
- data/lib/swagger_client/models/media_score_sharing_mode.rb +0 -23
- data/lib/swagger_client/models/organization_invitation.rb +0 -248
- data/lib/swagger_client/models/organization_invitation_creation.rb +0 -198
- data/lib/swagger_client/models/organization_roles.rb +0 -24
- data/lib/swagger_client/models/score_collaborator.rb +0 -263
- data/lib/swagger_client/models/score_collaborator_creation.rb +0 -245
- data/lib/swagger_client/models/score_comment.rb +0 -363
- data/lib/swagger_client/models/score_comment_context.rb +0 -282
- data/lib/swagger_client/models/score_comment_creation.rb +0 -245
- data/lib/swagger_client/models/score_comment_update.rb +0 -268
- data/lib/swagger_client/models/score_comments_counts.rb +0 -219
- data/lib/swagger_client/models/score_creation.rb +0 -240
- data/lib/swagger_client/models/score_creation_type.rb +0 -23
- data/lib/swagger_client/models/score_data.rb +0 -179
- data/lib/swagger_client/models/score_data_encoding.rb +0 -21
- data/lib/swagger_client/models/score_details.rb +0 -467
- data/lib/swagger_client/models/score_fork.rb +0 -179
- data/lib/swagger_client/models/score_license.rb +0 -28
- data/lib/swagger_client/models/score_likes_counts.rb +0 -209
- data/lib/swagger_client/models/score_modification.rb +0 -270
- data/lib/swagger_client/models/score_privacy.rb +0 -24
- data/lib/swagger_client/models/score_revision.rb +0 -249
- data/lib/swagger_client/models/score_revision_creation.rb +0 -222
- data/lib/swagger_client/models/score_revision_statistics.rb +0 -199
- data/lib/swagger_client/models/score_rights.rb +0 -203
- data/lib/swagger_client/models/score_source.rb +0 -189
- data/lib/swagger_client/models/score_summary.rb +0 -237
- data/lib/swagger_client/models/score_track.rb +0 -298
- data/lib/swagger_client/models/score_track_creation.rb +0 -229
- data/lib/swagger_client/models/score_track_point.rb +0 -252
- data/lib/swagger_client/models/score_track_state.rb +0 -23
- data/lib/swagger_client/models/score_track_type.rb +0 -24
- data/lib/swagger_client/models/score_track_update.rb +0 -219
- data/lib/swagger_client/models/score_views_counts.rb +0 -209
- data/lib/swagger_client/models/user_admin_update.rb +0 -214
- data/lib/swagger_client/models/user_basics.rb +0 -239
- data/lib/swagger_client/models/user_creation.rb +0 -266
- data/lib/swagger_client/models/user_details.rb +0 -418
- data/lib/swagger_client/models/user_details_admin.rb +0 -306
- data/lib/swagger_client/models/user_details_admin_license.rb +0 -227
- data/lib/swagger_client/models/user_instruments.rb +0 -179
- data/lib/swagger_client/models/user_public.rb +0 -356
- data/lib/swagger_client/models/user_public_summary.rb +0 -277
- data/lib/swagger_client/version.rb +0 -15
@@ -1,194 +0,0 @@
|
|
1
|
-
=begin
|
2
|
-
#Flat API
|
3
|
-
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
|
-
|
6
|
-
OpenAPI spec version: 2.5.0
|
7
|
-
Contact: developers@flat.io
|
8
|
-
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.2.3-SNAPSHOT
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require "uri"
|
14
|
-
|
15
|
-
module SwaggerClient
|
16
|
-
class UserApi
|
17
|
-
attr_accessor :api_client
|
18
|
-
|
19
|
-
def initialize(api_client = ApiClient.default)
|
20
|
-
@api_client = api_client
|
21
|
-
end
|
22
|
-
|
23
|
-
# List liked scores
|
24
|
-
#
|
25
|
-
# @param user Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user.
|
26
|
-
# @param [Hash] opts the optional parameters
|
27
|
-
# @option opts [BOOLEAN] :ids Return only the identifiers of the scores
|
28
|
-
# @return [Array<ScoreDetails>]
|
29
|
-
def ger_user_likes(user, opts = {})
|
30
|
-
data, _status_code, _headers = ger_user_likes_with_http_info(user, opts)
|
31
|
-
return data
|
32
|
-
end
|
33
|
-
|
34
|
-
# List liked scores
|
35
|
-
#
|
36
|
-
# @param user Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user.
|
37
|
-
# @param [Hash] opts the optional parameters
|
38
|
-
# @option opts [BOOLEAN] :ids Return only the identifiers of the scores
|
39
|
-
# @return [Array<(Array<ScoreDetails>, Fixnum, Hash)>] Array<ScoreDetails> data, response status code and response headers
|
40
|
-
def ger_user_likes_with_http_info(user, opts = {})
|
41
|
-
if @api_client.config.debugging
|
42
|
-
@api_client.config.logger.debug "Calling API: UserApi.ger_user_likes ..."
|
43
|
-
end
|
44
|
-
# verify the required parameter 'user' is set
|
45
|
-
if @api_client.config.client_side_validation && user.nil?
|
46
|
-
fail ArgumentError, "Missing the required parameter 'user' when calling UserApi.ger_user_likes"
|
47
|
-
end
|
48
|
-
# resource path
|
49
|
-
local_var_path = "/users/{user}/likes".sub('{' + 'user' + '}', user.to_s)
|
50
|
-
|
51
|
-
# query parameters
|
52
|
-
query_params = {}
|
53
|
-
query_params[:'ids'] = opts[:'ids'] if !opts[:'ids'].nil?
|
54
|
-
|
55
|
-
# header parameters
|
56
|
-
header_params = {}
|
57
|
-
# HTTP header 'Accept' (if needed)
|
58
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
59
|
-
# HTTP header 'Content-Type'
|
60
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
61
|
-
|
62
|
-
# form parameters
|
63
|
-
form_params = {}
|
64
|
-
|
65
|
-
# http body (model)
|
66
|
-
post_body = nil
|
67
|
-
auth_names = ['OAuth2']
|
68
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
69
|
-
:header_params => header_params,
|
70
|
-
:query_params => query_params,
|
71
|
-
:form_params => form_params,
|
72
|
-
:body => post_body,
|
73
|
-
:auth_names => auth_names,
|
74
|
-
:return_type => 'Array<ScoreDetails>')
|
75
|
-
if @api_client.config.debugging
|
76
|
-
@api_client.config.logger.debug "API called: UserApi#ger_user_likes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
77
|
-
end
|
78
|
-
return data, status_code, headers
|
79
|
-
end
|
80
|
-
|
81
|
-
# Get a public user profile
|
82
|
-
# Get a public profile of a Flat User.
|
83
|
-
# @param user This route parameter is the unique identifier of the user. You can specify an email instead of an unique identifier. If you are executing this request authenticated, you can use `me` as a value instead of the current User unique identifier to work on the current authenticated user.
|
84
|
-
# @param [Hash] opts the optional parameters
|
85
|
-
# @return [UserPublic]
|
86
|
-
def get_user(user, opts = {})
|
87
|
-
data, _status_code, _headers = get_user_with_http_info(user, opts)
|
88
|
-
return data
|
89
|
-
end
|
90
|
-
|
91
|
-
# Get a public user profile
|
92
|
-
# Get a public profile of a Flat User.
|
93
|
-
# @param user This route parameter is the unique identifier of the user. You can specify an email instead of an unique identifier. If you are executing this request authenticated, you can use `me` as a value instead of the current User unique identifier to work on the current authenticated user.
|
94
|
-
# @param [Hash] opts the optional parameters
|
95
|
-
# @return [Array<(UserPublic, Fixnum, Hash)>] UserPublic data, response status code and response headers
|
96
|
-
def get_user_with_http_info(user, opts = {})
|
97
|
-
if @api_client.config.debugging
|
98
|
-
@api_client.config.logger.debug "Calling API: UserApi.get_user ..."
|
99
|
-
end
|
100
|
-
# verify the required parameter 'user' is set
|
101
|
-
if @api_client.config.client_side_validation && user.nil?
|
102
|
-
fail ArgumentError, "Missing the required parameter 'user' when calling UserApi.get_user"
|
103
|
-
end
|
104
|
-
# resource path
|
105
|
-
local_var_path = "/users/{user}".sub('{' + 'user' + '}', user.to_s)
|
106
|
-
|
107
|
-
# query parameters
|
108
|
-
query_params = {}
|
109
|
-
|
110
|
-
# header parameters
|
111
|
-
header_params = {}
|
112
|
-
# HTTP header 'Accept' (if needed)
|
113
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
114
|
-
# HTTP header 'Content-Type'
|
115
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
116
|
-
|
117
|
-
# form parameters
|
118
|
-
form_params = {}
|
119
|
-
|
120
|
-
# http body (model)
|
121
|
-
post_body = nil
|
122
|
-
auth_names = ['OAuth2']
|
123
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
124
|
-
:header_params => header_params,
|
125
|
-
:query_params => query_params,
|
126
|
-
:form_params => form_params,
|
127
|
-
:body => post_body,
|
128
|
-
:auth_names => auth_names,
|
129
|
-
:return_type => 'UserPublic')
|
130
|
-
if @api_client.config.debugging
|
131
|
-
@api_client.config.logger.debug "API called: UserApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
132
|
-
end
|
133
|
-
return data, status_code, headers
|
134
|
-
end
|
135
|
-
|
136
|
-
# List user's scores
|
137
|
-
# Get the list of scores owned by the User
|
138
|
-
# @param user Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user.
|
139
|
-
# @param [Hash] opts the optional parameters
|
140
|
-
# @option opts [String] :parent Filter the score forked from the score id `parent`
|
141
|
-
# @return [Array<ScoreDetails>]
|
142
|
-
def get_user_scores(user, opts = {})
|
143
|
-
data, _status_code, _headers = get_user_scores_with_http_info(user, opts)
|
144
|
-
return data
|
145
|
-
end
|
146
|
-
|
147
|
-
# List user's scores
|
148
|
-
# Get the list of scores owned by the User
|
149
|
-
# @param user Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user.
|
150
|
-
# @param [Hash] opts the optional parameters
|
151
|
-
# @option opts [String] :parent Filter the score forked from the score id `parent`
|
152
|
-
# @return [Array<(Array<ScoreDetails>, Fixnum, Hash)>] Array<ScoreDetails> data, response status code and response headers
|
153
|
-
def get_user_scores_with_http_info(user, opts = {})
|
154
|
-
if @api_client.config.debugging
|
155
|
-
@api_client.config.logger.debug "Calling API: UserApi.get_user_scores ..."
|
156
|
-
end
|
157
|
-
# verify the required parameter 'user' is set
|
158
|
-
if @api_client.config.client_side_validation && user.nil?
|
159
|
-
fail ArgumentError, "Missing the required parameter 'user' when calling UserApi.get_user_scores"
|
160
|
-
end
|
161
|
-
# resource path
|
162
|
-
local_var_path = "/users/{user}/scores".sub('{' + 'user' + '}', user.to_s)
|
163
|
-
|
164
|
-
# query parameters
|
165
|
-
query_params = {}
|
166
|
-
query_params[:'parent'] = opts[:'parent'] if !opts[:'parent'].nil?
|
167
|
-
|
168
|
-
# header parameters
|
169
|
-
header_params = {}
|
170
|
-
# HTTP header 'Accept' (if needed)
|
171
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
172
|
-
# HTTP header 'Content-Type'
|
173
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
174
|
-
|
175
|
-
# form parameters
|
176
|
-
form_params = {}
|
177
|
-
|
178
|
-
# http body (model)
|
179
|
-
post_body = nil
|
180
|
-
auth_names = ['OAuth2']
|
181
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
182
|
-
:header_params => header_params,
|
183
|
-
:query_params => query_params,
|
184
|
-
:form_params => form_params,
|
185
|
-
:body => post_body,
|
186
|
-
:auth_names => auth_names,
|
187
|
-
:return_type => 'Array<ScoreDetails>')
|
188
|
-
if @api_client.config.debugging
|
189
|
-
@api_client.config.logger.debug "API called: UserApi#get_user_scores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
190
|
-
end
|
191
|
-
return data, status_code, headers
|
192
|
-
end
|
193
|
-
end
|
194
|
-
end
|
@@ -1,389 +0,0 @@
|
|
1
|
-
=begin
|
2
|
-
#Flat API
|
3
|
-
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
|
-
|
6
|
-
OpenAPI spec version: 2.5.0
|
7
|
-
Contact: developers@flat.io
|
8
|
-
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.2.3-SNAPSHOT
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'date'
|
14
|
-
require 'json'
|
15
|
-
require 'logger'
|
16
|
-
require 'tempfile'
|
17
|
-
require 'typhoeus'
|
18
|
-
require 'uri'
|
19
|
-
|
20
|
-
module SwaggerClient
|
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 = "Swagger-Codegen/#{VERSION}/ruby"
|
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, Fixnum, 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
|
-
# Check if the given MIME is a JSON MIME.
|
132
|
-
# JSON MIME examples:
|
133
|
-
# application/json
|
134
|
-
# application/json; charset=UTF8
|
135
|
-
# APPLICATION/JSON
|
136
|
-
# */*
|
137
|
-
# @param [String] mime MIME
|
138
|
-
# @return [Boolean] True if the MIME is application/json
|
139
|
-
def json_mime?(mime)
|
140
|
-
(mime == "*/*") || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
|
141
|
-
end
|
142
|
-
|
143
|
-
# Deserialize the response to the given return type.
|
144
|
-
#
|
145
|
-
# @param [Response] response HTTP response
|
146
|
-
# @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
|
147
|
-
def deserialize(response, return_type)
|
148
|
-
body = response.body
|
149
|
-
|
150
|
-
# handle file downloading - return the File instance processed in request callbacks
|
151
|
-
# note that response body is empty when the file is written in chunks in request on_body callback
|
152
|
-
return @tempfile if return_type == 'File'
|
153
|
-
|
154
|
-
return nil if body.nil? || body.empty?
|
155
|
-
|
156
|
-
# return response body directly for String return type
|
157
|
-
return body if return_type == 'String'
|
158
|
-
|
159
|
-
# ensuring a default content type
|
160
|
-
content_type = response.headers['Content-Type'] || 'application/json'
|
161
|
-
|
162
|
-
fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
|
163
|
-
|
164
|
-
begin
|
165
|
-
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
166
|
-
rescue JSON::ParserError => e
|
167
|
-
if %w(String Date DateTime).include?(return_type)
|
168
|
-
data = body
|
169
|
-
else
|
170
|
-
raise e
|
171
|
-
end
|
172
|
-
end
|
173
|
-
|
174
|
-
convert_to_type data, return_type
|
175
|
-
end
|
176
|
-
|
177
|
-
# Convert data to the given return type.
|
178
|
-
# @param [Object] data Data to be converted
|
179
|
-
# @param [String] return_type Return type
|
180
|
-
# @return [Mixed] Data in a particular type
|
181
|
-
def convert_to_type(data, return_type)
|
182
|
-
return nil if data.nil?
|
183
|
-
case return_type
|
184
|
-
when 'String'
|
185
|
-
data.to_s
|
186
|
-
when 'Integer'
|
187
|
-
data.to_i
|
188
|
-
when 'Float'
|
189
|
-
data.to_f
|
190
|
-
when 'BOOLEAN'
|
191
|
-
data == true
|
192
|
-
when 'DateTime'
|
193
|
-
# parse date time (expecting ISO 8601 format)
|
194
|
-
DateTime.parse data
|
195
|
-
when 'Date'
|
196
|
-
# parse date time (expecting ISO 8601 format)
|
197
|
-
Date.parse data
|
198
|
-
when 'Object'
|
199
|
-
# generic object (usually a Hash), return directly
|
200
|
-
data
|
201
|
-
when /\AArray<(.+)>\z/
|
202
|
-
# e.g. Array<Pet>
|
203
|
-
sub_type = $1
|
204
|
-
data.map {|item| convert_to_type(item, sub_type) }
|
205
|
-
when /\AHash\<String, (.+)\>\z/
|
206
|
-
# e.g. Hash<String, Integer>
|
207
|
-
sub_type = $1
|
208
|
-
{}.tap do |hash|
|
209
|
-
data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
|
210
|
-
end
|
211
|
-
else
|
212
|
-
# models, e.g. Pet
|
213
|
-
SwaggerClient.const_get(return_type).new.tap do |model|
|
214
|
-
model.build_from_hash data
|
215
|
-
end
|
216
|
-
end
|
217
|
-
end
|
218
|
-
|
219
|
-
# Save response body into a file in (the defined) temporary folder, using the filename
|
220
|
-
# from the "Content-Disposition" header if provided, otherwise a random filename.
|
221
|
-
# The response body is written to the file in chunks in order to handle files which
|
222
|
-
# size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
|
223
|
-
# process can use.
|
224
|
-
#
|
225
|
-
# @see Configuration#temp_folder_path
|
226
|
-
def download_file(request)
|
227
|
-
tempfile = nil
|
228
|
-
encoding = nil
|
229
|
-
request.on_headers do |response|
|
230
|
-
content_disposition = response.headers['Content-Disposition']
|
231
|
-
if content_disposition and content_disposition =~ /filename=/i
|
232
|
-
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
233
|
-
prefix = sanitize_filename(filename)
|
234
|
-
else
|
235
|
-
prefix = 'download-'
|
236
|
-
end
|
237
|
-
prefix = prefix + '-' unless prefix.end_with?('-')
|
238
|
-
encoding = response.body.encoding
|
239
|
-
tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
240
|
-
@tempfile = tempfile
|
241
|
-
end
|
242
|
-
request.on_body do |chunk|
|
243
|
-
chunk.force_encoding(encoding)
|
244
|
-
tempfile.write(chunk)
|
245
|
-
end
|
246
|
-
request.on_complete do |response|
|
247
|
-
tempfile.close
|
248
|
-
@config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
249
|
-
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
250
|
-
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
251
|
-
"explicitly with `tempfile.delete`"
|
252
|
-
end
|
253
|
-
end
|
254
|
-
|
255
|
-
# Sanitize filename by removing path.
|
256
|
-
# e.g. ../../sun.gif becomes sun.gif
|
257
|
-
#
|
258
|
-
# @param [String] filename the filename to be sanitized
|
259
|
-
# @return [String] the sanitized filename
|
260
|
-
def sanitize_filename(filename)
|
261
|
-
filename.gsub(/.*[\/\\]/, '')
|
262
|
-
end
|
263
|
-
|
264
|
-
def build_request_url(path)
|
265
|
-
# Add leading and trailing slashes to path
|
266
|
-
path = "/#{path}".gsub(/\/+/, '/')
|
267
|
-
URI.encode(@config.base_url + path)
|
268
|
-
end
|
269
|
-
|
270
|
-
# Builds the HTTP request body
|
271
|
-
#
|
272
|
-
# @param [Hash] header_params Header parameters
|
273
|
-
# @param [Hash] form_params Query parameters
|
274
|
-
# @param [Object] body HTTP body (JSON/XML)
|
275
|
-
# @return [String] HTTP body data in the form of string
|
276
|
-
def build_request_body(header_params, form_params, body)
|
277
|
-
# http form
|
278
|
-
if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
|
279
|
-
header_params['Content-Type'] == 'multipart/form-data'
|
280
|
-
data = {}
|
281
|
-
form_params.each do |key, value|
|
282
|
-
case value
|
283
|
-
when File, Array, nil
|
284
|
-
# let typhoeus handle File, Array and nil parameters
|
285
|
-
data[key] = value
|
286
|
-
else
|
287
|
-
data[key] = value.to_s
|
288
|
-
end
|
289
|
-
end
|
290
|
-
elsif body
|
291
|
-
data = body.is_a?(String) ? body : body.to_json
|
292
|
-
else
|
293
|
-
data = nil
|
294
|
-
end
|
295
|
-
data
|
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. swagger-codegen/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
|
-
return 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
|
-
return 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
|