aws-sdk-pinpointsmsvoice 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: feff95916b5482e64ac69d17b2ed69f61e3bc210
+  data.tar.gz: 5608ce1cf18cf7c16fd9a151b55ffcdcec9dc938
+SHA512:
+  metadata.gz: de951db6b120cf08074b819859eaa9981abb163eaf35c100441a248cbc1561e5487afd35be4b033838ad7d6c84289c1ff165031e64701e9f661ae5209a5aa50d
+  data.tar.gz: 29993e8fe1966156eda3ce700a1c412efc02f758fdc37beba3761082fa8c6380a6699ddfd42ff2fa2ceade1279850d242f83679ce18ba7c33e41a34c933cd53c

data/lib/aws-sdk-pinpointsmsvoice.rb

@@ -0,0 +1,47 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'aws-sdk-core'
+require 'aws-sigv4'
+
+require_relative 'aws-sdk-pinpointsmsvoice/types'
+require_relative 'aws-sdk-pinpointsmsvoice/client_api'
+require_relative 'aws-sdk-pinpointsmsvoice/client'
+require_relative 'aws-sdk-pinpointsmsvoice/errors'
+require_relative 'aws-sdk-pinpointsmsvoice/resource'
+require_relative 'aws-sdk-pinpointsmsvoice/customizations'
+
+# This module provides support for Amazon Pinpoint SMS and Voice Service. This module is available in the
+# `aws-sdk-pinpointsmsvoice` 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.
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from Amazon Pinpoint SMS and Voice Service all
+# extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue Aws::PinpointSMSVoice::Errors::ServiceError
+#       # rescues all service API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @service
+module Aws::PinpointSMSVoice
+
+  GEM_VERSION = '1.0.0'
+
+end

data/lib/aws-sdk-pinpointsmsvoice/client.rb

