RubyGems - wsc_sdk - Versions diffs - 1.3.1 - Mend

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.

Files changed (265) hide show

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

data/doc/WscSdk/Pagination.html ADDED

@@ -0,0 +1,1277 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>Wowza Streaming Cloud - SDK Code Documentation</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/custom.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "WscSdk::Pagination";
+  relpath = '../';
+</script>
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+  </head>
+  <body>
+    <div id="wowza-wrapper">
+      <header>
+        <div class="logo">
+          <a href="https://www.wowza.com">
+            <img src="https://cloud.wowza.com/apidocs/assets/logo.png" alt="Wowza Logo" />
+          </a>
+          <h1>Wowza Streaming Cloud<br/>SDK Code Documentation</h1>
+          <div class="clearfix"></div>
+        </div>
+        <div class="links">
+          <a href="https://www.wowza.com/">Wowza Home</a>
+          <a href="https://www.wowza.com/docs">Docs & APIS</a>
+          <a href="https://www.wowza.com/community/index.html">Forums</a>
+          <a href="https://www.wowza.com/support">Support</a>
+        </div>
+        <div class="clearfix"></div>
+      </header>
+      <div id="content">
+        <div class="nav_wrap">
+          <iframe id="nav" src="../class_list.html?1"></iframe>
+          <div id="resizer"></div>
+        </div>
+        <div id="main" tabindex="-1">
+          <div id="header">
+            <div id="menu">
+    <a href="../_index.html">Index (P)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../WscSdk.html" title="WscSdk (module)">WscSdk</a></span></span>
+     &raquo;
+    <span class="title">Pagination</span>
+</div>
+            <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+            <div class="clear"></div>
+          </div>
+          <div id="content"><h1>Class: WscSdk::Pagination
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">WscSdk::Pagination</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/wsc_sdk/pagination.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>A class for handling the pagination data returned by endpoint lists.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#page-instance_method" title="#page (instance method)">#<strong>page</strong>  &#x21d2; Object </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute page.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#page_first_index-instance_method" title="#page_first_index (instance method)">#<strong>page_first_index</strong>  &#x21d2; Object </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute page_first_index.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#page_last_index-instance_method" title="#page_last_index (instance method)">#<strong>page_last_index</strong>  &#x21d2; Object </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute page_last_index.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#per_page-instance_method" title="#per_page (instance method)">#<strong>per_page</strong>  &#x21d2; Object </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute per_page.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#total_pages-instance_method" title="#total_pages (instance method)">#<strong>total_pages</strong>  &#x21d2; Object </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute total_pages.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#total_records-instance_method" title="#total_records (instance method)">#<strong>total_records</strong>  &#x21d2; Object </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute total_records.</p>
+</div></span>
+</li>
+  </ul>
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#first_page-instance_method" title="#first_page (instance method)">#<strong>first_page</strong>  &#x21d2; Integer, Nil </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Get the number of the first page.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#first_page%3F-instance_method" title="#first_page? (instance method)">#<strong>first_page?</strong>  &#x21d2; Boolean </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Determine if the current page is the first page.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(pagination_data = {})  &#x21d2; Pagination </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Get a new instance of the pagination class.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#last_page-instance_method" title="#last_page (instance method)">#<strong>last_page</strong>  &#x21d2; Integer, Nil </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Get the number of the last page.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#last_page%3F-instance_method" title="#last_page? (instance method)">#<strong>last_page?</strong>  &#x21d2; Boolean </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Determine if the current page is the last page.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#next_page-instance_method" title="#next_page (instance method)">#<strong>next_page</strong>  &#x21d2; Integer, Nil </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Get the number of the next page.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#previous_page-instance_method" title="#previous_page (instance method)">#<strong>previous_page</strong>  &#x21d2; Integer, Nil </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Get the number of the previous page.</p>
+</div></span>
+</li>
+    </ul>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    #<strong>initialize</strong>(pagination_data = {})  &#x21d2; <tt><span class='object_link'><a href="" title="WscSdk::Pagination (class)">Pagination</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Get a new instance of the pagination class.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>pagination_data</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>A hash of pagination data</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+15
+16
+17
+18
+19
+20
+21
+22</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/wsc_sdk/pagination.rb', line 15</span>
+<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">initialize</span>(pagination_data={})
+  <span style="color:#33B">@page</span>               = pagination_data.fetch(<span style="color:#A60">:page</span>, <span style="color:#00D">1</span>)
+  <span style="color:#33B">@per_page</span>           = pagination_data.fetch(<span style="color:#A60">:per_page</span>, <span style="color:#00D">1000</span>)
+  <span style="color:#33B">@total_pages</span>        = pagination_data.fetch(<span style="color:#A60">:total_pages</span>, <span style="color:#00D">1</span>)
+  <span style="color:#33B">@total_records</span>      = pagination_data.fetch(<span style="color:#A60">:total_records</span>, <span style="color:#00D">-1</span>)
+  <span style="color:#33B">@page_first_index</span>   = pagination_data.fetch(<span style="color:#A60">:page_first_index</span>, <span style="color:#00D">-1</span>)
+  <span style="color:#33B">@page_last_index</span>    = pagination_data.fetch(<span style="color:#A60">:page_last_index</span>, <span style="color:#00D">-1</span>)
+<span style="color:#080;font-weight:bold">end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="page-instance_method">
+    #<strong>page</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute page</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/wsc_sdk/pagination.rb', line 9</span>
+<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">page</span>
+  <span style="color:#33B">@page</span>
+<span style="color:#080;font-weight:bold">end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="page_first_index-instance_method">
+    #<strong>page_first_index</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute page_first_index</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/wsc_sdk/pagination.rb', line 9</span>
+<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">page_first_index</span>
+  <span style="color:#33B">@page_first_index</span>
+<span style="color:#080;font-weight:bold">end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="page_last_index-instance_method">
+    #<strong>page_last_index</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute page_last_index</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/wsc_sdk/pagination.rb', line 9</span>
+<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">page_last_index</span>
+  <span style="color:#33B">@page_last_index</span>
+<span style="color:#080;font-weight:bold">end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="per_page-instance_method">
+    #<strong>per_page</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute per_page</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/wsc_sdk/pagination.rb', line 9</span>
+<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">per_page</span>
+  <span style="color:#33B">@per_page</span>
+<span style="color:#080;font-weight:bold">end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="total_pages-instance_method">
+    #<strong>total_pages</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute total_pages</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/wsc_sdk/pagination.rb', line 9</span>
+<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">total_pages</span>
+  <span style="color:#33B">@total_pages</span>
+<span style="color:#080;font-weight:bold">end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="total_records-instance_method">
+    #<strong>total_records</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute total_records</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/wsc_sdk/pagination.rb', line 9</span>
+<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">total_records</span>
+  <span style="color:#33B">@total_records</span>
+<span style="color:#080;font-weight:bold">end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="first_page-instance_method">
+    #<strong>first_page</strong>  &#x21d2; <tt>Integer</tt>, <tt>Nil</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Get the number of the first page</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Integer</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The number of the first page.</p>
+</div>
+    </li>
+    <li>
+        <span class='type'>(<tt>Nil</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>If there is no first page.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+39
+40
+41
+42</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/wsc_sdk/pagination.rb', line 39</span>
+<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">first_page</span>
+  <span style="color:#080;font-weight:bold">return</span> <span style="color:#069">nil</span> <span style="color:#080;font-weight:bold">if</span> total_pages &lt; <span style="color:#00D">1</span>
+  <span style="color:#080;font-weight:bold">return</span> <span style="color:#00D">1</span>
+<span style="color:#080;font-weight:bold">end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="first_page?-instance_method">
+    #<strong>first_page?</strong>  &#x21d2; <tt>Boolean</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Determine if the current page is the first page</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>An indication if the current page is the first page.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+28
+29
+30
+31</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/wsc_sdk/pagination.rb', line 28</span>
+<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">first_page?</span>
+  <span style="color:#080;font-weight:bold">return</span> <span style="color:#069">true</span> <span style="color:#080;font-weight:bold">if</span> total_pages &lt; <span style="color:#00D">1</span>
+  <span style="color:#080;font-weight:bold">return</span> (page == <span style="color:#00D">1</span>)
+<span style="color:#080;font-weight:bold">end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="last_page-instance_method">
+    #<strong>last_page</strong>  &#x21d2; <tt>Integer</tt>, <tt>Nil</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Get the number of the last page</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Integer</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The number of the first page.</p>
+</div>
+    </li>
+    <li>
+        <span class='type'>(<tt>Nil</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>If there is no first page.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+74
+75
+76
+77</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/wsc_sdk/pagination.rb', line 74</span>
+<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">last_page</span>
+  <span style="color:#080;font-weight:bold">return</span> <span style="color:#069">nil</span> <span style="color:#080;font-weight:bold">if</span> total_pages &lt; <span style="color:#00D">1</span>
+  <span style="color:#080;font-weight:bold">return</span> total_pages
+<span style="color:#080;font-weight:bold">end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="last_page?-instance_method">
+    #<strong>last_page?</strong>  &#x21d2; <tt>Boolean</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Determine if the current page is the last page</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>An indication if the current page is the last page.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+83
+84
+85
+86</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/wsc_sdk/pagination.rb', line 83</span>
+<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">last_page?</span>
+  <span style="color:#080;font-weight:bold">return</span> <span style="color:#069">true</span> <span style="color:#080;font-weight:bold">if</span> total_pages &lt; <span style="color:#00D">1</span>
+  <span style="color:#080;font-weight:bold">return</span> (page == total_pages)
+<span style="color:#080;font-weight:bold">end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="next_page-instance_method">
+    #<strong>next_page</strong>  &#x21d2; <tt>Integer</tt>, <tt>Nil</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Get the number of the next page.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Integer</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The number of the next page</p>
+</div>
+    </li>
+    <li>
+        <span class='type'>(<tt>Nil</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>If there are no remaining pages</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+50
+51
+52
+53
+54</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/wsc_sdk/pagination.rb', line 50</span>
+<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">next_page</span>
+  <span style="color:#080;font-weight:bold">return</span> <span style="color:#069">nil</span> <span style="color:#080;font-weight:bold">if</span> total_pages == <span style="color:#00D">-1</span>
+  <span style="color:#080;font-weight:bold">return</span> <span style="color:#069">nil</span> <span style="color:#080;font-weight:bold">if</span> page == total_pages
+  <span style="color:#080;font-weight:bold">return</span> page + <span style="color:#00D">1</span>
+<span style="color:#080;font-weight:bold">end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="previous_page-instance_method">
+    #<strong>previous_page</strong>  &#x21d2; <tt>Integer</tt>, <tt>Nil</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Get the number of the previous page.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Integer</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The number of the previous page</p>
+</div>
+    </li>
+    <li>
+        <span class='type'>(<tt>Nil</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>If there are no previous pages</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+62
+63
+64
+65
+66</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/wsc_sdk/pagination.rb', line 62</span>
+<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">previous_page</span>
+  <span style="color:#080;font-weight:bold">return</span> <span style="color:#069">nil</span> <span style="color:#080;font-weight:bold">if</span> total_pages &lt; <span style="color:#00D">1</span>
+  <span style="color:#080;font-weight:bold">return</span> <span style="color:#069">nil</span> <span style="color:#080;font-weight:bold">if</span> page == <span style="color:#00D">1</span>
+  <span style="color:#080;font-weight:bold">return</span> page - <span style="color:#00D">1</span>
+<span style="color:#080;font-weight:bold">end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+        </div>
+      </div>
+    </div>
+  </body>
+</html>