datadog_api_client 2.29.1 → 2.31.0

data/lib/datadog_api_client/v2/api/{apps_api.rb → app_builder_api.rb}

@@ -16,7 +16,7 @@ Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.ge
 require 'cgi'
 
 module DatadogAPIClient::V2
-  class AppsAPI
+  class AppBuilderAPI
     attr_accessor :api_client
 
     def initialize(api_client = DatadogAPIClient::APIClient.default)
@@ -33,25 +33,19 @@ module DatadogAPIClient::V2
 
     # Create App.
     #
-    # Create a new app, returning the app ID
+    # Create a new app, returning the app ID.
     #
     # @param body [CreateAppRequest] 
     # @param opts [Hash] the optional parameters
     # @return [Array<(CreateAppResponse, Integer, Hash)>] CreateAppResponse data, response status code and response headers
     def create_app_with_http_info(body, opts = {})
-      unstable_enabled = @api_client.config.unstable_operations["v2.create_app".to_sym]
-      if unstable_enabled
-        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_app")
-      else
-        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_app"))
-      end
 
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AppsAPI.create_app ...'
+        @api_client.config.logger.debug 'Calling API: AppBuilderAPI.create_app ...'
       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 AppsAPI.create_app"
+        fail ArgumentError, "Missing the required parameter 'body' when calling AppBuilderAPI.create_app"
       end
       # resource path
       local_var_path = '/api/v2/app-builder/apps'
@@ -91,7 +85,7 @@ module DatadogAPIClient::V2
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AppsAPI#create_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AppBuilderAPI#create_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -106,25 +100,19 @@ module DatadogAPIClient::V2
 
     # Delete App.
     #
-    # Delete an app by ID
+    # Delete a single app.
     #
-    # @param app_id [String] 
+    # @param app_id [UUID] The ID of the app to delete.
     # @param opts [Hash] the optional parameters
     # @return [Array<(DeleteAppResponse, Integer, Hash)>] DeleteAppResponse data, response status code and response headers
     def delete_app_with_http_info(app_id, opts = {})
-      unstable_enabled = @api_client.config.unstable_operations["v2.delete_app".to_sym]
-      if unstable_enabled
-        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_app")
-      else
-        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_app"))
-      end
 
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AppsAPI.delete_app ...'
+        @api_client.config.logger.debug 'Calling API: AppBuilderAPI.delete_app ...'
       end
       # verify the required parameter 'app_id' is set
       if @api_client.config.client_side_validation && app_id.nil?
-        fail ArgumentError, "Missing the required parameter 'app_id' when calling AppsAPI.delete_app"
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.delete_app"
       end
       # resource path
       local_var_path = '/api/v2/app-builder/apps/{app_id}'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/'))
@@ -162,7 +150,7 @@ module DatadogAPIClient::V2
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AppsAPI#delete_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AppBuilderAPI#delete_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -177,25 +165,19 @@ module DatadogAPIClient::V2
 
     # Delete Multiple Apps.
     #
-    # Delete multiple apps by ID
+    # Delete multiple apps in a single request from a list of app IDs.
     #
     # @param body [DeleteAppsRequest] 
     # @param opts [Hash] the optional parameters
     # @return [Array<(DeleteAppsResponse, Integer, Hash)>] DeleteAppsResponse data, response status code and response headers
     def delete_apps_with_http_info(body, opts = {})
-      unstable_enabled = @api_client.config.unstable_operations["v2.delete_apps".to_sym]
-      if unstable_enabled
-        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_apps")
-      else
-        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_apps"))
-      end
 
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AppsAPI.delete_apps ...'
+        @api_client.config.logger.debug 'Calling API: AppBuilderAPI.delete_apps ...'
       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 AppsAPI.delete_apps"
+        fail ArgumentError, "Missing the required parameter 'body' when calling AppBuilderAPI.delete_apps"
       end
       # resource path
       local_var_path = '/api/v2/app-builder/apps'
@@ -235,7 +217,7 @@ module DatadogAPIClient::V2
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AppsAPI#delete_apps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AppBuilderAPI#delete_apps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -250,31 +232,27 @@ module DatadogAPIClient::V2
 
     # Get App.
     #
