stage-ruby 0.0.02 → 0.0.04

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fca366a510de64357d0fe5b697797ea9ce0915fbde30e1cbff1c5c0a131a311
-  data.tar.gz: de34dfc043afd1b479f595536a34de81f8bde868e62aa32e7942f2a5980089b0
+  metadata.gz: 560a6c5af4474f961980b195795265a741824d6a517ca12b4a27a8de015dd512
+  data.tar.gz: 4c04f092e12f39d8a00e8df00f95d281feabf7e0f74ad4426ecd8d7e36778bf5
 SHA512:
-  metadata.gz: 693fae7376e6b09005bc78d00d03450fb1e427a15ed066a562000ddcc244bbe2b9a72c6bd2f44930acbec084d64ebbfa74e9a0b40d07fef6db6a72c1bde0408b
-  data.tar.gz: 28fa37e7a9be6100109ea9b570346a28a5a096450525d742afcc5cfb8d7b42c109773a6090574fb79dead0536ac542315fc64ce5f6a7313ea9b4e5646929b32f
+  metadata.gz: b7b28a3f9e959634955a23c41fc4ef366ac2927d9ac1be2763fc4b8ce8d6e105d4fe9040c6da15001841e4a66ea2f39d3cc83ced2fdd18b12d55cdd067b1999f
+  data.tar.gz: ab1c989921d086981538f857a237dd9800ba3eff86d8f3d07b6cde9729439135e4bcdc3abd7f3aa872d4379ab1490a69fb1d086777e1af424d513fd89b4a08c2

data/README.md

@@ -47,7 +47,9 @@ rvm use 3.0.0@stage-ruby
 bundle install
 ```
 
-### 1.2. Build Gem and Install Locally
+### 1.2. Build and Publish `stage-ruby` Gem Locally
+
+To build and publish `stage-ruby` gem locally for development or test, follow these steps:
 
 1. Build Ruby code into a gem:
 
@@ -61,19 +63,43 @@ gem build stage-ruby.gemspec
 gem install ./stage-ruby-{VERSION}.gem
 ```
 
