crimson-falcon 1.0.0 → 1.1.0

data/lib/crimson-falcon/api/user_management.rb

@@ -36,31 +36,97 @@ module Falcon
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Get User Grant(s). This endpoint lists both direct as well as flight control grants between a User and a Customer.
+    # Get host aggregates as specified via json in request body.
+    # @param body [Array<MsaAggregateQueryRequest>]
+    # @param [Hash] opts the optional parameters
+    # @return [FlightcontrolapiAggregatesResponse]
+    def aggregate_users_v1(body, opts = {})
+      data, _status_code, _headers = aggregate_users_v1_with_http_info(body, opts)
+      data
+    end
+
+    # Get host aggregates as specified via json in request body.
+    # @param body [Array<MsaAggregateQueryRequest>]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FlightcontrolapiAggregatesResponse, Integer, Hash)>] FlightcontrolapiAggregatesResponse data, response status code and response headers
+    def aggregate_users_v1_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserManagement.aggregate_users_v1 ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling UserManagement.aggregate_users_v1"
+      end
+      # resource path
+      local_var_path = '/user-management/aggregates/users/v1'
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FlightcontrolapiAggregatesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"UserManagement.aggregate_users_v1",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UserManagement#aggregate_users_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Deprecated : Please use GET /user-management/combined/user-roles/v2. Get User Grant(s). This endpoint lists both direct as well as flight control grants between a User and a Customer.
     # @param user_uuid [String] User UUID to get available roles for.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :cid Customer ID to get grants for. Empty CID would result in Role IDs for user against current CID in view.
     # @option opts [Boolean] :direct_only Specifies if to request direct Only role grants or all role grants between user and CID (specified in query params) (default to false)
-    # @option opts [String] :filter Filter using a query in Falcon Query Language (FQL). Supported filters: role_id, role_name
+    # @option opts [String] :filter Filter using a query in Falcon Query Language (FQL). Supported filters: expires_at, role_id, role_name
     # @option opts [Integer] :offset The offset to start retrieving records from (default to 0)
     # @option opts [Integer] :limit The maximum records to return. [1-500] (default to 100)
     # @option opts [String] :sort The property to sort by (default to 'role_name|asc')
-    # @return [FlightcontrolapiUserGrantResponse]
+    # @return [FlightcontrolapiCombinedUserRolesResponseV1]
     def combined_user_roles_v1(user_uuid, opts = {})
       data, _status_code, _headers = combined_user_roles_v1_with_http_info(user_uuid, opts)
       data
     end
 
-    # Get User Grant(s). This endpoint lists both direct as well as flight control grants between a User and a Customer.
+    # Deprecated : Please use GET /user-management/combined/user-roles/v2. Get User Grant(s). This endpoint lists both direct as well as flight control grants between a User and a Customer.
     # @param user_uuid [String] User UUID to get available roles for.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :cid Customer ID to get grants for. Empty CID would result in Role IDs for user against current CID in view.
     # @option opts [Boolean] :direct_only Specifies if to request direct Only role grants or all role grants between user and CID (specified in query params) (default to false)
-    # @option opts [String] :filter Filter using a query in Falcon Query Language (FQL). Supported filters: role_id, role_name
+    # @option opts [String] :filter Filter using a query in Falcon Query Language (FQL). Supported filters: expires_at, role_id, role_name
     # @option opts [Integer] :offset The offset to start retrieving records from (default to 0)
     # @option opts [Integer] :limit The maximum records to return. [1-500] (default to 100)
     # @option opts [String] :sort The property to sort by (default to 'role_name|asc')
