datadog_api_client 1.8.0 → 1.9.0

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

@@ -0,0 +1,102 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ This product includes software developed at Datadog (https://www.datadoghq.com/).
+ Copyright 2020-Present Datadog, Inc.
+
+=end
+
+require 'cgi'
+
+module DatadogAPIClient::V2
+  class UsageMeteringAPI
+    attr_accessor :api_client
+
+    def initialize(api_client = APIClient.default)
+      @api_client = api_client
+    end
+
+    # Get hourly usage for Observability Pipelines.
+    #
+    # @see #get_usage_observability_pipelines_with_http_info
+    def get_usage_observability_pipelines(start_hr, opts = {})
+      data, _status_code, _headers = get_usage_observability_pipelines_with_http_info(start_hr, opts)
+      data
+    end
+
+    # Get hourly usage for Observability Pipelines.
+    #
+    # Get hourly usage for Observability Pipelines.
+    #
+    # @param start_hr [Time] Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
+    # @param opts [Hash] the optional parameters
+    # @option opts [Time] :end_hr Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour.
+    # @return [Array<(UsageObservabilityPipelinesResponse, Integer, Hash)>] UsageObservabilityPipelinesResponse data, response status code and response headers
+    def get_usage_observability_pipelines_with_http_info(start_hr, opts = {})
+
+      if @api_client.config.unstable_operations.has_key?(:get_usage_observability_pipelines)
+        unstable_enabled = @api_client.config.unstable_operations[:get_usage_observability_pipelines]
+        if unstable_enabled
+          @api_client.config.logger.warn format("Using unstable operation '%s'", "get_usage_observability_pipelines")
+        else
+          raise APIError.new(message: format("Unstable operation '%s' is disabled", "get_usage_observability_pipelines"))
+        end
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsageMeteringAPI.get_usage_observability_pipelines ...'
+      end
+      # verify the required parameter 'start_hr' is set
+      if @api_client.config.client_side_validation && start_hr.nil?
+        fail ArgumentError, "Missing the required parameter 'start_hr' when calling UsageMeteringAPI.get_usage_observability_pipelines"
+      end
+      # resource path
+      local_var_path = '/api/v2/usage/observability_pipelines'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'start_hr'] = start_hr
+      query_params[:'end_hr'] = opts[:'end_hr'] if !opts[:'end_hr'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json;datetime-format=rfc3339'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UsageObservabilityPipelinesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
+
+      new_options = opts.merge(
+        :operation => :get_usage_observability_pipelines,
+        :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(Net::HTTP::Get, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsageMeteringAPI#get_usage_observability_pipelines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -23,18 +23,18 @@ module DatadogAPIClient::V2
       @api_client = api_client
     end
 
-    # Create a service account
-    # Create a service account for your organization.
-    # @param body [ServiceAccountCreateRequest] 
-    # @param opts [Hash] the optional parameters
-    # @return [UserResponse]
+    # Create a service account.
+    #
+    # @see #create_service_account_with_http_info
     def create_service_account(body, opts = {})
       data, _status_code, _headers = create_service_account_with_http_info(body, opts)
       data
     end
 
-    # Create a service account
+    # Create a service account.
+    #
     # Create a service account for your organization.
+    #
     # @param body [ServiceAccountCreateRequest] 
     # @param opts [Hash] the optional parameters
     # @return [Array<(UserResponse, Integer, Hash)>] UserResponse data, response status code and response headers
@@ -91,25 +91,25 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      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: UsersAPI#create_service_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Create a user
-    # Create a user for your organization.
-    # @param body [UserCreateRequest] 
-    # @param opts [Hash] the optional parameters
-    # @return [UserResponse]
+    # Create a user.
+    #
+    # @see #create_user_with_http_info
     def create_user(body, opts = {})
       data, _status_code, _headers = create_user_with_http_info(body, opts)
       data
     end
 
-    # Create a user
+    # Create a user.
+    #
     # Create a user for your organization.
+    #
     # @param body [UserCreateRequest] 
     # @param opts [Hash] the optional parameters
     # @return [Array<(UserResponse, Integer, Hash)>] UserResponse data, response status code and response headers
@@ -166,27 +166,26 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      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: UsersAPI#create_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Disable a user
-    # Disable a user. Can only be used with an application key belonging
-    # to an administrator user.
-    # @param user_id [String] The ID of the user.
-    # @param opts [Hash] the optional parameters
-    # @return [nil]
+    # Disable a user.
+    #
+    # @see #disable_user_with_http_info
     def disable_user(user_id, opts = {})
       disable_user_with_http_info(user_id, opts)
       nil
     end
 
-    # Disable a user
+    # Disable a user.
+    #
     # Disable a user. Can only be used with an application key belonging
     # to an administrator user.
+    #
     # @param user_id [String] The ID of the user.
     # @param opts [Hash] the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -241,25 +240,25 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      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: UsersAPI#disable_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get a user invitation
-    # Returns a single user invitation by its UUID.
-    # @param user_invitation_uuid [String] The UUID of the user invitation.
-    # @param opts [Hash] the optional parameters
-    # @return [UserInvitationResponse]
+    # Get a user invitation.
+    #
+    # @see #get_invitation_with_http_info
     def get_invitation(user_invitation_uuid, opts = {})
       data, _status_code, _headers = get_invitation_with_http_info(user_invitation_uuid, opts)
       data
     end
 
-    # Get a user invitation
+    # Get a user invitation.
+    #
     # Returns a single user invitation by its UUID.
+    #
     # @param user_invitation_uuid [String] The UUID of the user invitation.
     # @param opts [Hash] the optional parameters
     # @return [Array<(UserInvitationResponse, Integer, Hash)>] UserInvitationResponse data, response status code and response headers
@@ -314,25 +313,25 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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: UsersAPI#get_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get user details
-    # Get a user in the organization specified by the user’s `user_id`.
-    # @param user_id [String] The ID of the user.
-    # @param opts [Hash] the optional parameters
-    # @return [UserResponse]
+    # Get user details.
+    #
+    # @see #get_user_with_http_info
     def get_user(user_id, opts = {})
       data, _status_code, _headers = get_user_with_http_info(user_id, opts)
       data
     end
 
-    # Get user details
+    # Get user details.
+    #
     # Get a user in the organization specified by the user’s `user_id`.
+    #
     # @param user_id [String] The ID of the user.
     # @param opts [Hash] the optional parameters
     # @return [Array<(UserResponse, Integer, Hash)>] UserResponse data, response status code and response headers
@@ -387,27 +386,26 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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: UsersAPI#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get a user organization
-    # Get a user organization. Returns the user information and all organizations
-    # joined by this user.
-    # @param user_id [String] The ID of the user.
-    # @param opts [Hash] the optional parameters
-    # @return [UserResponse]
+    # Get a user organization.
+    #
+    # @see #list_user_organizations_with_http_info
     def list_user_organizations(user_id, opts = {})
       data, _status_code, _headers = list_user_organizations_with_http_info(user_id, opts)
       data
     end
 
-    # Get a user organization
+    # Get a user organization.
+    #
     # Get a user organization. Returns the user information and all organizations
     # joined by this user.
+    #
     # @param user_id [String] The ID of the user.
     # @param opts [Hash] the optional parameters
     # @return [Array<(UserResponse, Integer, Hash)>] UserResponse data, response status code and response headers
@@ -462,27 +460,26 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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: UsersAPI#list_user_organizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get a user permissions
-    # Get a user permission set. Returns a list of the user’s permissions
-    # granted by the associated user's roles.
-    # @param user_id [String] The ID of the user.
-    # @param opts [Hash] the optional parameters
-    # @return [PermissionsResponse]
+    # Get a user permissions.
+    #
+    # @see #list_user_permissions_with_http_info
     def list_user_permissions(user_id, opts = {})
       data, _status_code, _headers = list_user_permissions_with_http_info(user_id, opts)
       data
     end
 
-    # Get a user permissions
+    # Get a user permissions.
+    #
     # Get a user permission set. Returns a list of the user’s permissions
     # granted by the associated user's roles.
+    #
     # @param user_id [String] The ID of the user.
     # @param opts [Hash] the optional parameters
     # @return [Array<(PermissionsResponse, Integer, Hash)>] PermissionsResponse data, response status code and response headers
@@ -537,32 +534,26 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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: UsersAPI#list_user_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # List all users
-    # Get the list of all users in the organization. This list includes
-    # all users even if they are deactivated or unverified.
-    # @param opts [Hash] the optional parameters
-    # @option opts [Integer] :page_size Size for a given page.
-    # @option opts [Integer] :page_number Specific page number to return.
-    # @option opts [String] :sort User attribute to order results by. Sort order is ascending by default. Sort order is descending if the field is prefixed by a negative sign, for example `sort=-name`. Options: `name`, `modified_at`, `user_count`.
-    # @option opts [QuerySortOrder] :sort_dir Direction of sort. Options: `asc`, `desc`.
-    # @option opts [String] :filter Filter all users by the given string. Defaults to no filtering.
-    # @option opts [String] :filter_status Filter on status attribute. Comma separated list, with possible values `Active`, `Pending`, and `Disabled`. Defaults to no filtering.
-    # @return [UsersResponse]
+    # List all users.
+    #
+    # @see #list_users_with_http_info
     def list_users(opts = {})
       data, _status_code, _headers = list_users_with_http_info(opts)
       data
     end
 
-    # List all users
+    # List all users.
+    #
     # Get the list of all users in the organization. This list includes
     # all users even if they are deactivated or unverified.
+    #
     # @param opts [Hash] the optional parameters
     # @option opts [Integer] :page_size Size for a given page.
     # @option opts [Integer] :page_number Specific page number to return.
@@ -628,25 +619,25 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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: UsersAPI#list_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Send invitation emails
-    # Sends emails to one or more users inviting them to join the organization.
-    # @param body [UserInvitationsRequest] 
-    # @param opts [Hash] the optional parameters
-    # @return [UserInvitationsResponse]
+    # Send invitation emails.
+    #
+    # @see #send_invitations_with_http_info
     def send_invitations(body, opts = {})
       data, _status_code, _headers = send_invitations_with_http_info(body, opts)
       data
     end
 
-    # Send invitation emails
+    # Send invitation emails.
+    #
     # Sends emails to one or more users inviting them to join the organization.
+    #
     # @param body [UserInvitationsRequest] 
     # @param opts [Hash] the optional parameters
     # @return [Array<(UserInvitationsResponse, Integer, Hash)>] UserInvitationsResponse data, response status code and response headers
@@ -703,28 +694,26 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      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: UsersAPI#send_invitations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Update a user
-    # Edit a user. Can only be used with an application key belonging
-    # to an administrator user.
-    # @param user_id [String] The ID of the user.
-    # @param body [UserUpdateRequest] 
-    # @param opts [Hash] the optional parameters
-    # @return [UserResponse]
+    # Update a user.
+    #
+    # @see #update_user_with_http_info
     def update_user(user_id, body, opts = {})
       data, _status_code, _headers = update_user_with_http_info(user_id, body, opts)
       data
     end
 
-    # Update a user
+    # Update a user.
+    #
     # Edit a user. Can only be used with an application key belonging
     # to an administrator user.
+    #
     # @param user_id [String] The ID of the user.
     # @param body [UserUpdateRequest] 
     # @param opts [Hash] the optional parameters
@@ -786,7 +775,7 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      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: UsersAPI#update_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end