datadog_api_client 2.37.0 → 2.38.0

data/lib/datadog_api_client/v2/api/action_connection_api.rb

@@ -33,7 +33,7 @@ module DatadogAPIClient::V2
 
     # Create a new Action Connection.
     #
-    # Create a new Action Connection
+    # Create a new Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
     #
     # @param body [CreateActionConnectionRequest] 
     # @param opts [Hash] the optional parameters
@@ -100,7 +100,7 @@ module DatadogAPIClient::V2
 
     # Delete an existing Action Connection.
     #
-    # Delete an existing Action Connection
+    # Delete an existing Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
     #
     # @param connection_id [String] The ID of the action connection
     # @param opts [Hash] the optional parameters
@@ -165,7 +165,7 @@ module DatadogAPIClient::V2
 
     # Get an existing Action Connection.
     #
-    # Get an existing Action Connection
+    # Get an existing Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
     #
     # @param connection_id [String] The ID of the action connection
     # @param opts [Hash] the optional parameters
@@ -220,6 +220,265 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
+    # Get an existing App Key Registration.
+    #
+    # @see #get_app_key_registration_with_http_info
+    def get_app_key_registration(app_key_id, opts = {})
+      data, _status_code, _headers = get_app_key_registration_with_http_info(app_key_id, opts)
+      data
+    end
+
+    # Get an existing App Key Registration.
+    #
+    # Get an existing App Key Registration
+    #
+    # @param app_key_id [String] The ID of the app key
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(GetAppKeyRegistrationResponse, Integer, Hash)>] GetAppKeyRegistrationResponse data, response status code and response headers
+    def get_app_key_registration_with_http_info(app_key_id, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ActionConnectionAPI.get_app_key_registration ...'
+      end
+      # verify the required parameter 'app_key_id' is set
+      if @api_client.config.client_side_validation && app_key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_key_id' when calling ActionConnectionAPI.get_app_key_registration"
+      end
+      # resource path
+      local_var_path = '/api/v2/actions/app_key_registrations/{app_key_id}'.sub('{app_key_id}', CGI.escape(app_key_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] || 'GetAppKeyRegistrationResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :get_app_key_registration,
+        :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::Get, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ActionConnectionAPI#get_app_key_registration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List App Key Registrations.
+    #
+    # @see #list_app_key_registrations_with_http_info
+    def list_app_key_registrations(opts = {})
+      data, _status_code, _headers = list_app_key_registrations_with_http_info(opts)
+      data
+    end
+
+    # List App Key Registrations.
+    #
+    # List App Key Registrations
+    #
+    # @param opts [Hash] the optional parameters
+    # @option opts [Integer] :page_size The number of App Key Registrations to return per page.
+    # @option opts [Integer] :page_number The page number to return.
+    # @return [Array<(ListAppKeyRegistrationsResponse, Integer, Hash)>] ListAppKeyRegistrationsResponse data, response status code and response headers
+    def list_app_key_registrations_with_http_info(opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ActionConnectionAPI.list_app_key_registrations ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/actions/app_key_registrations'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].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] || 'ListAppKeyRegistrationsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :list_app_key_registrations,
+        :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::Get, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ActionConnectionAPI#list_app_key_registrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Register a new App Key.
+    #
+    # @see #register_app_key_with_http_info
+    def register_app_key(app_key_id, opts = {})
+      data, _status_code, _headers = register_app_key_with_http_info(app_key_id, opts)
+      data
+    end
+
+    # Register a new App Key.
+    #
+    # Register a new App Key
+    #
+    # @param app_key_id [String] The ID of the app key
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(RegisterAppKeyResponse, Integer, Hash)>] RegisterAppKeyResponse data, response status code and response headers
+    def register_app_key_with_http_info(app_key_id, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ActionConnectionAPI.register_app_key ...'
+      end
+      # verify the required parameter 'app_key_id' is set
+      if @api_client.config.client_side_validation && app_key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_key_id' when calling ActionConnectionAPI.register_app_key"
+      end
+      # resource path
+      local_var_path = '/api/v2/actions/app_key_registrations/{app_key_id}'.sub('{app_key_id}', CGI.escape(app_key_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] || 'RegisterAppKeyResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :register_app_key,
+        :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::Put, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ActionConnectionAPI#register_app_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Unregister an App Key.
+    #
+    # @see #unregister_app_key_with_http_info
+    def unregister_app_key(app_key_id, opts = {})
+      unregister_app_key_with_http_info(app_key_id, opts)
+      nil
+    end
+
+    # Unregister an App Key.
+    #
+    # Unregister an App Key
+    #
+    # @param app_key_id [String] The ID of the app key
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def unregister_app_key_with_http_info(app_key_id, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ActionConnectionAPI.unregister_app_key ...'
+      end
+      # verify the required parameter 'app_key_id' is set
+      if @api_client.config.client_side_validation && app_key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_key_id' when calling ActionConnectionAPI.unregister_app_key"
+      end
+      # resource path
+      local_var_path = '/api/v2/actions/app_key_registrations/{app_key_id}'.sub('{app_key_id}', CGI.escape(app_key_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(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :unregister_app_key,
+        :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: ActionConnectionAPI#unregister_app_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update an existing Action Connection.
     #
     # @see #update_action_connection_with_http_info
@@ -230,7 +489,7 @@ module DatadogAPIClient::V2
 
     # Update an existing Action Connection.
     #
-    # Update an existing Action Connection
+    # Update an existing Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
     #
     # @param connection_id [String] The ID of the action connection
     # @param body [UpdateActionConnectionRequest] Update an existing Action Connection request body

data/lib/datadog_api_client/v2/api/app_builder_api.rb

@@ -33,7 +33,7 @@ module DatadogAPIClient::V2
 
     # Create App.
     #
-    # Create a new app, returning the app ID.
+    # Create a new app, returning the app ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
     #
     # @param body [CreateAppRequest] 
     # @param opts [Hash] the optional parameters
@@ -100,7 +100,7 @@ module DatadogAPIClient::V2
 
     # Delete App.
     #
-    # Delete a single app.
+    # Delete a single app. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
     #
     # @param app_id [UUID] The ID of the app to delete.
     # @param opts [Hash] the optional parameters
@@ -165,7 +165,7 @@ module DatadogAPIClient::V2
 
     # Delete Multiple Apps.
     #
-    # Delete multiple apps in a single request from a list of app IDs.
+    # Delete multiple apps in a single request from a list of app IDs. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
     #
     # @param body [DeleteAppsRequest] 
     # @param opts [Hash] the optional parameters
@@ -232,7 +232,7 @@ module DatadogAPIClient::V2
 
     # Get App.
     #
-    # Get the full definition of an app.
+    # Get the full definition of an app. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
     #
     # @param app_id [UUID] The ID of the app to retrieve.
     # @param opts [Hash] the optional parameters
@@ -299,7 +299,7 @@ module DatadogAPIClient::V2
 
     # List Apps.
     #
-    # 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.
+    # 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. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
     #
     # @param opts [Hash] the optional parameters
     # @option opts [Integer] :limit The number of apps to return per page.
@@ -381,7 +381,7 @@ module DatadogAPIClient::V2
 
     # 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.
+    # 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. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
     #
     # @param app_id [UUID] The ID of the app to publish.
     # @param opts [Hash] the optional parameters
@@ -446,7 +446,7 @@ module DatadogAPIClient::V2
 
     # 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.
+    # 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. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
     #
     # @param app_id [UUID] The ID of the app to unpublish.
     # @param opts [Hash] the optional parameters
@@ -511,7 +511,7 @@ module DatadogAPIClient::V2
 
     # Update App.
     #
-    # Update an existing app. This creates a new version of the app.
+    # Update an existing app. This creates a new version of the app. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
     #
     # @param app_id [UUID] The ID of the app to update.
     # @param body [UpdateAppRequest] 

data/lib/datadog_api_client/v2/api/events_api.rb

@@ -33,13 +33,17 @@ module DatadogAPIClient::V2
 
     # Post an event.
     #
-    # This endpoint allows you to post events.
+    # This endpoint allows you to publish events.
     #
-    # ✅ **Only events with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking) for more details.
+    # ✅ **Only events with the `change` or `alert` category** are in General Availability. For change events, see [Change Tracking](https://docs.datadoghq.com/change_tracking) for more details.
     #
-    # ❌ For use cases involving other event categories, please use the V1 endpoint.
+    # ❌ For use cases involving other event categories, use the V1 endpoint or reach out to [support](https://www.datadoghq.com/support/).
     #
-    # @param body [EventCreateRequestPayload] Event request object
+    # ❌ Notifications are not yet supported for events sent to this endpoint. Use the V1 endpoint for notification functionality.
+    #
+    # ❌ This endpoint is not available for the Government (US1-FED) site. Contact your account representative for more information.
+    #
+    # @param body [EventCreateRequestPayload] Event creation request payload.
     # @param opts [Hash] the optional parameters
     # @return [Array<(EventCreateResponsePayload, Integer, Hash)>] EventCreateResponsePayload data, response status code and response headers
     def create_event_with_http_info(body, opts = {})