-    # @return [Array<(FlightcontrolapiUserGrantResponse, Integer, Hash)>] FlightcontrolapiUserGrantResponse data, response status code and response headers
+    # @return [Array<(FlightcontrolapiCombinedUserRolesResponseV1, Integer, Hash)>] FlightcontrolapiCombinedUserRolesResponseV1 data, response status code and response headers
     def combined_user_roles_v1_with_http_info(user_uuid, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: UserManagement.combined_user_roles_v1 ...'
@@ -81,7 +147,7 @@ module Falcon
         fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UserManagement.combined_user_roles_v1, must be greater than or equal to 1.'
       end
 
-      allowable_values = ["cid|asc", "cid|desc", "role_name|asc", "role_name|desc", "type|asc", "type|desc"]
+      allowable_values = ["cid|asc", "cid|desc", "expires_at|asc", "expires_at|desc", "role_name|asc", "role_name|desc", "type|asc", "type|desc"]
       if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
         fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
       end
@@ -110,7 +176,7 @@ module Falcon
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'FlightcontrolapiUserGrantResponse'
+      return_type = opts[:debug_return_type] || 'FlightcontrolapiCombinedUserRolesResponseV1'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['oauth2']
@@ -132,6 +198,102 @@ module Falcon
       return data, status_code, headers
     end
 
+    # Get User Grant(s). This endpoint lists both direct as well as flight control grants between a User and a Customer.
+    # @param user_uuid [String] User UUID to get available roles for.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cid Customer ID to get grants for. Empty CID would result in Role IDs for user against current CID in view.
+    # @option opts [Boolean] :direct_only Specifies if to request direct Only role grants or all role grants between user and CID (specified in query params) (default to false)
+    # @option opts [String] :filter Filter using a query in Falcon Query Language (FQL). Supported filters: expires_at, role_id, role_name
+    # @option opts [Integer] :offset The offset to start retrieving records from (default to 0)
+    # @option opts [Integer] :limit The maximum records to return. [1-500] (default to 100)
+    # @option opts [String] :sort The property to sort by (default to 'role_name|asc')
+    # @return [FlightcontrolapiCombinedUserRolesResponseV2]
+    def combined_user_roles_v2(user_uuid, opts = {})
+      data, _status_code, _headers = combined_user_roles_v2_with_http_info(user_uuid, opts)
+      data
+    end
+
+    # Get User Grant(s). This endpoint lists both direct as well as flight control grants between a User and a Customer.
+    # @param user_uuid [String] User UUID to get available roles for.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cid Customer ID to get grants for. Empty CID would result in Role IDs for user against current CID in view.
+    # @option opts [Boolean] :direct_only Specifies if to request direct Only role grants or all role grants between user and CID (specified in query params) (default to false)
+    # @option opts [String] :filter Filter using a query in Falcon Query Language (FQL). Supported filters: expires_at, role_id, role_name
+    # @option opts [Integer] :offset The offset to start retrieving records from (default to 0)
+    # @option opts [Integer] :limit The maximum records to return. [1-500] (default to 100)
+    # @option opts [String] :sort The property to sort by (default to 'role_name|asc')
+    # @return [Array<(FlightcontrolapiCombinedUserRolesResponseV2, Integer, Hash)>] FlightcontrolapiCombinedUserRolesResponseV2 data, response status code and response headers
+    def combined_user_roles_v2_with_http_info(user_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserManagement.combined_user_roles_v2 ...'
+      end
+      # verify the required parameter 'user_uuid' is set
+      if @api_client.config.client_side_validation && user_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'user_uuid' when calling UserManagement.combined_user_roles_v2"
+      end
+      if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling UserManagement.combined_user_roles_v2, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UserManagement.combined_user_roles_v2, must be smaller than or equal to 500.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UserManagement.combined_user_roles_v2, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["cid|asc", "cid|desc", "expires_at|asc", "expires_at|desc", "role_name|asc", "role_name|desc", "type|asc", "type|desc"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/user-management/combined/user-roles/v2'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'user_uuid'] = user_uuid
+      query_params[:'cid'] = opts[:'cid'] if !opts[:'cid'].nil?
+      query_params[:'direct_only'] = opts[:'direct_only'] if !opts[:'direct_only'].nil?
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'FlightcontrolapiCombinedUserRolesResponseV2'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"UserManagement.combined_user_roles_v2",
+        :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: UserManagement#combined_user_roles_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Deprecated : Please use POST /user-management/entities/users/v1. Create a new user. After creating a user, assign one or more roles with POST /user-roles/entities/user-roles/v1
     # @param body [DomainUserCreateRequest] Attributes for this user. &#x60;uid&#x60; (required) is the user&#39;s email address, which is their username in Falcon.  Optional attributes:  &lt;ul&gt;&lt;li&gt;&#x60;firstName&#x60;&lt;/li&gt;&lt;li&gt;&#x60;lastName&#x60;&lt;/li&gt;&lt;li&gt;&#x60;password&#x60;&lt;/li&gt;&lt;/ul&gt;  As a best practice, we recommend omitting &#x60;password&#x60;. If single sign-on is enabled for your customer account, the &#x60;password&#x60; attribute is ignored. If single sign-on is not enabled, we send a user activation request to their email address when you create the user with no &#x60;password&#x60;. The user should use the activation email to set their own password.
     # @param [Hash] opts the optional parameters
@@ -774,7 +936,7 @@ module Falcon
 
     # List user IDs for all users in your customer account. For more information on each user, provide the user ID to `/user-management/entities/users/GET/v1`.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :filter Filter using a query in Falcon Query Language (FQL). Supported filters: assigned_cids, cid, first_name, last_name, name, uid
+    # @option opts [String] :filter Filter using a query in Falcon Query Language (FQL). Supported filters: assigned_cids, cid, direct_assigned_cids, factors, first_name, has_temporary_roles, last_name, name, status, temporarily_assigned_cids, uid
     # @option opts [Integer] :offset The offset to start retrieving records from (default to 0)
     # @option opts [Integer] :limit The maximum records to return. [1-500] (default to 100)
     # @option opts [String] :sort The property to sort by (default to 'uid|asc')
@@ -786,7 +948,7 @@ module Falcon
 
     # List user IDs for all users in your customer account. For more information on each user, provide the user ID to &#x60;/user-management/entities/users/GET/v1&#x60;.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :filter Filter using a query in Falcon Query Language (FQL). Supported filters: assigned_cids, cid, first_name, last_name, name, uid
+    # @option opts [String] :filter Filter using a query in Falcon Query Language (FQL). Supported filters: assigned_cids, cid, direct_assigned_cids, factors, first_name, has_temporary_roles, last_name, name, status, temporarily_assigned_cids, uid
     # @option opts [Integer] :offset The offset to start retrieving records from (default to 0)
     # @option opts [Integer] :limit The maximum records to return. [1-500] (default to 100)
     # @option opts [String] :sort The property to sort by (default to 'uid|asc')
@@ -807,7 +969,7 @@ module Falcon
         fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UserManagement.query_user_v1, must be greater than or equal to 1.'
       end
 
-      allowable_values = ["cid_name|asc", "cid_name|desc", "created_at|asc", "created_at|desc", "first_name|asc", "first_name|desc", "last_login_at|asc", "last_login_at|desc", "last_name|asc", "last_name|desc", "name|asc", "name|desc", "uid|asc", "uid|desc"]
+      allowable_values = ["cid_name|asc", "cid_name|desc", "created_at|asc", "created_at|desc", "first_name|asc", "first_name|desc", "has_temporary_roles|asc", "has_temporary_roles|desc", "last_login_at|asc", "last_login_at|desc", "last_name|asc", "last_name|desc", "name|asc", "name|desc", "status|asc", "status|desc", "temporarily_assigned_cids|asc", "temporarily_assigned_cids|desc", "uid|asc", "uid|desc"]
       if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
         fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
       end
@@ -1437,7 +1599,7 @@ module Falcon
     end
 
     # Grant or Revoke one or more role(s) to a user against a CID. User UUID, CID and Role ID(s) can be provided in request payload. Available Action(s) : grant, revoke
-    # @param body [DomainActionUserRolesRequest] All fields including CID, RoleID(s), User UUID and Action are required. Allowed values for Action param include &#39;grant&#39; and &#39;revoke&#39;.
+    # @param body [FlightcontrolapiGrantInput] All fields including CID, RoleID(s), User UUID and Action are required. Allowed values for Action param include &#39;grant&#39; and &#39;revoke&#39;.
     # @param [Hash] opts the optional parameters
     # @return [MsaspecResponseFields]
     def user_roles_action_v1(body, opts = {})
@@ -1446,7 +1608,7 @@ module Falcon
     end
 
     # Grant or Revoke one or more role(s) to a user against a CID. User UUID, CID and Role ID(s) can be provided in request payload. Available Action(s) : grant, revoke
-    # @param body [DomainActionUserRolesRequest] All fields including CID, RoleID(s), User UUID and Action are required. Allowed values for Action param include &#39;grant&#39; and &#39;revoke&#39;.
+    # @param body [FlightcontrolapiGrantInput] All fields including CID, RoleID(s), User UUID and Action are required. Allowed values for Action param include &#39;grant&#39; and &#39;revoke&#39;.
     # @param [Hash] opts the optional parameters
     # @return [Array<(MsaspecResponseFields, Integer, Hash)>] MsaspecResponseFields data, response status code and response headers
     def user_roles_action_v1_with_http_info(body, opts = {})

data/lib/crimson-falcon/api/workflows.rb

@@ -108,6 +108,78 @@ module Falcon
       return data, status_code, headers
     end
 
+    # Search for activities by name. Returns all supported activities if no filter specified
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter FQL query specifying filter parameters.
+    # @option opts [String] :offset Starting pagination offset of records to return.
+    # @option opts [Integer] :limit Maximum number of records to return.
+    # @option opts [String] :sort Sort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.
+    # @return [ActivitiesActivityExternalResponse]
+    def workflow_activities_content_combined(opts = {})
+      data, _status_code, _headers = workflow_activities_content_combined_with_http_info(opts)
+      data
+    end
+
+    # Search for activities by name. Returns all supported activities if no filter specified
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter FQL query specifying filter parameters.
+    # @option opts [String] :offset Starting pagination offset of records to return.
+    # @option opts [Integer] :limit Maximum number of records to return.
+    # @option opts [String] :sort Sort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.
+    # @return [Array<(ActivitiesActivityExternalResponse, Integer, Hash)>] ActivitiesActivityExternalResponse data, response status code and response headers
+    def workflow_activities_content_combined_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Workflows.workflow_activities_content_combined ...'
+      end
+      pattern = Regexp.new(/^\w+(\.asc|\.desc)?(,\w+(\.asc|\.desc)?)*$/)
+      if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling Workflows.workflow_activities_content_combined, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/workflows/combined/activity-content/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'ActivitiesActivityExternalResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"Workflows.workflow_activities_content_combined",
+        :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: Workflows#workflow_activities_content_combined\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Search workflow definitions based on the provided filter
     # @param [Hash] opts the optional parameters
     # @option opts [String] :filter FQL query specifying filter parameters.

data/lib/crimson-falcon/models/activities_activity.rb

@@ -44,6 +44,9 @@ module Falcon
     # Activity class to identify how it should be orchestrated. E.g. External, Break, CreateVariable and UpdateVariable
     attr_accessor :_class
 
+    # List of dependencies (store apps or foundry app templates) of the activity
+    attr_accessor :dependencies
+
     # A detailed description of what this action does
     attr_accessor :description
 
@@ -96,6 +99,7 @@ module Falcon
         :'app_id' => :'app_id',
         :'cid' => :'cid',
         :'_class' => :'class',
+        :'dependencies' => :'dependencies',
         :'description' => :'description',
         :'disruptive' => :'disruptive',
         :'has_permission' => :'has_permission',
@@ -127,6 +131,7 @@ module Falcon
         :'app_id' => :'String',
         :'cid' => :'String',
         :'_class' => :'String',
+        :'dependencies' => :'Array<ActivitiesDependency>',
         :'description' => :'String',
         :'disruptive' => :'Boolean',
         :'has_permission' => :'Boolean',
@@ -183,6 +188,12 @@ module Falcon
         self._class = attributes[:'_class']
       end
 
+      if attributes.key?(:'dependencies')
+        if (value = attributes[:'dependencies']).is_a?(Array)
+          self.dependencies = value
+        end
+      end
+
       if attributes.key?(:'description')
         self.description = attributes[:'description']
       end
@@ -308,6 +319,7 @@ module Falcon
           app_id == o.app_id &&
           cid == o.cid &&
           _class == o._class &&
+          dependencies == o.dependencies &&
           description == o.description &&
           disruptive == o.disruptive &&
           has_permission == o.has_permission &&
@@ -335,7 +347,7 @@ module Falcon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [api_scope, app_id, cid, _class, description, disruptive, has_permission, id, input_fields, input_schema, mock_output, name, namespace, output_fields, output_schema, tag_ids, updated, use_cases, vendor, version].hash
+      [api_scope, app_id, cid, _class, dependencies, description, disruptive, has_permission, id, input_fields, input_schema, mock_output, name, namespace, output_fields, output_schema, tag_ids, updated, use_cases, vendor, version].hash
     end
 
     # Builds the object from hash