datadog_api_client 1.11.0 → 2.0.0

data/examples/v2/events/ListEvents.rb

@@ -0,0 +1,8 @@
+# Get a list of events returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient::V2.configure do |config|
+  config.unstable_operations["v2.list_events".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::EventsAPI.new
+p api_instance.list_events()

data/examples/v2/events/ListEvents_2663715109.rb

@@ -0,0 +1,14 @@
+# Get a quick list of events returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient::V2.configure do |config|
+  config.unstable_operations["v2.list_events".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::EventsAPI.new
+opts = {
+  filter_query: "datadog-agent",
+  filter_from: "2020-09-17T11:48:36+01:00",
+  filter_to: "2020-09-17T12:48:36+01:00",
+  page_limit: 5,
+}
+p api_instance.list_events(opts)

data/examples/v2/events/SearchEvents.rb

@@ -0,0 +1,23 @@
+# Search events returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient::V2.configure do |config|
+  config.unstable_operations["v2.search_events".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::EventsAPI.new
+
+body = DatadogAPIClient::V2::EventsListRequest.new({
+  filter: DatadogAPIClient::V2::EventsQueryFilter.new({
+    query: "datadog-agent",
+    from: "2020-09-17T11:48:36+01:00",
+    to: "2020-09-17T12:48:36+01:00",
+  }),
+  sort: DatadogAPIClient::V2::EventsSort::TIMESTAMP_ASCENDING,
+  page: DatadogAPIClient::V2::EventsRequestPage.new({
+    limit: 5,
+  }),
+})
+opts = {
+  body: body,
+}
+p api_instance.search_events(opts)

data/examples/v2/incident-services/CreateIncidentService.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:create_incident_service] = true
+  config.unstable_operations["v2.create_incident_service".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentServicesAPI.new
 

data/examples/v2/incident-services/DeleteIncidentService.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:delete_incident_service] = true
+  config.unstable_operations["v2.delete_incident_service".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentServicesAPI.new
 

data/examples/v2/incident-services/GetIncidentService.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:get_incident_service] = true
+  config.unstable_operations["v2.get_incident_service".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentServicesAPI.new
 

data/examples/v2/incident-services/ListIncidentServices.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:list_incident_services] = true
+  config.unstable_operations["v2.list_incident_services".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentServicesAPI.new
 

data/examples/v2/incident-services/UpdateIncidentService.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:update_incident_service] = true
+  config.unstable_operations["v2.update_incident_service".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentServicesAPI.new
 

data/examples/v2/incident-teams/CreateIncidentTeam.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:create_incident_team] = true
+  config.unstable_operations["v2.create_incident_team".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentTeamsAPI.new
 

data/examples/v2/incident-teams/DeleteIncidentTeam.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:delete_incident_team] = true
+  config.unstable_operations["v2.delete_incident_team".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentTeamsAPI.new
 

data/examples/v2/incident-teams/GetIncidentTeam.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:get_incident_team] = true
+  config.unstable_operations["v2.get_incident_team".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentTeamsAPI.new
 

data/examples/v2/incident-teams/ListIncidentTeams.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:list_incident_teams] = true
+  config.unstable_operations["v2.list_incident_teams".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentTeamsAPI.new
 

data/examples/v2/incident-teams/UpdateIncidentTeam.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:update_incident_team] = true
+  config.unstable_operations["v2.update_incident_team".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentTeamsAPI.new
 

data/examples/v2/incidents/CreateIncident.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:create_incident] = true
+  config.unstable_operations["v2.create_incident".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentsAPI.new
 

data/examples/v2/incidents/DeleteIncident.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:delete_incident] = true
+  config.unstable_operations["v2.delete_incident".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentsAPI.new
 

data/examples/v2/incidents/GetIncident.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:get_incident] = true
+  config.unstable_operations["v2.get_incident".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentsAPI.new
 

data/examples/v2/incidents/ListIncidents.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:list_incidents] = true
+  config.unstable_operations["v2.list_incidents".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentsAPI.new
 p api_instance.list_incidents()

data/examples/v2/incidents/UpdateIncident.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:update_incident] = true
+  config.unstable_operations["v2.update_incident".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentsAPI.new
 

data/examples/v2/incidents/UpdateIncident_1009194038.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:update_incident] = true
+  config.unstable_operations["v2.update_incident".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentsAPI.new
 

data/examples/v2/incidents/UpdateIncident_3369341440.rb

@@ -2,7 +2,7 @@
 
 require "datadog_api_client"
 DatadogAPIClient::V2.configure do |config|
-  config.unstable_operations[:update_incident] = true
+  config.unstable_operations["v2.update_incident".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::IncidentsAPI.new
 

data/examples/v2/metrics/SubmitMetrics.rb

@@ -14,6 +14,12 @@ body = DatadogAPIClient::V2::MetricPayload.new({
           value: 0.7,
         }),
       ],
+      resources: [
+        DatadogAPIClient::V2::MetricResource.new({
+          name: "dummyhost",
+          type: "host",
+        }),
+      ],
     }),
   ],
 })

