pnap_location_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab7be44e474a0ef90f27d40ffd6c315fb7d2c092168bc7fd9fb0c466dad109b2
+  data.tar.gz: bf01c02c183f80d47d1e72a2203c10e75a4b5009a220e39b8d0a7050b1dafbd5
+SHA512:
+  metadata.gz: 52e5bb9b67dd0ff803e0e8c919a80812b36f7fef87d8dc9a0e04792cba701493e54d54b532b4f24317a685232514fc91cbbb5eed54ad80841c84817c0f31c981
+  data.tar.gz: 4d451141a1025e8af54cfad191871aa5107ca6628bd9436279f7b3ff9338589892d157d4a6fd87ae68f9b7f8968197c31506519b6da9a4677cf9f3b263c880cd

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,116 @@
+# pnap_location_api
+
+LocationApi - the Ruby gem for the Locations API
+
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0
+For more information, please visit [https://phoenixnap.com](https://phoenixnap.com)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build pnap_location_api.gemspec
+```
+
+Then either install the gem locally, replacing `<VERSION>` with the actual version:
+
+```shell
+gem install ./pnap_location_api-<VERSION>.gem
+```
+
+(for development, run `gem install --dev ./pnap_location_api-<VERSION>.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'pnap_location_api', '~> <VERSION>'
+
+### Install from Git
+
+To install this Gem from this repository, you'll need to get Bundler by doing `gem install bundler`. Add the following line in your Gemfile:
+
+    gem 'pnap_location_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'LocationApi/*.gemspec'
+
+If you'd like the development version:
+
+    gem 'pnap_location_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'LocationApi/*.gemspec', branch: 'develop'
+
+Then run `bundle install`.
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'pnap_location_api'
+
+api_instance = LocationApi::LocationsApi.new
+opts = {
+  location: LocationApi::LocationEnum::PHX, # LocationEnum | Location of interest
+  product_category: LocationApi::ProductCategoryEnum::SERVER # ProductCategoryEnum | Product category of interest
+}
+
+begin
+  #Get All Locations
+  result = api_instance.get_locations(opts)
+  p result
+rescue LocationApi::ApiError => e
+  puts "Exception when calling LocationsApi->get_locations: #{e}"
+end
+
+```
+
+Authorization can also be setup by using the [`oauth`](https://github.com/oauth-xx/oauth2) library:
+
+```ruby
+# Load the gem
+require 'pnap_location_api'
+require 'oauth2'
+
+# Setup variables for getting a token.
+client_id = 'YOUR_CLIENT_ID'
+client_secret = 'YOUR_CLIENT_SECRET'
+auth_url = 'https://auth.phoenixnap.com/auth/realms/BMC/protocol/openid-connect/token'
+
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.phoenixnap.com/location-api/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*LocationApi::LocationsApi* | [**get_locations**](docs/LocationsApi.md#get_locations) | **GET** /locations | Get All Locations
+
+
+## Documentation for Models
+
+ - [LocationApi::Error](docs/Error.md)
+ - [LocationApi::Location](docs/Location.md)
+ - [LocationApi::LocationEnum](docs/LocationEnum.md)
+ - [LocationApi::ProductCategory](docs/ProductCategory.md)
+ - [LocationApi::ProductCategoryEnum](docs/ProductCategoryEnum.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/docs/Error.md

@@ -0,0 +1,20 @@
+# LocationApi::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | The description detailing the cause of the error code. | [readonly] |
+| **validation_errors** | **Array<String>** | Validation errors, if any. | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'pnap_location_api'
+
+instance = LocationApi::Error.new(
+  message: null,
+  validation_errors: null
+)
+```
+

data/docs/Location.md

@@ -0,0 +1,22 @@
+# LocationApi::Location
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **location** | [**LocationEnum**](LocationEnum.md) |  |  |
+| **location_description** | **String** |  | [optional] |
+| **product_categories** | [**Array<ProductCategory>**](ProductCategory.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_location_api'
+
+instance = LocationApi::Location.new(
+  location: null,
+  location_description: Phoenix, USA,
+  product_categories: null
+)
+```
+

data/docs/LocationEnum.md

@@ -0,0 +1,15 @@
+# LocationApi::LocationEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pnap_location_api'
+
+instance = LocationApi::LocationEnum.new()
+```
+

data/docs/LocationsApi.md

@@ -0,0 +1,76 @@
+# LocationApi::LocationsApi
+
+All URIs are relative to *https://api.phoenixnap.com/location-api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_locations**](LocationsApi.md#get_locations) | **GET** /locations | Get All Locations |
+
+
+## get_locations
+
+> <Array<Location>> get_locations(opts)
+
+Get All Locations
+
+Retrieve the locations info.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_location_api'
+
+api_instance = LocationApi::LocationsApi.new
+opts = {
+  location: LocationApi::LocationEnum::PHX, # LocationEnum | Location of interest
+  product_category: LocationApi::ProductCategoryEnum::SERVER # ProductCategoryEnum | Product category of interest
+}
+
+begin
+  # Get All Locations
+  result = api_instance.get_locations(opts)
+  p result
+rescue LocationApi::ApiError => e
+  puts "Error when calling LocationsApi->get_locations: #{e}"
+end
+```
+
+#### Using the get_locations_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Location>>, Integer, Hash)> get_locations_with_http_info(opts)
+
+```ruby
+begin
+  # Get All Locations
+  data, status_code, headers = api_instance.get_locations_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Location>>
+rescue LocationApi::ApiError => e
+  puts "Error when calling LocationsApi->get_locations_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **location** | [**LocationEnum**](.md) | Location of interest | [optional] |
+| **product_category** | [**ProductCategoryEnum**](.md) | Product category of interest | [optional] |
+
+### Return type
+
+[**Array&lt;Location&gt;**](Location.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ProductCategory.md

@@ -0,0 +1,20 @@
+# LocationApi::ProductCategory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_category** | [**ProductCategoryEnum**](ProductCategoryEnum.md) |  |  |
+| **product_category_description** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_location_api'
+
+instance = LocationApi::ProductCategory.new(
+  product_category: null,
+  product_category_description: Bare metal server
+)
+```
+

data/docs/ProductCategoryEnum.md

@@ -0,0 +1,15 @@
+# LocationApi::ProductCategoryEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pnap_location_api'
+
+instance = LocationApi::ProductCategoryEnum.new()
+```
+

data/lib/pnap_location_api/api/locations_api.rb

@@ -0,0 +1,85 @@
+=begin
+#Locations API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.1.0
+
+=end
+
+require 'cgi'
+
+module LocationApi
+  class LocationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get All Locations
+    # Retrieve the locations info.
+    # @param [Hash] opts the optional parameters
+    # @option opts [LocationEnum] :location Location of interest
+    # @option opts [ProductCategoryEnum] :product_category Product category of interest
+    # @return [Array<Location>]
+    def get_locations(opts = {})
+      data, _status_code, _headers = get_locations_with_http_info(opts)
+      data
+    end
+
+    # Get All Locations
+    # Retrieve the locations info.
+    # @param [Hash] opts the optional parameters
+    # @option opts [LocationEnum] :location Location of interest
+    # @option opts [ProductCategoryEnum] :product_category Product category of interest
+    # @return [Array<(Array<Location>, Integer, Hash)>] Array<Location> data, response status code and response headers
+    def get_locations_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LocationsApi.get_locations ...'
+      end
+      # resource path
+      local_var_path = '/locations'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'location'] = opts[:'location'] if !opts[:'location'].nil?
+      query_params[:'productCategory'] = opts[:'product_category'] if !opts[:'product_category'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<Location>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"LocationsApi.get_locations",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LocationsApi#get_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end