twilio-ruby 5.12.4 → 5.13.0

data/lib/twilio-ruby/rest/verify/v1/service/verification.rb

@@ -0,0 +1,185 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Verify < Domain
+      class V1 < Version
+        class ServiceContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class VerificationList < ListResource
+            ##
+            # Initialize the VerificationList
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The unique SID identifier of the Service.
+            # @return [VerificationList] VerificationList
+            def initialize(version, service_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {service_sid: service_sid}
+              @uri = "/Services/#{@solution[:service_sid]}/Verifications"
+            end
+
+            ##
+            # Retrieve a single page of VerificationInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] to The To phonenumber of the phone being verified
+            # @param [String] channel The method in which the phone will be verified. Either
+            #   sms or call
+            # @param [String] custom_message A character string containing a custom message
+            #   for this verification
+            # @return [VerificationInstance] Newly created VerificationInstance
+            def create(to: nil, channel: nil, custom_message: :unset)
+              data = Twilio::Values.of({'To' => to, 'Channel' => channel, 'CustomMessage' => custom_message, })
+
+              payload = @version.create(
+                  'POST',
+                  @uri,
+                  data: data
+              )
+
+              VerificationInstance.new(@version, payload, service_sid: @solution[:service_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Verify.V1.VerificationList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class VerificationPage < Page
+            ##
+            # Initialize the VerificationPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [VerificationPage] VerificationPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of VerificationInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [VerificationInstance] VerificationInstance
+            def get_instance(payload)
+              VerificationInstance.new(@version, payload, service_sid: @solution[:service_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Verify.V1.VerificationPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class VerificationInstance < InstanceResource
+            ##
+            # Initialize the VerificationInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] service_sid The unique SID identifier of the Service.
+            # @return [VerificationInstance] VerificationInstance
+            def initialize(version, payload, service_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'service_sid' => payload['service_sid'],
+                  'account_sid' => payload['account_sid'],
+                  'to' => payload['to'],
+                  'channel' => payload['channel'],
+                  'status' => payload['status'],
+                  'valid' => payload['valid'],
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+              }
+            end
+
+            ##
+            # @return [String] A string that uniquely identifies this Verification.
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] Service Sid.
+            def service_sid
+              @properties['service_sid']
+            end
+
+            ##
+            # @return [String] Account Sid.
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] To phonenumber
+            def to
+              @properties['to']
+            end
+
+            ##
+            # @return [verification.Channel] sms or call
+            def channel
+              @properties['channel']
+            end
+
+            ##
+            # @return [String] pending, approved, denied or expired
+            def status
+              @properties['status']
+            end
+
+            ##
+            # @return [Boolean] successful verification
+            def valid
+              @properties['valid']
+            end
+
+            ##
+            # @return [Time] The date this Verification was created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [Time] The date this Verification was updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Verify.V1.VerificationInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Verify.V1.VerificationInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/verify/v1/service/verification_check.rb

@@ -0,0 +1,182 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Verify < Domain
+      class V1 < Version
+        class ServiceContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class VerificationCheckList < ListResource
+            ##
+            # Initialize the VerificationCheckList
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The unique SID identifier of the Service.
+            # @return [VerificationCheckList] VerificationCheckList
+            def initialize(version, service_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {service_sid: service_sid}
+              @uri = "/Services/#{@solution[:service_sid]}/VerificationCheck"
+            end
+
+            ##
+            # Retrieve a single page of VerificationCheckInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] code The 4-10 character string being verified
+            # @param [String] to The To phonenumber of the phone being verified
+            # @return [VerificationCheckInstance] Newly created VerificationCheckInstance
+            def create(code: nil, to: :unset)
+              data = Twilio::Values.of({'Code' => code, 'To' => to, })
+
+              payload = @version.create(
+                  'POST',
+                  @uri,
+                  data: data
+              )
+
+              VerificationCheckInstance.new(@version, payload, service_sid: @solution[:service_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Verify.V1.VerificationCheckList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class VerificationCheckPage < Page
+            ##
+            # Initialize the VerificationCheckPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [VerificationCheckPage] VerificationCheckPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of VerificationCheckInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [VerificationCheckInstance] VerificationCheckInstance
+            def get_instance(payload)
+              VerificationCheckInstance.new(@version, payload, service_sid: @solution[:service_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Verify.V1.VerificationCheckPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class VerificationCheckInstance < InstanceResource
+            ##
+            # Initialize the VerificationCheckInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] service_sid The unique SID identifier of the Service.
+            # @return [VerificationCheckInstance] VerificationCheckInstance
+            def initialize(version, payload, service_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'service_sid' => payload['service_sid'],
+                  'account_sid' => payload['account_sid'],
+                  'to' => payload['to'],
+                  'channel' => payload['channel'],
+                  'status' => payload['status'],
+                  'valid' => payload['valid'],
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+              }
+            end
+
+            ##
+            # @return [String] A string that uniquely identifies this Verification Check.
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] Service Sid.
+            def service_sid
+              @properties['service_sid']
+            end
+
+            ##
+            # @return [String] Account Sid.
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] To phonenumber
+            def to
+              @properties['to']
+            end
+
+            ##
+            # @return [verification_check.Channel] sms or call
+            def channel
+              @properties['channel']
+            end
+
+            ##
+            # @return [String] pending, approved, denied or expired
+            def status
+              @properties['status']
+            end
+
+            ##
+            # @return [Boolean] successful verification
+            def valid
+              @properties['valid']
+            end
+
+            ##
+            # @return [Time] The date this Verification Check was created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [Time] The date this Verification Check was updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Verify.V1.VerificationCheckInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Verify.V1.VerificationCheckInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/version.rb

@@ -1,3 +1,3 @@
 module Twilio
-    VERSION = '5.12.4'
+    VERSION = '5.13.0'
 end

data/spec/integration/preview/authy/service/entity_spec.rb

@@ -0,0 +1,173 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+require 'spec_helper.rb'
+
+describe 'Entity' do
+  it "can create" do
+    @holodeck.mock(Twilio::Response.new(500, ''))
+
+    expect {
+      @client.preview.authy.services('ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX') \
+                           .entities.create(identity: 'identity')
+    }.to raise_exception(Twilio::REST::TwilioError)
+
+    values = {'Identity' => 'identity', }
+    expect(
+    @holodeck.has_request?(Holodeck::Request.new(
+        method: 'post',
+        url: 'https://preview.twilio.com/Authy/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Entities',
+        data: values,
+    ))).to eq(true)
+  end
+
+  it "receives create responses" do
+    @holodeck.mock(Twilio::Response.new(
+        201,
+      %q[
+      {
+          "sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+          "identity": "ff483d1ff591898a9942916050d2ca3f",
+          "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+          "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+          "date_created": "2015-07-30T20:00:00Z",
+          "date_updated": "2015-07-30T20:00:00Z",
+          "url": "https://preview.twilio.com/Authy/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f",
+          "links": {
+              "factors": "https://preview.twilio.com/Authy/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors"
+          }
+      }
+      ]
+    ))
+
+    actual = @client.preview.authy.services('ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX') \
+                                  .entities.create(identity: 'identity')
+
+    expect(actual).to_not eq(nil)
+  end
+
+  it "can read" do
+    @holodeck.mock(Twilio::Response.new(500, ''))
+
+    expect {
+      @client.preview.authy.services('ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX') \
+                           .entities.list()
+    }.to raise_exception(Twilio::REST::TwilioError)
+
+    values = {}
+    expect(
+    @holodeck.has_request?(Holodeck::Request.new(
+        method: 'get',
+        url: 'https://preview.twilio.com/Authy/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Entities',
+    ))).to eq(true)
+  end
+
+  it "receives read_empty responses" do
+    @holodeck.mock(Twilio::Response.new(
+        200,
+      %q[
+      {
+          "entities": [],
+          "meta": {
+              "page": 0,
+              "page_size": 50,
+              "first_page_url": "https://preview.twilio.com/Authy/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0",
+              "previous_page_url": null,
+              "url": "https://preview.twilio.com/Authy/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0",
+              "next_page_url": null,
+              "key": "entities"
+          }
+      }
+      ]
+    ))
+
+    actual = @client.preview.authy.services('ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX') \
+                                  .entities.list()
+
+    expect(actual).to_not eq(nil)
+  end
+
+  it "receives read_full responses" do
+    @holodeck.mock(Twilio::Response.new(
+        200,
+      %q[
+      {
+          "entities": [
+              {
+                  "sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+                  "identity": "ff483d1ff591898a9942916050d2ca3f",
+                  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+                  "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+                  "date_created": "2015-07-30T20:00:00Z",
+                  "date_updated": "2015-07-30T20:00:00Z",
+                  "url": "https://preview.twilio.com/Authy/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f",
+                  "links": {
+                      "factors": "https://preview.twilio.com/Authy/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors"
+                  }
+              }
+          ],
+          "meta": {
+              "page": 0,
+              "page_size": 50,
+              "first_page_url": "https://preview.twilio.com/Authy/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0",
+              "previous_page_url": null,
+              "url": "https://preview.twilio.com/Authy/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0",
+              "next_page_url": null,
+              "key": "entities"
+          }
+      }
+      ]
+    ))
+
+    actual = @client.preview.authy.services('ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX') \
+                                  .entities.list()
+
+    expect(actual).to_not eq(nil)
+  end
+
+  it "can fetch" do
+    @holodeck.mock(Twilio::Response.new(500, ''))
+
+    expect {
+      @client.preview.authy.services('ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX') \
+                           .entities('identity').fetch()
+    }.to raise_exception(Twilio::REST::TwilioError)
+
+    values = {}
+    expect(
+    @holodeck.has_request?(Holodeck::Request.new(
+        method: 'get',
+        url: 'https://preview.twilio.com/Authy/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Entities/identity',
+    ))).to eq(true)
+  end
+
+  it "receives fetch responses" do
+    @holodeck.mock(Twilio::Response.new(
+        200,
+      %q[
+      {
+          "sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+          "identity": "ff483d1ff591898a9942916050d2ca3f",
+          "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+          "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+          "date_created": "2015-07-30T20:00:00Z",
+          "date_updated": "2015-07-30T20:00:00Z",
+          "url": "https://preview.twilio.com/Authy/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f",
+          "links": {
+              "factors": "https://preview.twilio.com/Authy/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors"
+          }
+      }
+      ]
+    ))
+
+    actual = @client.preview.authy.services('ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX') \
+                                  .entities('identity').fetch()
+
+    expect(actual).to_not eq(nil)
+  end
+end