stage-ruby 0.0.02 → 0.0.04

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

@@ -84,6 +84,54 @@ 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
@@ -108,8 +156,8 @@ module Stage
     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 [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 = {})
@@ -159,7 +207,159 @@ module Stage
       return data, status_code, headers
     end
 
-    # Updates a user's plan..
+    # If the user has access to the feature, this marks that feature as accessed.
+    # @param user_identifier The identifier of the user who is accessing the feature.
+    # @param feature_identifier The feature_identifier of the feature being accessed.
+    # @param [Hash] opts the optional parameters
+    # @return [AccessForm]
+    def access(user_identifier, feature_identifier, opts = {})
+      data, _status_code, _headers = access_with_http_info(user_identifier, [feature_identifier], opts)
+      data
+    end
+
+    # If the user has access to the features, this marks those features as accessed.
+    # @param user_identifier The identifier of the user who is accessing the feature.
+    # @param feature_identifiers The feature_identifiers of the features being accessed.
+    # @param [Hash] opts the optional parameters
+    # @return [AccessForm]
+    def accessAll(user_identifier, feature_identifiers, opts = {})
+      data, _status_code, _headers = access_with_http_info(user_identifier, feature_identifiers, opts)
+      data
+    end
+
+    # If the user has access to the features, this marks those features as accessed.
+    # @param user_identifier The identifier of the user who is accessing the feature.
+    # @param feature_identifiers The identifiers of the features being accessed.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccessForm, Integer, Hash)>] AccessForm data, response status code and response headers
+    def access_with_http_info(user_identifier, feature_identifiers, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StageApi.access ...'
+      end
+      # verify the required parameter 'feature_identifiers' is set
+      if @api_client.config.client_side_validation && feature_identifiers.nil?
+        fail ArgumentError, "Missing the required parameter 'feature_identifiers' when calling StageApi.access"
+      end
+      # verify the required parameter 'user_identifier' is set
+      if @api_client.config.client_side_validation && user_identifier.nil?
+        fail ArgumentError, "Missing the required parameter 'user_identifier' when calling StageApi.access"
+      end
+      # resource path
+      local_var_path = '/sdk-api/v1/users/{userIdentifier}/features'.sub('{' + 'userIdentifier' + '}', user_identifier.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'identifiers'] = @api_client.build_collection_param(feature_identifiers, :multi)
+
+      # 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] || 'AccessForm'
+
+      auth_names = opts[:auth_names] || ['stage-api-token', 'stage-read-only-api-token']
+      data, status_code, headers = @api_client.call_api(:POST, 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#access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # If the user has access to the feature, this un-accesses that features.
+    # @param user_identifier The identifier of the user who is accessing the feature.
+    # @param feature_identifier The identifier of the feature being accessed.
+    # @param as_credit When set to true, this un-accessing of a feature is treated as a credit instead of decrementing the access count.
+    # @param [Hash] opts the optional parameters
+    # @return [AccessForm]
+    def un_access(user_identifier, feature_identifier, as_credit, opts = {})
+      data, _status_code, _headers = un_access_with_http_info(as_credit, [feature_identifier], user_identifier, opts)
+      data
+    end
+
+    # If the user has access to the features, this un-accesses those features.
+    # @param user_identifier The identifier of the user who is accessing the feature.
+    # @param feature_identifiers The identifiers of the features being accessed.
+    # @param as_credit When set to true, this un-accessing of a feature is treated as a credit instead of decrementing the access count.
+    # @param [Hash] opts the optional parameters
+    # @return [AccessForm]
+    def un_access_all(user_identifier, feature_identifiers, as_credit, opts = {})
+      data, _status_code, _headers = un_access_with_http_info(as_credit, feature_identifiers, user_identifier, opts)
+      data
+    end
+
+    # If the user has access to the features, this un-accesses those features.
+    # @param as_credit When set to true, this un-accessing of a feature is treated as a credit instead of decrementing the access count.
+    # @param feature_identifiers The identifiers of the features being accessed.
+    # @param user_identifier The identifier of the user who is accessing the feature.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccessForm, Integer, Hash)>] AccessForm data, response status code and response headers
+    def un_access_with_http_info(user_identifier, feature_identifiers, as_credit, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StageApi.un_access ...'
+      end
+      # verify the required parameter 'as_credit' is set
+      if @api_client.config.client_side_validation && as_credit.nil?
+        fail ArgumentError, "Missing the required parameter 'as_credit' when calling StageApi.un_access"
+      end
+      # verify the required parameter 'feature_identifiers' is set
+      if @api_client.config.client_side_validation && feature_identifiers.nil?
+        fail ArgumentError, "Missing the required parameter 'feature_identifiers' when calling StageApi.un_access"
+      end
+      # verify the required parameter 'user_identifier' is set
+      if @api_client.config.client_side_validation && user_identifier.nil?
+        fail ArgumentError, "Missing the required parameter 'user_identifier' when calling StageApi.un_access"
+      end
+      # resource path
+      local_var_path = '/sdk-api/v1/users/{userIdentifier}/features'.sub('{' + 'userIdentifier' + '}', user_identifier.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'asCredit'] = as_credit
+      query_params[:'identifiers'] = @api_client.build_collection_param(feature_identifiers, :multi)
+
+      # 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] || 'AccessForm'
+
+      auth_names = opts[:auth_names] || ['stage-api-token', 'stage-read-only-api-token']
+      data, status_code, headers = @api_client.call_api(:DELETE, 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#un_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Updates a user's plan.
     # @param user_identifier The identifier of the user.
     # @param plan_identifier The plan identifier.
     # @return [ClientUserForm]
@@ -176,7 +376,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/configuration.rb

@@ -199,6 +199,13 @@ module Stage
             key: 'Authorization',
             value: api_key_with_prefix('Authorization')
           },
+        'stage-read-only-api-token' =>
+          {
+            type: 'api_key',
+            in: 'header',
+            key: 'Authorization',
+            value: api_key_with_prefix('Authorization')
+          },
       }
     end
   end

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
 
@@ -28,22 +30,31 @@ module Stage
     # A client user identifier.
     attr_accessor :identifier
 
+    # The organization this user belongs to.
+    attr_accessor :organization_id
+
     # The plan to be assigned to the client user.
     attr_accessor :plan_id
 
     # The plan to be assigned to the user.
     attr_accessor :plan_identifier
 
+    # The role within the organization's plan this user is assigned.
+    attr_accessor :plan_role_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'arena_id' => :'arenaId',
         :'created_at' => :'createdAt',
+        :'created_by' => :'createdBy',
         :'deleted' => :'deleted',
         :'id' => :'id',
         :'identifier' => :'identifier',
+        :'organization_id' => :'organizationId',
         :'plan_id' => :'planId',
-        :'plan_identifier' => :'planIdentifier'
+        :'plan_identifier' => :'planIdentifier',
+        :'plan_role_id' => :'planRoleId'
       }
     end
 
@@ -52,11 +63,14 @@ module Stage
       {
         :'arena_id' => :'Object',
         :'created_at' => :'Object',
+        :'created_by' => :'Object',
         :'deleted' => :'Object',
         :'id' => :'Object',
         :'identifier' => :'Object',
+        :'organization_id' => :'Object',
         :'plan_id' => :'Object',
-        :'plan_identifier' => :'Object'
+        :'plan_identifier' => :'Object',
+        :'plan_role_id' => :'Object'
       }
     end
 
@@ -89,6 +103,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
@@ -101,6 +119,10 @@ module Stage
         self.identifier = attributes[:'identifier']
       end
 
+      if attributes.key?(:'organization_id')
+        self.organization_id = attributes[:'organization_id']
+      end
+
       if attributes.key?(:'plan_id')
         self.plan_id = attributes[:'plan_id']
       end
@@ -108,6 +130,10 @@ module Stage
       if attributes.key?(:'plan_identifier')
         self.plan_identifier = attributes[:'plan_identifier']
       end
+
+      if attributes.key?(:'plan_role_id')
+        self.plan_role_id = attributes[:'plan_role_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -130,11 +156,14 @@ 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 &&
+          organization_id == o.organization_id &&
           plan_id == o.plan_id &&
-          plan_identifier == o.plan_identifier
+          plan_identifier == o.plan_identifier &&
+          plan_role_id == o.plan_role_id
     end
 
     # @see the `==` method
@@ -146,7 +175,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, organization_id, plan_id, plan_identifier, plan_role_id].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,247 @@
+=begin
+#Stage API Docs
+
+#Stage Technologies complete API Documentation
+
+OpenAPI spec version: 1.0.0
+Contact: support@heystage.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.33
+=end
+
+require 'date'
+
+module Stage
+  class FeatureObjectForm
+    # Feature description.
+    attr_accessor :description
+
+    # Feature identifier.
+    attr_accessor :identifier
+
+    # Feature limit.
+    attr_accessor :limit
+
+    # Feature name.
+    attr_accessor :name
+
+    # Feature order.
+    attr_accessor :order
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'identifier' => :'identifier',
+        :'limit' => :'limit',
+        :'name' => :'name',
+        :'order' => :'order'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'description' => :'Object',
+        :'identifier' => :'Object',
+        :'limit' => :'Object',
+        :'name' => :'Object',
+        :'order' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+  
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Stage::FeatureObjectForm` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Stage::FeatureObjectForm`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'identifier')
+        self.identifier = attributes[:'identifier']
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'order')
+        self.order = attributes[:'order']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          description == o.description &&
+          identifier == o.identifier &&
+          limit == o.limit &&
+          name == o.name &&
+          order == o.order
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [description, identifier, limit, name, order].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        Stage.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end  end
+end