tangocard-raas 1.1.2 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ae496c795949b521cc2579a540bc6232e6b3980
-  data.tar.gz: e48508da3f993cce362dbaaf655f230e4f7142f0
+  metadata.gz: e5d39ff1495f92546c2b68e8029f731c08c665e6
+  data.tar.gz: 4ce8922e73942ffff4cc3b8006c994e2496e2342
 SHA512:
-  metadata.gz: 5e40fb9d56a89122fda23a93765ce45199ab8d89e34b48c80b6eb149026a3c1b4dc49b75ec0f31d531cc7d9ab97ae2c3c30817957fd8a737bd61bec543d478d5
-  data.tar.gz: dfcc6e2afa95450d742b3e8169d365518863202f6dcf9fb1f00f4d44dc4bec3378acbdcfe137e36aef452b5004205bef2b787d2b7161889bc460d9867a178f94
+  metadata.gz: 2ffbcfddc702b378d80d9de53614492f2485a22e4b0bd7a168949d1fe59427310cdf4e7c3623ab70c7fadebefabfe2d4db0d0f910ba5c01eb1afdf3bd1caf280
+  data.tar.gz: 753fc5e31e501a3da63fb9103f9636a88e4dec86ad10646f3738fc2e917c44170659a190ca055d74c4bfb6f9d1b67ed5931471011266fde70b2e7d529d9132c4

data/LICENSE

@@ -1,175 +1,28 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-      
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2016 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -1,542 +1,55 @@
-# Getting started
+Raas
+=================
+This API SDK was automatically generated by APIMATIC v2.0
 
-With this RESTful API you can integrate a global reward or incentive program into your app or platform. If you have any questions or if you'd like to receive your own credentials, please contact us at devsupport@tangocard.com.
+How to configure:
+=================
+The generated code might need to be configured with your API credentials. To do that,
+open the file "configuration.rb" and edit it's contents.
 