-    # Get the full definition of an app by ID
+    # Get the full definition of an app.
     #
-    # @param app_id [String] 
+    # @param app_id [UUID] The ID of the app to retrieve.
     # @param opts [Hash] the optional parameters
+    # @option opts [String] :version The version number of the app to retrieve. If not specified, the latest version is returned. Version numbers start at 1 and increment with each update. The special values `latest` and `deployed` can be used to retrieve the latest version or the published version, respectively.
     # @return [Array<(GetAppResponse, Integer, Hash)>] GetAppResponse data, response status code and response headers
     def get_app_with_http_info(app_id, opts = {})
-      unstable_enabled = @api_client.config.unstable_operations["v2.get_app".to_sym]
-      if unstable_enabled
-        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_app")
-      else
-        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_app"))
-      end
 
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AppsAPI.get_app ...'
+        @api_client.config.logger.debug 'Calling API: AppBuilderAPI.get_app ...'
       end
       # verify the required parameter 'app_id' is set
       if @api_client.config.client_side_validation && app_id.nil?
-        fail ArgumentError, "Missing the required parameter 'app_id' when calling AppsAPI.get_app"
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.get_app"
       end
       # resource path
       local_var_path = '/api/v2/app-builder/apps/{app_id}'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/'))
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -306,7 +284,7 @@ module DatadogAPIClient::V2
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AppsAPI#get_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AppBuilderAPI#get_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -321,30 +299,25 @@ module DatadogAPIClient::V2
 
     # List Apps.
     #
-    # List all apps, with optional filters and sorting
+    # List all apps, with optional filters and sorting. This endpoint is paginated. Only basic app information such as the app ID, name, and description is returned by this endpoint.
     #
     # @param opts [Hash] the optional parameters
-    # @option opts [Integer] :limit The number of apps to return per page
-    # @option opts [Integer] :page The page number to return
-    # @option opts [String] :filter_user_name The `AppsFilter` `user_name`.
-    # @option opts [String] :filter_user_uuid The `AppsFilter` `user_uuid`.
-    # @option opts [String] :filter_name The `AppsFilter` `name`.
-    # @option opts [String] :filter_query The `AppsFilter` `query`.
-    # @option opts [Boolean] :filter_deployed The `AppsFilter` `deployed`.
-    # @option opts [String] :filter_tags The `AppsFilter` `tags`.
-    # @option opts [Boolean] :filter_favorite The `AppsFilter` `favorite`.
-    # @option opts [Array<AppsSortField>] :sort 
+    # @option opts [Integer] :limit The number of apps to return per page.
+    # @option opts [Integer] :page The page number to return.
+    # @option opts [String] :filter_user_name Filter apps by the app creator. Usually the user's email.
+    # @option opts [UUID] :filter_user_uuid Filter apps by the app creator's UUID.
+    # @option opts [String] :filter_name Filter by app name.
+    # @option opts [String] :filter_query Filter apps by the app name or the app creator.
+    # @option opts [Boolean] :filter_deployed Filter apps by whether they are published.
+    # @option opts [String] :filter_tags Filter apps by tags.
+    # @option opts [Boolean] :filter_favorite Filter apps by whether you have added them to your favorites.
+    # @option opts [Boolean] :filter_self_service Filter apps by whether they are enabled for self-service.
+    # @option opts [Array<AppsSortField>] :sort The fields and direction to sort apps by.
     # @return [Array<(ListAppsResponse, Integer, Hash)>] ListAppsResponse data, response status code and response headers
     def list_apps_with_http_info(opts = {})
-      unstable_enabled = @api_client.config.unstable_operations["v2.list_apps".to_sym]
-      if unstable_enabled
-        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_apps")
-      else
-        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_apps"))
-      end
 
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AppsAPI.list_apps ...'
+        @api_client.config.logger.debug 'Calling API: AppBuilderAPI.list_apps ...'
       end
       # resource path
       local_var_path = '/api/v2/app-builder/apps'
@@ -360,6 +333,7 @@ module DatadogAPIClient::V2
       query_params[:'filter[deployed]'] = opts[:'filter_deployed'] if !opts[:'filter_deployed'].nil?
       query_params[:'filter[tags]'] = opts[:'filter_tags'] if !opts[:'filter_tags'].nil?
       query_params[:'filter[favorite]'] = opts[:'filter_favorite'] if !opts[:'filter_favorite'].nil?
