mux_ruby 1.9.0 → 2.0.0.pre.rc.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +3 -1
- data/Gemfile.lock +26 -37
- data/README.md +36 -13
- data/docs/AbridgedVideoView.md +33 -13
- data/docs/Asset.md +57 -26
- data/docs/AssetErrors.md +15 -4
- data/docs/AssetMaster.md +15 -4
- data/docs/AssetNonStandardInputReasons.md +29 -11
- data/docs/AssetRecordingTimes.md +15 -4
- data/docs/AssetResponse.md +13 -3
- data/docs/AssetStaticRenditions.md +15 -4
- data/docs/AssetStaticRenditionsFiles.md +23 -8
- data/docs/AssetsApi.md +387 -160
- data/docs/BreakdownValue.md +21 -7
- data/docs/CreateAssetRequest.md +27 -10
- data/docs/CreateLiveStreamRequest.md +25 -9
- data/docs/CreatePlaybackIDRequest.md +13 -3
- data/docs/CreatePlaybackIDResponse.md +13 -3
- data/docs/CreateSimulcastTargetRequest.md +17 -5
- data/docs/CreateTrackRequest.md +25 -9
- data/docs/CreateTrackResponse.md +13 -3
- data/docs/CreateUploadRequest.md +19 -6
- data/docs/DeliveryReport.md +27 -9
- data/docs/DeliveryUsageApi.md +40 -22
- data/docs/DimensionValue.md +15 -4
- data/docs/DimensionsApi.md +72 -34
- data/docs/DirectUploadsApi.md +131 -56
- data/docs/DisableLiveStreamResponse.md +13 -3
- data/docs/EnableLiveStreamResponse.md +13 -3
- data/docs/Error.md +27 -10
- data/docs/ErrorsApi.md +37 -19
- data/docs/ExportsApi.md +32 -13
- data/docs/FilterValue.md +15 -4
- data/docs/FiltersApi.md +71 -33
- data/docs/GetAssetInputInfoResponse.md +13 -3
- data/docs/GetAssetOrLiveStreamIdResponse.md +13 -3
- data/docs/GetAssetOrLiveStreamIdResponseData.md +17 -5
- data/docs/GetAssetOrLiveStreamIdResponseDataObject.md +15 -4
- data/docs/GetAssetPlaybackIDResponse.md +13 -3
- data/docs/GetMetricTimeseriesDataResponse.md +17 -5
- data/docs/GetOverallValuesResponse.md +17 -5
- data/docs/GetRealTimeBreakdownResponse.md +17 -5
- data/docs/GetRealTimeHistogramTimeseriesResponse.md +19 -6
- data/docs/GetRealTimeHistogramTimeseriesResponseMeta.md +13 -3
- data/docs/GetRealTimeTimeseriesResponse.md +17 -5
- data/docs/Incident.md +53 -23
- data/docs/IncidentBreakdown.md +17 -5
- data/docs/IncidentNotification.md +17 -5
- data/docs/IncidentNotificationRule.md +21 -7
- data/docs/IncidentResponse.md +15 -4
- data/docs/IncidentsApi.md +115 -59
- data/docs/InputFile.md +15 -4
- data/docs/InputInfo.md +15 -4
- data/docs/InputSettings.md +31 -12
- data/docs/InputSettingsOverlaySettings.md +25 -9
- data/docs/InputTrack.md +29 -11
- data/docs/Insight.md +23 -8
- data/docs/ListAllMetricValuesResponse.md +17 -5
- data/docs/ListAssetsResponse.md +13 -3
- data/docs/ListBreakdownValuesResponse.md +17 -5
- data/docs/ListDeliveryUsageResponse.md +19 -6
- data/docs/ListDimensionValuesResponse.md +17 -5
- data/docs/ListDimensionsResponse.md +17 -5
- data/docs/ListErrorsResponse.md +17 -5
- data/docs/ListExportsResponse.md +17 -5
- data/docs/ListFilterValuesResponse.md +17 -5
- data/docs/ListFiltersResponse.md +17 -5
- data/docs/ListFiltersResponseData.md +15 -4
- data/docs/ListIncidentsResponse.md +17 -5
- data/docs/ListInsightsResponse.md +17 -5
- data/docs/ListLiveStreamsResponse.md +13 -3
- data/docs/ListRealTimeDimensionsResponse.md +17 -5
- data/docs/ListRealTimeDimensionsResponseData.md +15 -4
- data/docs/ListRealTimeMetricsResponse.md +17 -5
- data/docs/ListRelatedIncidentsResponse.md +17 -5
- data/docs/ListSigningKeysResponse.md +13 -3
- data/docs/ListUploadsResponse.md +13 -3
- data/docs/ListVideoViewsResponse.md +17 -5
- data/docs/LiveStream.md +37 -15
- data/docs/LiveStreamResponse.md +13 -3
- data/docs/LiveStreamsApi.md +418 -170
- data/docs/Metric.md +21 -7
- data/docs/MetricsApi.md +206 -112
- data/docs/NotificationRule.md +17 -5
- data/docs/OverallValues.md +19 -6
- data/docs/PlaybackID.md +15 -4
- data/docs/PlaybackIDApi.md +34 -16
- data/docs/PlaybackPolicy.md +10 -2
- data/docs/RealTimeApi.md +172 -76
- data/docs/RealTimeBreakdownValue.md +21 -7
- data/docs/RealTimeHistogramTimeseriesBucket.md +15 -4
- data/docs/RealTimeHistogramTimeseriesBucketValues.md +15 -4
- data/docs/RealTimeHistogramTimeseriesDatapoint.md +25 -9
- data/docs/RealTimeTimeseriesDatapoint.md +17 -5
- data/docs/Score.md +23 -8
- data/docs/SignalLiveStreamCompleteResponse.md +13 -3
- data/docs/SigningKey.md +17 -5
- data/docs/SigningKeyResponse.md +13 -3
- data/docs/SimulcastTarget.md +21 -7
- data/docs/SimulcastTargetResponse.md +13 -3
- data/docs/Track.md +37 -15
- data/docs/URLSigningKeysApi.md +127 -51
- data/docs/UpdateAssetMP4SupportRequest.md +13 -3
- data/docs/UpdateAssetMasterAccessRequest.md +13 -3
- data/docs/Upload.md +29 -11
- data/docs/UploadError.md +15 -4
- data/docs/UploadResponse.md +13 -3
- data/docs/VideoView.md +235 -114
- data/docs/VideoViewEvent.md +19 -6
- data/docs/VideoViewResponse.md +15 -4
- data/docs/VideoViewsApi.md +76 -39
- data/gen/.gitignore +7 -0
- data/gen/Makefile +31 -0
- data/gen/generator-config.json +11 -0
- data/gen/openapitools.json +7 -0
- data/gen/package.json +17 -0
- data/gen/templates/Gemfile.mustache +11 -0
- data/gen/templates/README.mustache +158 -0
- data/gen/templates/Rakefile.mustache +10 -0
- data/gen/templates/api.mustache +206 -0
- data/gen/templates/api_client.mustache +264 -0
- data/gen/templates/api_client_faraday_partial.mustache +138 -0
- data/gen/templates/api_client_spec.mustache +220 -0
- data/gen/templates/api_client_typhoeus_partial.mustache +183 -0
- data/gen/templates/api_doc.mustache +118 -0
- data/gen/templates/api_error.mustache +67 -0
- data/gen/templates/api_info.mustache +12 -0
- data/gen/templates/api_test.mustache +47 -0
- data/gen/templates/base_object.mustache +120 -0
- data/gen/templates/configuration.mustache +349 -0
- data/gen/templates/configuration_spec.mustache +34 -0
- data/gen/templates/configuration_tls_faraday_partial.mustache +29 -0
- data/gen/templates/configuration_tls_typhoeus_partial.mustache +34 -0
- data/gen/templates/gem.mustache +40 -0
- data/gen/templates/gemspec.mustache +35 -0
- data/gen/templates/gitignore.mustache +39 -0
- data/gen/templates/model.mustache +26 -0
- data/gen/templates/model_doc.mustache +12 -0
- data/gen/templates/model_test.mustache +77 -0
- data/gen/templates/partial_model_enum_class.mustache +20 -0
- data/gen/templates/partial_model_generic.mustache +371 -0
- data/gen/templates/partial_model_generic_doc.mustache +28 -0
- data/gen/templates/partial_oneof_module.mustache +137 -0
- data/gen/templates/partial_oneof_module_doc.mustache +92 -0
- data/gen/templates/rspec.mustache +2 -0
- data/gen/templates/rubocop.mustache +148 -0
- data/gen/templates/spec_helper.mustache +103 -0
- data/gen/templates/version.mustache +7 -0
- data/gen/yarn.lock +1878 -0
- data/lib/mux_ruby.rb +9 -2
- data/lib/mux_ruby/api/assets_api.rb +279 -150
- data/lib/mux_ruby/api/delivery_usage_api.rb +28 -12
- data/lib/mux_ruby/api/dimensions_api.rb +55 -29
- data/lib/mux_ruby/api/direct_uploads_api.rb +90 -44
- data/lib/mux_ruby/api/errors_api.rb +32 -16
- data/lib/mux_ruby/api/exports_api.rb +28 -12
- data/lib/mux_ruby/api/filters_api.rb +53 -27
- data/lib/mux_ruby/api/incidents_api.rb +88 -46
- data/lib/mux_ruby/api/live_streams_api.rb +299 -157
- data/lib/mux_ruby/api/metrics_api.rb +175 -104
- data/lib/mux_ruby/api/playback_id_api.rb +31 -15
- data/lib/mux_ruby/api/real_time_api.rb +139 -77
- data/lib/mux_ruby/api/url_signing_keys_api.rb +89 -42
- data/lib/mux_ruby/api/video_views_api.rb +56 -29
- data/lib/mux_ruby/api_client.rb +94 -79
- data/lib/mux_ruby/api_error.rb +35 -7
- data/lib/mux_ruby/configuration.rb +50 -14
- data/lib/mux_ruby/models/abridged_video_view.rb +58 -24
- data/lib/mux_ruby/models/asset.rb +88 -61
- data/lib/mux_ruby/models/asset_errors.rb +50 -15
- data/lib/mux_ruby/models/asset_master.rb +52 -17
- data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +70 -35
- data/lib/mux_ruby/models/asset_recording_times.rb +50 -16
- data/lib/mux_ruby/models/asset_response.rb +48 -14
- data/lib/mux_ruby/models/asset_static_renditions.rb +53 -17
- data/lib/mux_ruby/models/asset_static_renditions_files.rb +58 -23
- data/lib/mux_ruby/models/breakdown_value.rb +52 -18
- data/lib/mux_ruby/models/create_asset_request.rb +64 -30
- data/lib/mux_ruby/models/create_live_stream_request.rb +57 -22
- data/lib/mux_ruby/models/create_playback_id_request.rb +48 -14
- data/lib/mux_ruby/models/create_playback_id_response.rb +48 -14
- data/lib/mux_ruby/models/create_simulcast_target_request.rb +50 -16
- data/lib/mux_ruby/models/create_track_request.rb +59 -25
- data/lib/mux_ruby/models/create_track_response.rb +48 -14
- data/lib/mux_ruby/models/create_upload_request.rb +52 -18
- data/lib/mux_ruby/models/delivery_report.rb +106 -21
- data/lib/mux_ruby/models/dimension_value.rb +49 -15
- data/lib/mux_ruby/models/disable_live_stream_response.rb +48 -14
- data/lib/mux_ruby/models/enable_live_stream_response.rb +48 -14
- data/lib/mux_ruby/models/error.rb +63 -21
- data/lib/mux_ruby/models/filter_value.rb +49 -15
- data/lib/mux_ruby/models/get_asset_input_info_response.rb +48 -14
- data/lib/mux_ruby/models/get_asset_or_live_stream_id_response.rb +48 -14
- data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data.rb +50 -16
- data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data_object.rb +51 -17
- data/lib/mux_ruby/models/get_asset_playback_id_response.rb +48 -14
- data/lib/mux_ruby/models/get_metric_timeseries_data_response.rb +50 -16
- data/lib/mux_ruby/models/get_overall_values_response.rb +50 -16
- data/lib/mux_ruby/models/get_real_time_breakdown_response.rb +50 -16
- data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response.rb +51 -17
- data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response_meta.rb +48 -14
- data/lib/mux_ruby/models/get_real_time_timeseries_response.rb +50 -16
- data/lib/mux_ruby/models/incident.rb +68 -34
- data/lib/mux_ruby/models/incident_breakdown.rb +50 -16
- data/lib/mux_ruby/models/incident_notification.rb +50 -16
- data/lib/mux_ruby/models/incident_notification_rule.rb +52 -18
- data/lib/mux_ruby/models/incident_response.rb +49 -15
- data/lib/mux_ruby/models/input_file.rb +49 -15
- data/lib/mux_ruby/models/input_info.rb +49 -15
- data/lib/mux_ruby/models/input_settings.rb +64 -30
- data/lib/mux_ruby/models/input_settings_overlay_settings.rb +58 -24
- data/lib/mux_ruby/models/input_track.rb +56 -22
- data/lib/mux_ruby/models/insight.rb +53 -19
- data/lib/mux_ruby/models/list_all_metric_values_response.rb +50 -16
- data/lib/mux_ruby/models/list_assets_response.rb +48 -14
- data/lib/mux_ruby/models/list_breakdown_values_response.rb +50 -16
- data/lib/mux_ruby/models/list_delivery_usage_response.rb +51 -17
- data/lib/mux_ruby/models/list_dimension_values_response.rb +50 -16
- data/lib/mux_ruby/models/list_dimensions_response.rb +50 -16
- data/lib/mux_ruby/models/list_errors_response.rb +50 -16
- data/lib/mux_ruby/models/list_exports_response.rb +50 -16
- data/lib/mux_ruby/models/list_filter_values_response.rb +50 -16
- data/lib/mux_ruby/models/list_filters_response.rb +50 -16
- data/lib/mux_ruby/models/list_filters_response_data.rb +49 -15
- data/lib/mux_ruby/models/list_incidents_response.rb +50 -16
- data/lib/mux_ruby/models/list_insights_response.rb +50 -16
- data/lib/mux_ruby/models/list_live_streams_response.rb +48 -14
- data/lib/mux_ruby/models/list_real_time_dimensions_response.rb +50 -16
- data/lib/mux_ruby/models/list_real_time_dimensions_response_data.rb +49 -15
- data/lib/mux_ruby/models/list_real_time_metrics_response.rb +50 -16
- data/lib/mux_ruby/models/list_related_incidents_response.rb +50 -16
- data/lib/mux_ruby/models/list_signing_keys_response.rb +48 -14
- data/lib/mux_ruby/models/list_uploads_response.rb +48 -14
- data/lib/mux_ruby/models/list_video_views_response.rb +50 -16
- data/lib/mux_ruby/models/live_stream.rb +110 -28
- data/lib/mux_ruby/models/live_stream_response.rb +48 -14
- data/lib/mux_ruby/models/metric.rb +52 -18
- data/lib/mux_ruby/models/notification_rule.rb +50 -16
- data/lib/mux_ruby/models/overall_values.rb +51 -17
- data/lib/mux_ruby/models/playback_id.rb +49 -15
- data/lib/mux_ruby/models/playback_policy.rb +12 -6
- data/lib/mux_ruby/models/real_time_breakdown_value.rb +52 -18
- data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket.rb +50 -16
- data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket_values.rb +49 -15
- data/lib/mux_ruby/models/real_time_histogram_timeseries_datapoint.rb +54 -20
- data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb +50 -16
- data/lib/mux_ruby/models/score.rb +53 -19
- data/lib/mux_ruby/models/signal_live_stream_complete_response.rb +48 -14
- data/lib/mux_ruby/models/signing_key.rb +53 -16
- data/lib/mux_ruby/models/signing_key_response.rb +48 -14
- data/lib/mux_ruby/models/simulcast_target.rb +54 -20
- data/lib/mux_ruby/models/simulcast_target_response.rb +48 -14
- data/lib/mux_ruby/models/track.rb +67 -33
- data/lib/mux_ruby/models/update_asset_master_access_request.rb +50 -16
- data/lib/mux_ruby/models/update_asset_mp4_support_request.rb +50 -16
- data/lib/mux_ruby/models/upload.rb +61 -25
- data/lib/mux_ruby/models/upload_error.rb +51 -15
- data/lib/mux_ruby/models/upload_response.rb +48 -14
- data/lib/mux_ruby/models/video_view.rb +166 -132
- data/lib/mux_ruby/models/video_view_event.rb +51 -17
- data/lib/mux_ruby/models/video_view_response.rb +49 -15
- data/lib/mux_ruby/version.rb +10 -3
- data/mux_ruby.gemspec +15 -17
- data/spec/api_client_spec.rb +10 -3
- data/spec/configuration_spec.rb +9 -2
- data/spec/spec_helper.rb +9 -2
- metadata +139 -242
@@ -0,0 +1,206 @@
|
|
1
|
+
=begin
|
2
|
+
{{> api_info}}
|
3
|
+
=end
|
4
|
+
|
5
|
+
require 'cgi'
|
6
|
+
|
7
|
+
module {{moduleName}}
|
8
|
+
{{#operations}}
|
9
|
+
class {{classname}}
|
10
|
+
attr_accessor :api_client
|
11
|
+
|
12
|
+
def initialize(api_client = ApiClient.default)
|
13
|
+
@api_client = api_client
|
14
|
+
end
|
15
|
+
{{#operation}}
|
16
|
+
{{#summary}}
|
17
|
+
# {{{summary}}}
|
18
|
+
{{/summary}}
|
19
|
+
{{#notes}}
|
20
|
+
# {{{notes}}}
|
21
|
+
{{/notes}}
|
22
|
+
{{#allParams}}{{#required}} # @param {{paramName}} [{{{dataType}}}] {{description}}
|
23
|
+
{{/required}}{{/allParams}} # @param [Hash] opts the optional parameters
|
24
|
+
{{#allParams}}{{^required}} # @option opts [{{{dataType}}}] :{{paramName}} {{description}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
|
25
|
+
{{/required}}{{/allParams}} # @return [{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}nil{{/returnType}}]
|
26
|
+
def {{operationId}}({{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}opts = {})
|
27
|
+
{{#returnType}}data, _status_code, _headers = {{/returnType}}{{operationId}}_with_http_info({{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}opts)
|
28
|
+
{{#returnType}}data{{/returnType}}{{^returnType}}nil{{/returnType}}
|
29
|
+
end
|
30
|
+
|
31
|
+
{{#summary}}
|
32
|
+
# {{summary}}
|
33
|
+
{{/summary}}
|
34
|
+
{{#notes}}
|
35
|
+
# {{notes}}
|
36
|
+
{{/notes}}
|
37
|
+
{{#allParams}}{{#required}} # @param {{paramName}} [{{{dataType}}}] {{description}}
|
38
|
+
{{/required}}{{/allParams}} # @param [Hash] opts the optional parameters
|
39
|
+
{{#allParams}}{{^required}} # @option opts [{{{dataType}}}] :{{paramName}} {{description}}
|
40
|
+
{{/required}}{{/allParams}} # @return [Array<({{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}nil{{/returnType}}, Integer, Hash)>] {{#returnType}}{{{returnType}}} data{{/returnType}}{{^returnType}}nil{{/returnType}}, response status code and response headers
|
41
|
+
def {{operationId}}_with_http_info({{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}opts = {})
|
42
|
+
if @api_client.config.debugging
|
43
|
+
@api_client.config.logger.debug 'Calling API: {{classname}}.{{operationId}} ...'
|
44
|
+
end
|
45
|
+
{{#allParams}}
|
46
|
+
{{^isNullable}}
|
47
|
+
{{#required}}
|
48
|
+
# verify the required parameter '{{paramName}}' is set
|
49
|
+
if @api_client.config.client_side_validation && {{{paramName}}}.nil?
|
50
|
+
fail ArgumentError, "Missing the required parameter '{{paramName}}' when calling {{classname}}.{{operationId}}"
|
51
|
+
end
|
52
|
+
{{#isEnum}}
|
53
|
+
{{^isContainer}}
|
54
|
+
# verify enum value
|
55
|
+
allowable_values = [{{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}]
|
56
|
+
if @api_client.config.client_side_validation && !allowable_values.include?({{{paramName}}})
|
57
|
+
fail ArgumentError, "invalid value for \"{{{paramName}}}\", must be one of #{allowable_values}"
|
58
|
+
end
|
59
|
+
{{/isContainer}}
|
60
|
+
{{/isEnum}}
|
61
|
+
{{/required}}
|
62
|
+
{{/isNullable}}
|
63
|
+
{{^required}}
|
64
|
+
{{#isEnum}}
|
65
|
+
{{#collectionFormat}}
|
66
|
+
allowable_values = [{{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}]
|
67
|
+
if @api_client.config.client_side_validation && opts[:'{{{paramName}}}'] && !opts[:'{{{paramName}}}'].all? { |item| allowable_values.include?(item) }
|
68
|
+
fail ArgumentError, "invalid value for \"{{{paramName}}}\", must include one of #{allowable_values}"
|
69
|
+
end
|
70
|
+
{{/collectionFormat}}
|
71
|
+
{{^collectionFormat}}
|
72
|
+
allowable_values = [{{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}]
|
73
|
+
if @api_client.config.client_side_validation && opts[:'{{{paramName}}}'] && !allowable_values.include?(opts[:'{{{paramName}}}'])
|
74
|
+
fail ArgumentError, "invalid value for \"{{{paramName}}}\", must be one of #{allowable_values}"
|
75
|
+
end
|
76
|
+
{{/collectionFormat}}
|
77
|
+
{{/isEnum}}
|
78
|
+
{{/required}}
|
79
|
+
{{#hasValidation}}
|
80
|
+
{{#maxLength}}
|
81
|
+
if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}.to_s.length > {{{maxLength}}}
|
82
|
+
fail ArgumentError, 'invalid value for "{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:"{{{paramName}}}"]{{/required}}" when calling {{classname}}.{{operationId}}, the character length must be smaller than or equal to {{{maxLength}}}.'
|
83
|
+
end
|
84
|
+
|
85
|
+
{{/maxLength}}
|
86
|
+
{{#minLength}}
|
87
|
+
if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}.to_s.length < {{{minLength}}}
|
88
|
+
fail ArgumentError, 'invalid value for "{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:"{{{paramName}}}"]{{/required}}" when calling {{classname}}.{{operationId}}, the character length must be great than or equal to {{{minLength}}}.'
|
89
|
+
end
|
90
|
+
|
91
|
+
{{/minLength}}
|
92
|
+
{{#maximum}}
|
93
|
+
if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}} >{{#exclusiveMaximum}}={{/exclusiveMaximum}} {{{maximum}}}
|
94
|
+
fail ArgumentError, 'invalid value for "{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:"{{{paramName}}}"]{{/required}}" when calling {{classname}}.{{operationId}}, must be smaller than {{^exclusiveMaximum}}or equal to {{/exclusiveMaximum}}{{{maximum}}}.'
|
95
|
+
end
|
96
|
+
|
97
|
+
{{/maximum}}
|
98
|
+
{{#minimum}}
|
99
|
+
if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}} <{{#exclusiveMinimum}}={{/exclusiveMinimum}} {{{minimum}}}
|
100
|
+
fail ArgumentError, 'invalid value for "{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:"{{{paramName}}}"]{{/required}}" when calling {{classname}}.{{operationId}}, must be greater than {{^exclusiveMinimum}}or equal to {{/exclusiveMinimum}}{{{minimum}}}.'
|
101
|
+
end
|
102
|
+
|
103
|
+
{{/minimum}}
|
104
|
+
{{#pattern}}
|
105
|
+
pattern = Regexp.new({{{pattern}}})
|
106
|
+
if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}} !~ pattern
|
107
|
+
fail ArgumentError, "invalid value for '{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:\"{{{paramName}}}\"]{{/required}}' when calling {{classname}}.{{operationId}}, must conform to the pattern #{pattern}."
|
108
|
+
end
|
109
|
+
|
110
|
+
{{/pattern}}
|
111
|
+
{{#maxItems}}
|
112
|
+
if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}.length > {{{maxItems}}}
|
113
|
+
fail ArgumentError, 'invalid value for "{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:"{{{paramName}}}"]{{/required}}" when calling {{classname}}.{{operationId}}, number of items must be less than or equal to {{{maxItems}}}.'
|
114
|
+
end
|
115
|
+
|
116
|
+
{{/maxItems}}
|
117
|
+
{{#minItems}}
|
118
|
+
if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}.length < {{{minItems}}}
|
119
|
+
fail ArgumentError, 'invalid value for "{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:"{{{paramName}}}"]{{/required}}" when calling {{classname}}.{{operationId}}, number of items must be greater than or equal to {{{minItems}}}.'
|
120
|
+
end
|
121
|
+
|
122
|
+
{{/minItems}}
|
123
|
+
{{/hasValidation}}
|
124
|
+
{{/allParams}}
|
125
|
+
# resource path
|
126
|
+
local_var_path = '{{{path}}}'{{#pathParams}}.sub('{' + '{{baseName}}' + '}', CGI.escape({{paramName}}.to_s){{^strictSpecBehavior}}.gsub('%2F', '/'){{/strictSpecBehavior}}){{/pathParams}}
|
127
|
+
|
128
|
+
# query parameters
|
129
|
+
query_params = opts[:query_params] || {}
|
130
|
+
{{#queryParams}}
|
131
|
+
{{#required}}
|
132
|
+
query_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param({{{paramName}}}, :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}{{{paramName}}}{{/collectionFormat}}
|
133
|
+
{{/required}}
|
134
|
+
{{/queryParams}}
|
135
|
+
{{#queryParams}}
|
136
|
+
{{^required}}
|
137
|
+
query_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param(opts[:'{{{paramName}}}'], :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}opts[:'{{{paramName}}}']{{/collectionFormat}} if !opts[:'{{{paramName}}}'].nil?
|
138
|
+
{{/required}}
|
139
|
+
{{/queryParams}}
|
140
|
+
|
141
|
+
# header parameters
|
142
|
+
header_params = opts[:header_params] || {}
|
143
|
+
{{#hasProduces}}
|
144
|
+
# HTTP header 'Accept' (if needed)
|
145
|
+
header_params['Accept'] = @api_client.select_header_accept([{{#produces}}'{{{mediaType}}}'{{^-last}}, {{/-last}}{{/produces}}])
|
146
|
+
{{/hasProduces}}
|
147
|
+
{{#hasConsumes}}
|
148
|
+
# HTTP header 'Content-Type'
|
149
|
+
header_params['Content-Type'] = @api_client.select_header_content_type([{{#consumes}}'{{{mediaType}}}'{{^-last}}, {{/-last}}{{/consumes}}])
|
150
|
+
{{/hasConsumes}}
|
151
|
+
{{#headerParams}}
|
152
|
+
{{#required}}
|
153
|
+
header_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param({{{paramName}}}, :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}{{{paramName}}}{{/collectionFormat}}
|
154
|
+
{{/required}}
|
155
|
+
{{/headerParams}}
|
156
|
+
{{#headerParams}}
|
157
|
+
{{^required}}
|
158
|
+
header_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param(opts[:'{{{paramName}}}'], :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}opts[:'{{{paramName}}}']{{/collectionFormat}} if !opts[:'{{{paramName}}}'].nil?
|
159
|
+
{{/required}}
|
160
|
+
{{/headerParams}}
|
161
|
+
|
162
|
+
# form parameters
|
163
|
+
form_params = opts[:form_params] || {}
|
164
|
+
{{#formParams}}
|
165
|
+
{{#required}}
|
166
|
+
form_params['{{baseName}}'] = {{#collectionFormat}}@api_client.build_collection_param({{{paramName}}}, :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}{{{paramName}}}{{/collectionFormat}}
|
167
|
+
{{/required}}
|
168
|
+
{{/formParams}}
|
169
|
+
{{#formParams}}
|
170
|
+
{{^required}}
|
171
|
+
form_params['{{baseName}}'] = {{#collectionFormat}}@api_client.build_collection_param(opts[:'{{{paramName}}}'], :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}opts[:'{{{paramName}}}']{{/collectionFormat}} if !opts[:'{{paramName}}'].nil?
|
172
|
+
{{/required}}
|
173
|
+
{{/formParams}}
|
174
|
+
|
175
|
+
# http body (model)
|
176
|
+
post_body = opts[:debug_body]{{#bodyParam}} || @api_client.object_to_http_body({{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}){{/bodyParam}}
|
177
|
+
|
178
|
+
# return_type
|
179
|
+
return_type = opts[:debug_return_type]{{#returnType}} || '{{{returnType}}}'{{/returnType}}
|
180
|
+
|
181
|
+
# auth_names
|
182
|
+
auth_names = opts[:debug_auth_names] || [{{#authMethods}}'{{name}}'{{^-last}}, {{/-last}}{{/authMethods}}]
|
183
|
+
|
184
|
+
new_options = opts.merge(
|
185
|
+
:operation => :"{{classname}}.{{operationId}}",
|
186
|
+
:header_params => header_params,
|
187
|
+
:query_params => query_params,
|
188
|
+
:form_params => form_params,
|
189
|
+
:body => post_body,
|
190
|
+
:auth_names => auth_names,
|
191
|
+
:return_type => return_type
|
192
|
+
)
|
193
|
+
|
194
|
+
data, status_code, headers = @api_client.call_api(:{{httpMethod}}, local_var_path, new_options)
|
195
|
+
if @api_client.config.debugging
|
196
|
+
@api_client.config.logger.debug "API called: {{classname}}#{{operationId}}\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
197
|
+
end
|
198
|
+
return data, status_code, headers
|
199
|
+
end
|
200
|
+
{{^-last}}
|
201
|
+
|
202
|
+
{{/-last}}
|
203
|
+
{{/operation}}
|
204
|
+
end
|
205
|
+
{{/operations}}
|
206
|
+
end
|
@@ -0,0 +1,264 @@
|
|
1
|
+
=begin
|
2
|
+
{{> api_info}}
|
3
|
+
=end
|
4
|
+
|
5
|
+
require 'date'
|
6
|
+
require 'json'
|
7
|
+
require 'logger'
|
8
|
+
require 'tempfile'
|
9
|
+
require 'time'
|
10
|
+
{{^isFaraday}}
|
11
|
+
require 'typhoeus'
|
12
|
+
{{/isFaraday}}
|
13
|
+
{{#isFaraday}}
|
14
|
+
require 'faraday'
|
15
|
+
{{/isFaraday}}
|
16
|
+
|
17
|
+
module {{moduleName}}
|
18
|
+
class ApiClient
|
19
|
+
# The Configuration object holding settings to be used in the API client.
|
20
|
+
attr_accessor :config
|
21
|
+
|
22
|
+
# Defines the headers to be used in HTTP requests of all API calls by default.
|
23
|
+
#
|
24
|
+
# @return [Hash]
|
25
|
+
attr_accessor :default_headers
|
26
|
+
|
27
|
+
# Initializes the ApiClient
|
28
|
+
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
29
|
+
def initialize(config = Configuration.default)
|
30
|
+
@config = config
|
31
|
+
@user_agent = "Mux Ruby | #{VERSION}"
|
32
|
+
@default_headers = {
|
33
|
+
'Content-Type' => 'application/json',
|
34
|
+
'User-Agent' => @user_agent
|
35
|
+
}
|
36
|
+
end
|
37
|
+
|
38
|
+
def self.default
|
39
|
+
@@default ||= ApiClient.new
|
40
|
+
end
|
41
|
+
|
42
|
+
{{^isFaraday}}
|
43
|
+
{{> api_client_typhoeus_partial}}
|
44
|
+
{{/isFaraday}}
|
45
|
+
{{#isFaraday}}
|
46
|
+
{{> api_client_faraday_partial}}
|
47
|
+
{{/isFaraday}}
|
48
|
+
# Check if the given MIME is a JSON MIME.
|
49
|
+
# JSON MIME examples:
|
50
|
+
# application/json
|
51
|
+
# application/json; charset=UTF8
|
52
|
+
# APPLICATION/JSON
|
53
|
+
# */*
|
54
|
+
# @param [String] mime MIME
|
55
|
+
# @return [Boolean] True if the MIME is application/json
|
56
|
+
def json_mime?(mime)
|
57
|
+
(mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
|
58
|
+
end
|
59
|
+
|
60
|
+
# Deserialize the response to the given return type.
|
61
|
+
#
|
62
|
+
# @param [Response] response HTTP response
|
63
|
+
# @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
|
64
|
+
def deserialize(response, return_type)
|
65
|
+
body = response.body
|
66
|
+
|
67
|
+
# handle file downloading - return the File instance processed in request callbacks
|
68
|
+
# note that response body is empty when the file is written in chunks in request on_body callback
|
69
|
+
{{^isFaraday}}
|
70
|
+
return @tempfile if return_type == 'File'
|
71
|
+
{{/isFaraday}}
|
72
|
+
{{#isFaraday}}
|
73
|
+
if return_type == 'File'
|
74
|
+
content_disposition = response.headers['Content-Disposition']
|
75
|
+
if content_disposition && content_disposition =~ /filename=/i
|
76
|
+
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
77
|
+
prefix = sanitize_filename(filename)
|
78
|
+
else
|
79
|
+
prefix = 'download-'
|
80
|
+
end
|
81
|
+
prefix = prefix + '-' unless prefix.end_with?('-')
|
82
|
+
encoding = body.encoding
|
83
|
+
@tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
84
|
+
@tempfile.write(@stream.join.force_encoding(encoding))
|
85
|
+
@tempfile.close
|
86
|
+
@config.logger.info "Temp file written to #{@tempfile.path}, please copy the file to a proper folder "\
|
87
|
+
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
88
|
+
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
89
|
+
"explicitly with `tempfile.delete`"
|
90
|
+
return @tempfile
|
91
|
+
end
|
92
|
+
{{/isFaraday}}
|
93
|
+
|
94
|
+
return nil if body.nil? || body.empty?
|
95
|
+
|
96
|
+
# return response body directly for String return type
|
97
|
+
return body if return_type == 'String'
|
98
|
+
|
99
|
+
# ensuring a default content type
|
100
|
+
content_type = response.headers['Content-Type'] || 'application/json'
|
101
|
+
|
102
|
+
fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
|
103
|
+
|
104
|
+
begin
|
105
|
+
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
106
|
+
rescue JSON::ParserError => e
|
107
|
+
if %w(String Date Time).include?(return_type)
|
108
|
+
data = body
|
109
|
+
else
|
110
|
+
raise e
|
111
|
+
end
|
112
|
+
end
|
113
|
+
|
114
|
+
convert_to_type data, return_type
|
115
|
+
end
|
116
|
+
|
117
|
+
# Convert data to the given return type.
|
118
|
+
# @param [Object] data Data to be converted
|
119
|
+
# @param [String] return_type Return type
|
120
|
+
# @return [Mixed] Data in a particular type
|
121
|
+
def convert_to_type(data, return_type)
|
122
|
+
return nil if data.nil?
|
123
|
+
case return_type
|
124
|
+
when 'String'
|
125
|
+
data.to_s
|
126
|
+
when 'Integer'
|
127
|
+
data.to_i
|
128
|
+
when 'Float'
|
129
|
+
data.to_f
|
130
|
+
when 'Boolean'
|
131
|
+
data == true
|
132
|
+
when 'Time'
|
133
|
+
# parse date time (expecting ISO 8601 format)
|
134
|
+
Time.parse data
|
135
|
+
when 'Date'
|
136
|
+
# parse date time (expecting ISO 8601 format)
|
137
|
+
Date.parse data
|
138
|
+
when 'Object'
|
139
|
+
# generic object (usually a Hash), return directly
|
140
|
+
data
|
141
|
+
when /\AArray<(.+)>\z/
|
142
|
+
# e.g. Array<Pet>
|
143
|
+
sub_type = $1
|
144
|
+
data.map { |item| convert_to_type(item, sub_type) }
|
145
|
+
when /\AHash\<String, (.+)\>\z/
|
146
|
+
# e.g. Hash<String, Integer>
|
147
|
+
sub_type = $1
|
148
|
+
{}.tap do |hash|
|
149
|
+
data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
|
150
|
+
end
|
151
|
+
else
|
152
|
+
# models (e.g. Pet) or oneOf
|
153
|
+
klass = {{moduleName}}.const_get(return_type)
|
154
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
|
155
|
+
end
|
156
|
+
end
|
157
|
+
|
158
|
+
# Sanitize filename by removing path.
|
159
|
+
# e.g. ../../sun.gif becomes sun.gif
|
160
|
+
#
|
161
|
+
# @param [String] filename the filename to be sanitized
|
162
|
+
# @return [String] the sanitized filename
|
163
|
+
def sanitize_filename(filename)
|
164
|
+
filename.gsub(/.*[\/\\]/, '')
|
165
|
+
end
|
166
|
+
|
167
|
+
def build_request_url(path, opts = {})
|
168
|
+
# Add leading and trailing slashes to path
|
169
|
+
path = "/#{path}".gsub(/\/+/, '/')
|
170
|
+
@config.base_url(opts[:operation]) + path
|
171
|
+
end
|
172
|
+
|
173
|
+
# Update hearder and query params based on authentication settings.
|
174
|
+
#
|
175
|
+
# @param [Hash] header_params Header parameters
|
176
|
+
# @param [Hash] query_params Query parameters
|
177
|
+
# @param [String] auth_names Authentication scheme name
|
178
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
179
|
+
Array(auth_names).each do |auth_name|
|
180
|
+
auth_setting = @config.auth_settings[auth_name]
|
181
|
+
next unless auth_setting
|
182
|
+
case auth_setting[:in]
|
183
|
+
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
184
|
+
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
185
|
+
else fail ArgumentError, 'Authentication token must be in `query` or `header`'
|
186
|
+
end
|
187
|
+
end
|
188
|
+
end
|
189
|
+
|
190
|
+
# Sets user agent in HTTP header
|
191
|
+
#
|
192
|
+
# @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
|
193
|
+
def user_agent=(user_agent)
|
194
|
+
@user_agent = user_agent
|
195
|
+
@default_headers['User-Agent'] = @user_agent
|
196
|
+
end
|
197
|
+
|
198
|
+
# Return Accept header based on an array of accepts provided.
|
199
|
+
# @param [Array] accepts array for Accept
|
200
|
+
# @return [String] the Accept header (e.g. application/json)
|
201
|
+
def select_header_accept(accepts)
|
202
|
+
return nil if accepts.nil? || accepts.empty?
|
203
|
+
# use JSON when present, otherwise use all of the provided
|
204
|
+
json_accept = accepts.find { |s| json_mime?(s) }
|
205
|
+
json_accept || accepts.join(',')
|
206
|
+
end
|
207
|
+
|
208
|
+
# Return Content-Type header based on an array of content types provided.
|
209
|
+
# @param [Array] content_types array for Content-Type
|
210
|
+
# @return [String] the Content-Type header (e.g. application/json)
|
211
|
+
def select_header_content_type(content_types)
|
212
|
+
# use application/json by default
|
213
|
+
return 'application/json' if content_types.nil? || content_types.empty?
|
214
|
+
# use JSON when present, otherwise use the first one
|
215
|
+
json_content_type = content_types.find { |s| json_mime?(s) }
|
216
|
+
json_content_type || content_types.first
|
217
|
+
end
|
218
|
+
|
219
|
+
# Convert object (array, hash, object, etc) to JSON string.
|
220
|
+
# @param [Object] model object to be converted into JSON string
|
221
|
+
# @return [String] JSON string representation of the object
|
222
|
+
def object_to_http_body(model)
|
223
|
+
return model if model.nil? || model.is_a?(String)
|
224
|
+
local_body = nil
|
225
|
+
if model.is_a?(Array)
|
226
|
+
local_body = model.map { |m| object_to_hash(m) }
|
227
|
+
else
|
228
|
+
local_body = object_to_hash(model)
|
229
|
+
end
|
230
|
+
local_body.to_json
|
231
|
+
end
|
232
|
+
|
233
|
+
# Convert object(non-array) to hash.
|
234
|
+
# @param [Object] obj object to be converted into JSON string
|
235
|
+
# @return [String] JSON string representation of the object
|
236
|
+
def object_to_hash(obj)
|
237
|
+
if obj.respond_to?(:to_hash)
|
238
|
+
obj.to_hash
|
239
|
+
else
|
240
|
+
obj
|
241
|
+
end
|
242
|
+
end
|
243
|
+
|
244
|
+
# Build parameter value according to the given collection format.
|
245
|
+
# @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
|
246
|
+
def build_collection_param(param, collection_format)
|
247
|
+
case collection_format
|
248
|
+
when :csv
|
249
|
+
param.join(',')
|
250
|
+
when :ssv
|
251
|
+
param.join(' ')
|
252
|
+
when :tsv
|
253
|
+
param.join("\t")
|
254
|
+
when :pipes
|
255
|
+
param.join('|')
|
256
|
+
when :multi
|
257
|
+
# return the array directly as typhoeus will handle it as expected
|
258
|
+
param
|
259
|
+
else
|
260
|
+
fail "unknown collection format: #{collection_format.inspect}"
|
261
|
+
end
|
262
|
+
end
|
263
|
+
end
|
264
|
+
end
|