stage-ruby 0.0.02 → 0.0.03

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fca366a510de64357d0fe5b697797ea9ce0915fbde30e1cbff1c5c0a131a311
-  data.tar.gz: de34dfc043afd1b479f595536a34de81f8bde868e62aa32e7942f2a5980089b0
+  metadata.gz: a8d7dd1333a2e7a46ab3a03c46d6de8408b365980d779926698c884137b2d93e
+  data.tar.gz: 1e4ec0c51ca67372c5b803fcfbe73243422ae360898083a63665299547d62fce
 SHA512:
-  metadata.gz: 693fae7376e6b09005bc78d00d03450fb1e427a15ed066a562000ddcc244bbe2b9a72c6bd2f44930acbec084d64ebbfa74e9a0b40d07fef6db6a72c1bde0408b
-  data.tar.gz: 28fa37e7a9be6100109ea9b570346a28a5a096450525d742afcc5cfb8d7b42c109773a6090574fb79dead0536ac542315fc64ce5f6a7313ea9b4e5646929b32f
+  metadata.gz: 1b694ed28479e23f7ffa1d99806ac9dd2750908f5ba0e0bc4a37228d6e43c9164a4953e805a23e51227e37bbb92619369e19d4c2210c0c4fc02a188b9bfd3162
+  data.tar.gz: 1ea07c3cb282a46d09d36a5aeb7e0fb5c9b7f7de18ff0991af675a8f410f49dd06ee3eea0a2bf432bf83b6aeacbd91df49cdcda2969dee8789b13daa9aa9c475

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')
@@ -121,8 +148,9 @@ end
 | 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 feature. |