data/examples/v2/security-monitoring/EditSecurityMonitoringSignalAssignee.rb

@@ -0,0 +1,15 @@
+# Modify the triage assignee of a security signal returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+body = DatadogAPIClient::V2::SecurityMonitoringSignalAssigneeUpdateRequest.new({
+  data: DatadogAPIClient::V2::SecurityMonitoringSignalAssigneeUpdateData.new({
+    attributes: DatadogAPIClient::V2::SecurityMonitoringSignalAssigneeUpdateAttributes.new({
+      assignee: DatadogAPIClient::V2::SecurityMonitoringTriageUser.new({
+        uuid: "",
+      }),
+    }),
+  }),
+})
+p api_instance.edit_security_monitoring_signal_assignee("AQAAAYG1bl5K4HuUewAAAABBWUcxYmw1S0FBQmt2RmhRN0V4ZUVnQUE", body)

data/examples/v2/security-monitoring/EditSecurityMonitoringSignalIncidents.rb

@@ -0,0 +1,15 @@
+# Change the related incidents of a security signal returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+body = DatadogAPIClient::V2::SecurityMonitoringSignalIncidentsUpdateRequest.new({
+  data: DatadogAPIClient::V2::SecurityMonitoringSignalIncidentsUpdateData.new({
+    attributes: DatadogAPIClient::V2::SecurityMonitoringSignalIncidentsUpdateAttributes.new({
+      incident_ids: [
+        2066,
+      ],
+    }),
+  }),
+})
+p api_instance.edit_security_monitoring_signal_incidents("AQAAAYG1bl5K4HuUewAAAABBWUcxYmw1S0FBQmt2RmhRN0V4ZUVnQUE", body)

data/examples/v2/security-monitoring/EditSecurityMonitoringSignalState.rb

@@ -0,0 +1,14 @@
+# Change the triage state of a security signal returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+body = DatadogAPIClient::V2::SecurityMonitoringSignalStateUpdateRequest.new({
+  data: DatadogAPIClient::V2::SecurityMonitoringSignalStateUpdateData.new({
+    attributes: DatadogAPIClient::V2::SecurityMonitoringSignalStateUpdateAttributes.new({
+      archive_reason: DatadogAPIClient::V2::SecurityMonitoringSignalArchiveReason::NONE,
+      state: DatadogAPIClient::V2::SecurityMonitoringSignalState::OPEN,
+    }),
+  }),
+})
+p api_instance.edit_security_monitoring_signal_state("AQAAAYG1bl5K4HuUewAAAABBWUcxYmw1S0FBQmt2RmhRN0V4ZUVnQUE", body)

data/examples/v2/security-monitoring/UpdateSecurityMonitoringRule.rb

@@ -38,6 +38,7 @@ body = DatadogAPIClient::V2::SecurityMonitoringRuleUpdatePayload.new({
       aggregation: DatadogAPIClient::V2::SecurityMonitoringRuleQueryAggregation::COUNT,
       distinct_fields: [],
       group_by_fields: [],
+      metrics: [],
     }),
   ],
   tags: [],

data/examples/v2/usage-metering/GetEstimatedCostByOrg.rb

@@ -1,5 +1,8 @@
-# Get estimated cost across multi-org account returns "OK" response
+# Get estimated cost across your account returns "OK" response
 
 require "datadog_api_client"
+DatadogAPIClient::V2.configure do |config|
+  config.unstable_operations["v2.get_estimated_cost_by_org".to_sym] = true
+end
 api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
-p api_instance.get_estimated_cost_by_org()
+p api_instance.get_estimated_cost_by_org("view")

data/examples/v2/usage-metering/GetEstimatedCostByOrg_2734954020.rb