-## How to Use
-You can add this SDK to your project via RubyGems, it's called ```tangocard-raas```. Then you can include it where needed by calling ```require 'raas'```
-
-## How to Build
-
-This client library is a Ruby gem which can be compiled and used in your Ruby and Ruby on Rails project. This library requires a few gems from the RubyGems repository.
-
-1. Open the command line interface or the terminal and navigate to the folder containing the source code.
-2. Run ``` gem build tangocard-raas.gemspec ``` to build the gem.
-3. Once built, the gem can be installed on the current work environment using ``` gem install tangocard-raas-1.1.2.gem ```
-
-![Building Gem](https://apidocs.io/illustration/ruby?step=buildSDK&workspaceFolder=Raas-Ruby&workspaceName=Raas-Ruby&projectName=raas&gemName=raas&gemVer=1.1.2)
-
-## How to Use
-
-The following section explains how to use the Raas Ruby Gem in a new Rails project using RubyMine™. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
-
-### 1. Starting a new project
-
-Close any existing projects in RubyMine™ by selecting ``` File -> Close Project ```. Next, click on ``` Create New Project ``` to create a new project from scratch.
-
-![Create a new project in RubyMine](https://apidocs.io/illustration/ruby?step=createNewProject0&workspaceFolder=Raas-Ruby&workspaceName=Raas&projectName=raas&gemName=raas&gemVer=1.1.2)
-
-Next, provide ``` TestApp ``` as the project name, choose ``` Rails Application ``` as the project type, and click ``` OK ```.
-
-![Create a new Rails Application in RubyMine - step 1](https://apidocs.io/illustration/ruby?step=createNewProject1&workspaceFolder=Raas-Ruby&workspaceName=Raas&projectName=raas&gemName=raas&gemVer=1.1.2)
-
-In the next dialog make sure that correct *Ruby SDK* is being used (minimum 2.0.0) and click ``` OK ```.
-
-![Create a new Rails Application in RubyMine - step 2](https://apidocs.io/illustration/ruby?step=createNewProject2&workspaceFolder=Raas-Ruby&workspaceName=Raas&projectName=raas&gemName=raas&gemVer=1.1.2)
-
-This will create a new Rails Application project with an existing set of files and folder.
-
-### 2. Add reference of the gem
-
-In order to use the Raas gem in the new project we must add a gem reference. Locate the ```Gemfile``` in the *Project Explorer* window under the ``` TestApp ``` project node. The file contains references to all gems being used in the project. Here, add the reference to the library gem by adding the following line: ``` gem 'tangocard-raas', '~> 1.1.2' ```
-
-![Add references of the Gemfile](https://apidocs.io/illustration/ruby?step=addReference&workspaceFolder=Raas-Ruby&workspaceName=Raas&projectName=raas&gemName=raas&gemVer=1.1.2)
-
-### 3. Adding a new Rails Controller
-
-Once the ``` TestApp ``` project is created, a folder named ``` controllers ``` will be visible in the *Project Explorer* under the following path: ``` TestApp > app > controllers ```. Right click on this folder and select ``` New -> Run Rails Generator... ```.
-
-![Run Rails Generator on Controllers Folder](https://apidocs.io/illustration/ruby?step=addCode0&workspaceFolder=Raas-Ruby&workspaceName=Raas&projectName=raas&gemName=raas&gemVer=1.1.2)
-
-Selecting the said option will popup a small window where the generator names are displayed. Here, select the ``` controller ``` template.
-
-![Create a new Controller](https://apidocs.io/illustration/ruby?step=addCode1&workspaceFolder=Raas-Ruby&workspaceName=Raas&projectName=raas&gemName=raas&gemVer=1.1.2)
+Alternatively, you can modify the Configuration parameters at run-time through the following:
+```
+Raas::Configuration.your_paramater = YOUR_VALUE
+```
 
-Next, a popup window will ask you for a Controller name and included Actions. For controller name provide ``` Hello ``` and include an action named ``` Index ``` and click ``` OK ```.
+How to build and install: 
+=============================
+The generated code depends on a few Ruby gems. The references to these gems are 
+added in the gemspec file. The easiest way to resolve the dependencies,
+build the gem and install it is through Rake:
 
-![Add a new Controller](https://apidocs.io/illustration/ruby?step=addCode2&workspaceFolder=Raas-Ruby&workspaceName=Raas&projectName=raas&gemName=raas&gemVer=1.1.2)
+  1. Install Rake if not already installed: `gem install rake`
+  2. Install Bundler if not already installed: `gem install bundler`
+  3. From terminal/cmd navigate to the root directory of the SDK.
+  4. Invoke: `rake install`
 
-A new controller class anmed ``` HelloController ``` will be created in a file named ``` hello_controller.rb ``` containing a method named ``` Index ```. In this method, add code for initialization and a sample for its usage.
+Alternatively, you can build and install the gem manually:
 
-![Initialize the library](https://apidocs.io/illustration/ruby?step=addCode3&workspaceFolder=Raas-Ruby&workspaceName=Raas&projectName=raas&gemName=raas&gemVer=1.1.2)
+  1. From terminal/cmd navigate to the root directory of the SDK.
+  2. Run the build command: `gem build raas.gemspec`
+  3. Run the install command: `gem install ./raas-2.0.0.gem`
 
-## How to Test
+Note: You will need to have internet access for this step.
 
+How  to test:
+=============
 You can test the generated SDK and the server with automatically generated test
 cases as follows:
 
   1. From terminal/cmd navigate to the root directory of the SDK.
   2. Invoke: `bundle exec rake`
 
-## Initialization
-
-### Authentication
-In order to setup authentication and initialization of the API client, you need the following information.
-
-| Parameter | Description |
-|-----------|-------------|
-| platform_name | RaaS v2 API Platform Name |
-| platform_key | RaaS v2 API Platform Key |
-
-
-
-API client can be initialized as following.
-
-```ruby
-# Configuration parameters and credentials
-platform_name = 'QAPlatform2' # RaaS v2 API Platform Name
-platform_key = 'apYPfT6HNONpDRUj3CLGWYt7gvIHONpDRUYPfT6Hj' # RaaS v2 API Platform Key
-
-client = Raas::RaasClient.new(
-  platform_name: platform_name,
-  platform_key: platform_key
-)
-```
-
-The added initlization code can be debugged by putting a breakpoint in the ``` Index ``` method and running the project in debug mode by selecting ``` Run -> Debug 'Development: TestApp' ```.
-
-![Debug the TestApp](https://apidocs.io/illustration/ruby?step=addCode4&workspaceFolder=Tango%20Card%20RaaS%20v2%20API-Ruby&workspaceName=Raas&projectName=raas&gemName=raas&gemVer=1.1.2&initLine=client%2520%253D%2520RaasClient.new%2528%2527platform_name%2527%252C%2520%2527platform_key%2527%2529)
-
-
-
-# Class Reference
-
-## <a name="list_of_controllers"></a>List of Controllers
-
-* [AccountsController](#accounts_controller)
-* [OrdersController](#orders_controller)
-* [CatalogController](#catalog_controller)
-* [ExchangeRatesController](#exchange_rates_controller)
-* [StatusController](#status_controller)
-* [CustomersController](#customers_controller)
-
-## <a name="accounts_controller"></a>![Class: ](https://apidocs.io/img/class.png ".AccountsController") AccountsController
-
-### Get singleton instance
-
-The singleton instance of the ``` AccountsController ``` class can be accessed from the API Client.
-
-```ruby
-accounts = client.accounts
-```
-
-### <a name="get_accounts_by_customer"></a>![Method: ](https://apidocs.io/img/method.png ".AccountsController.get_accounts_by_customer") get_accounts_by_customer
-
-> Gets a list of accounts for a given customer
-
-
-```ruby
-def get_accounts_by_customer(customer_identifier); end
-```
-
-#### Parameters
-
-| Parameter | Tags | Description |
-|-----------|------|-------------|
-| customer_identifier |  ``` Required ```  | Customer Identifier |
-
-
-#### Example Usage
+How to use:
+===========
+After having installed the gem, you can easily use the SDK following these steps.
 
+  1. Create a "raas_test.rb" file in the root directory.
+  2. Use any controller as follows:
 ```ruby
-customer_identifier = 'customerIdentifier'
-
-result = accounts.get_accounts_by_customer(customer_identifier)
-
-```
-
-
-### <a name="get_account"></a>![Method: ](https://apidocs.io/img/method.png ".AccountsController.get_account") get_account
-
-> Get an account
-
-
-```ruby
-def get_account(account_identifier); end
-```
-
-#### Parameters
-
-| Parameter | Tags | Description |
-|-----------|------|-------------|
-| account_identifier |  ``` Required ```  | Account Identifier |
-
-
-#### Example Usage
-
-```ruby
-account_identifier = 'accountIdentifier'
-
-result = accounts.get_account(account_identifier)
-
-```
-
-
-### <a name="create_account"></a>![Method: ](https://apidocs.io/img/method.png ".AccountsController.create_account") create_account
-
-> Create an account under a given customer
-
-
-```ruby
-def create_account(customer_identifier,
-                       body); end
-```
-
-#### Parameters
-
-| Parameter | Tags | Description |
-|-----------|------|-------------|
-| customer_identifier |  ``` Required ```  | Customer Identifier |
-| body |  ``` Required ```  | Request Body |
-
-
-#### Example Usage
-
-```ruby
-customer_identifier = 'customerIdentifier'
-body = CreateAccountRequestModel.new
-
-result = accounts.create_account(customer_identifier, body)
-
-```
-
-
-### <a name="get_all_accounts"></a>![Method: ](https://apidocs.io/img/method.png ".AccountsController.get_all_accounts") get_all_accounts
-
-> Gets all accounts under the platform
-
-
-```ruby
-def get_all_accounts; end
-```
-
-#### Example Usage
-
-```ruby
-
-result = accounts.get_all_accounts()
-
-```
-
-
-[Back to List of Controllers](#list_of_controllers)
-
-## <a name="orders_controller"></a>![Class: ](https://apidocs.io/img/class.png ".OrdersController") OrdersController
-
-### Get singleton instance
-
-The singleton instance of the ``` OrdersController ``` class can be accessed from the API Client.
-
-```ruby
-orders = client.orders
-```
-
-### <a name="create_order"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.create_order") create_order
-
-> TODO: Add a method description
-
-
-```ruby
-def create_order(body); end
-```
-
-#### Parameters
-
-| Parameter | Tags | Description |
-|-----------|------|-------------|
-| body |  ``` Required ```  | TODO: Add a parameter description |
-
-
-#### Example Usage
-
-```ruby
-body = CreateOrderRequestModel.new
-
-result = orders.create_order(body)
-
-```
-
-
-### <a name="get_order"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.get_order") get_order
-
-> TODO: Add a method description
-
-
-```ruby
-def get_order(reference_order_id); end
-```
-
-#### Parameters
-
-| Parameter | Tags | Description |
-|-----------|------|-------------|
-| reference_order_id |  ``` Required ```  | Reference Order ID |
-
-
-#### Example Usage
-
-```ruby
-reference_order_id = 'referenceOrderID'
-
-result = orders.get_order(reference_order_id)
-
-```
-
-
-### <a name="create_resend_order"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.create_resend_order") create_resend_order
-
-> TODO: Add a method description
-
-
-```ruby
-def create_resend_order(reference_order_id); end
-```
-
-#### Parameters
-
-| Parameter | Tags | Description |
-|-----------|------|-------------|
-| reference_order_id |  ``` Required ```  | TODO: Add a parameter description |
-
-
-#### Example Usage
-
-```ruby
-reference_order_id = 'referenceOrderID'
-
-result = orders.create_resend_order(reference_order_id)
-
-```
-
-
-### <a name="get_orders"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.get_orders") get_orders
-
-> TODO: Add a method description
-
-
-```ruby
-def get_orders(options = Hash.new); end
-```
-
-#### Parameters
-
-| Parameter | Tags | Description |
-|-----------|------|-------------|
-| account_identifier |  ``` Optional ```  | TODO: Add a parameter description |
-| customer_identifier |  ``` Optional ```  | TODO: Add a parameter description |
-| external_ref_id |  ``` Optional ```  | TODO: Add a parameter description |
-| start_date |  ``` Optional ```  | TODO: Add a parameter description |
-| end_date |  ``` Optional ```  | TODO: Add a parameter description |
-| elements_per_block |  ``` Optional ```  | TODO: Add a parameter description |
-| page |  ``` Optional ```  | TODO: Add a parameter description |
-
-
-#### Example Usage
-
-```ruby
-collect = Hash.new
-
-account_identifier = 'accountIdentifier'
-collect['account_identifier'] = account_identifier
-
-customer_identifier = 'customerIdentifier'
-collect['customer_identifier'] = customer_identifier
-
-external_ref_id = 'externalRefID'
-collect['external_ref_id'] = external_ref_id
-
-start_date = DateTime.now
-collect['start_date'] = start_date
-
-end_date = DateTime.now
-collect['end_date'] = end_date
-
-elements_per_block = 201
-collect['elements_per_block'] = elements_per_block
-
-page = 201
-collect['page'] = page
-
-
-result = orders.get_orders(collect)
-
-```
-
-
-[Back to List of Controllers](#list_of_controllers)
-
-## <a name="catalog_controller"></a>![Class: ](https://apidocs.io/img/class.png ".CatalogController") CatalogController
-
-### Get singleton instance
-
-The singleton instance of the ``` CatalogController ``` class can be accessed from the API Client.
-
-```ruby
-catalog = client.catalog
-```
-
-### <a name="get_catalog"></a>![Method: ](https://apidocs.io/img/method.png ".CatalogController.get_catalog") get_catalog
-
-> Get Catalog
-
-
-```ruby
-def get_catalog; end
-```
-
-#### Example Usage
-
-```ruby
-
-result = catalog.get_catalog()
-
-```
-
-
-[Back to List of Controllers](#list_of_controllers)
-
-## <a name="exchange_rates_controller"></a>![Class: ](https://apidocs.io/img/class.png ".ExchangeRatesController") ExchangeRatesController
-
-### Get singleton instance
-
-The singleton instance of the ``` ExchangeRatesController ``` class can be accessed from the API Client.
-
-```ruby
-exchangeRates = client.exchange_rates
-```
-
-### <a name="get_exchange_rates"></a>![Method: ](https://apidocs.io/img/method.png ".ExchangeRatesController.get_exchange_rates") get_exchange_rates
-
-> Retrieve current exchange rates
-
-
-```ruby
-def get_exchange_rates; end
-```
-
-#### Example Usage
-
-```ruby
-
-exchangeRates.get_exchange_rates()
-
-```
-
-
-[Back to List of Controllers](#list_of_controllers)
-
-## <a name="status_controller"></a>![Class: ](https://apidocs.io/img/class.png ".StatusController") StatusController
-
-### Get singleton instance
-
-The singleton instance of the ``` StatusController ``` class can be accessed from the API Client.
-
-```ruby
-status = client.status
-```
-
-### <a name="get_system_status"></a>![Method: ](https://apidocs.io/img/method.png ".StatusController.get_system_status") get_system_status
-
-> *Tags:*  ``` Skips Authentication ``` 
-
-> Retrieve system status
-
-
-```ruby
-def get_system_status; end
-```
-
-#### Example Usage
-
-```ruby
-
-result = status.get_system_status()
-
-```
-
-
-[Back to List of Controllers](#list_of_controllers)
-
-## <a name="customers_controller"></a>![Class: ](https://apidocs.io/img/class.png ".CustomersController") CustomersController
-
-### Get singleton instance
-
-The singleton instance of the ``` CustomersController ``` class can be accessed from the API Client.
-
-```ruby
-customers = client.customers
-```
-
-### <a name="get_customer"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_customer") get_customer
-
-> Get a customer
-
-
-```ruby
-def get_customer(customer_identifier); end
-```
-
-#### Parameters
-
-| Parameter | Tags | Description |
-|-----------|------|-------------|
-| customer_identifier |  ``` Required ```  | Customer Identifier |
-
-
-#### Example Usage
-
-```ruby
-customer_identifier = 'customerIdentifier'
-
-result = customers.get_customer(customer_identifier)
-
-```
-
-
-### <a name="create_customer"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.create_customer") create_customer
-
-> Create a new customer
-
-
-```ruby
-def create_customer(body); end
-```
-
-#### Parameters
-
-| Parameter | Tags | Description |
-|-----------|------|-------------|
-| body |  ``` Required ```  | Request Body |
-
-
-#### Example Usage
-
-```ruby
-body = CreateCustomerRequestModel.new
-
-result = customers.create_customer(body)
-
-```
-
-
-### <a name="get_all_customers"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_all_customers") get_all_customers
-
-> Gets all customers under the platform
-
-
-```ruby
-def get_all_customers; end
-```
-
-#### Example Usage
-
-```ruby
-
-result = customers.get_all_customers()
-
-```
-
-
-[Back to List of Controllers](#list_of_controllers)
-
-
+require 'raas'
 
+api_client = Raas::RaasClient.new
+controller = api_client.status_controller
+response = controller.get_system_status(<required parameters if any>)
+p response
+```