@@ -0,0 +1,488 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'seahorse/client/plugins/content_length.rb'
+require 'aws-sdk-core/plugins/credentials_configuration.rb'
+require 'aws-sdk-core/plugins/logging.rb'
+require 'aws-sdk-core/plugins/param_converter.rb'
+require 'aws-sdk-core/plugins/param_validator.rb'
+require 'aws-sdk-core/plugins/user_agent.rb'
+require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
+require 'aws-sdk-core/plugins/retry_errors.rb'
+require 'aws-sdk-core/plugins/global_configuration.rb'
+require 'aws-sdk-core/plugins/regional_endpoint.rb'
+require 'aws-sdk-core/plugins/endpoint_discovery.rb'
+require 'aws-sdk-core/plugins/response_paging.rb'
+require 'aws-sdk-core/plugins/stub_responses.rb'
+require 'aws-sdk-core/plugins/idempotency_token.rb'
+require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
+require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
+require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
+require 'aws-sdk-core/plugins/signature_v4.rb'
+require 'aws-sdk-core/plugins/protocols/rest_json.rb'
+
+Aws::Plugins::GlobalConfiguration.add_identifier(:pinpointsmsvoice)
+
+module Aws::PinpointSMSVoice
+  class Client < Seahorse::Client::Base
+
+    include Aws::ClientStubs
+
+    @identifier = :pinpointsmsvoice
+
+    set_api(ClientApi::API)
+
+    add_plugin(Seahorse::Client::Plugins::ContentLength)
+    add_plugin(Aws::Plugins::CredentialsConfiguration)
+    add_plugin(Aws::Plugins::Logging)
+    add_plugin(Aws::Plugins::ParamConverter)
+    add_plugin(Aws::Plugins::ParamValidator)
+    add_plugin(Aws::Plugins::UserAgent)
+    add_plugin(Aws::Plugins::HelpfulSocketErrors)
+    add_plugin(Aws::Plugins::RetryErrors)
+    add_plugin(Aws::Plugins::GlobalConfiguration)
+    add_plugin(Aws::Plugins::RegionalEndpoint)
+    add_plugin(Aws::Plugins::EndpointDiscovery)
+    add_plugin(Aws::Plugins::ResponsePaging)
+    add_plugin(Aws::Plugins::StubResponses)
+    add_plugin(Aws::Plugins::IdempotencyToken)
+    add_plugin(Aws::Plugins::JsonvalueConverter)
+    add_plugin(Aws::Plugins::ClientMetricsPlugin)
+    add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
+    add_plugin(Aws::Plugins::SignatureV4)
+    add_plugin(Aws::Plugins::Protocols::RestJson)
+
+    # @overload initialize(options)
+    #   @param [Hash] options
+    #   @option options [required, Aws::CredentialProvider] :credentials
+    #     Your AWS credentials. This can be an instance of any one of the
+    #     following classes:
+    #
+    #     * `Aws::Credentials` - Used for configuring static, non-refreshing
+    #       credentials.
+    #
+    #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
+    #       from an EC2 IMDS on an EC2 instance.
+    #
+    #     * `Aws::SharedCredentials` - Used for loading credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     When `:credentials` are not configured directly, the following
+    #     locations will be searched for credentials:
+    #
+    #     * `Aws.config[:credentials]`
+    #     * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
+    #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
+    #     * `~/.aws/credentials`
+    #     * `~/.aws/config`
+    #     * EC2 IMDS instance profile - When used by default, the timeouts are
+    #       very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` to enable retries and extended
+    #       timeouts.
+    #
+    #   @option options [required, String] :region
+    #     The AWS region to connect to.  The configured `:region` is
+    #     used to determine the service `:endpoint`. When not passed,
+    #     a default `:region` is search for in the following locations:
+    #
+    #     * `Aws.config[:region]`
+    #     * `ENV['AWS_REGION']`
+    #     * `ENV['AMAZON_REGION']`
+    #     * `ENV['AWS_DEFAULT_REGION']`
+    #     * `~/.aws/credentials`
+    #     * `~/.aws/config`
+    #
+    #   @option options [String] :access_key_id
+    #
+    #   @option options [Boolean] :active_endpoint_cache (false)
+    #     When set to `true`, a thread polling for endpoints will be running in
+    #     the background every 60 secs (default). Defaults to `false`.
+    #
+    #   @option options [Boolean] :client_side_monitoring (false)
+    #     When `true`, client-side metrics will be collected for all API requests from
+    #     this client.
+    #
+    #   @option options [String] :client_side_monitoring_client_id ("")
+    #     Allows you to provide an identifier for this client which will be attached to
+    #     all generated client side metrics. Defaults to an empty string.
+    #
+    #   @option options [Integer] :client_side_monitoring_port (31000)
+    #     Required for publishing client metrics. The port that the client side monitoring
+    #     agent is running on, where client metrics will be published via UDP.
+    #
+    #   @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
+    #     Allows you to provide a custom client-side monitoring publisher class. By default,
+    #     will use the Client Side Monitoring Agent Publisher.
+    #
+    #   @option options [Boolean] :convert_params (true)
+    #     When `true`, an attempt is made to coerce request parameters into
+    #     the required types.
+    #
+    #   @option options [String] :endpoint
+    #     The client endpoint is normally constructed from the `:region`
+    #     option. You should only configure an `:endpoint` when connecting
+    #     to test endpoints. This should be avalid HTTP(S) URI.
+    #
+    #   @option options [Integer] :endpoint_cache_max_entries (1000)
+    #     Used for the maximum size limit of the LRU cache storing endpoints data
+    #     for endpoint discovery enabled operations. Defaults to 1000.
+    #
+    #   @option options [Integer] :endpoint_cache_max_threads (10)
+    #     Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
+    #
+    #   @option options [Integer] :endpoint_cache_poll_interval (60)
+    #     When :endpoint_discovery and :active_endpoint_cache is enabled,
+    #     Use this option to config the time interval in seconds for making
+    #     requests fetching endpoints information. Defaults to 60 sec.
+    #
+    #   @option options [Boolean] :endpoint_discovery (false)
+    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #
+    #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
+    #     The log formatter.
+    #
+    #   @option options [Symbol] :log_level (:info)
+    #     The log level to send messages to the `:logger` at.
+    #
+    #   @option options [Logger] :logger
+    #     The Logger instance to send log messages to.  If this option
+    #     is not set, logging will be disabled.
+    #
+    #   @option options [String] :profile ("default")
+    #     Used when loading credentials from the shared credentials file
+    #     at HOME/.aws/credentials.  When not specified, 'default' is used.
+    #
+    #   @option options [Float] :retry_base_delay (0.3)
+    #     The base delay in seconds used by the default backoff function.
+    #
+    #   @option options [Symbol] :retry_jitter (:none)
+    #     A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
+    #
+    #     @see https://www.awsarchitectureblog.com/2015/03/backoff.html
+    #
+    #   @option options [Integer] :retry_limit (3)
+    #     The maximum number of times to retry failed requests.  Only
+    #     ~ 500 level server errors and certain ~ 400 level client errors
+    #     are retried.  Generally, these are throttling errors, data
+    #     checksum errors, networking errors, timeout errors and auth
+    #     errors from expired credentials.
+    #
+    #   @option options [Integer] :retry_max_delay (0)
+    #     The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
+    #
+    #   @option options [String] :secret_access_key
+    #
+    #   @option options [String] :session_token
+    #
+    #   @option options [Boolean] :stub_responses (false)
+    #     Causes the client to return stubbed responses. By default
+    #     fake responses are generated and returned. You can specify
+    #     the response data to return or errors to raise by calling
+    #     {ClientStubs#stub_responses}. See {ClientStubs} for more information.
+    #
+    #     ** Please note ** When response stubbing is enabled, no HTTP
+    #     requests are made, and retries are disabled.
+    #
+    #   @option options [Boolean] :validate_params (true)
+    #     When `true`, request parameters are validated before
+    #     sending the request.
+    #
+    def initialize(*args)
+      super
+    end
+
+    # @!group API Operations
+
+    # Create a new configuration set. After you create the configuration
+    # set, you can add one or more event destinations to it.
+    #
+    # @option params [String] :configuration_set_name
+    #   The name that you want to give the configuration set.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_configuration_set({
+    #     configuration_set_name: "WordCharactersWithDelimiters",
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CreateConfigurationSet AWS API Documentation
+    #
+    # @overload create_configuration_set(params = {})
+    # @param [Hash] params ({})
+    def create_configuration_set(params = {}, options = {})
+      req = build_request(:create_configuration_set, params)
+      req.send_request(options)
+    end
+
+    # Create a new event destination in a configuration set.
+    #
+    # @option params [required, String] :configuration_set_name
+    #
+    # @option params [Types::EventDestinationDefinition] :event_destination
+    #   An object that defines a single event destination.
+    #
+    # @option params [String] :event_destination_name
+    #   A name that identifies the event destination.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_configuration_set_event_destination({
+    #     configuration_set_name: "__string", # required
+    #     event_destination: {
+    #       cloud_watch_logs_destination: {
+    #         iam_role_arn: "String",
+    #         log_group_arn: "String",
+    #       },
+    #       enabled: false,
+    #       kinesis_firehose_destination: {
+    #         delivery_stream_arn: "String",
+    #         iam_role_arn: "String",
+    #       },
+    #       matching_event_types: ["INITIATED_CALL"], # accepts INITIATED_CALL, RINGING, ANSWERED, COMPLETED_CALL, BUSY, FAILED, NO_ANSWER
+    #     },
+    #     event_destination_name: "NonEmptyString",
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CreateConfigurationSetEventDestination AWS API Documentation
+    #
+    # @overload create_configuration_set_event_destination(params = {})
+    # @param [Hash] params ({})
+    def create_configuration_set_event_destination(params = {}, options = {})
+      req = build_request(:create_configuration_set_event_destination, params)
+      req.send_request(options)
+    end
+
+    # Deletes an existing configuration set.
+    #
+    # @option params [required, String] :configuration_set_name
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_configuration_set({
+    #     configuration_set_name: "__string", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/DeleteConfigurationSet AWS API Documentation
+    #
+    # @overload delete_configuration_set(params = {})
+    # @param [Hash] params ({})
+    def delete_configuration_set(params = {}, options = {})
+      req = build_request(:delete_configuration_set, params)
+      req.send_request(options)
+    end
+
+    # Deletes an event destination in a configuration set.
+    #
+    # @option params [required, String] :configuration_set_name
+    #
+    # @option params [required, String] :event_destination_name
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_configuration_set_event_destination({
+    #     configuration_set_name: "__string", # required
+    #     event_destination_name: "__string", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/DeleteConfigurationSetEventDestination AWS API Documentation
+    #
+    # @overload delete_configuration_set_event_destination(params = {})
+    # @param [Hash] params ({})
+    def delete_configuration_set_event_destination(params = {}, options = {})
+      req = build_request(:delete_configuration_set_event_destination, params)
+      req.send_request(options)
+    end
+
+    # Obtain information about an event destination, including the types of
+    # events it reports, the Amazon Resource Name (ARN) of the destination,
+    # and the name of the event destination.
+    #
+    # @option params [required, String] :configuration_set_name
+    #
+    # @return [Types::GetConfigurationSetEventDestinationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetConfigurationSetEventDestinationsResponse#event_destinations #event_destinations} => Array&lt;Types::EventDestination&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_configuration_set_event_destinations({
+    #     configuration_set_name: "__string", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.event_destinations #=> Array
+    #   resp.event_destinations[0].cloud_watch_logs_destination.iam_role_arn #=> String
+    #   resp.event_destinations[0].cloud_watch_logs_destination.log_group_arn #=> String
+    #   resp.event_destinations[0].enabled #=> Boolean
+    #   resp.event_destinations[0].kinesis_firehose_destination.delivery_stream_arn #=> String
+    #   resp.event_destinations[0].kinesis_firehose_destination.iam_role_arn #=> String
+    #   resp.event_destinations[0].matching_event_types #=> Array
+    #   resp.event_destinations[0].matching_event_types[0] #=> String, one of "INITIATED_CALL", "RINGING", "ANSWERED", "COMPLETED_CALL", "BUSY", "FAILED", "NO_ANSWER"
+    #   resp.event_destinations[0].name #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/GetConfigurationSetEventDestinations AWS API Documentation
+    #
+    # @overload get_configuration_set_event_destinations(params = {})
+    # @param [Hash] params ({})
+    def get_configuration_set_event_destinations(params = {}, options = {})
+      req = build_request(:get_configuration_set_event_destinations, params)
+      req.send_request(options)
+    end
+
+    # Create a new voice message and send it to a recipient's phone number.
+    #
+    # @option params [String] :caller_id
+    #   The phone number that appears on recipients' devices when they
+    #   receive the message.
+    #
+    # @option params [String] :configuration_set_name
+    #   The name of the configuration set that you want to use to send the
+    #   message.
+    #
+    # @option params [Types::VoiceMessageContent] :content
+    #   An object that contains a voice message and information about the
+    #   recipient that you want to send it to.
+    #
+    # @option params [String] :destination_phone_number
+    #   The phone number that you want to send the voice message to.
+    #
+    # @option params [String] :origination_phone_number
+    #   The phone number that Amazon Pinpoint should use to send the voice
+    #   message. This isn't necessarily the phone number that appears on
+    #   recipients' devices when they receive the message, because you can
+    #   specify a CallerId parameter in the request.
+    #
+    # @return [Types::SendVoiceMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::SendVoiceMessageResponse#message_id #message_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.send_voice_message({
+    #     caller_id: "String",
+    #     configuration_set_name: "WordCharactersWithDelimiters",
+    #     content: {
+    #       call_instructions_message: {
+    #         text: "NonEmptyString",
+    #       },
+    #       plain_text_message: {
+    #         language_code: "String",
+    #         text: "NonEmptyString",
+    #         voice_id: "String",
+    #       },
+    #       ssml_message: {
+    #         language_code: "String",
+    #         text: "NonEmptyString",
+    #         voice_id: "String",
+    #       },
+    #     },
+    #     destination_phone_number: "NonEmptyString",
+    #     origination_phone_number: "NonEmptyString",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.message_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/SendVoiceMessage AWS API Documentation
+    #
+    # @overload send_voice_message(params = {})
+    # @param [Hash] params ({})
+    def send_voice_message(params = {}, options = {})
+      req = build_request(:send_voice_message, params)
+      req.send_request(options)
+    end
+
+    # Update an event destination in a configuration set. An event
+    # destination is a location that you publish information about your
+    # voice calls to. For example, you can log an event to an Amazon
+    # CloudWatch destination when a call fails.
+    #
+    # @option params [required, String] :configuration_set_name
+    #
+    # @option params [Types::EventDestinationDefinition] :event_destination
+    #   An object that defines a single event destination.
+    #
+    # @option params [required, String] :event_destination_name
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_configuration_set_event_destination({
+    #     configuration_set_name: "__string", # required
+    #     event_destination: {
+    #       cloud_watch_logs_destination: {
+    #         iam_role_arn: "String",
+    #         log_group_arn: "String",
+    #       },
+    #       enabled: false,
+    #       kinesis_firehose_destination: {
+    #         delivery_stream_arn: "String",
+    #         iam_role_arn: "String",
+    #       },
+    #       matching_event_types: ["INITIATED_CALL"], # accepts INITIATED_CALL, RINGING, ANSWERED, COMPLETED_CALL, BUSY, FAILED, NO_ANSWER
+    #     },
+    #     event_destination_name: "__string", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/UpdateConfigurationSetEventDestination AWS API Documentation
+    #
+    # @overload update_configuration_set_event_destination(params = {})
+    # @param [Hash] params ({})
+    def update_configuration_set_event_destination(params = {}, options = {})
+      req = build_request(:update_configuration_set_event_destination, params)
+      req.send_request(options)
+    end
+
+    # @!endgroup
+
+    # @param params ({})
+    # @api private
+    def build_request(operation_name, params = {})
+      handlers = @handlers.for(operation_name)
+      context = Seahorse::Client::RequestContext.new(
+        operation_name: operation_name,
+        operation: config.api.operation(operation_name),
+        client: self,
+        params: params,
+        config: config)
+      context[:gem_name] = 'aws-sdk-pinpointsmsvoice'
+      context[:gem_version] = '1.0.0'
+      Seahorse::Client::Request.new(handlers, context)
+    end
+
+    # @api private
+    # @deprecated
+    def waiter_names
+      []
+    end
+
+    class << self
+
+      # @api private
+      attr_reader :identifier
+
+      # @api private
+      def errors_module
+        Errors
+      end
+
+    end
+  end
+end