twilio-ruby 5.37.0 → 5.39.3

data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb

@@ -88,8 +88,7 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of FeedbackInstance records from the API.
-              # Request is executed immediately.
+              # Create the FeedbackInstance
               # @param [String] quality_score The call quality expressed as an integer from `1`
               #   to `5` where `1` represents very poor call quality and `5` represents a perfect
               #   call.
@@ -97,18 +96,14 @@ module Twilio
               #   the call. Issues can be: `imperfect-audio`, `dropped-call`,
               #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
               #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
-              # @return [FeedbackInstance] Newly created FeedbackInstance
+              # @return [FeedbackInstance] Created FeedbackInstance
               def create(quality_score: nil, issue: :unset)
                 data = Twilio::Values.of({
                     'QualityScore' => quality_score,
                     'Issue' => Twilio.serialize_list(issue) { |e| e },
                 })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 FeedbackInstance.new(
                     @version,
@@ -119,16 +114,10 @@ module Twilio
               end
 
               ##
-              # Fetch a FeedbackInstance
+              # Fetch the FeedbackInstance
               # @return [FeedbackInstance] Fetched FeedbackInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 FeedbackInstance.new(
                     @version,
@@ -154,11 +143,7 @@ module Twilio
                     'Issue' => Twilio.serialize_list(issue) { |e| e },
                 })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 FeedbackInstance.new(
                     @version,
@@ -260,8 +245,7 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of FeedbackInstance records from the API.
-              # Request is executed immediately.
+              # Create the FeedbackInstance
               # @param [String] quality_score The call quality expressed as an integer from `1`
               #   to `5` where `1` represents very poor call quality and `5` represents a perfect
               #   call.
@@ -269,13 +253,13 @@ module Twilio
               #   the call. Issues can be: `imperfect-audio`, `dropped-call`,
               #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
               #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
-              # @return [FeedbackInstance] Newly created FeedbackInstance
+              # @return [FeedbackInstance] Created FeedbackInstance
               def create(quality_score: nil, issue: :unset)
                 context.create(quality_score: quality_score, issue: issue, )
               end
 
               ##
-              # Fetch a FeedbackInstance
+              # Fetch the FeedbackInstance
               # @return [FeedbackInstance] Fetched FeedbackInstance
               def fetch
                 context.fetch

data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb

@@ -29,8 +29,7 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of FeedbackSummaryInstance records from the API.
-              # Request is executed immediately.
+              # Create the FeedbackSummaryInstance
               # @param [Date] start_date Only include feedback given on or after this date.
               #   Format is `YYYY-MM-DD` and specified in UTC.
               # @param [Date] end_date Only include feedback given on or before this date.
@@ -42,7 +41,7 @@ module Twilio
               #   summary is complete.
               # @param [String] status_callback_method The HTTP method (`GET` or `POST`) we use
               #   to make the request to the `StatusCallback` URL.
-              # @return [FeedbackSummaryInstance] Newly created FeedbackSummaryInstance
+              # @return [FeedbackSummaryInstance] Created FeedbackSummaryInstance
               def create(start_date: nil, end_date: nil, include_subaccounts: :unset, status_callback: :unset, status_callback_method: :unset)
                 data = Twilio::Values.of({
                     'StartDate' => Twilio.serialize_iso8601_date(start_date),
@@ -52,11 +51,7 @@ module Twilio
                     'StatusCallbackMethod' => status_callback_method,
                 })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 FeedbackSummaryInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
@@ -116,16 +111,10 @@ module Twilio
               end
 
               ##
-              # Fetch a FeedbackSummaryInstance
+              # Fetch the FeedbackSummaryInstance
               # @return [FeedbackSummaryInstance] Fetched FeedbackSummaryInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 FeedbackSummaryInstance.new(
                     @version,
@@ -136,10 +125,10 @@ module Twilio
               end
 
               ##
-              # Deletes the FeedbackSummaryInstance
+              # Delete the FeedbackSummaryInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -290,14 +279,14 @@ module Twilio
               end
 
               ##
-              # Fetch a FeedbackSummaryInstance
+              # Fetch the FeedbackSummaryInstance
               # @return [FeedbackSummaryInstance] Fetched FeedbackSummaryInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the FeedbackSummaryInstance
+              # Delete the FeedbackSummaryInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete

data/lib/twilio-ruby/rest/api/v2010/account/call/notification.rb

@@ -127,11 +127,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 NotificationPage.new(@version, response, @solution)
               end
 
@@ -211,16 +209,10 @@ module Twilio
               end
 
               ##
-              # Fetch a NotificationInstance
+              # Fetch the NotificationInstance
               # @return [NotificationInstance] Fetched NotificationInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 NotificationInstance.new(
                     @version,
@@ -408,7 +400,7 @@ module Twilio
               end
 
               ##
-              # Fetch a NotificationInstance
+              # Fetch the NotificationInstance
               # @return [NotificationInstance] Fetched NotificationInstance
               def fetch
                 context.fetch

data/lib/twilio-ruby/rest/api/v2010/account/call/payment.rb

@@ -35,53 +35,61 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of PaymentInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] idempotency_key A unique token for each payment session that
-              #   should be provided to maintain idempotency of the session.
-              # @param [String] status_callback The URL we should call using the
-              #   `status_callback` to send status information of payment session.
-              # @param [payment.BankAccountType] bank_account_type If Payment source is ACH,
-              #   type of bank account. Can be: `consumer-checking`, `consumer-savings`,
+              # Create the PaymentInstance
+              # @param [String] idempotency_key A unique token that will be used to ensure that
+              #   multiple API calls with the same information do not result in multiple
+              #   transactions. This should be a unique string value per API call and can be a
+              #   randomly generated.
+              # @param [String] status_callback Provide an absolute or relative URL to receive
+              #   status updates regarding your Pay session. Read more about the [expected
+              #   StatusCallback
+              #   values](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback)
+              # @param [payment.BankAccountType] bank_account_type Type of bank account if
+              #   payment source is ACH. One of `consumer-checking`, `consumer-savings`, or
               #   `commercial-checking`. The default value is `consumer-checking`.
