twilio-ruby 5.0.0 → 5.1.0

data/lib/twilio-ruby/rest/notify/v1/service/segment.rb

@@ -0,0 +1,230 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Notify < 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 SegmentList < ListResource
+            ##
+            # Initialize the SegmentList
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The service_sid
+            # @return [SegmentList] SegmentList
+            def initialize(version, service_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {
+                  service_sid: service_sid
+              }
+              @uri = "/Services/#{@solution[:service_sid]}/Segments"
+            end
+
+            ##
+            # Lists SegmentInstance records from the API as a list.
+            # Unlike stream(), this operation is eager and will load `limit` records into
+            # memory before returning.
+            # @param [Integer] limit Upper limit for the number of records to return. stream()
+            #    guarantees to never return more than limit.  Default is no limit
+            # @param [Integer] page_size Number of records to fetch per request, when
+            #    not set will use the default value of 50 records.  If no page_size is defined
+            #    but a limit is defined, stream() will attempt to read the limit with the most
+            #    efficient page size, i.e. min(limit, 1000)
+            # @return [Array] Array of up to limit results
+            def list(limit: nil, page_size: nil)
+              self.stream(
+                  limit: limit,
+                  page_size: page_size
+              ).entries
+            end
+
+            ##
+            # Streams SegmentInstance records from the API as an Enumerable.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            # @param [Integer] limit Upper limit for the number of records to return. stream()
+            #    guarantees to never return more than limit. Default is no limit.
+            # @param [Integer] page_size Number of records to fetch per request, when
+            #    not set will use the default value of 50 records. If no page_size is defined
+            #    but a limit is defined, stream() will attempt to read the limit with the most
+            #    efficient page size, i.e. min(limit, 1000)
+            # @return [Enumerable] Enumerable that will yield up to limit results
+            def stream(limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(
+                  page_size: limits[:page_size],
+              )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields SegmentInstance records from the API.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            def each
+              limits = @version.read_limits
+
+              page = self.page(
+                  page_size: limits[:page_size],
+              )
+
+              @version.stream(page,
+                              limit: limits[:limit],
+                              page_limit: limits[:page_limit]).each {|x| yield x}
+            end
+
+            ##
+            # Retrieve a single page of SegmentInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] page_token PageToken provided by the API
+            # @param [Integer] page_number Page Number, this value is simply for client state
+            # @param [Integer] page_size Number of records to return, defaults to 50
+            # @return [Page] Page of SegmentInstance
+            def page(page_token: :unset, page_number: :unset, page_size: :unset)
+              params = Twilio::Values.of({
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+              response = @version.page(
+                  'GET',
+                  @uri,
+                  params
+              )
+              SegmentPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of SegmentInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of SegmentInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              SegmentPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Notify.V1.SegmentList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class SegmentPage < Page
+            ##
+            # Initialize the SegmentPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [SegmentPage] SegmentPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of SegmentInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [SegmentInstance] SegmentInstance
+            def get_instance(payload)
+              SegmentInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Notify.V1.SegmentPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class SegmentInstance < InstanceResource
+            ##
+            # Initialize the SegmentInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] service_sid The service_sid
+            # @return [SegmentInstance] SegmentInstance
+            def initialize(version, payload, service_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'account_sid' => payload['account_sid'],
+                  'service_sid' => payload['service_sid'],
+                  'unique_name' => payload['unique_name'],
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+              }
+            end
+
+            ##
+            # @return [String] The sid
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] The account_sid
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] The service_sid
+            def service_sid
+              @properties['service_sid']
+            end
+
+            ##
+            # @return [String] The unique_name
+            def unique_name
+              @properties['unique_name']
+            end
+
+            ##
+            # @return [Time] The date_created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [Time] The date_updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Notify.V1.SegmentInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/notify/v1/service/user/segment_memberships.rb

@@ -0,0 +1,262 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Notify < Domain
+      class V1 < Version
+        class ServiceContext < InstanceContext
+          class UserContext < InstanceContext
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class SegmentMembershipList < ListResource
+              ##
+              # Initialize the SegmentMembershipList
+              # @param [Version] version Version that contains the resource
+              # @param [String] service_sid The service_sid
+              # @param [String] identity The identity
+              # @return [SegmentMembershipList] SegmentMembershipList
+              def initialize(version, service_sid: nil, identity: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {
+                    service_sid: service_sid,
+                    identity: identity
+                }
+                @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:identity]}/SegmentMemberships"
+              end
+
+              ##
+              # Retrieve a single page of SegmentMembershipInstance records from the API.
+              # Request is executed immediately.
+              # @param [String] segment The segment
+              # @return [SegmentMembershipInstance] Newly created SegmentMembershipInstance
+              def create(segment: nil)
+                data = Twilio::Values.of({
+                    'Segment' => segment,
+                })
+
+                payload = @version.create(
+                    'POST',
+                    @uri,
+                    data: data
+                )
+
+                SegmentMembershipInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    identity: @solution[:identity],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Notify.V1.SegmentMembershipList>'
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class SegmentMembershipPage < Page
+              ##
+              # Initialize the SegmentMembershipPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [SegmentMembershipPage] SegmentMembershipPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of SegmentMembershipInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [SegmentMembershipInstance] SegmentMembershipInstance
+              def get_instance(payload)
+                SegmentMembershipInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    identity: @solution[:identity],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Notify.V1.SegmentMembershipPage>'
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class SegmentMembershipContext < InstanceContext
+              ##
+              # Initialize the SegmentMembershipContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] service_sid The service_sid
+              # @param [String] identity The identity
+              # @param [String] segment The segment
+              # @return [SegmentMembershipContext] SegmentMembershipContext
+              def initialize(version, service_sid, identity, segment)
+                super(version)
+
+                # Path Solution
+                @solution = {
+                    service_sid: service_sid,
+                    identity: identity,
+                    segment: segment,
+                }
+                @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:identity]}/SegmentMemberships/#{@solution[:segment]}"
+              end
+
+              ##
+              # Deletes the SegmentMembershipInstance
+              # @return [Boolean] true if delete succeeds, true otherwise
+              def delete
+                @version.delete('delete', @uri)
+              end
+
+              ##
+              # Fetch a SegmentMembershipInstance
+              # @return [SegmentMembershipInstance] Fetched SegmentMembershipInstance
+              def fetch
+                params = Twilio::Values.of({})
+
+                payload = @version.fetch(
+                    'GET',
+                    @uri,
+                    params,
+                )
+
+                SegmentMembershipInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    identity: @solution[:identity],
+                    segment: @solution[:segment],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Notify.V1.SegmentMembershipContext #{context}>"
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class SegmentMembershipInstance < InstanceResource
+              ##
+              # Initialize the SegmentMembershipInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] service_sid The service_sid
+              # @param [String] identity The identity
+              # @param [String] segment The segment
+              # @return [SegmentMembershipInstance] SegmentMembershipInstance
+              def initialize(version, payload, service_sid: nil, identity: nil, segment: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'service_sid' => payload['service_sid'],
+                    'identity' => payload['identity'],
+                    'segment' => payload['segment'],
+                    'url' => payload['url'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {
+                    'service_sid' => service_sid,
+                    'identity' => identity,
+                    'segment' => segment || @properties['segment'],
+                }
+              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 [SegmentMembershipContext] SegmentMembershipContext for this SegmentMembershipInstance
+              def context
+                unless @instance_context
+                  @instance_context = SegmentMembershipContext.new(
+                      @version,
+                      @params['service_sid'],
+                      @params['identity'],
+                      @params['segment'],
+                  )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The account_sid
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [String] The service_sid
+              def service_sid
+                @properties['service_sid']
+              end
+
+              ##
+              # @return [String] The identity
+              def identity
+                @properties['identity']
+              end
+
+              ##
+              # @return [String] The segment
+              def segment
+                @properties['segment']
+              end
+
+              ##
+              # @return [String] The url
+              def url
+                @properties['url']
+              end
+
+              ##
+              # Deletes the SegmentMembershipInstance
+              # @return [Boolean] true if delete succeeds, true otherwise
+              def delete
+                context.delete
+              end
+
+              ##
+              # Fetch a SegmentMembershipInstance
+              # @return [SegmentMembershipInstance] Fetched SegmentMembershipInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Notify.V1.SegmentMembershipInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end