-## 2. Using `stage-ruby` Gem
+To find the installation directory, run the following command: `rvm gemdir`.
+
+### 1.3. Build and Publish `stage-ruby` Gem to RubyGems.org
+
+Before proceeding, please see the RubyGems's documentation on how to publish a gem
+[here](https://guides.rubygems.org/publishing/). To build and publish `stage-ruby` gem to
+[RubyGems.org](https://guides.rubygems.org/), follow these steps:
+
+1. Either create an account on RubyGems.org or use an existing account (username: `dennis_stage`, password: see
+the password stored in Doppler's `RUBY_GEMS_PASSWORD`, under the `general` environment).
 
-To use a locally installed `stage-ruby` gem, add the following to your project's Gemfile, where `{GEM_DIR}` is your
-local gem installation directory (run `rvm gemdir` to find out):
+2. Build Ruby code into a gem:
 
 ```shell
-gem 'stage-ruby', "~> 0.0.01", :path => '{GEM_DIR}'
+gem build stage-ruby.gemspec
 ```
 
-To use the `stage-ruby` that's uploaded to a gem service, add the following to your project's Gemfile, where `{VERSION}`
-is the gem's version number:
+2. Push `stage-ruby` to RubyGems.org, where `{VERSION}` is the gem's version number (enter your username and password
+when prompted):
 
+```shell
+gem push stage-ruby-{VERSION}.gem
 ```
+
+## 2. Using `stage-ruby` Gem
+
+When the `stage-ruby` gem is installed locally, add the following to your project's Gemfile, where `{VERSION}` is
+the gem's version number, and `{GEM_DIR}` is your local gem installation directory (again, `rvm gemdir` to find out):
+
+```ruby
+gem 'stage-ruby', '~> {VERSION}', :path => '{GEM_DIR}'
+```
+
+To use the `stage-ruby` from RubyGems.org, add the following to your project's Gemfile, where `{VERSION}` is the gem's
+version number:
+
+```ruby
 gem 'stage-ruby', '~> {VERSION}'
 ```
 
@@ -105,7 +131,8 @@ begin
   new_user = api_instance.create_user(user_identifier, feature_identifier: 'BASIC_PLAN')
   p "Created user: #{new_user}"
 
-  result = api_instance.has_access(user_identifier, feature_identifier: 'BASIC_PLAN')
+  mark_accessed = true
+  result = api_instance.has_access(user_identifier, feature_identifier: 'BASIC_PLAN', mark_accessed)
   p "User #{user_identifier} has access to plan: #{result}"
 
   updated_user = api_instance.update_user_plan(user_identifier, feature_identifier: 'PRO_PLAN')
@@ -118,11 +145,14 @@ end
 
 ## 4. Documentation for API Endpoints
 
-| Class             | Method                                                    | HTTP request                                        | Description                                            |
-|-------------------|-----------------------------------------------------------|-----------------------------------------------------|--------------------------------------------------------|
-| *Stage::StageApi* | [**create_user**](docs/StageApi.md#create_user)           | **POST** /sdk-api/v1/users                          | Creates a user and assigning it to a pre-defined role. |
-| *Stage::StageApi* | [**has_access**](docs/StageApi.md#has_access)             | **GET** /sdk-api/v1/users/{userIdentifier}/features | Checks if a user has access to the identified feature. |
-| *Stage::StageApi* | [**update_user_plan**](docs/StageApi.md#update_user_plan) | **PUT** /sdk-api/v1/users/{userIdentifier}/plans    | Updates a user's plan..                                |
+| Class             | Method                                                    | HTTP request                                           | Description                                                                    |
+|-------------------|-----------------------------------------------------------|--------------------------------------------------------|--------------------------------------------------------------------------------|
+| *Stage::StageApi* | [**create_user**](docs/StageApi.md#create_user)           | **POST** /sdk-api/v1/users                             | Creates a user and assigning it to a pre-defined role.                         |
+| *Stage::StageApi* | [**get_plans**](docs/StageApi.md#get_plans)               | **GET** /sdk-api/v1/plans                              | Gets all plans.                                                                |
+| *Stage::StageApi* | [**has_access**](docs/StageApi.md#has_access)             | **GET** /sdk-api/v1/users/{userIdentifier}/features    | Checks if a user has access to the identified features.                        |
+| *Stage::StageApi* | [**access**](docs/StageApi.md#access)                     | **POST** /sdk-api/v1/users/{userIdentifier}/features   | If the user has access to the features, this marks those features as accessed. |
+| *Stage::StageApi* | [**un_access**](docs/StageApi.md#un_access)               | **DELETE** /sdk-api/v1/users/{userIdentifier}/features | If the user has access to the features, this un-accesses those features.       |
+| *Stage::StageApi* | [**update_user_plan**](docs/StageApi.md#update_user_plan) | **PUT** /sdk-api/v1/users/{userIdentifier}/plans       | Updates a user's plan.                                                         |
 
 ## 5. Documentation for Models
 
@@ -130,8 +160,11 @@ end
  - [Stage::AccessForm](docs/AccessForm.md)
  - [Stage::ClientUserForm](docs/ClientUserForm.md)
  - [Stage::ClientUserObjectForm](docs/ClientUserObjectForm.md)
+ - [Stage::FeatureObjectForm](docs/FeatureObjectForm.md)
  - [Stage::Field](docs/Field.md)
+ - [Stage::PlanObjectForm](docs/PlanObjectForm.md)
  - [Stage::StageError](docs/StageError.md)
+ - [Stage::StageUserObjectForm](docs/StageUserObjectForm.md)
 
 ## 6. Documentation for Authorization
 
@@ -140,4 +173,3 @@ end
 - **Type**: API key
 - **API key parameter name**: Authorization
 - **Location**: HTTP header
-

data/docs/ClientUserObjectForm.md

@@ -5,9 +5,12 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **arena_id** | **Integer** | The Arena ID of the client user. | [optional] 
 **created_at** | **DateTime** | The creation date. | [optional] 
+**created_by** | [**StageUserObjectFormReq**](StageUserObjectFormReq.md) |  | [optional]
 **deleted** | **BOOLEAN** | A boolean value indicating whether the client user is deleted or not. | [optional] 
 **id** | **Integer** | The ID of the client user. | [optional] 
 **identifier** | **String** | A client user identifier. | [optional] 
+**organization_id** | **Integer** | The organization this user belongs to. | [optional]
 **plan_id** | **Integer** | The plan to be assigned to the client user. | [optional] 
 **plan_identifier** | **String** | The plan to be assigned to the user. | [optional] 
+**plan_role_id** | **Integer** | The role within the organization's plan this user is assigned. | [optional]
 

data/docs/FeatureObjectForm.md

@@ -0,0 +1,11 @@
+# Stage::FeatureObjectForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | Feature description. | [optional] 
+**identifier** | **String** | Feature identifier. | [optional] 
+**limit** | **Integer** | Feature limit. | [optional] 
+**name** | **String** | Feature name. | [optional] 
+**order** | **Integer** | Feature order. | [optional] 
+

data/docs/PlanObjectForm.md

@@ -0,0 +1,12 @@
+# Stage::PlanObjectForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | Plan description. | [optional] 
+**features** | [**Array<FeatureObjectForm>**](FeatureObjectForm.md) | Features associated to this plan. | [optional] 
+**identifier** | **String** | Plan identifier. | [optional] 
+**name** | **String** | Plan name. | [optional] 
+**order** | **Integer** | Plan order. | [optional] 
+**stripe_product_id** | **String** | Stripe product identifier. | [optional] 
+

data/docs/StageApi.md

@@ -4,9 +4,70 @@ All URIs are relative to *//localhost:8080/*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**access**](StageApi.md#access) | **POST** /sdk-api/v1/users/{userIdentifier}/features | If the user has access to the features, this marks those features as accessed.
 [**create_user**](StageApi.md#create_user) | **POST** /sdk-api/v1/users | Creates a user and assigning it to a pre-defined role.
-[**has_access**](StageApi.md#has_access) | **GET** /sdk-api/v1/users/{userIdentifier}/features | Checks if a user has access to the identified feature.
-[**update_user_plan**](StageApi.md#update_user_plan) | **PUT** /sdk-api/v1/users/{userIdentifier}/plans | Updates a user's plan..
+[**get_plans**](StageApi.md#get_plans) | **GET** /sdk-api/v1/plans | Gets all plans.
+[**has_access**](StageApi.md#has_access) | **GET** /sdk-api/v1/users/{userIdentifier}/features | Checks if a user has access to the identified features.
+[**un_access**](StageApi.md#un_access) | **DELETE** /sdk-api/v1/users/{userIdentifier}/features | If the user has access to the features, this un-accesses those features.
+[**update_user_plan**](StageApi.md#update_user_plan) | **PUT** /sdk-api/v1/users/{userIdentifier}/plans | Updates a user's plan.
+
+# **access**
+> AccessForm access(identifiers, user_identifier)
+
+If the user has access to the features, this marks those features as accessed.
+
+### Example
+```ruby
+# load the gem
+require 'stage-ruby'
+# setup authorization
+Stage.configure do |config|
+  # Configure API key authorization: stage-api-token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+
+  # Configure API key authorization: stage-read-only-api-token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Stage::StageApi.new
+identifiers = ['identifiers_example'] # Array<String> | The identifiers of the features being accessed.
+user_identifier = 'user_identifier_example' # String | The identifier of the user who is accessing the feature.
+
+
+begin
+  #If the user has access to the features, this marks those features as accessed.
+  result = api_instance.access(identifiers, user_identifier)
+  p result
+rescue Stage::ApiError => e
+  puts "Exception when calling StageApi->access: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifiers** | [**Array&lt;String&gt;**](String.md)| The identifiers of the features being accessed. |
+ **user_identifier** | **String**| The identifier of the user who is accessing the feature. |
+
+### Return type
+
+[**AccessForm**](AccessForm.md)
+
+### Authorization
+
+[stage-api-token](../README.md#stage-api-token), [stage-read-only-api-token](../README.md#stage-read-only-api-token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 
 # **create_user**
 > ClientUserForm create_user(body)
@@ -23,6 +84,11 @@ Stage.configure do |config|
   config.api_key['Authorization'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['Authorization'] = 'Bearer'
+
+  # Configure API key authorization: stage-read-only-api-token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
 end
 
 api_instance = Stage::StageApi.new
@@ -50,7 +116,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[stage-api-token](../README.md#stage-api-token)
+[stage-api-token](../README.md#stage-api-token), [stage-read-only-api-token](../README.md#stage-read-only-api-token)
 
 ### HTTP request headers
 
@@ -59,10 +125,61 @@ Name | Type | Description  | Notes
 
 
 
+# **get_plans**
+> Array&lt;PlanObjectForm&gt; get_plans
+
+Gets all plans.
+
+### Example
+```ruby
+# load the gem
+require 'stage-ruby'
+# setup authorization
+Stage.configure do |config|
+  # Configure API key authorization: stage-api-token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+
+  # Configure API key authorization: stage-read-only-api-token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Stage::StageApi.new
+
+begin
+  #Gets all plans.
+  result = api_instance.get_plans
+  p result
+rescue Stage::ApiError => e
+  puts "Exception when calling StageApi->get_plans: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;PlanObjectForm&gt;**](PlanObjectForm.md)
+
+### Authorization
+
+[stage-api-token](../README.md#stage-api-token), [stage-read-only-api-token](../README.md#stage-read-only-api-token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
 # **has_access**
 > AccessForm has_access(identifiers, user_identifier)
 
-Checks if a user has access to the identified feature.
+Checks if a user has access to the identified features.
 
 ### Example
 ```ruby
@@ -74,15 +191,20 @@ Stage.configure do |config|
   config.api_key['Authorization'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['Authorization'] = 'Bearer'
+
+  # Configure API key authorization: stage-read-only-api-token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
 end
 
 api_instance = Stage::StageApi.new
-identifiers = ['identifiers_example'] # Array<String> | identifiers
+identifiers = ['identifiers_example'] # Array<String> | The identifiers of the features being accessed.
 user_identifier = 'user_identifier_example' # String | The identifier of the user who is accessing the feature.
 
 
 begin
-  #Checks if a user has access to the identified feature.
+  #Checks if a user has access to the identified features.
   result = api_instance.has_access(identifiers, user_identifier)
   p result
 rescue Stage::ApiError => e
@@ -94,7 +216,67 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **identifiers** | [**Array&lt;String&gt;**](String.md)| identifiers | 
+ **identifiers** | [**Array&lt;String&gt;**](String.md)| The identifiers of the features being accessed. | 
+ **user_identifier** | **String**| The identifier of the user who is accessing the feature. | 
+
+### Return type
+
+[**AccessForm**](AccessForm.md)
+
+### Authorization
+
+[stage-api-token](../README.md#stage-api-token), [stage-read-only-api-token](../README.md#stage-read-only-api-token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **un_access**
+> AccessForm un_access(as_credit, identifiers, user_identifier)
+
+If the user has access to the features, this un-accesses those features.
+
+### Example
+```ruby
+# load the gem
+require 'stage-ruby'
+# setup authorization
+Stage.configure do |config|
+  # Configure API key authorization: stage-api-token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+
+  # Configure API key authorization: stage-read-only-api-token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Stage::StageApi.new
+as_credit = true # BOOLEAN | When set to true, this un-accessing of a feature is treated as a credit instead of decrementing the access count.
+identifiers = ['identifiers_example'] # Array<String> | The identifiers of the features being accessed.
+user_identifier = 'user_identifier_example' # String | The identifier of the user who is accessing the feature.
+
+
+begin
+  #If the user has access to the features, this un-accesses those features.
+  result = api_instance.un_access(as_credit, identifiers, user_identifier)
+  p result
+rescue Stage::ApiError => e
+  puts "Exception when calling StageApi->un_access: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **as_credit** | **BOOLEAN**| When set to true, this un-accessing of a feature is treated as a credit instead of decrementing the access count. | 
+ **identifiers** | [**Array&lt;String&gt;**](String.md)| The identifiers of the features being accessed. | 
  **user_identifier** | **String**| The identifier of the user who is accessing the feature. | 
 
 ### Return type
@@ -103,7 +285,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[stage-api-token](../README.md#stage-api-token)
+[stage-api-token](../README.md#stage-api-token), [stage-read-only-api-token](../README.md#stage-read-only-api-token)
 
 ### HTTP request headers
 
@@ -115,7 +297,7 @@ Name | Type | Description  | Notes
 # **update_user_plan**
 > ClientUserForm update_user_plan(bodyuser_identifier)
 
-Updates a user's plan..
+Updates a user's plan.
 
 ### Example
 ```ruby
@@ -127,6 +309,11 @@ Stage.configure do |config|
   config.api_key['Authorization'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['Authorization'] = 'Bearer'
+
+  # Configure API key authorization: stage-read-only-api-token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
 end
 
 api_instance = Stage::StageApi.new
@@ -135,7 +322,7 @@ user_identifier = 'user_identifier_example' # String | The identifier of the use
 
 
 begin
-  #Updates a user's plan..
+  #Updates a user's plan.
   result = api_instance.update_user_plan(bodyuser_identifier)
   p result
 rescue Stage::ApiError => e
@@ -147,7 +334,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **body** | [**ClientUserForm**](ClientUserForm.md)| The payload containing the information to update a user&#x27;s plan. Only identifier and planIdentifier fields are required. | 
+ **body** | [**ClientUserForm**](ClientUserForm.md)| The payload containing the information to update a user&#x27;s plan. Only identifier and planIdentifier fields are required. |
  **user_identifier** | **String**| The identifier of the user. | 
 
 ### Return type
@@ -156,7 +343,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[stage-api-token](../README.md#stage-api-token)
+[stage-api-token](../README.md#stage-api-token), [stage-read-only-api-token](../README.md#stage-read-only-api-token)
 
 ### HTTP request headers
 

data/docs/StageUserObjectForm.md

@@ -0,0 +1,17 @@
+# Stage::StageUserObjectForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**arena_id** | **Integer** |  | [optional] 
+**created_at** | **DateTime** |  | [optional]
+**deleted** | **BOOLEAN** |  | [optional] 
+**email** | **String** |  | [optional] 
+**existing_password** | **String** |  | [optional]
+**first_name** | **String** |  | [optional]
+**id** | **Integer** |  | [optional]
+**invite_accepted** | **BOOLEAN** |  | [optional]
+**last_name** | **String** |  | [optional]
+**password** | **String** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional]
+