-              # @param [String] charge_amount If this field is present and greater than `0.0`
-              #   payment source will be charged. Otherwise payment source will be tokenized.
-              # @param [String] currency Currency `charge_amount` is in. It's format should be
-              #   as specified in [ISO
+              # @param [String] charge_amount A positive decimal value less than 1,000,000 to
+              #   charge against the credit card or bank account. Default currency can be
+              #   overwritten with `currency` field. Leave blank or set to 0 to tokenize.
+              # @param [String] currency The currency of the `charge_amount`, formatted as [ISO
               #   4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format. The
-              #   default value is `USD`.
-              # @param [String] description Decription of the charge.
-              # @param [String] input Kind of medium customer would enter payment source
-              #   information in. Currently only 'DTMF' is supported, which means customer would
-              #   use keypad of their phone to enter card number etc.
-              # @param [String] min_postal_code_length If postal code is expected, minimum
-              #   length of the postal code. When user enters postal code, this value will be used
-              #   to validate.
-              # @param [Hash] parameter Additonal data to be sent over to payment provider. It
-              #   has to be a JSON string with only one level object. This parameter can be used
-              #   to send information such as customer name, phone number etc. Refer to specific
-              #   payment provider's documentation in Twilio console for supported
-              #   names/values/format.
-              # @param [String] payment_connector Payment connector that you would like Twilio
-              #   to use for processing payments. The default value is `Default`, which means you
-              #   need to have at least one payment connector configured in Twilio with name
-              #   'Default'. If not you must provide connector configuration name here.
-              # @param [payment.PaymentMethod] payment_method Payment source type. Can be:
-              #   `credit-card`, `ach-debit`. The default value is `credit-card`.
-              # @param [Boolean] postal_code Whether to expect postal code during payment source
-              #   data gathering. Can be: `true`, `false`. The default value is `true`.
-              # @param [Boolean] security_code Whether to expect security code during payment
-              #   source data gathering. Can be: `true`, `false`. The default value is `true`.
-              # @param [String] timeout The number of seconds that we should allow customer to
-              #   enter payment information. Can be an integer between `5` and `600`, inclusive.
-              #   The default value is `5`.
-              # @param [payment.TokenType] token_type If tokenization of payment source is
-              #   desired, this represents type of token. Can be: `one-time`, `reusable`. The
-              #   default value is `reusable`.
-              # @param [String] valid_card_types List of card types accepted with each card
-              #   types separated by space. Can be:
-              #   `visa`,`nmastercard`,`amex`,`maestro`,`discover`,`optima`,`jcb`,`diners-club`,`enroute`. The default value is `visa mastercard amex`.
-              # @return [PaymentInstance] Newly created PaymentInstance
+              #   default value is `USD` and all values allowed from the <Pay> Connector are
+              #   accepted.
+              # @param [String] description The description can be used to provide more details
+              #   regarding the transaction. This information is submitted along with the payment
+              #   details to the Payment Connector which are then posted on the transactions.
+              # @param [String] input A list of inputs that should be accepted. Currently only
+              #   `dtmf` is supported. All digits captured during a pay session are redacted from
+              #   the logs.
+              # @param [String] min_postal_code_length A positive integer that is used to
+              #   validate the length of the `PostalCode` inputted by the user. User must enter
+              #   this many digits.
+              # @param [Hash] parameter A single level JSON string that is required when
+              #   accepting certain information specific only to ACH payments. The information
+              #   that has to be included here depends on the <Pay> Connector. [Read
+              #   more](https://www.twilio.com/console/voice/pay-connectors).
+              # @param [String] payment_connector This is the unique name corresponding to the
+              #   Payment Gateway Connector installed in the Twilio Add-ons. Learn more about
+              #   [<Pay> Connectors](https://www.twilio.com/console/voice/pay-connectors). The
+              #   default value is `Default`.
+              # @param [payment.PaymentMethod] payment_method Type of payment being captured.
+              #   One of `credit-card` or `ach-debit`. The default value is `credit-card`.
+              # @param [Boolean] postal_code Indicates whether the credit card postal code (zip
+              #   code) is a required piece of payment information that must be provided by the
+              #   caller. The default is `true`.
+              # @param [Boolean] security_code Indicates whether the credit card security code
+              #   is a required piece of payment information that must be provided by the caller.
+              #   The default is `true`.
+              # @param [String] timeout The number of seconds that <Pay> should wait for the
+              #   caller to press a digit between each subsequent digit, after the first one,
+              #   before moving on to validate the digits captured. The default is `5`, maximum is
+              #   `600`.
+              # @param [payment.TokenType] token_type Indicates whether the payment method
+              #   should be tokenized as a `one-time` or `reusable` token. The default value is
+              #   `reusable`. Do not enter a charge amount when tokenizing. If a charge amount is
+              #   entered, the payment method will be charged and not tokenized.
+              # @param [String] valid_card_types Credit card types separated by space that Pay
+              #   should accept. The default value is `visa mastercard amex`
+              # @return [PaymentInstance] Created PaymentInstance
               def create(idempotency_key: nil, status_callback: nil, bank_account_type: :unset, charge_amount: :unset, currency: :unset, description: :unset, input: :unset, min_postal_code_length: :unset, parameter: :unset, payment_connector: :unset, payment_method: :unset, postal_code: :unset, security_code: :unset, timeout: :unset, token_type: :unset, valid_card_types: :unset)
                 data = Twilio::Values.of({
                     'IdempotencyKey' => idempotency_key,
@@ -102,11 +110,7 @@ module Twilio
                     'ValidCardTypes' => valid_card_types,
                 })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 PaymentInstance.new(
                     @version,
@@ -182,15 +186,20 @@ module Twilio
 
               ##
               # Update the PaymentInstance
-              # @param [String] idempotency_key A unique token for each payment session that
-              #   should be provided to maintain idempotency of the session.
-              # @param [String] status_callback The URL we should call using the
-              #   `status_callback` to send status information of payment session.
-              # @param [payment.Capture] capture Specific payment source information to expect.
-              #   Can be:
-              #   `payment-card-number`,`expiration-date`,`security-code`,`postal-code`,`bank-routing-number`,`bank-account-number`.
-              # @param [payment.Status] status Instruction to complete or cancel the
-              #   transaction. Can be: `complete`, `cancel.`
+              # @param [String] idempotency_key A unique token that will be used to ensure that
+              #   multiple API calls with the same information do not result in multiple
+              #   transactions. This should be a unique string value per API call and can be a
+              #   randomly generated.
+              # @param [String] status_callback Provide an absolute or relative URL to receive
+              #   status updates regarding your Pay session. Read more about the
+              #   [Update](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-update) and [Complete/Cancel](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete) POST requests.
+              # @param [payment.Capture] capture The piece of payment information that you wish
+              #   the caller to enter. Must be one of `payment-card-number`, `expiration-date`,
+              #   `security-code`, `postal-code`, `bank-routing-number`, or `bank-account-number`.
+              # @param [payment.Status] status Indicates whether the current payment session
+              #   should be cancelled or completed. When `cancel` the payment session is
+              #   cancelled. When `complete`, Twilio sends the payment information to the selected
+              #   <Pay> connector for processing.
               # @return [PaymentInstance] Updated PaymentInstance
               def update(idempotency_key: nil, status_callback: nil, capture: :unset, status: :unset)
                 data = Twilio::Values.of({
@@ -200,11 +209,7 @@ module Twilio
                     'Status' => status,
                 })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 PaymentInstance.new(
                     @version,
@@ -318,15 +323,20 @@ module Twilio
 
               ##
               # Update the PaymentInstance
-              # @param [String] idempotency_key A unique token for each payment session that
-              #   should be provided to maintain idempotency of the session.
-              # @param [String] status_callback The URL we should call using the
-              #   `status_callback` to send status information of payment session.
-              # @param [payment.Capture] capture Specific payment source information to expect.
-              #   Can be:
-              #   `payment-card-number`,`expiration-date`,`security-code`,`postal-code`,`bank-routing-number`,`bank-account-number`.
-              # @param [payment.Status] status Instruction to complete or cancel the
-              #   transaction. Can be: `complete`, `cancel.`
+              # @param [String] idempotency_key A unique token that will be used to ensure that
+              #   multiple API calls with the same information do not result in multiple
+              #   transactions. This should be a unique string value per API call and can be a
+              #   randomly generated.
+              # @param [String] status_callback Provide an absolute or relative URL to receive
+              #   status updates regarding your Pay session. Read more about the
+              #   [Update](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-update) and [Complete/Cancel](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete) POST requests.
+              # @param [payment.Capture] capture The piece of payment information that you wish
+              #   the caller to enter. Must be one of `payment-card-number`, `expiration-date`,
+              #   `security-code`, `postal-code`, `bank-routing-number`, or `bank-account-number`.
+              # @param [payment.Status] status Indicates whether the current payment session
+              #   should be cancelled or completed. When `cancel` the payment session is
+              #   cancelled. When `complete`, Twilio sends the payment information to the selected
+              #   <Pay> connector for processing.
               # @return [PaymentInstance] Updated PaymentInstance
               def update(idempotency_key: nil, status_callback: nil, capture: :unset, status: :unset)
                 context.update(

data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb

@@ -32,8 +32,7 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of RecordingInstance records from the API.
-              # Request is executed immediately.
+              # Create the RecordingInstance
               # @param [String] recording_status_callback_event The recording status events on
               #   which we should call the `recording_status_callback` URL. Can be: `in-progress`,
               #   `completed` and `absent` and the default is `completed`. Separate multiple event
@@ -54,7 +53,7 @@ module Twilio
               #   Can be: `mono` or `dual` and the default is `mono`. `mono` records all parties
               #   of the call into one channel. `dual` records each party of a 2-party call into
               #   separate channels.
-              # @return [RecordingInstance] Newly created RecordingInstance
+              # @return [RecordingInstance] Created RecordingInstance
               def create(recording_status_callback_event: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, trim: :unset, recording_channels: :unset)
                 data = Twilio::Values.of({
                     'RecordingStatusCallbackEvent' => Twilio.serialize_list(recording_status_callback_event) { |e| e },
@@ -64,11 +63,7 @@ module Twilio
                     'RecordingChannels' => recording_channels,
                 })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 RecordingInstance.new(
                     @version,
@@ -162,11 +157,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 RecordingPage.new(@version, response, @solution)
               end
 
@@ -258,11 +251,7 @@ module Twilio
               def update(status: nil, pause_behavior: :unset)
                 data = Twilio::Values.of({'Status' => status, 'PauseBehavior' => pause_behavior, })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 RecordingInstance.new(
                     @version,
@@ -274,16 +263,10 @@ module Twilio
               end
 
               ##
-              # Fetch a RecordingInstance
+              # Fetch the RecordingInstance
               # @return [RecordingInstance] Fetched RecordingInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 RecordingInstance.new(
                     @version,
@@ -295,10 +278,10 @@ module Twilio
               end
 
               ##
-              # Deletes the RecordingInstance
+              # Delete the RecordingInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -492,14 +475,14 @@ module Twilio
               end
 
               ##
-              # Fetch a RecordingInstance
+              # Fetch the RecordingInstance
               # @return [RecordingInstance] Fetched RecordingInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the RecordingInstance
+              # Delete the RecordingInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete