twilio-ruby 5.31.2 → 5.31.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97e9af8abf406d407ed5b2ac3335d5920a14b3f15c57959ccb08f19d767380bd
-  data.tar.gz: 45777c544fddd89d53041a640e43d3eef9efb62d3b14a89955c42dc031a113ca
+  metadata.gz: 236e413c122b4f2876aad35e70b6980b58cfe80266dba55d42c87b842ab08136
+  data.tar.gz: bde3f07e1175e3a15457b866af0554560efd3ab368cd02d469e0422318465284
 SHA512:
-  metadata.gz: d1166fef8722efcdf85db0594e8ffc1b94612d3ac64f78c0caf955e55a98f7c73cd437a731bab380daff56ac297a0f1e4badc68b42214dab5c4c716105eaa14d
-  data.tar.gz: 0a135ab533b362d551dc6832925fbcf8e295165d020a08c9108dd35c85ae931750fe8463d67135b24b316a09efdb15fbabc3f94dd6f352d7403ceac6907e6c30
+  metadata.gz: c16f6ab3796ceecae3569e8490ec437d27561613fae35c338e59661c5bf4b0d84ca2462c7df336c84bdc27ba6d9ea260e5ddf859e23e571e07b4b7563e3330d8
+  data.tar.gz: 2f7f7ecdec0b96df316c9daaacc7740344e198cb8384bf63dcc8a368e633212ce6c2224081cbe77a5fdd3e222a4651ce8da8e9ab87b72acdfad172722742e54f

data/.travis.yml

@@ -5,6 +5,7 @@ bundler_args: --without development
 
 rvm:
   - ruby-head
+  - 2.7
   - 2.6
   - 2.5
   - 2.4

data/CHANGES.md

@@ -1,6 +1,37 @@
 twilio-ruby changelog
 =====================
 
