wsc_sdk 1.3.1
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.
- checksums.yaml +7 -0
- data/.circleci/config.yml +146 -0
- data/.circleci/docker/build/Dockerfile +3 -0
- data/.circleci/helpers/add_preamble.rb +29 -0
- data/.circleci/helpers/build_docs.sh +5 -0
- data/.circleci/helpers/build_gem.sh +5 -0
- data/.circleci/helpers/debundle-context.sh +14 -0
- data/.circleci/helpers/finalize_release.sh +24 -0
- data/.circleci/helpers/publish_docs.sh +10 -0
- data/.circleci/helpers/release_gem.sh +8 -0
- data/.circleci/helpers/setup.sh +11 -0
- data/.circleci/helpers/setup_aws.sh +13 -0
- data/.circleci/helpers/setup_gem.sh +2 -0
- data/.circleci/helpers/setup_git.sh +27 -0
- data/.circleci/helpers/setup_rubygems.sh +15 -0
- data/.circleci/helpers/test_integration.sh +12 -0
- data/.circleci/helpers/test_unit.sh +6 -0
- data/.circleci/jobs/publish-production.sh +17 -0
- data/.circleci/jobs/publish-staging.sh +17 -0
- data/.circleci/jobs/release-production.sh +21 -0
- data/.circleci/jobs/test-integration.sh +9 -0
- data/.circleci/jobs/test-unit.sh +9 -0
- data/.circleci/tag_repo.rb +46 -0
- data/.gitignore +28 -0
- data/.rspec +2 -0
- data/.yard/config +2 -0
- data/.yard/template/default/fulldoc/html/css/custom.css +151 -0
- data/.yard/template/default/layout/html/footer.erb +0 -0
- data/.yard/template/default/layout/html/headers.erb +10 -0
- data/.yard/template/default/layout/html/layout.erb +45 -0
- data/.yard/template/default/layout/html/setup.rb +24 -0
- data/.yardopts +1 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +99 -0
- data/LICENSE.txt +28 -0
- data/README.md +397 -0
- data/Rakefile +2 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/doc/Hash.html +291 -0
- data/doc/WscSdk.html +570 -0
- data/doc/WscSdk/ApiResponse.html +242 -0
- data/doc/WscSdk/Attributes.html +128 -0
- data/doc/WscSdk/Attributes/Mode.html +191 -0
- data/doc/WscSdk/Attributes/Type.html +389 -0
- data/doc/WscSdk/Client.html +2677 -0
- data/doc/WscSdk/Configuration.html +595 -0
- data/doc/WscSdk/Endpoint.html +2974 -0
- data/doc/WscSdk/Endpoints.html +141 -0
- data/doc/WscSdk/Endpoints/CustomStreamTargets.html +383 -0
- data/doc/WscSdk/Endpoints/LiveStreams.html +197 -0
- data/doc/WscSdk/Endpoints/OutputStreamTargets.html +180 -0
- data/doc/WscSdk/Endpoints/Outputs.html +180 -0
- data/doc/WscSdk/Endpoints/StreamTargets.html +446 -0
- data/doc/WscSdk/Endpoints/Transcoders.html +197 -0
- data/doc/WscSdk/Endpoints/UllStreamTargets.html +383 -0
- data/doc/WscSdk/Endpoints/WowzaStreamTargets.html +383 -0
- data/doc/WscSdk/Enum.html +225 -0
- data/doc/WscSdk/Enums.html +321 -0
- data/doc/WscSdk/Enums/BillingMode.html +188 -0
- data/doc/WscSdk/Enums/BroadcastLocation.html +396 -0
- data/doc/WscSdk/Enums/BufferSize.html +301 -0
- data/doc/WscSdk/Enums/ClosedCaptionType.html +221 -0
- data/doc/WscSdk/Enums/CustomProvider.html +252 -0
- data/doc/WscSdk/Enums/DeliveryMethod.html +188 -0
- data/doc/WscSdk/Enums/DeliveryType.html +188 -0
- data/doc/WscSdk/Enums/Encoder.html +460 -0
- data/doc/WscSdk/Enums/Errors.html +555 -0
- data/doc/WscSdk/Enums/IdleTimeout.html +398 -0
- data/doc/WscSdk/Enums/ImagePosition.html +220 -0
- data/doc/WscSdk/Enums/ModelMode.html +175 -0
- data/doc/WscSdk/Enums/ModelType.html +373 -0
- data/doc/WscSdk/Enums/PlayerType.html +188 -0
- data/doc/WscSdk/Enums/Protocol.html +204 -0
- data/doc/WscSdk/Enums/TargetDeliveryProtocol.html +188 -0
- data/doc/WscSdk/Enums/TranscoderType.html +188 -0
- data/doc/WscSdk/Enums/UserRegion.html +383 -0
- data/doc/WscSdk/Enums/WowzaProvider.html +188 -0
- data/doc/WscSdk/Errors.html +683 -0
- data/doc/WscSdk/Loggable.html +346 -0
- data/doc/WscSdk/Model.html +3316 -0
- data/doc/WscSdk/ModelList.html +442 -0
- data/doc/WscSdk/ModelTemplate.html +267 -0
- data/doc/WscSdk/Models.html +141 -0
- data/doc/WscSdk/Models/CustomStreamTarget.html +192 -0
- data/doc/WscSdk/Models/Error.html +351 -0
- data/doc/WscSdk/Models/LiveStream.html +601 -0
- data/doc/WscSdk/Models/LiveStreamConnectionCode.html +192 -0
- data/doc/WscSdk/Models/LiveStreamState.html +200 -0
- data/doc/WscSdk/Models/LiveStreamStats.html +200 -0
- data/doc/WscSdk/Models/LiveStreamThumbnailUrl.html +200 -0
- data/doc/WscSdk/Models/Output.html +294 -0
- data/doc/WscSdk/Models/OutputStreamTarget.html +274 -0
- data/doc/WscSdk/Models/StreamTarget.html +273 -0
- data/doc/WscSdk/Models/Transcoder.html +793 -0
- data/doc/WscSdk/Models/TranscoderBooleanStat.html +278 -0
- data/doc/WscSdk/Models/TranscoderConnectionCode.html +192 -0
- data/doc/WscSdk/Models/TranscoderFloatStat.html +278 -0
- data/doc/WscSdk/Models/TranscoderIntegerStat.html +278 -0
- data/doc/WscSdk/Models/TranscoderState.html +196 -0
- data/doc/WscSdk/Models/TranscoderStats.html +196 -0
- data/doc/WscSdk/Models/TranscoderStreamTargetState.html +192 -0
- data/doc/WscSdk/Models/TranscoderStringStat.html +278 -0
- data/doc/WscSdk/Models/TranscoderThumbnailUrl.html +196 -0
- data/doc/WscSdk/Models/UllStreamTarget.html +360 -0
- data/doc/WscSdk/Models/WowzaStreamTarget.html +380 -0
- data/doc/WscSdk/Pagination.html +1277 -0
- data/doc/WscSdk/Schema.html +861 -0
- data/doc/WscSdk/SchemaAttribute.html +2400 -0
- data/doc/WscSdk/Templates.html +141 -0
- data/doc/WscSdk/Templates/CustomStreamTarget.html +1045 -0
- data/doc/WscSdk/Templates/LiveStream.html +1432 -0
- data/doc/WscSdk/Templates/Output.html +829 -0
- data/doc/WscSdk/Templates/Transcoder.html +699 -0
- data/doc/WscSdk/Templates/UllStreamTarget.html +411 -0
- data/doc/WscSdk/Templates/WowzaStreamTarget.html +447 -0
- data/doc/WscSdk/TranscoderSharedMethods.html +1113 -0
- data/doc/_index.html +705 -0
- data/doc/class_list.html +51 -0
- data/doc/css/bootstrap.css +5 -0
- data/doc/css/common.css +1 -0
- data/doc/css/custom.css +151 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +496 -0
- data/doc/file.README.html +570 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/images/wsc-ruby-1800x400.png +0 -0
- data/doc/index.html +570 -0
- data/doc/js/app.js +292 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +1731 -0
- data/doc/top-level-namespace.html +182 -0
- data/examples/client.rb +40 -0
- data/examples/helpers.rb +100 -0
- data/examples/live_streams/create.rb +39 -0
- data/examples/live_streams/delete.rb +32 -0
- data/examples/live_streams/find.rb +22 -0
- data/examples/live_streams/flood.rb +126 -0
- data/examples/live_streams/list.rb +24 -0
- data/examples/live_streams/regenerate_connection_code.rb +29 -0
- data/examples/live_streams/reset.rb +32 -0
- data/examples/live_streams/reset_and_wait.rb +51 -0
- data/examples/live_streams/start.rb +33 -0
- data/examples/live_streams/start_and_wait.rb +51 -0
- data/examples/live_streams/state.rb +33 -0
- data/examples/live_streams/stats.rb +43 -0
- data/examples/live_streams/stop.rb +33 -0
- data/examples/live_streams/stop_and_wait.rb +51 -0
- data/examples/live_streams/thumbnail_url.rb +46 -0
- data/examples/live_streams/update.rb +43 -0
- data/examples/live_streams/workflow.rb +165 -0
- data/examples/output_stream_targets/create.rb +56 -0
- data/examples/output_stream_targets/delete.rb +45 -0
- data/examples/output_stream_targets/find.rb +37 -0
- data/examples/output_stream_targets/list.rb +36 -0
- data/examples/output_stream_targets/update.rb +56 -0
- data/examples/outputs/create.rb +49 -0
- data/examples/outputs/delete.rb +39 -0
- data/examples/outputs/find.rb +31 -0
- data/examples/outputs/list.rb +29 -0
- data/examples/outputs/update.rb +50 -0
- data/examples/stream_targets/custom/create.rb +42 -0
- data/examples/stream_targets/custom/delete.rb +31 -0
- data/examples/stream_targets/custom/find.rb +23 -0
- data/examples/stream_targets/custom/list.rb +24 -0
- data/examples/stream_targets/custom/update.rb +43 -0
- data/examples/stream_targets/list.rb +24 -0
- data/examples/stream_targets/ull/create.rb +41 -0
- data/examples/stream_targets/ull/delete.rb +31 -0
- data/examples/stream_targets/ull/find.rb +23 -0
- data/examples/stream_targets/ull/list.rb +24 -0
- data/examples/stream_targets/ull/update.rb +43 -0
- data/examples/stream_targets/wowza/create.rb +42 -0
- data/examples/stream_targets/wowza/delete.rb +31 -0
- data/examples/stream_targets/wowza/find.rb +23 -0
- data/examples/stream_targets/wowza/list.rb +23 -0
- data/examples/stream_targets/wowza/update.rb +43 -0
- data/examples/transcoders/create.rb +39 -0
- data/examples/transcoders/delete.rb +31 -0
- data/examples/transcoders/find.rb +23 -0
- data/examples/transcoders/list.rb +24 -0
- data/examples/transcoders/reset.rb +32 -0
- data/examples/transcoders/reset_and_wait.rb +48 -0
- data/examples/transcoders/start.rb +33 -0
- data/examples/transcoders/start_and_wait.rb +50 -0
- data/examples/transcoders/state.rb +33 -0
- data/examples/transcoders/stats.rb +43 -0
- data/examples/transcoders/stop.rb +33 -0
- data/examples/transcoders/stop_and_wait.rb +50 -0
- data/examples/transcoders/thumbnail_url.rb +46 -0
- data/examples/transcoders/update.rb +43 -0
- data/images/wsc-ruby-1800x400.png +0 -0
- data/lib/wsc_sdk.rb +81 -0
- data/lib/wsc_sdk/client.rb +417 -0
- data/lib/wsc_sdk/configuration.rb +21 -0
- data/lib/wsc_sdk/constants.rb +29 -0
- data/lib/wsc_sdk/endpoint.rb +492 -0
- data/lib/wsc_sdk/endpoints/custom_stream_targets.rb +44 -0
- data/lib/wsc_sdk/endpoints/live_streams.rb +34 -0
- data/lib/wsc_sdk/endpoints/output_stream_targets.rb +17 -0
- data/lib/wsc_sdk/endpoints/outputs.rb +17 -0
- data/lib/wsc_sdk/endpoints/stream_targets.rb +45 -0
- data/lib/wsc_sdk/endpoints/transcoders.rb +38 -0
- data/lib/wsc_sdk/endpoints/ull_stream_targets.rb +44 -0
- data/lib/wsc_sdk/endpoints/wowza_stream_targets.rb +44 -0
- data/lib/wsc_sdk/enums.rb +31 -0
- data/lib/wsc_sdk/enums/billing_mode.rb +20 -0
- data/lib/wsc_sdk/enums/broadcast_location.rb +58 -0
- data/lib/wsc_sdk/enums/buffer_size.rb +41 -0
- data/lib/wsc_sdk/enums/closed_caption_type.rb +26 -0
- data/lib/wsc_sdk/enums/custom_provider.rb +32 -0
- data/lib/wsc_sdk/enums/delivery_method.rb +20 -0
- data/lib/wsc_sdk/enums/delivery_type.rb +20 -0
- data/lib/wsc_sdk/enums/encoder.rb +71 -0
- data/lib/wsc_sdk/enums/idle_timeout.rb +50 -0
- data/lib/wsc_sdk/enums/image_position.rb +26 -0
- data/lib/wsc_sdk/enums/player_type.rb +20 -0
- data/lib/wsc_sdk/enums/protocol.rb +23 -0
- data/lib/wsc_sdk/enums/target_delivery_protocol.rb +20 -0
- data/lib/wsc_sdk/enums/transcoder_type.rb +20 -0
- data/lib/wsc_sdk/enums/wowza_provider.rb +20 -0
- data/lib/wsc_sdk/errors.rb +115 -0
- data/lib/wsc_sdk/model.rb +515 -0
- data/lib/wsc_sdk/model_list.rb +42 -0
- data/lib/wsc_sdk/model_template.rb +27 -0
- data/lib/wsc_sdk/models/custom_stream_target.rb +34 -0
- data/lib/wsc_sdk/models/error.rb +53 -0
- data/lib/wsc_sdk/models/live_stream.rb +130 -0
- data/lib/wsc_sdk/models/live_stream_connection_code.rb +31 -0
- data/lib/wsc_sdk/models/live_stream_state.rb +20 -0
- data/lib/wsc_sdk/models/live_stream_stats.rb +20 -0
- data/lib/wsc_sdk/models/live_stream_thumbnail_url.rb +20 -0
- data/lib/wsc_sdk/models/output.rb +61 -0
- data/lib/wsc_sdk/models/output_stream_target.rb +37 -0
- data/lib/wsc_sdk/models/stream_target.rb +29 -0
- data/lib/wsc_sdk/models/transcoder.rb +135 -0
- data/lib/wsc_sdk/models/transcoder_boolean_stat.rb +41 -0
- data/lib/wsc_sdk/models/transcoder_connection_code.rb +29 -0
- data/lib/wsc_sdk/models/transcoder_float_stat.rb +40 -0
- data/lib/wsc_sdk/models/transcoder_integer_stat.rb +40 -0
- data/lib/wsc_sdk/models/transcoder_state.rb +31 -0
- data/lib/wsc_sdk/models/transcoder_stats.rb +51 -0
- data/lib/wsc_sdk/models/transcoder_stream_target_state.rb +29 -0
- data/lib/wsc_sdk/models/transcoder_string_stat.rb +40 -0
- data/lib/wsc_sdk/models/transcoder_thumbnail_url.rb +29 -0
- data/lib/wsc_sdk/models/ull_stream_target.rb +54 -0
- data/lib/wsc_sdk/models/wowza_stream_target.rb +60 -0
- data/lib/wsc_sdk/modules/api_response.rb +24 -0
- data/lib/wsc_sdk/modules/loggable.rb +44 -0
- data/lib/wsc_sdk/modules/transcoder_shared_methods.rb +221 -0
- data/lib/wsc_sdk/pagination.rb +89 -0
- data/lib/wsc_sdk/schema.rb +140 -0
- data/lib/wsc_sdk/schema_attribute.rb +349 -0
- data/lib/wsc_sdk/templates/custom_stream_target.rb +154 -0
- data/lib/wsc_sdk/templates/live_stream.rb +234 -0
- data/lib/wsc_sdk/templates/output.rb +133 -0
- data/lib/wsc_sdk/templates/transcoder.rb +97 -0
- data/lib/wsc_sdk/templates/ull_stream_target.rb +49 -0
- data/lib/wsc_sdk/templates/wowza_stream_target.rb +57 -0
- data/lib/wsc_sdk/version.rb +7 -0
- data/wsc_sdk.gemspec +48 -0
- metadata +460 -0
|
@@ -0,0 +1,555 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Module: WscSdk::Enums::Errors
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.18
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "WscSdk::Enums::Errors";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../_index.html">Index (E)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../WscSdk.html" title="WscSdk (module)">WscSdk</a></span></span> » <span class='title'><span class='object_link'><a href="../Enums.html" title="WscSdk::Enums (module)">Enums</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Errors</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Module: WscSdk::Enums::Errors
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
<dl>
|
|
73
|
+
<dt>Extended by:</dt>
|
|
74
|
+
<dd><span class='object_link'><a href="../Enums.html" title="WscSdk::Enums (module)">WscSdk::Enums</a></span></dd>
|
|
75
|
+
</dl>
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
<dl>
|
|
85
|
+
<dt>Defined in:</dt>
|
|
86
|
+
<dd>lib/wsc_sdk/enums/errors.rb</dd>
|
|
87
|
+
</dl>
|
|
88
|
+
|
|
89
|
+
</div>
|
|
90
|
+
|
|
91
|
+
<h2>Overview</h2><div class="docstring">
|
|
92
|
+
<div class="discussion">
|
|
93
|
+
|
|
94
|
+
<p>Enumerate the errors that can be generated by the SDK</p>
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
</div>
|
|
98
|
+
</div>
|
|
99
|
+
<div class="tags">
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>
|
|
105
|
+
Constant Summary
|
|
106
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
107
|
+
</h2>
|
|
108
|
+
|
|
109
|
+
<dl class="constants">
|
|
110
|
+
|
|
111
|
+
<dt id="INVALID_ATTRIBUTES-constant" class="">INVALID_ATTRIBUTES =
|
|
112
|
+
<div class="docstring">
|
|
113
|
+
<div class="discussion">
|
|
114
|
+
|
|
115
|
+
<p>Error returned when the model does not validate.</p>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
</div>
|
|
119
|
+
</div>
|
|
120
|
+
<div class="tags">
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
</div>
|
|
124
|
+
</dt>
|
|
125
|
+
<dd><pre class="code">{
|
|
126
|
+
<span style="color:#606">meta</span>: {
|
|
127
|
+
<span style="color:#606">status</span>: <span style="color:#00D">422</span>,
|
|
128
|
+
<span style="color:#606">code</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">ERR-422-InvalidAttributes</span><span style="color:#710">"</span></span>,
|
|
129
|
+
<span style="color:#606">title</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">Invalid Attributes</span><span style="color:#710">"</span></span>,
|
|
130
|
+
<span style="color:#606">message</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">The model has invalid attribute values assigned to it. Check the `WscSdk::Model#errors` property for more details.</span><span style="color:#710">"</span></span>,
|
|
131
|
+
<span style="color:#606">description</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#710">"</span></span>
|
|
132
|
+
}
|
|
133
|
+
}</pre></dd>
|
|
134
|
+
|
|
135
|
+
<dt id="MODEL_DOES_NOT_EXIST-constant" class="">MODEL_DOES_NOT_EXIST =
|
|
136
|
+
<div class="docstring">
|
|
137
|
+
<div class="discussion">
|
|
138
|
+
|
|
139
|
+
<p>Error returned when the model is attempting an update, but it doesn't
|
|
140
|
+
have a primary key.</p>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
</div>
|
|
144
|
+
</div>
|
|
145
|
+
<div class="tags">
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
</div>
|
|
149
|
+
</dt>
|
|
150
|
+
<dd><pre class="code">{
|
|
151
|
+
<span style="color:#606">meta</span>: {
|
|
152
|
+
<span style="color:#606">status</span>: <span style="color:#00D">422</span>,
|
|
153
|
+
<span style="color:#606">code</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">ERR-422-RecordInvalid</span><span style="color:#710">"</span></span>,
|
|
154
|
+
<span style="color:#606">title</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">Record Invalid</span><span style="color:#710">"</span></span>,
|
|
155
|
+
<span style="color:#606">message</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">You are attempting to access or update a record that does not exist.</span><span style="color:#710">"</span></span>,
|
|
156
|
+
<span style="color:#606">description</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#710">"</span></span>
|
|
157
|
+
}
|
|
158
|
+
}</pre></dd>
|
|
159
|
+
|
|
160
|
+
<dt id="MODEL_EXISTS-constant" class="">MODEL_EXISTS =
|
|
161
|
+
<div class="docstring">
|
|
162
|
+
<div class="discussion">
|
|
163
|
+
|
|
164
|
+
<p>Error returned when the model is attempting to create, but it already has a
|
|
165
|
+
primary key.</p>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
</div>
|
|
169
|
+
</div>
|
|
170
|
+
<div class="tags">
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
</div>
|
|
174
|
+
</dt>
|
|
175
|
+
<dd><pre class="code">{
|
|
176
|
+
<span style="color:#606">meta</span>: {
|
|
177
|
+
<span style="color:#606">status</span>: <span style="color:#00D">422</span>,
|
|
178
|
+
<span style="color:#606">code</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">ERR-422-RecordInvalid</span><span style="color:#710">"</span></span>,
|
|
179
|
+
<span style="color:#606">title</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">Record Invalid</span><span style="color:#710">"</span></span>,
|
|
180
|
+
<span style="color:#606">message</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">You are attempting to create a record that already exists.</span><span style="color:#710">"</span></span>,
|
|
181
|
+
<span style="color:#606">description</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#710">"</span></span>
|
|
182
|
+
}
|
|
183
|
+
}</pre></dd>
|
|
184
|
+
|
|
185
|
+
</dl>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
<h2>
|
|
196
|
+
Class Method Summary
|
|
197
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
198
|
+
</h2>
|
|
199
|
+
|
|
200
|
+
<ul class="summary">
|
|
201
|
+
|
|
202
|
+
<li class="public ">
|
|
203
|
+
<span class="summary_signature">
|
|
204
|
+
|
|
205
|
+
<a href="#invalid_attributes-class_method" title="invalid_attributes (class method)">.<strong>invalid_attributes</strong>(endpoint) ⇒ WscSdk::Models::Error </a>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
</span>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
<span class="summary_desc"><div class='inline'>
|
|
220
|
+
<p>Build an INVALID_ATTRIBUTES error model object.</p>
|
|
221
|
+
</div></span>
|
|
222
|
+
|
|
223
|
+
</li>
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
<li class="public ">
|
|
227
|
+
<span class="summary_signature">
|
|
228
|
+
|
|
229
|
+
<a href="#model_does_not_exist-class_method" title="model_does_not_exist (class method)">.<strong>model_does_not_exist</strong>(endpoint) ⇒ WscSdk::Models::Error </a>
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
</span>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
<span class="summary_desc"><div class='inline'>
|
|
244
|
+
<p>Build an RECORD_DOES_NOT_EXIST error model object.</p>
|
|
245
|
+
</div></span>
|
|
246
|
+
|
|
247
|
+
</li>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
<li class="public ">
|
|
251
|
+
<span class="summary_signature">
|
|
252
|
+
|
|
253
|
+
<a href="#model_exists-class_method" title="model_exists (class method)">.<strong>model_exists</strong>(endpoint) ⇒ WscSdk::Models::Error </a>
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
</span>
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
<span class="summary_desc"><div class='inline'>
|
|
268
|
+
<p>Build an RECORD_EXISTS error model object.</p>
|
|
269
|
+
</div></span>
|
|
270
|
+
|
|
271
|
+
</li>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
</ul>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Enums.html" title="WscSdk::Enums (module)">WscSdk::Enums</a></span></h3>
|
|
287
|
+
<p class="inherited"><span class='object_link'><a href="../Enums.html#to_constant-instance_method" title="WscSdk::Enums#to_constant (method)">to_constant</a></span>, <span class='object_link'><a href="../Enums.html#values-instance_method" title="WscSdk::Enums#values (method)">values</a></span></p>
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
<div id="class_method_details" class="method_details_list">
|
|
291
|
+
<h2>Class Method Details</h2>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<div class="method_details first">
|
|
295
|
+
<h3 class="signature first" id="invalid_attributes-class_method">
|
|
296
|
+
|
|
297
|
+
.<strong>invalid_attributes</strong>(endpoint) ⇒ <tt><span class='object_link'><a href="../Models/Error.html" title="WscSdk::Models::Error (class)">WscSdk::Models::Error</a></span></tt>
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
</h3><div class="docstring">
|
|
304
|
+
<div class="discussion">
|
|
305
|
+
|
|
306
|
+
<p>Build an INVALID_ATTRIBUTES error model object.</p>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
</div>
|
|
310
|
+
</div>
|
|
311
|
+
<div class="tags">
|
|
312
|
+
<p class="tag_title">Parameters:</p>
|
|
313
|
+
<ul class="param">
|
|
314
|
+
|
|
315
|
+
<li>
|
|
316
|
+
|
|
317
|
+
<span class='name'>endpoint</span>
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Endpoint.html" title="WscSdk::Endpoint (class)">WscSdk::Endpoint</a></span></tt>)</span>
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
—
|
|
325
|
+
<div class='inline'>
|
|
326
|
+
<p>The endpoint that is building the error.</p>
|
|
327
|
+
</div>
|
|
328
|
+
|
|
329
|
+
</li>
|
|
330
|
+
|
|
331
|
+
</ul>
|
|
332
|
+
|
|
333
|
+
<p class="tag_title">Returns:</p>
|
|
334
|
+
<ul class="return">
|
|
335
|
+
|
|
336
|
+
<li>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Error.html" title="WscSdk::Models::Error (class)">WscSdk::Models::Error</a></span></tt>)</span>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
—
|
|
344
|
+
<div class='inline'>
|
|
345
|
+
<p>The newly built error object.</p>
|
|
346
|
+
</div>
|
|
347
|
+
|
|
348
|
+
</li>
|
|
349
|
+
|
|
350
|
+
</ul>
|
|
351
|
+
|
|
352
|
+
</div><table class="source_code">
|
|
353
|
+
<tr>
|
|
354
|
+
<td>
|
|
355
|
+
<pre class="lines">
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
55
|
|
359
|
+
56
|
|
360
|
+
57
|
|
361
|
+
58
|
|
362
|
+
59</pre>
|
|
363
|
+
</td>
|
|
364
|
+
<td>
|
|
365
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk/enums/errors.rb', line 55</span>
|
|
366
|
+
|
|
367
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#069">self</span>.<span style="color:#06B;font-weight:bold">invalid_attributes</span>(endpoint)
|
|
368
|
+
error = <span style="color:#036;font-weight:bold">WscSdk</span>::<span style="color:#036;font-weight:bold">Models</span>::<span style="color:#036;font-weight:bold">Error</span>.new(endpoint)
|
|
369
|
+
error.attributes = <span style="color:#036;font-weight:bold">INVALID_ATTRIBUTES</span>
|
|
370
|
+
error
|
|
371
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
372
|
+
</td>
|
|
373
|
+
</tr>
|
|
374
|
+
</table>
|
|
375
|
+
</div>
|
|
376
|
+
|
|
377
|
+
<div class="method_details ">
|
|
378
|
+
<h3 class="signature " id="model_does_not_exist-class_method">
|
|
379
|
+
|
|
380
|
+
.<strong>model_does_not_exist</strong>(endpoint) ⇒ <tt><span class='object_link'><a href="../Models/Error.html" title="WscSdk::Models::Error (class)">WscSdk::Models::Error</a></span></tt>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
</h3><div class="docstring">
|
|
387
|
+
<div class="discussion">
|
|
388
|
+
|
|
389
|
+
<p>Build an RECORD_DOES_NOT_EXIST error model object.</p>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
</div>
|
|
393
|
+
</div>
|
|
394
|
+
<div class="tags">
|
|
395
|
+
<p class="tag_title">Parameters:</p>
|
|
396
|
+
<ul class="param">
|
|
397
|
+
|
|
398
|
+
<li>
|
|
399
|
+
|
|
400
|
+
<span class='name'>endpoint</span>
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Endpoint.html" title="WscSdk::Endpoint (class)">WscSdk::Endpoint</a></span></tt>)</span>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
—
|
|
408
|
+
<div class='inline'>
|
|
409
|
+
<p>The endpoint that is building the error.</p>
|
|
410
|
+
</div>
|
|
411
|
+
|
|
412
|
+
</li>
|
|
413
|
+
|
|
414
|
+
</ul>
|
|
415
|
+
|
|
416
|
+
<p class="tag_title">Returns:</p>
|
|
417
|
+
<ul class="return">
|
|
418
|
+
|
|
419
|
+
<li>
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Error.html" title="WscSdk::Models::Error (class)">WscSdk::Models::Error</a></span></tt>)</span>
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
—
|
|
427
|
+
<div class='inline'>
|
|
428
|
+
<p>The newly built error object.</p>
|
|
429
|
+
</div>
|
|
430
|
+
|
|
431
|
+
</li>
|
|
432
|
+
|
|
433
|
+
</ul>
|
|
434
|
+
|
|
435
|
+
</div><table class="source_code">
|
|
436
|
+
<tr>
|
|
437
|
+
<td>
|
|
438
|
+
<pre class="lines">
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
69
|
|
442
|
+
70
|
|
443
|
+
71
|
|
444
|
+
72
|
|
445
|
+
73</pre>
|
|
446
|
+
</td>
|
|
447
|
+
<td>
|
|
448
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk/enums/errors.rb', line 69</span>
|
|
449
|
+
|
|
450
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#069">self</span>.<span style="color:#06B;font-weight:bold">model_does_not_exist</span>(endpoint)
|
|
451
|
+
error = <span style="color:#036;font-weight:bold">WscSdk</span>::<span style="color:#036;font-weight:bold">Models</span>::<span style="color:#036;font-weight:bold">Error</span>.new(endpoint)
|
|
452
|
+
error.attributes = <span style="color:#036;font-weight:bold">INVALID_ATTRIBUTES</span>
|
|
453
|
+
error
|
|
454
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
455
|
+
</td>
|
|
456
|
+
</tr>
|
|
457
|
+
</table>
|
|
458
|
+
</div>
|
|
459
|
+
|
|
460
|
+
<div class="method_details ">
|
|
461
|
+
<h3 class="signature " id="model_exists-class_method">
|
|
462
|
+
|
|
463
|
+
.<strong>model_exists</strong>(endpoint) ⇒ <tt><span class='object_link'><a href="../Models/Error.html" title="WscSdk::Models::Error (class)">WscSdk::Models::Error</a></span></tt>
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
</h3><div class="docstring">
|
|
470
|
+
<div class="discussion">
|
|
471
|
+
|
|
472
|
+
<p>Build an RECORD_EXISTS error model object.</p>
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
</div>
|
|
476
|
+
</div>
|
|
477
|
+
<div class="tags">
|
|
478
|
+
<p class="tag_title">Parameters:</p>
|
|
479
|
+
<ul class="param">
|
|
480
|
+
|
|
481
|
+
<li>
|
|
482
|
+
|
|
483
|
+
<span class='name'>endpoint</span>
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Endpoint.html" title="WscSdk::Endpoint (class)">WscSdk::Endpoint</a></span></tt>)</span>
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
—
|
|
491
|
+
<div class='inline'>
|
|
492
|
+
<p>The endpoint that is building the error.</p>
|
|
493
|
+
</div>
|
|
494
|
+
|
|
495
|
+
</li>
|
|
496
|
+
|
|
497
|
+
</ul>
|
|
498
|
+
|
|
499
|
+
<p class="tag_title">Returns:</p>
|
|
500
|
+
<ul class="return">
|
|
501
|
+
|
|
502
|
+
<li>
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Error.html" title="WscSdk::Models::Error (class)">WscSdk::Models::Error</a></span></tt>)</span>
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
—
|
|
510
|
+
<div class='inline'>
|
|
511
|
+
<p>The newly built error object.</p>
|
|
512
|
+
</div>
|
|
513
|
+
|
|
514
|
+
</li>
|
|
515
|
+
|
|
516
|
+
</ul>
|
|
517
|
+
|
|
518
|
+
</div><table class="source_code">
|
|
519
|
+
<tr>
|
|
520
|
+
<td>
|
|
521
|
+
<pre class="lines">
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
83
|
|
525
|
+
84
|
|
526
|
+
85
|
|
527
|
+
86
|
|
528
|
+
87</pre>
|
|
529
|
+
</td>
|
|
530
|
+
<td>
|
|
531
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk/enums/errors.rb', line 83</span>
|
|
532
|
+
|
|
533
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#069">self</span>.<span style="color:#06B;font-weight:bold">model_exists</span>(endpoint)
|
|
534
|
+
error = <span style="color:#036;font-weight:bold">WscSdk</span>::<span style="color:#036;font-weight:bold">Models</span>::<span style="color:#036;font-weight:bold">Error</span>.new(endpoint)
|
|
535
|
+
error.attributes = <span style="color:#036;font-weight:bold">INVALID_ATTRIBUTES</span>
|
|
536
|
+
error
|
|
537
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
538
|
+
</td>
|
|
539
|
+
</tr>
|
|
540
|
+
</table>
|
|
541
|
+
</div>
|
|
542
|
+
|
|
543
|
+
</div>
|
|
544
|
+
|
|
545
|
+
</div>
|
|
546
|
+
|
|
547
|
+
<div id="footer">
|
|
548
|
+
Generated on Wed Feb 27 12:57:42 2019 by
|
|
549
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
550
|
+
0.9.18 (ruby-2.3.1).
|
|
551
|
+
</div>
|
|
552
|
+
|
|
553
|
+
</div>
|
|
554
|
+
</body>
|
|
555
|
+
</html>
|