twilio-ruby 5.11.2 → 5.12.0

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

@@ -1,438 +0,0 @@
-##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
-# 
-# frozen_string_literal: true
-
-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 UserList < ListResource
-            ##
-            # Initialize the UserList
-            # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @return [UserList] UserList
-            def initialize(version, service_sid: nil)
-              super(version)
-
-              # Path Solution
-              @solution = {service_sid: service_sid}
-              @uri = "/Services/#{@solution[:service_sid]}/Users"
-            end
-
-            ##
-            # Retrieve a single page of UserInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] identity The identifier of the User, defined by your
-            #   application.
-            # @param [String] segment The list of segments this User belongs to. Segments can
-            #   be used to select recipients of a notification. Maximum 20 Segments per User
-            #   allowed.
-            # @return [UserInstance] Newly created UserInstance
-            def create(identity: nil, segment: :unset)
-              data = Twilio::Values.of({
-                  'Identity' => identity,
-                  'Segment' => Twilio.serialize_list(segment) { |e| e },
-              })
-
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
-
-              UserInstance.new(@version, payload, service_sid: @solution[:service_sid], )
-            end
-
-            ##
-            # Lists UserInstance records from the API as a list.
-            # Unlike stream(), this operation is eager and will load `limit` records into
-            # memory before returning.
-            # @param [String] identity The identifier of the User, defined by your
-            #   application.
-            # @param [String] segment The list of segments this User belongs to. Segments can
-            #   be used to select recipients of a notification. Maximum 20 Segments per User
-            #   allowed.
-            # @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(identity: :unset, segment: :unset, limit: nil, page_size: nil)
-              self.stream(identity: identity, segment: segment, limit: limit, page_size: page_size).entries
-            end
-
-            ##
-            # Streams UserInstance records from the API as an Enumerable.
-            # This operation lazily loads records as efficiently as possible until the limit
-            # is reached.
-            # @param [String] identity The identifier of the User, defined by your
-            #   application.
-            # @param [String] segment The list of segments this User belongs to. Segments can
-            #   be used to select recipients of a notification. Maximum 20 Segments per User
-            #   allowed.
-            # @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(identity: :unset, segment: :unset, limit: nil, page_size: nil)
-              limits = @version.read_limits(limit, page_size)
-
-              page = self.page(identity: identity, segment: segment, page_size: limits[:page_size], )
-
-              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
-            end
-
-            ##
-            # When passed a block, yields UserInstance 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 UserInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] identity The identifier of the User, defined by your
-            #   application.
-            # @param [String] segment The list of segments this User belongs to. Segments can
-            #   be used to select recipients of a notification. Maximum 20 Segments per User
-            #   allowed.
-            # @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 UserInstance
-            def page(identity: :unset, segment: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
-              params = Twilio::Values.of({
-                  'Identity' => Twilio.serialize_list(identity) { |e| e },
-                  'Segment' => segment,
-                  'PageToken' => page_token,
-                  'Page' => page_number,
-                  'PageSize' => page_size,
-              })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
-              UserPage.new(@version, response, @solution)
-            end
-
-            ##
-            # Retrieve a single page of UserInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] target_url API-generated URL for the requested results page
-            # @return [Page] Page of UserInstance
-            def get_page(target_url)
-              response = @version.domain.request(
-                  'GET',
-                  target_url
-              )
-              UserPage.new(@version, response, @solution)
-            end
-
-            ##
-            # Provide a user friendly representation
-            def to_s
-              '#<Twilio.Notify.V1.UserList>'
-            end
-          end
-
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class UserPage < Page
-            ##
-            # Initialize the UserPage
-            # @param [Version] version Version that contains the resource
-            # @param [Response] response Response from the API
-            # @param [Hash] solution Path solution for the resource
-            # @return [UserPage] UserPage
-            def initialize(version, response, solution)
-              super(version, response)
-
-              # Path Solution
-              @solution = solution
-            end
-
-            ##
-            # Build an instance of UserInstance
-            # @param [Hash] payload Payload response from the API
-            # @return [UserInstance] UserInstance
-            def get_instance(payload)
-              UserInstance.new(@version, payload, service_sid: @solution[:service_sid], )
-            end
-
-            ##
-            # Provide a user friendly representation
-            def to_s
-              '<Twilio.Notify.V1.UserPage>'
-            end
-          end
-
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class UserContext < InstanceContext
-            ##
-            # Initialize the UserContext
-            # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] identity The identity
-            # @return [UserContext] UserContext
-            def initialize(version, service_sid, identity)
-              super(version)
-
-              # Path Solution
-              @solution = {service_sid: service_sid, identity: identity, }
-              @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:identity]}"
-
-              # Dependents
-              @bindings = nil
-              @segment_memberships = nil
-            end
-
-            ##
-            # Deletes the UserInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              @version.delete('delete', @uri)
-            end
-
-            ##
-            # Fetch a UserInstance
-            # @return [UserInstance] Fetched UserInstance
-            def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
-
-              UserInstance.new(
-                  @version,
-                  payload,
-                  service_sid: @solution[:service_sid],
-                  identity: @solution[:identity],
-              )
-            end
-
-            ##
-            # Access the bindings
-            # @return [UserBindingList]
-            # @return [UserBindingContext] if sid was passed.
-            def bindings(sid=:unset)
-              raise ArgumentError, 'sid cannot be nil' if sid.nil?
-
-              if sid != :unset
-                return UserBindingContext.new(@version, @solution[:service_sid], @solution[:identity], sid, )
-              end
-
-              unless @bindings
-                @bindings = UserBindingList.new(
-                    @version,
-                    service_sid: @solution[:service_sid],
-                    identity: @solution[:identity],
-                )
-              end
-
-              @bindings
-            end
-
-            ##
-            # Access the segment_memberships
-            # @return [SegmentMembershipList]
-            # @return [SegmentMembershipContext] if segment was passed.
-            def segment_memberships(segment=:unset)
-              raise ArgumentError, 'segment cannot be nil' if segment.nil?
-
-              if segment != :unset
-                return SegmentMembershipContext.new(
-                    @version,
-                    @solution[:service_sid],
-                    @solution[:identity],
-                    segment,
-                )
-              end
-
-              unless @segment_memberships
-                @segment_memberships = SegmentMembershipList.new(
-                    @version,
-                    service_sid: @solution[:service_sid],
-                    identity: @solution[:identity],
-                )
-              end
-
-              @segment_memberships
-            end
-
-            ##
-            # Provide a user friendly representation
-            def to_s
-              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Notify.V1.UserContext #{context}>"
-            end
-          end
-
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class UserInstance < InstanceResource
-            ##
-            # Initialize the UserInstance
-            # @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
-            # @return [UserInstance] UserInstance
-            def initialize(version, payload, service_sid: nil, identity: nil)
-              super(version)
-
-              # Marshaled Properties
-              @properties = {
-                  'sid' => payload['sid'],
-                  'account_sid' => payload['account_sid'],
-                  'service_sid' => payload['service_sid'],
-                  'identity' => payload['identity'],
-                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
-                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                  'segments' => payload['segments'],
-                  'url' => payload['url'],
-                  'links' => payload['links'],
-              }
-
-              # Context
-              @instance_context = nil
-              @params = {'service_sid' => service_sid, 'identity' => identity || @properties['identity'], }
-            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 [UserContext] UserContext for this UserInstance
-            def context
-              unless @instance_context
-                @instance_context = UserContext.new(@version, @params['service_sid'], @params['identity'], )
-              end
-              @instance_context
-            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 identifier of the User, defined by your application.
-            def identity
-              @properties['identity']
-            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
-
-            ##
-            # @return [String] The segments
-            def segments
-              @properties['segments']
-            end
-
-            ##
-            # @return [String] The url
-            def url
-              @properties['url']
-            end
-
-            ##
-            # @return [String] The links
-            def links
-              @properties['links']
-            end
-
-            ##
-            # Deletes the UserInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              context.delete
-            end
-
-            ##
-            # Fetch a UserInstance
-            # @return [UserInstance] Fetched UserInstance
-            def fetch
-              context.fetch
-            end
-
-            ##
-            # Access the bindings
-            # @return [bindings] bindings
-            def bindings
-              context.bindings
-            end
-
-            ##
-            # Access the segment_memberships
-            # @return [segment_memberships] segment_memberships
-            def segment_memberships
-              context.segment_memberships
-            end
-
-            ##
-            # Provide a user friendly representation
-            def to_s
-              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Notify.V1.UserInstance #{values}>"
-            end
-
-            ##
-            # Provide a detailed, user friendly representation
-            def inspect
-              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Notify.V1.UserInstance #{values}>"
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,262 +0,0 @@
-##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
-# 
-# frozen_string_literal: true
-
-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
-
-              ##
-              # Provide a detailed, user friendly representation
-              def inspect
-                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Notify.V1.SegmentMembershipInstance #{values}>"
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end