@@ -0,0 +1,11 @@
+# GetEstimatedCostByOrg with start_date returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient::V2.configure do |config|
+  config.unstable_operations["v2.get_estimated_cost_by_org".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
+opts = {
+  start_date: (Time.now + -5 * 86400),
+}
+p api_instance.get_estimated_cost_by_org("sub-org", opts)

data/examples/v2/usage-metering/GetEstimatedCostByOrg_3186693804.rb

@@ -0,0 +1,11 @@
+# GetEstimatedCostByOrg with start_month returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient::V2.configure do |config|
+  config.unstable_operations["v2.get_estimated_cost_by_org".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
+opts = {
+  start_month: (Time.now + -5 * 86400),
+}
+p api_instance.get_estimated_cost_by_org("sub-org", opts)

data/examples/v2/usage-metering/GetUsageApplicationSecurityMonitoring.rb

@@ -1,8 +1,5 @@
-# Get hourly usage for Application Security returns "OK" response
+# Get hourly usage for application security returns "OK" response
 
 require "datadog_api_client"
 api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
-opts = {
-  end_hr: (Time.now + -3 * 86400),
-}
-p api_instance.get_usage_application_security_monitoring((Time.now + -5 * 86400), opts)
+p api_instance.get_usage_application_security_monitoring("2021-11-11T11:11:11.111+00:00")

data/examples/v2/usage-metering/GetUsageApplicationSecurityMonitoring_3959166796.rb

@@ -0,0 +1,8 @@
+# Get hourly usage for Application Security returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
+opts = {
+  end_hr: (Time.now + -3 * 86400),
+}
+p api_instance.get_usage_application_security_monitoring((Time.now + -5 * 86400), opts)

data/examples/v2/usage-metering/GetUsageLambdaTracedInvocations.rb

@@ -1,8 +1,5 @@
-# Get hourly usage for Lambda Traced Invocations returns "OK" response
+# Get hourly usage for lambda traced invocations returns "OK" response
 
 require "datadog_api_client"
 api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
-opts = {
-  end_hr: (Time.now + -3 * 86400),
-}
-p api_instance.get_usage_lambda_traced_invocations((Time.now + -5 * 86400), opts)
+p api_instance.get_usage_lambda_traced_invocations("2021-11-11T11:11:11.111+00:00")

data/examples/v2/usage-metering/GetUsageLambdaTracedInvocations_1436752065.rb

@@ -0,0 +1,8 @@
+# Get hourly usage for Lambda Traced Invocations returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
+opts = {
+  end_hr: (Time.now + -3 * 86400),
+}
+p api_instance.get_usage_lambda_traced_invocations((Time.now + -5 * 86400), opts)

data/examples/v2/usage-metering/GetUsageObservabilityPipelines.rb

@@ -1,8 +1,5 @@
-# Get hourly usage for Observability Pipelines returns "OK" response
+# Get hourly usage for observability pipelines returns "OK" response
 
 require "datadog_api_client"
 api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
-opts = {
-  end_hr: (Time.now + -3 * 86400),
-}
-p api_instance.get_usage_observability_pipelines((Time.now + -5 * 86400), opts)
+p api_instance.get_usage_observability_pipelines("2021-11-11T11:11:11.111+00:00")

data/examples/v2/usage-metering/GetUsageObservabilityPipelines_970725512.rb

@@ -0,0 +1,8 @@
+# Get hourly usage for Observability Pipelines returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
+opts = {
+  end_hr: (Time.now + -3 * 86400),
+}
+p api_instance.get_usage_observability_pipelines((Time.now + -5 * 86400), opts)

data/lib/datadog_api_client/{v2/api_client.rb → api_client.rb}

@@ -19,8 +19,12 @@ require 'logger'
 require 'tempfile'
 require 'time'
 require 'httparty'
+begin
+  require 'zstandard'
+rescue LoadError
+end
 
-module DatadogAPIClient::V2
+module DatadogAPIClient
   class APIClient
     # The Configuration object holding settings to be used in the API client.
     attr_accessor :config
@@ -111,7 +115,7 @@ module DatadogAPIClient::V2
       end
 
       if opts[:return_type]
-        data = deserialize(response, opts[:return_type])
+        data = deserialize(opts[:api_version], response, opts[:return_type])
       else
         data = nil
       end
@@ -198,6 +202,8 @@ module DatadogAPIClient::V2
         gzip.close
       elsif header_params['Content-Encoding'] == 'deflate'
         data = Zlib::deflate(data)
+      elsif header_params['Content-Encoding'] == 'zstd1'
+        data = Zstandard.deflate(data)
       end
       data
     end
@@ -216,9 +222,10 @@ module DatadogAPIClient::V2
 
     # Deserialize the response to the given return type.
     #
+    # @param [String] the api version
     # @param [Response] response HTTP response
     # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
-    def deserialize(response, return_type)
+    def deserialize(api_version, response, return_type)
       body = response.body
 
       # handle file downloading - return the File instance processed in request callbacks
@@ -251,14 +258,14 @@ module DatadogAPIClient::V2
         end
       end
 
-      convert_to_type data, return_type
+      convert_to_type data, return_type, api_version
     end
 
     # Convert data to the given return type.
     # @param [Object] data Data to be converted
     # @param [String] return_type Return type
     # @return [Mixed] Data in a particular type
-    def convert_to_type(data, return_type)
+    def convert_to_type(data, return_type, api_version)
       return nil if data.nil?
       case return_type
       when 'String'
@@ -281,16 +288,16 @@ module DatadogAPIClient::V2
       when /\AArray<(.+)>\z/
         # e.g. Array<Pet>
         sub_type = $1
-        data.map { |item| convert_to_type(item, sub_type) }
+        data.map { |item| convert_to_type(item, sub_type, api_version) }
       when /\AHash\<String, (.+)\>\z/
         # e.g. Hash<String, Integer>
         sub_type = $1
         {}.tap do |hash|
-          data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
+          data.each { |k, v| hash[k] = convert_to_type(v, sub_type, api_version) }
         end
       else
         # models (e.g. Pet) or oneOf
-        klass = DatadogAPIClient::V2.const_get(return_type)
+        klass = DatadogAPIClient.const_get(api_version).const_get(return_type)
         klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
       end
     end
@@ -307,7 +314,7 @@ module DatadogAPIClient::V2
     def build_request_url(path, opts = {})
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      @config.base_url(opts[:operation]) + path
+      @config.base_url("#{opts[:api_version].respond_to?(:downcase) ? opts[:api_version].downcase : opts[:api_version]}.#{opts[:operation]}") + path
     end
 
     # Update header and query params based on authentication settings.
@@ -422,12 +429,13 @@ module DatadogAPIClient::V2
 
     # Set an attribute at the given path
     #
+    # @param [String] api_version The api version
     # @param [Object] obj The source object
     # @param [String] attribute_path The path spefication, separated by "."
     # @param [Object] builder The class matching the top level attribute
     # @param [Object] value The value to set
     # @!visibility private
-    def set_attribute_from_path(obj, attribute_path, builder, value)
+    def set_attribute_from_path(api_version, obj, attribute_path, builder, value)
       attrs = attribute_path.split(".")
       last = attrs.pop
       i = 0
@@ -438,7 +446,7 @@ module DatadogAPIClient::V2
         else
           obj = obj.send(attr)
         end
-        builder = DatadogAPIClient::V2.const_get(builder.openapi_types[attr.to_sym]) if i > 0
+        builder = DatadogAPIClient.const_get(api_version).const_get(builder.openapi_types[attr.to_sym]) if i > 0
         obj = builder.new if obj.nil?
         i += 1
       end
@@ -450,4 +458,48 @@ module DatadogAPIClient::V2
       end
     end
   end
+
+  class APIError < StandardError
+    attr_reader :code, :response_headers, :response_body
+
+    # Usage examples:
+    #   APIError.new
+    #   APIError.new("message")
+    #   APIError.new(:code => 500, :response_headers => {}, :response_body => "")
+    #   APIError.new(:code => 404, :message => "Not Found")
+    def initialize(arg = nil)
+      if arg.is_a? Hash
+        if arg.key?(:message) || arg.key?('message')
+          super(arg[:message] || arg['message'])
+        else
+          super arg
+        end
+
+        arg.each do |k, v|
+          instance_variable_set "@#{k}", v
+        end
+      else
+        super arg
+      end
+    end
+
+    # Override to_s to display a friendly error message
+    def to_s
+      message
+    end
+
+    def message
+      if @message.nil?
+        msg = "Error message: the server returns an error"
+      else
+        msg = @message
+      end
+
+      msg += "\nHTTP status code: #{code}" if code
+      msg += "\nResponse headers: #{response_headers}" if response_headers
+      msg += "\nResponse body: #{response_body}" if response_body
+
+      msg
+    end
+  end
 end

data/lib/datadog_api_client/api_key_configuration.rb

@@ -1,24 +1,7 @@
-require 'datadog_api_client/v1'
-require 'datadog_api_client/v2'
-
 # Extend the automatically-generated client configuration classes with a user-friendly
 # authentication configuration, hiding the original #api_key method.
 
-module DatadogAPIClient::V1
-  class Configuration
-    private :api_key # Make original getter private
-
-    def api_key=(api_key)
-      @api_key['apiKeyAuth'] = api_key
-    end
-
-    def application_key=(app_key)
-      @api_key['appKeyAuth'] = app_key
-    end
-  end
-end
-
-module DatadogAPIClient::V2
+module DatadogAPIClient
   class Configuration
     private :api_key # Make original getter private