-| *Stage::StageApi* | [**update_user_plan**](docs/StageApi.md#update_user_plan) | **PUT** /sdk-api/v1/users/{userIdentifier}/plans    | Updates a user's plan..                                |
+| *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 +158,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 +171,3 @@ end
 - **Type**: API key
 - **API key parameter name**: Authorization
 - **Location**: HTTP header
-

data/docs/ClientUserObjectForm.md

@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **arena_id** | **Integer** | The Arena ID of the client user. | [optional] 
 **created_at** | **DateTime** | The creation date. | [optional] 
+**created_by** | [**StageUserObjectForm**](StageUserObjectForm.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] 

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

@@ -5,8 +5,9 @@ All URIs are relative to *//localhost:8080/*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**create_user**](StageApi.md#create_user) | **POST** /sdk-api/v1/users | Creates a user and assigning it to a pre-defined role.
+[**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 feature.
-[**update_user_plan**](StageApi.md#update_user_plan) | **PUT** /sdk-api/v1/users/{userIdentifier}/plans | Updates a user's plan..
+[**update_user_plan**](StageApi.md#update_user_plan) | **PUT** /sdk-api/v1/users/{userIdentifier}/plans | Updates a user's plan.
 
 # **create_user**
 > ClientUserForm create_user(body)
@@ -59,8 +60,54 @@ Name | Type | Description  | Notes
 
 
 
+# **get_plans**
+> Array<PlanObjectForm> 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'
+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<PlanObjectForm>**](PlanObjectForm.md)
+
+### Authorization
+
+[stage-api-token](../README.md#stage-api-token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
 # **has_access**
-> AccessForm has_access(identifiers, user_identifier)
+> AccessForm has_access(identifiers, user_identifier, mark_accessed)
 
 Checks if a user has access to the identified feature.
 
@@ -77,13 +124,14 @@ Stage.configure do |config|
 end
 
 api_instance = Stage::StageApi.new
-identifiers = ['identifiers_example'] # Array<String> | identifiers
+identifiers = ['identifiers_example'] # Array<String> | The identifiers of the features being accessed.
+mark_accessed = true # BOOLEAN | Whether this has-access check should mark the features as having been 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.
-  result = api_instance.has_access(identifiers, user_identifier)
+  result = api_instance.has_access(identifiers, user_identifier, mark_accessed)
   p result
 rescue Stage::ApiError => e
   puts "Exception when calling StageApi->has_access: #{e}"
@@ -94,7 +142,8 @@ 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. | 
+ **mark_accessed** | **BOOLEAN**| Whether this has-access check should mark the features as having been accessed. | 
  **user_identifier** | **String**| The identifier of the user who is accessing the feature. | 
 
 ### Return type
@@ -115,7 +164,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
@@ -135,7 +184,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

data/docs/StageUserObjectForm.md

@@ -0,0 +1,11 @@
+# Stage::StageUserObjectForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**arena_id** | **Integer** |  | [optional] 
+**deleted** | **BOOLEAN** |  | [optional] 
+**email** | **String** |  | [optional] 
+**id** | **Integer** |  | [optional] 
+**password** | **String** |  | [optional] 
+

data/lib/stage-ruby/api/stage_api.rb

@@ -84,35 +84,85 @@ module Stage
       return data, status_code, headers
     end
 
+    # Gets all plans.
+    # @return [Array<PlanObjectForm>]
+    def get_plans()
+      data, _status_code, _headers = get_plans_with_http_info({})
+      data
+    end
+
+    # Gets all plans.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<PlanObjectForm>, Integer, Hash)>] Array<PlanObjectForm> data, response status code and response headers
+    def get_plans_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StageApi.get_plans ...'
+      end
+      # resource path
+      local_var_path = PLANS_PATH
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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[:body]
+
+      return_type = opts[:return_type] || 'Array<PlanObjectForm>'
+
+      auth_names = opts[:auth_names] || ['stage-api-token']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StageApi#get_plans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Checks if a user has access to the identified feature.
     # @param user_identifier The identifier of the user who is accessing the feature.
     # @param feature_identifiers identifiers
+    # @param mark_accessed Whether this has-access check should mark the features as having been accessed.
     # @return [AccessForm]
-    def has_access_verbose(user_identifier, feature_identifiers)
-      data, _status_code, _headers = has_access_with_http_info(user_identifier, feature_identifiers, {})
+    def has_access_verbose(user_identifier, feature_identifiers, mark_accessed)
+      data, _status_code, _headers = has_access_with_http_info(user_identifier, feature_identifiers, mark_accessed, {})
       data
     end
 
-    def has_access(user_identifier, feature_identifier)
-      has_access_to_all(user_identifier, [feature_identifier])
+    def has_access(user_identifier, feature_identifier, mark_accessed)
+      has_access_to_all(user_identifier, [feature_identifier], mark_accessed)
     end
 
-    def has_access_to_any(user_identifier, feature_identifiers)
-      data, _status_code, _headers = has_access_with_http_info(user_identifier, feature_identifiers, {})
+    def has_access_to_any(user_identifier, feature_identifiers, mark_accessed)
+      data, _status_code, _headers = has_access_with_http_info(user_identifier, feature_identifiers, mark_accessed, {})
       data.features.map { |feature| feature[:hasAccess] }.any?
     end
 
-    def has_access_to_all(user_identifier, feature_identifiers)
-      data, _status_code, _headers = has_access_with_http_info(user_identifier, feature_identifiers, {})
+    def has_access_to_all(user_identifier, feature_identifiers, mark_accessed)
+      data, _status_code, _headers = has_access_with_http_info(user_identifier, feature_identifiers, mark_accessed, {})
       data.features.map { |feature| feature[:hasAccess] }.all?
     end
 
     # Checks if a user has access to the identified feature.
-    # @param feature_identifiers identifiers
     # @param user_identifier The identifier of the user who is accessing the feature.
+    # @param feature_identifiers identifiers
+    # @param mark_accessed Whether this has-access check should mark the features as having been accessed.
     # @param [Hash] opts the optional parameters
     # @return [Array<(AccessForm, Integer, Hash)>] AccessForm data, response status code and response headers
-    def has_access_with_http_info(user_identifier, feature_identifiers, opts = {})
+    def has_access_with_http_info(user_identifier, feature_identifiers, mark_accessed, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: StageApi.has_access ...'
       end
@@ -130,6 +180,7 @@ module Stage
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'identifiers'] = @api_client.build_collection_param(feature_identifiers, :csv)
+      query_params[:'markAccessed'] = mark_accessed
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -159,7 +210,7 @@ module Stage
       return data, status_code, headers
     end
 
-    # Updates a user's plan..
+    # Updates a user's plan.
     # @param user_identifier The identifier of the user.
     # @param plan_identifier The plan identifier.
     # @return [ClientUserForm]
@@ -176,7 +227,7 @@ module Stage
       data
     end
 
-    # Updates a user&#x27;s plan..
+    # Updates a user&#x27;s plan.
     # @param user_identifier The identifier of the user.
     # @param body The payload containing the information to update a user&#x27;s plan. Only identifier and planIdentifier fields are required.
     # @param [Hash] opts the optional parameters

data/lib/stage-ruby/models/client_user_object_form.rb

@@ -19,6 +19,8 @@ module Stage
     # The creation date.
     attr_accessor :created_at
 
+    attr_accessor :created_by
+
     # A boolean value indicating whether the client user is deleted or not.
     attr_accessor :deleted
 
@@ -39,6 +41,7 @@ module Stage
       {
         :'arena_id' => :'arenaId',
         :'created_at' => :'createdAt',
+        :'created_by' => :'createdBy',
         :'deleted' => :'deleted',
         :'id' => :'id',
         :'identifier' => :'identifier',
@@ -52,6 +55,7 @@ module Stage
       {
         :'arena_id' => :'Object',
         :'created_at' => :'Object',
+        :'created_by' => :'Object',
         :'deleted' => :'Object',
         :'id' => :'Object',
         :'identifier' => :'Object',
@@ -89,6 +93,10 @@ module Stage
         self.created_at = attributes[:'created_at']
       end
 
+      if attributes.key?(:'created_by')
+        self.created_by = attributes[:'created_by']
+      end
+
       if attributes.key?(:'deleted')
         self.deleted = attributes[:'deleted']
       end
@@ -130,6 +138,7 @@ module Stage
       self.class == o.class &&
           arena_id == o.arena_id &&
           created_at == o.created_at &&
+          created_by == o.created_by &&
           deleted == o.deleted &&
           id == o.id &&
           identifier == o.identifier &&
@@ -146,7 +155,7 @@ module Stage
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [arena_id, created_at, deleted, id, identifier, plan_id, plan_identifier].hash
+      [arena_id, created_at, created_by, deleted, id, identifier, plan_id, plan_identifier].hash
     end
 
     # Builds the object from hash