+[2020-01-22] Version 5.31.3
+---------------------------
+**Library - Docs**
+- [PR #492](https://github.com/twilio/twilio-ruby/pull/492): baseline all the templated markdown docs. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+**Library - Chore**
+- [PR #490](https://github.com/twilio/twilio-ruby/pull/490): add support for Ruby 2.7. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+**Api**
+- Add payments public APIs
+- Add optional parameter `byoc` to call create request.
+
+**Flex**
+- Updating a Flex Flow `creation_on_message` parameter documentation
+
+**Preview**
+-
+- Removed Verify v2 from preview in favor of its own namespace as GA **(breaking change)**
+
+**Studio**
+- Flow definition type update from string to object
+
+**Verify**
+- Add `AppHash` parameter when creating a Verification.
+- Add `DoNotShareWarningEnabled` parameter to the Service resource.
+
+**Twiml**
+- Add `track` attribute to siprec noun.
+- Add attribute `byoc` to `<Number>`
+
+
 [2020-01-08] Version 5.31.2
 ---------------------------
 **Library - Chore**

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at open-source@twilio.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

data/ISSUE_TEMPLATE.md

@@ -1,9 +1,14 @@
-*Note: These issues are for bugs and feature requests for the helper libraries.
-If you need help or support, please email help@twilio.com and one of our experts
-will assist you!*
+<!--
+If this is a feature request, make sure you search Issues for an existing request before creating a new one!
+-->
 
+### Issue Summary
+A summary of the issue and the environment in which it occurs. If suitable, include the steps required to reproduce the bug. Please feel free to include screenshots, screencasts, or code examples.
 
-**Version:**
+### Steps to Reproduce
+1. This is the first step
+2. This is the second step
+3. Further steps, etc.
 
 ### Code Snippet
 ```ruby
@@ -12,15 +17,10 @@ will assist you!*
 
 ### Exception/Log
 ```
-<place exception/log here>
+# paste exception/log here
 ```
 
-### Steps to Reproduce
-1.
-2.
-3.
-
+### Technical details:
+* twilio-ruby version:
+* ruby version:
 
-### Feature Request
-_If this is a feature request, make sure you search Issues for an existing
-request before creating a new one!_

data/LICENSE.md

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

data/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,31 @@
+<!--
+We appreciate the effort for this pull request but before that please make sure you read the contribution guidelines, then fill out the blanks below.
+
+Please format the PR title appropriately based on the type of change:
+  <type>[!]: <description>
+Where <type> is one of: docs, chore, feat, fix, test.
+Add a '!' after the type for breaking changes (e.g. feat!: new breaking feature).
+
+**All third-party contributors acknowledge that any contributions they provide will be made under the same open-source license that the open-source project is provided under.**
+
+Please enter each Issue number you are resolving in your PR after one of the following words [Fixes, Closes, Resolves]. This will auto-link these issues and close them when this PR is merged!
+e.g.
+Fixes #1
+Closes #2
+-->
+
+# Fixes #
+
+A short description of what this PR does.
+
+### Checklist
+- [ ] I acknowledge that all my contributions will be made under the project's license
+- [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
+- [ ] I have read the [Contribution Guidelines](CONTRIBUTING.md) and my PR follows them
+- [ ] I have titled the PR appropriately
+- [ ] I have updated my branch with the master branch
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] I have added necessary documentation about the functionality in the appropriate .md file
+- [ ] I have added inline documentation to the code I modified
+
+If you have questions, please file a [support ticket](https://twilio.com/help/contact), or create a GitHub Issue in this repository.

data/README.md

@@ -21,6 +21,7 @@ This library supports the following Ruby implementations:
 * Ruby 2.4
 * Ruby 2.5
 * Ruby 2.6
+* Ruby 2.7
 
 ### Migrating from 4.x
 
@@ -31,13 +32,13 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.31.2'
+gem 'twilio-ruby', '~> 5.31.3'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.31.2
+gem install twilio-ruby -v 5.31.3
 ```
 
 To build and install the development branch yourself from the latest source:

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

@@ -127,6 +127,9 @@ module Twilio
             # @param [String] machine_detection_silence_timeout The number of milliseconds of
             #   initial silence after which an `unknown` AnsweredBy result will be returned.
             #   Possible Values: 2000-10000. Default: 5000.
+            # @param [String] byoc The SID of a BYOC (Bring Your Own Carrier) trunk to route
+            #   this call with. Note that `byoc` is only meaningful when `to` is a phone number;
+            #   it will otherwise be ignored. (Beta)
             # @param [String] url The absolute URL that returns the TwiML instructions for the
             #   call. We will call this URL using the `method` when the call connects. For more
             #   information, see the [Url
@@ -138,7 +141,7 @@ module Twilio
             # @param [String] application_sid The SID of the Application resource that will
             #   handle the call, if the call will be handled by an application.
             # @return [CallInstance] Newly created CallInstance
-            def create(to: nil, from: nil, method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_event: :unset, status_callback_method: :unset, send_digits: :unset, timeout: :unset, record: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, machine_detection: :unset, machine_detection_timeout: :unset, recording_status_callback_event: :unset, trim: :unset, caller_id: :unset, machine_detection_speech_threshold: :unset, machine_detection_speech_end_threshold: :unset, machine_detection_silence_timeout: :unset, url: :unset, twiml: :unset, application_sid: :unset)
+            def create(to: nil, from: nil, method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_event: :unset, status_callback_method: :unset, send_digits: :unset, timeout: :unset, record: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, machine_detection: :unset, machine_detection_timeout: :unset, recording_status_callback_event: :unset, trim: :unset, caller_id: :unset, machine_detection_speech_threshold: :unset, machine_detection_speech_end_threshold: :unset, machine_detection_silence_timeout: :unset, byoc: :unset, url: :unset, twiml: :unset, application_sid: :unset)
               data = Twilio::Values.of({
                   'To' => to,
                   'From' => from,
@@ -167,6 +170,7 @@ module Twilio
                   'MachineDetectionSpeechThreshold' => machine_detection_speech_threshold,
                   'MachineDetectionSpeechEndThreshold' => machine_detection_speech_end_threshold,
                   'MachineDetectionSilenceTimeout' => machine_detection_silence_timeout,
+                  'Byoc' => byoc,
               })
 
               payload = @version.create(
@@ -412,6 +416,7 @@ module Twilio
               @recordings = nil
               @notifications = nil
               @feedback = nil
+              @payments = nil
             end
 
             ##
@@ -541,6 +546,28 @@ module Twilio
               FeedbackContext.new(@version, @solution[:account_sid], @solution[:sid], )
             end
 
+            ##
+            # Access the payments
+            # @return [PaymentList]
+            # @return [PaymentContext] if sid was passed.
+            def payments(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return PaymentContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
+              end
+
+              unless @payments
+                @payments = PaymentList.new(
+                    @version,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:sid],
+                )
+              end
+
+              @payments
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -844,6 +871,13 @@ module Twilio
               context.feedback
             end
 
+            ##
+            # Access the payments
+            # @return [payments] payments
+            def payments
+              context.payments
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

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

@@ -231,13 +231,6 @@ module Twilio
                 )
               end
 
-              ##
-              # Deletes the NotificationInstance
-              # @return [Boolean] true if delete succeeds, false otherwise
-              def delete
-                @version.delete('delete', @uri)
-              end
-
               ##
               # Provide a user friendly representation
               def to_s
@@ -421,13 +414,6 @@ module Twilio
                 context.fetch
               end
 
-              ##
-              # Deletes the NotificationInstance
-              # @return [Boolean] true if delete succeeds, false otherwise
-              def delete
-                context.delete
-              end
-
               ##
               # Provide a user friendly representation
               def to_s

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

@@ -0,0 +1,359 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Api < Domain
+      class V2010 < Version
+        class AccountContext < InstanceContext
+          class CallContext < InstanceContext
+            ##
+            # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+            class PaymentList < ListResource
+              ##
+              # Initialize the PaymentList
+              # @param [Version] version Version that contains the resource
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that created the Payments
+              #   resource.
+              # @param [String] call_sid The SID of the
+              #   [Call](https://www.twilio.com/docs/voice/api/call-resource) the Payments
+              #   resource is associated with. This will refer to the call sid that is producing
+              #   the payment card (credit/ACH) information thru DTMF.
+              # @return [PaymentList] PaymentList
+              def initialize(version, account_sid: nil, call_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {account_sid: account_sid, call_sid: call_sid}
+                @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Payments.json"
+              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`,
+              #   `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
+              #   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
+              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,
+                    'StatusCallback' => status_callback,
+                    'BankAccountType' => bank_account_type,
+                    'ChargeAmount' => charge_amount,
+                    'Currency' => currency,
+                    'Description' => description,
+                    'Input' => input,
+                    'MinPostalCodeLength' => min_postal_code_length,
+                    'Parameter' => Twilio.serialize_object(parameter),
+                    'PaymentConnector' => payment_connector,
+                    'PaymentMethod' => payment_method,
+                    'PostalCode' => postal_code,
+                    'SecurityCode' => security_code,
+                    'Timeout' => timeout,
+                    'TokenType' => token_type,
+                    'ValidCardTypes' => valid_card_types,
+                })
+
+                payload = @version.create(
+                    'POST',
+                    @uri,
+                    data: data
+                )
+
+                PaymentInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Api.V2010.PaymentList>'
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+            class PaymentPage < Page
+              ##
+              # Initialize the PaymentPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [PaymentPage] PaymentPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of PaymentInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [PaymentInstance] PaymentInstance
+              def get_instance(payload)
+                PaymentInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Api.V2010.PaymentPage>'
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+            class PaymentContext < InstanceContext
+              ##
+              # Initialize the PaymentContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that will update the
+              #   resource.
+              # @param [String] call_sid The SID of the call that will update the resource. This
+              #   should be the same call sid that was used to create payments resource.
+              # @param [String] sid The SID of Payments session that needs to be updated.
+              # @return [PaymentContext] PaymentContext
+              def initialize(version, account_sid, call_sid, sid)
+                super(version)
+
+                # Path Solution
+                @solution = {account_sid: account_sid, call_sid: call_sid, sid: sid, }
+                @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Payments/#{@solution[:sid]}.json"
+              end
+
+              ##
+              # 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.`
+              # @return [PaymentInstance] Updated PaymentInstance
+              def update(idempotency_key: nil, status_callback: nil, capture: :unset, status: :unset)
+                data = Twilio::Values.of({
+                    'IdempotencyKey' => idempotency_key,
+                    'StatusCallback' => status_callback,
+                    'Capture' => capture,
+                    'Status' => status,
+                })
+
+                payload = @version.update(
+                    'POST',
+                    @uri,
+                    data: data,
+                )
+
+                PaymentInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                    sid: @solution[:sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.PaymentContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.PaymentContext #{context}>"
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+            class PaymentInstance < InstanceResource
+              ##
+              # Initialize the PaymentInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that created the Payments
+              #   resource.
+              # @param [String] call_sid The SID of the
+              #   [Call](https://www.twilio.com/docs/voice/api/call-resource) the Payments
+              #   resource is associated with. This will refer to the call sid that is producing
+              #   the payment card (credit/ACH) information thru DTMF.
+              # @param [String] sid The SID of Payments session that needs to be updated.
+              # @return [PaymentInstance] PaymentInstance
+              def initialize(version, payload, account_sid: nil, call_sid: nil, sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'call_sid' => payload['call_sid'],
+                    'sid' => payload['sid'],
+                    'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
+                    'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                    'uri' => payload['uri'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'account_sid' => account_sid, 'call_sid' => call_sid, 'sid' => sid || @properties['sid'], }
+              end
+
+              ##
+              # Generate an instance context for the instance, the context is capable of
+              # performing various actions.  All instance actions are proxied to the context
+              # @return [PaymentContext] PaymentContext for this PaymentInstance
+              def context
+                unless @instance_context
+                  @instance_context = PaymentContext.new(
+                      @version,
+                      @params['account_sid'],
+                      @params['call_sid'],
+                      @params['sid'],
+                  )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The SID of the Account that created the Payments resource.
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [String] The SID of the Call the resource is associated with.
+              def call_sid
+                @properties['call_sid']
+              end
+
+              ##
+              # @return [String] The SID of the Payments resource.
+              def sid
+                @properties['sid']
+              end
+
+              ##
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was created
+              def date_created
+                @properties['date_created']
+              end
+
+              ##
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
+              def date_updated
+                @properties['date_updated']
+              end
+
+              ##
+              # @return [String] The URI of the resource, relative to `https://api.twilio.com`
+              def uri
+                @properties['uri']
+              end
+
+              ##
+              # 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.`
+              # @return [PaymentInstance] Updated PaymentInstance
+              def update(idempotency_key: nil, status_callback: nil, capture: :unset, status: :unset)
+                context.update(
+                    idempotency_key: idempotency_key,
+                    status_callback: status_callback,
+                    capture: capture,
+                    status: status,
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Api.V2010.PaymentInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Api.V2010.PaymentInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end