datadog_api_client 1.11.0 → 2.0.2

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
 

data/lib/datadog_api_client/{v1/configuration.rb → configuration.rb}

@@ -1,5 +1,5 @@
 =begin
-#Datadog API V1 Collection
+#Datadog API V2 Collection
 
 #Collection of all Datadog Public endpoints.
 
@@ -13,7 +13,7 @@ Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.ge
 
 =end
 
-module DatadogAPIClient::V1
+module DatadogAPIClient
   class Configuration
     # Defines url scheme
     attr_accessor :scheme
@@ -158,15 +158,31 @@ module DatadogAPIClient::V1
       @compress = true
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
       @unstable_operations = {
-            get_daily_custom_reports: false,
-            get_specified_daily_custom_reports: false,
-            get_monthly_custom_reports: false,
-            get_specified_monthly_custom_reports: false,
-            search_slo: false,
-            get_slo_history: false,
-            get_usage_attribution: false,
-            get_hourly_usage_attribution: false,
-            get_monthly_usage_attribution: false,
+            "v1.get_daily_custom_reports": false,
+            "v1.get_monthly_custom_reports": false,
+            "v1.get_specified_daily_custom_reports": false,
+            "v1.get_specified_monthly_custom_reports": false,
+            "v1.get_usage_attribution": false,
+            "v1.get_slo_history": false,
+            "v1.search_slo": false,
+            "v2.list_events": false,
+            "v2.search_events": false,
+            "v2.create_incident": false,
+            "v2.delete_incident": false,
+            "v2.get_incident": false,
+            "v2.list_incidents": false,
+            "v2.update_incident": false,
+            "v2.create_incident_service": false,
+            "v2.delete_incident_service": false,
+            "v2.get_incident_service": false,
+            "v2.list_incident_services": false,
+            "v2.update_incident_service": false,
+            "v2.create_incident_team": false,
+            "v2.delete_incident_team": false,
+            "v2.get_incident_team": false,
+            "v2.list_incident_teams": false,
+            "v2.update_incident_team": false,
+            "v2.get_estimated_cost_by_org": false,
       }
       @server_variables[:site] = ENV['DD_SITE'] if ENV.key? 'DD_SITE'
       @api_key['apiKeyAuth'] = ENV['DD_API_KEY'] if ENV.key? 'DD_API_KEY'
@@ -202,10 +218,10 @@ module DatadogAPIClient::V1
 
     # Returns base URL for specified operation based on server settings
     def base_url(operation = nil)
-      index = server_operation_index.fetch(operation, server_index)
+      index = server_operation_index.fetch(operation.to_sym, server_index)
       return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil
 
-      server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      server_url(index, server_operation_variables.fetch(operation.to_sym, server_variables), operation_server_settings[operation.to_sym])
     end
 
     # Gets API key (with prefix if set).
@@ -242,13 +258,6 @@ module DatadogAPIClient::V1
             key: 'DD-API-KEY',
             value: api_key_with_prefix('apiKeyAuth')
           },
-        apiKeyAuthQuery:
-          {
-            type: 'api_key',
-            in: 'query',
-            key: 'api_key',
-            value: api_key_with_prefix('apiKeyAuthQuery', 'apiKeyAuth')
-          },
         appKeyAuth:
           {
             type: 'api_key',
@@ -256,13 +265,6 @@ module DatadogAPIClient::V1
             key: 'DD-APPLICATION-KEY',
             value: api_key_with_prefix('appKeyAuth')
           },
-        appKeyAuthQuery:
-          {
-            type: 'api_key',
-            in: 'query',
-            key: 'application_key',
-            value: api_key_with_prefix('appKeyAuthQuery', 'appKeyAuth')
-          },
       }
     end
 
@@ -274,7 +276,7 @@ module DatadogAPIClient::V1
           description: "No description provided",
           variables: {
             site: {
-              description: "The regional site for a Datadog customer.",
+              description: "The regional site for Datadog customers.",
               default_value: "datadoghq.com",
               enum_values: [
                 "datadoghq.com",
@@ -323,7 +325,7 @@ module DatadogAPIClient::V1
 
     def operation_server_settings
       {
-        get_ip_ranges: [
+        "v1.get_ip_ranges": [
           {
             url: "https://{subdomain}.{site}",
             description: "No description provided",
@@ -370,7 +372,7 @@ module DatadogAPIClient::V1
             }
           }  
         ],
-        search_slo: [
+        "v1.search_slo": [
           {
             url: "https://{subdomain}.{site}",
             description: "No description provided",
@@ -420,7 +422,7 @@ module DatadogAPIClient::V1
             }
           }  
         ],
-        submit_log: [
+        "v1.submit_log": [
           {
             url: "https://{subdomain}.{site}",
             description: "No description provided",
@@ -471,6 +473,57 @@ module DatadogAPIClient::V1
             }
           }  
         ],
+        "v2.submit_log": [
+          {
+            url: "https://{subdomain}.{site}",
+            description: "No description provided",
+            variables: {
+              site: {
+                description: "The regional site for customers.",
+                default_value: "datadoghq.com",
+                enum_values: [
+                  "datadoghq.com",
+                  "us3.datadoghq.com",
+                  "us5.datadoghq.com",
+                  "datadoghq.eu",
+                  "ddog-gov.com"
+                ]
+              },
+              subdomain: {
+                description: "The subdomain where the API is deployed.",
+                default_value: "http-intake.logs",
+              }
+            }
+          },
+          {
+            url: "{protocol}://{name}",
+            description: "No description provided",
+            variables: {
+              name: {
+                description: "Full site DNS name.",
+                default_value: "http-intake.logs.datadoghq.com",
+              },
+              protocol: {
+                description: "The protocol for accessing the API.",
+                default_value: "https",
+              }
+            }
+          },
+          {
+            url: "https://{subdomain}.{site}",
+            description: "No description provided",
+            variables: {
+              site: {
+                description: "Any Datadog deployment.",
+                default_value: "datadoghq.com",
+              },
+              subdomain: {
+                description: "The subdomain where the API is deployed.",
+                default_value: "http-intake.logs",
+              }
+            }
+          }  
+        ],
       }
     end