+      query_params[:'filter[self_service]'] = opts[:'filter_self_service'] if !opts[:'filter_self_service'].nil?
       query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :csv) if !opts[:'sort'].nil?
 
       # header parameters
@@ -392,7 +366,137 @@ module DatadogAPIClient::V2
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AppsAPI#list_apps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AppBuilderAPI#list_apps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Publish App.
+    #
+    # @see #publish_app_with_http_info
+    def publish_app(app_id, opts = {})
+      data, _status_code, _headers = publish_app_with_http_info(app_id, opts)
+      data
+    end
+
+    # Publish App.
+    #
+    # Publish an app for use by other users. To ensure the app is accessible to the correct users, you also need to set a [Restriction Policy](https://docs.datadoghq.com/api/latest/restriction-policies/) on the app if a policy does not yet exist.
+    #
+    # @param app_id [UUID] The ID of the app to publish.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(PublishAppResponse, Integer, Hash)>] PublishAppResponse data, response status code and response headers
+    def publish_app_with_http_info(app_id, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AppBuilderAPI.publish_app ...'
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.publish_app"
+      end
+      # resource path
+      local_var_path = '/api/v2/app-builder/apps/{app_id}/deployment'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/'))
+
+      # 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[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PublishAppResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :publish_app,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type,
+        :api_version => "V2"
+      )
+
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AppBuilderAPI#publish_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Unpublish App.
+    #
+    # @see #unpublish_app_with_http_info
+    def unpublish_app(app_id, opts = {})
+      data, _status_code, _headers = unpublish_app_with_http_info(app_id, opts)
+      data
+    end
+
+    # Unpublish App.
+    #
+    # Unpublish an app, removing the live version of the app. Unpublishing creates a new instance of a `deployment` object on the app, with a nil `app_version_id` (`00000000-0000-0000-0000-000000000000`). The app can still be updated and published again in the future.
+    #
+    # @param app_id [UUID] The ID of the app to unpublish.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(UnpublishAppResponse, Integer, Hash)>] UnpublishAppResponse data, response status code and response headers
+    def unpublish_app_with_http_info(app_id, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AppBuilderAPI.unpublish_app ...'
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.unpublish_app"
+      end
+      # resource path
+      local_var_path = '/api/v2/app-builder/apps/{app_id}/deployment'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/'))
+
+      # 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[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UnpublishAppResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :unpublish_app,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type,
+        :api_version => "V2"
+      )
+
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AppBuilderAPI#unpublish_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -407,30 +511,24 @@ module DatadogAPIClient::V2
 
     # Update App.
     #
-    # Update an existing app by ID. Creates a new version of the app
+    # Update an existing app. This creates a new version of the app.
     #
-    # @param app_id [String] 
+    # @param app_id [UUID] The ID of the app to update.
     # @param body [UpdateAppRequest] 
     # @param opts [Hash] the optional parameters
     # @return [Array<(UpdateAppResponse, Integer, Hash)>] UpdateAppResponse data, response status code and response headers
     def update_app_with_http_info(app_id, body, opts = {})
-      unstable_enabled = @api_client.config.unstable_operations["v2.update_app".to_sym]
-      if unstable_enabled
-        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_app")
-      else
-        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_app"))
-      end
 
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AppsAPI.update_app ...'
+        @api_client.config.logger.debug 'Calling API: AppBuilderAPI.update_app ...'
       end
       # verify the required parameter 'app_id' is set
       if @api_client.config.client_side_validation && app_id.nil?
-        fail ArgumentError, "Missing the required parameter 'app_id' when calling AppsAPI.update_app"
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.update_app"
       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 AppsAPI.update_app"
+        fail ArgumentError, "Missing the required parameter 'body' when calling AppBuilderAPI.update_app"
       end
       # resource path
       local_var_path = '/api/v2/app-builder/apps/{app_id}'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/'))
@@ -470,7 +568,7 @@ module DatadogAPIClient::V2
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AppsAPI#update_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AppBuilderAPI#update_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end