aws-sdk-sustainability 1.0.0

data/lib/aws-sdk-sustainability/types.rb

@@ -0,0 +1,328 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::Sustainability
+  module Types
+
+    # You do not have sufficient access to perform this action.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sustainability-2018-05-10/AccessDeniedException AWS API Documentation
+    #
+    class AccessDeniedException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Represents a dimension and its corresponding value.
+    #
+    # @!attribute [rw] dimension
+    #   The dimension type that categorizes this entry.
+    #   @return [String]
+    #
+    # @!attribute [rw] value
+    #   The value for the specified dimension. Valid values vary based on
+    #   the dimension type (e.g., `us-east-1` for the `REGION` dimension,
+    #   `AmazonEC2` for the `SERVICE` dimension).
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sustainability-2018-05-10/DimensionEntry AWS API Documentation
+    #
+    class DimensionEntry < Struct.new(
+      :dimension,
+      :value)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Represents a carbon emissions quantity with its value and unit of
+    # measurement.
+    #
+    # @!attribute [rw] value
+    #   The numeric value of the emissions quantity.
+    #   @return [Float]
+    #
+    # @!attribute [rw] unit
+    #   The unit of measurement for the emissions value.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sustainability-2018-05-10/Emissions AWS API Documentation
+    #
+    class Emissions < Struct.new(
+      :value,
+      :unit)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Contains estimated carbon emissions data for a specific time period
+    # and dimension grouping.
+    #
+    # @!attribute [rw] time_period
+    #   The reporting period for emission values.
+    #   @return [Types::TimePeriod]
+    #
+    # @!attribute [rw] dimensions_values
+    #   The dimensions used to group emissions values.
+    #   @return [Hash<String,String>]
+    #
+    # @!attribute [rw] model_version
+    #   The semantic version-formatted string that indicates the methodology
+    #   version used to calculate the emission values.
+    #
+    #   <note markdown="1"> The AWS Sustainability service reflects the most recent model
+    #   version for every month. You will not see two entries for the same
+    #   month with different `ModelVersion` values. To track the evolution
+    #   of the methodology and compare emission values from previous
+    #   versions, we recommend creating a [Data Export][1].
+    #
+    #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/cur/latest/userguide/what-is-data-exports.html
+    #   @return [String]
+    #
+    # @!attribute [rw] emissions_values
+    #   The emissions values for the requested emissions types.
+    #   @return [Hash<String,Types::Emissions>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sustainability-2018-05-10/EstimatedCarbonEmissions AWS API Documentation
+    #
+    class EstimatedCarbonEmissions < Struct.new(
+      :time_period,
+      :dimensions_values,
+      :model_version,
+      :emissions_values)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Filters emission values by specific dimension values.
+    #
+    # @!attribute [rw] dimensions
+    #   Filters emission values by specific dimension values.
+    #   @return [Hash<String,Array<String>>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sustainability-2018-05-10/FilterExpression AWS API Documentation
+    #
+    class FilterExpression < Struct.new(
+      :dimensions)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] time_period
+    #   The date range for fetching the dimension values.
+    #   @return [Types::TimePeriod]
+    #
+    # @!attribute [rw] dimensions
+    #   The dimensions available for grouping estimated carbon emissions.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return in a single call. Default is
+    #   40.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   The pagination token specifying which page of results to return in
+    #   the response. If no token is provided, the default page is the first
+    #   page.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sustainability-2018-05-10/GetEstimatedCarbonEmissionsDimensionValuesRequest AWS API Documentation
+    #
+    class GetEstimatedCarbonEmissionsDimensionValuesRequest < Struct.new(
+      :time_period,
+      :dimensions,
+      :max_results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] results
+    #   The list of possible dimensions over which the emissions data is
+    #   aggregated.
+    #   @return [Array<Types::DimensionEntry>]
+    #
+    # @!attribute [rw] next_token
+    #   The pagination token indicating there are additional pages
+    #   available. You can use the token in a following request to fetch the
+    #   next set of results.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sustainability-2018-05-10/GetEstimatedCarbonEmissionsDimensionValuesResponse AWS API Documentation
+    #
+    class GetEstimatedCarbonEmissionsDimensionValuesResponse < Struct.new(
+      :results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] time_period
+    #   The date range for fetching estimated carbon emissions.
+    #   @return [Types::TimePeriod]
+    #
+    # @!attribute [rw] group_by
+    #   The dimensions available for grouping estimated carbon emissions.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] filter_by
+    #   The criteria for filtering estimated carbon emissions.
+    #   @return [Types::FilterExpression]
+    #
+    # @!attribute [rw] emissions_types
+    #   The emission types to include in the results. If absent, returns
+    #   `TOTAL_LBM_CARBON_EMISSIONS` and `TOTAL_MBM_CARBON_EMISSIONS`
+    #   emissions types.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] granularity
+    #   The time granularity for the results. If absent, uses `MONTHLY` time
+    #   granularity.
+    #   @return [String]
+    #
+    # @!attribute [rw] granularity_configuration
+    #   Configuration for fiscal year calculations when using
+    #   `YEARLY_FISCAL` or `QUARTERLY_FISCAL` granularity.
+    #   @return [Types::GranularityConfiguration]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return in a single call. Default is
+    #   40.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   The pagination token specifying which page of results to return in
+    #   the response. If no token is provided, the default page is the first
+    #   page.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sustainability-2018-05-10/GetEstimatedCarbonEmissionsRequest AWS API Documentation
+    #
+    class GetEstimatedCarbonEmissionsRequest < Struct.new(
+      :time_period,
+      :group_by,
+      :filter_by,
+      :emissions_types,
+      :granularity,
+      :granularity_configuration,
+      :max_results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] results
+    #   The result of the requested inputs.
+    #   @return [Array<Types::EstimatedCarbonEmissions>]
+    #
+    # @!attribute [rw] next_token
+    #   The pagination token indicating there are additional pages
+    #   available. You can use the token in a following request to fetch the
+    #   next set of results.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sustainability-2018-05-10/GetEstimatedCarbonEmissionsResponse AWS API Documentation
+    #
+    class GetEstimatedCarbonEmissionsResponse < Struct.new(
+      :results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Contains configuration for the fiscal year granularities (e.g.,
+    # `YEARLY_FISCAL`, `QUARTERLY_FISCAL`.
+    #
+    # @!attribute [rw] fiscal_year_start_month
+    #   The month (1-12) when the fiscal year begins. Used for
+    #   `YEARLY_FISCAL` and `QUARTERLY_FISCAL` granularity. Defaults to 1
+    #   (January).
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sustainability-2018-05-10/GranularityConfiguration AWS API Documentation
+    #
+    class GranularityConfiguration < Struct.new(
+      :fiscal_year_start_month)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The request processing has failed because of an unknown error,
+    # exception, or failure.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sustainability-2018-05-10/InternalServerException AWS API Documentation
+    #
+    class InternalServerException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The request was denied due to request throttling.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sustainability-2018-05-10/ThrottlingException AWS API Documentation
+    #
+    class ThrottlingException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Represents a duration of time defined by start and end timestamps.
+    #
+    # @!attribute [rw] start
+    #   The start (inclusive) of the time period. ISO-8601 formatted
+    #   timestamp, for example: `YYYY-MM-DDThh:mm:ss.sssZ`
+    #   @return [Time]
+    #
+    # @!attribute [rw] end
+    #   The end (exclusive) of the time period. ISO-8601 formatted
+    #   timestamp, for example: `YYYY-MM-DDThh:mm:ss.sssZ`
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sustainability-2018-05-10/TimePeriod AWS API Documentation
+    #
+    class TimePeriod < Struct.new(
+      :start,
+      :end)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The input fails to satisfy the constraints specified by an Amazon Web
+    # Services service.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sustainability-2018-05-10/ValidationException AWS API Documentation
+    #
+    class ValidationException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+  end
+end
+

data/lib/aws-sdk-sustainability.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+
+require 'aws-sdk-core'
+require 'aws-sigv4'
+
+Aws::Plugins::GlobalConfiguration.add_identifier(:sustainability)
+
+# This module provides support for AWS Sustainability. This module is available in the
+# `aws-sdk-sustainability` gem.
+#
+# # Client
+#
+# The {Client} class provides one method for each API operation. Operation
+# methods each accept a hash of request parameters and return a response
+# structure.
+#
+#     sustainability = Aws::Sustainability::Client.new
+#     resp = sustainability.get_estimated_carbon_emissions(params)
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from AWS Sustainability are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue Aws::Sustainability::Errors::ServiceError
+#       # rescues all AWS Sustainability API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @!group service
+module Aws::Sustainability
+  autoload :Types, 'aws-sdk-sustainability/types'
+  autoload :ClientApi, 'aws-sdk-sustainability/client_api'
+  module Plugins
+    autoload :Endpoints, 'aws-sdk-sustainability/plugins/endpoints.rb'
+  end
+  autoload :Client, 'aws-sdk-sustainability/client'
+  autoload :Errors, 'aws-sdk-sustainability/errors'
+  autoload :Resource, 'aws-sdk-sustainability/resource'
+  autoload :EndpointParameters, 'aws-sdk-sustainability/endpoint_parameters'
+  autoload :EndpointProvider, 'aws-sdk-sustainability/endpoint_provider'
+  autoload :Endpoints, 'aws-sdk-sustainability/endpoints'
+
+  GEM_VERSION = '1.0.0'
+
+end
+
+require_relative 'aws-sdk-sustainability/customizations'

data/sig/client.rbs

@@ -0,0 +1,125 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module Sustainability
+    class Client < ::Seahorse::Client::Base
+      include ::Aws::ClientStubs
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Sustainability/Client.html#initialize-instance_method
+      def self.new: (
+                      ?credentials: untyped,
+                      ?region: String,
+                      ?access_key_id: String,
+                      ?account_id: String,
+                      ?active_endpoint_cache: bool,
+                      ?adaptive_retry_wait_to_fill: bool,
+                      ?auth_scheme_preference: Array[String],
+                      ?client_side_monitoring: bool,
+                      ?client_side_monitoring_client_id: String,
+                      ?client_side_monitoring_host: String,
+                      ?client_side_monitoring_port: Integer,
+                      ?client_side_monitoring_publisher: untyped,
+                      ?convert_params: bool,
+                      ?correct_clock_skew: bool,
+                      ?defaults_mode: String,
+                      ?disable_host_prefix_injection: bool,
+                      ?disable_request_compression: bool,
+                      ?endpoint: String,
+                      ?endpoint_cache_max_entries: Integer,
+                      ?endpoint_cache_max_threads: Integer,
+                      ?endpoint_cache_poll_interval: Integer,
+                      ?endpoint_discovery: bool,
+                      ?ignore_configured_endpoint_urls: bool,
+                      ?log_formatter: untyped,
+                      ?log_level: Symbol,
+                      ?logger: untyped,
+                      ?max_attempts: Integer,
+                      ?profile: String,
+                      ?request_checksum_calculation: String,
+                      ?request_min_compression_size_bytes: Integer,
+                      ?response_checksum_validation: String,
+                      ?retry_backoff: Proc,
+                      ?retry_base_delay: Float,
+                      ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
+                      ?retry_limit: Integer,
+                      ?retry_max_delay: Integer,
+                      ?retry_mode: ("legacy" | "standard" | "adaptive"),
+                      ?sdk_ua_app_id: String,
+                      ?secret_access_key: String,
+                      ?session_token: String,
+                      ?sigv4a_signing_region_set: Array[String],
+                      ?stub_responses: untyped,
+                      ?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
+                      ?token_provider: untyped,
+                      ?use_dualstack_endpoint: bool,
+                      ?use_fips_endpoint: bool,
+                      ?validate_params: bool,
+                      ?endpoint_provider: untyped,
+                      ?http_proxy: String,
+                      ?http_open_timeout: (Float | Integer),
+                      ?http_read_timeout: (Float | Integer),
+                      ?http_idle_timeout: (Float | Integer),
+                      ?http_continue_timeout: (Float | Integer),
+                      ?ssl_timeout: (Float | Integer | nil),
+                      ?http_wire_trace: bool,
+                      ?ssl_verify_peer: bool,
+                      ?ssl_ca_bundle: String,
+                      ?ssl_ca_directory: String,
+                      ?ssl_ca_store: String,
+                      ?on_chunk_received: Proc,
+                      ?on_chunk_sent: Proc,
+                      ?raise_response_errors: bool
+                    ) -> instance
+                  | (?Hash[Symbol, untyped]) -> instance
+
+
+      interface _GetEstimatedCarbonEmissionsResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::GetEstimatedCarbonEmissionsResponse]
+        def results: () -> ::Array[Types::EstimatedCarbonEmissions]
+        def next_token: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Sustainability/Client.html#get_estimated_carbon_emissions-instance_method
+      def get_estimated_carbon_emissions: (
+                                            time_period: {
+                                              start: ::Time,
+                                              end: ::Time
+                                            },
+                                            ?group_by: Array[("USAGE_ACCOUNT_ID" | "REGION" | "SERVICE")],
+                                            ?filter_by: {
+                                              dimensions: Hash[("USAGE_ACCOUNT_ID" | "REGION" | "SERVICE"), Array[::String]]?
+                                            },
+                                            ?emissions_types: Array[("TOTAL_LBM_CARBON_EMISSIONS" | "TOTAL_MBM_CARBON_EMISSIONS" | "TOTAL_SCOPE_1_CARBON_EMISSIONS" | "TOTAL_SCOPE_2_LBM_CARBON_EMISSIONS" | "TOTAL_SCOPE_2_MBM_CARBON_EMISSIONS" | "TOTAL_SCOPE_3_LBM_CARBON_EMISSIONS" | "TOTAL_SCOPE_3_MBM_CARBON_EMISSIONS")],
+                                            ?granularity: ("YEARLY_CALENDAR" | "YEARLY_FISCAL" | "QUARTERLY_CALENDAR" | "QUARTERLY_FISCAL" | "MONTHLY"),
+                                            ?granularity_configuration: {
+                                              fiscal_year_start_month: ::Integer?
+                                            },
+                                            ?max_results: ::Integer,
+                                            ?next_token: ::String
+                                          ) -> _GetEstimatedCarbonEmissionsResponseSuccess
+                                        | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetEstimatedCarbonEmissionsResponseSuccess
+
+      interface _GetEstimatedCarbonEmissionsDimensionValuesResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::GetEstimatedCarbonEmissionsDimensionValuesResponse]
+        def results: () -> ::Array[Types::DimensionEntry]
+        def next_token: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Sustainability/Client.html#get_estimated_carbon_emissions_dimension_values-instance_method
+      def get_estimated_carbon_emissions_dimension_values: (
+                                                             time_period: {
+                                                               start: ::Time,
+                                                               end: ::Time
+                                                             },
+                                                             dimensions: Array[("USAGE_ACCOUNT_ID" | "REGION" | "SERVICE")],
+                                                             ?max_results: ::Integer,
+                                                             ?next_token: ::String
+                                                           ) -> _GetEstimatedCarbonEmissionsDimensionValuesResponseSuccess
+                                                         | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetEstimatedCarbonEmissionsDimensionValuesResponseSuccess
+    end
+  end
+end
+

data/sig/errors.rbs

@@ -0,0 +1,28 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module Sustainability
+    module Errors
+      class ServiceError < ::Aws::Errors::ServiceError
+      end
+
+      class AccessDeniedException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+      end
+      class InternalServerException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+      end
+      class ThrottlingException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+      end
+      class ValidationException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+      end
+    end
+  end
+end

data/sig/resource.rbs

@@ -0,0 +1,85 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module Sustainability
+    # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Sustainability/Resource.html
+    class Resource
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Sustainability/Resource.html#initialize-instance_method
+      def initialize: (
+                        ?client: Client,
+                        ?credentials: untyped,
+                        ?region: String,
+                        ?access_key_id: String,
+                        ?account_id: String,
+                        ?active_endpoint_cache: bool,
+                        ?adaptive_retry_wait_to_fill: bool,
+                        ?auth_scheme_preference: Array[String],
+                        ?client_side_monitoring: bool,
+                        ?client_side_monitoring_client_id: String,
+                        ?client_side_monitoring_host: String,
+                        ?client_side_monitoring_port: Integer,
+                        ?client_side_monitoring_publisher: untyped,
+                        ?convert_params: bool,
+                        ?correct_clock_skew: bool,
+                        ?defaults_mode: String,
+                        ?disable_host_prefix_injection: bool,
+                        ?disable_request_compression: bool,
+                        ?endpoint: String,
+                        ?endpoint_cache_max_entries: Integer,
+                        ?endpoint_cache_max_threads: Integer,
+                        ?endpoint_cache_poll_interval: Integer,
+                        ?endpoint_discovery: bool,
+                        ?ignore_configured_endpoint_urls: bool,
+                        ?log_formatter: untyped,
+                        ?log_level: Symbol,
+                        ?logger: untyped,
+                        ?max_attempts: Integer,
+                        ?profile: String,
+                        ?request_checksum_calculation: String,
+                        ?request_min_compression_size_bytes: Integer,
+                        ?response_checksum_validation: String,
+                        ?retry_backoff: Proc,
+                        ?retry_base_delay: Float,
+                        ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
+                        ?retry_limit: Integer,
+                        ?retry_max_delay: Integer,
+                        ?retry_mode: ("legacy" | "standard" | "adaptive"),
+                        ?sdk_ua_app_id: String,
+                        ?secret_access_key: String,
+                        ?session_token: String,
+                        ?sigv4a_signing_region_set: Array[String],
+                        ?stub_responses: untyped,
+                        ?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
+                        ?token_provider: untyped,
+                        ?use_dualstack_endpoint: bool,
+                        ?use_fips_endpoint: bool,
+                        ?validate_params: bool,
+                        ?endpoint_provider: untyped,
+                        ?http_proxy: String,
+                        ?http_open_timeout: (Float | Integer),
+                        ?http_read_timeout: (Float | Integer),
+                        ?http_idle_timeout: (Float | Integer),
+                        ?http_continue_timeout: (Float | Integer),
+                        ?ssl_timeout: (Float | Integer | nil),
+                        ?http_wire_trace: bool,
+                        ?ssl_verify_peer: bool,
+                        ?ssl_ca_bundle: String,
+                        ?ssl_ca_directory: String,
+                        ?ssl_ca_store: String,
+                        ?on_chunk_received: Proc,
+                        ?on_chunk_sent: Proc,
+                        ?raise_response_errors: bool
+                      ) -> void
+                    | (?Hash[Symbol, untyped]) -> void
+
+      def client: () -> Client
+
+
+    end
+  end
+end