lib/twilio-ruby/rest/chat/v2/service/binding.rb in twilio-ruby-5.77.0 vs lib/twilio-ruby/rest/chat/v2/service/binding.rb in twilio-ruby-6.0.0.pre.rc.1

- old
+ new

@@ -1,377 +1,379 @@ ## -# This code was generated by -# \ / _ _ _| _ _ -# | (_)\/(_)(_|\/| |(/_ v1.0.0 -# / / +# This code was generated by +# ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ +# | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ +# | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ # -# frozen_string_literal: true +# Twilio - Chat +# This is the public Twilio REST API. +# +# NOTE: This class is auto generated by OpenAPI Generator. +# https://openapi-generator.tech +# Do not edit the class manually. +# + module Twilio - module REST - class Chat < Domain - class V2 < Version - class ServiceContext < InstanceContext - class BindingList < ListResource - ## - # Initialize the BindingList - # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the - # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Binding - # resource is associated with. - # @return [BindingList] BindingList - def initialize(version, service_sid: nil) - super(version) + module REST + class Chat < ChatBase + class V2 < Version + class ServiceContext < InstanceContext - # Path Solution - @solution = {service_sid: service_sid} - @uri = "/Services/#{@solution[:service_sid]}/Bindings" - end + class BindingList < ListResource + ## + # Initialize the BindingList + # @param [Version] version Version that contains the resource + # @return [BindingList] BindingList + def initialize(version, service_sid: nil) + super(version) + # Path Solution + @solution = { service_sid: service_sid } + @uri = "/Services/#{@solution[:service_sid]}/Bindings" + + end + + ## + # Lists BindingInstance records from the API as a list. + # Unlike stream(), this operation is eager and will load `limit` records into + # memory before returning. + # @param [Array[BindingType]] binding_type The push technology used by the Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info. + # @param [Array[String]] identity The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # @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(binding_type: :unset, identity: :unset, limit: nil, page_size: nil) + self.stream( + binding_type: binding_type, + identity: identity, + limit: limit, + page_size: page_size + ).entries + end - ## - # Lists BindingInstance records from the API as a list. - # Unlike stream(), this operation is eager and will load `limit` records into - # memory before returning. - # @param [Array[binding.BindingType]] binding_type The push technology used by the - # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push - # notification - # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] - # for more info. - # @param [Array[String]] identity The - # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value - # of the resources to read. See {access - # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. - # @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(binding_type: :unset, identity: :unset, limit: nil, page_size: nil) - self.stream( - binding_type: binding_type, - identity: identity, - limit: limit, - page_size: page_size - ).entries - end + ## + # Streams Instance records from the API as an Enumerable. + # This operation lazily loads records as efficiently as possible until the limit + # is reached. + # @param [Array[BindingType]] binding_type The push technology used by the Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info. + # @param [Array[String]] identity The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # @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(binding_type: :unset, identity: :unset, limit: nil, page_size: nil) + limits = @version.read_limits(limit, page_size) - ## - # Streams BindingInstance records from the API as an Enumerable. - # This operation lazily loads records as efficiently as possible until the limit - # is reached. - # @param [Array[binding.BindingType]] binding_type The push technology used by the - # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push - # notification - # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] - # for more info. - # @param [Array[String]] identity The - # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value - # of the resources to read. See {access - # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. - # @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(binding_type: :unset, identity: :unset, limit: nil, page_size: nil) - limits = @version.read_limits(limit, page_size) + page = self.page( + binding_type: binding_type, + identity: identity, + page_size: limits[:page_size], ) - page = self.page(binding_type: binding_type, identity: identity, page_size: limits[:page_size], ) + @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) + end - @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) - end + ## + # When passed a block, yields BindingInstance records from the API. + # This operation lazily loads records as efficiently as possible until the limit + # is reached. + def each + limits = @version.read_limits - ## - # When passed a block, yields BindingInstance 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], ) - page = self.page(page_size: limits[:page_size], ) + @version.stream(page, + limit: limits[:limit], + page_limit: limits[:page_limit]).each {|x| yield x} + end - @version.stream(page, - limit: limits[:limit], - page_limit: limits[:page_limit]).each {|x| yield x} - end + ## + # Retrieve a single page of BindingInstance records from the API. + # Request is executed immediately. + # @param [Array[BindingType]] binding_type The push technology used by the Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info. + # @param [Array[String]] identity The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. + # @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 BindingInstance + def page(binding_type: :unset, identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset) + params = Twilio::Values.of({ + + 'BindingType' => Twilio.serialize_list(binding_type), + + 'Identity' => Twilio.serialize_list(identity), + + 'PageToken' => page_token, + 'Page' => page_number, + 'PageSize' => page_size, + }) - ## - # Retrieve a single page of BindingInstance records from the API. - # Request is executed immediately. - # @param [Array[binding.BindingType]] binding_type The push technology used by the - # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See {push - # notification - # configuration}[https://www.twilio.com/docs/chat/push-notification-configuration] - # for more info. - # @param [Array[String]] identity The - # {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value - # of the resources to read. See {access - # tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details. - # @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 BindingInstance - def page(binding_type: :unset, identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset) - params = Twilio::Values.of({ - 'BindingType' => Twilio.serialize_list(binding_type) { |e| e }, - 'Identity' => Twilio.serialize_list(identity) { |e| e }, - 'PageToken' => page_token, - 'Page' => page_number, - 'PageSize' => page_size, - }) + response = @version.page('GET', @uri, params: params) - response = @version.page('GET', @uri, params: params) + BindingPage.new(@version, response, @solution) + end - BindingPage.new(@version, response, @solution) - end + ## + # Retrieve a single page of BindingInstance records from the API. + # Request is executed immediately. + # @param [String] target_url API-generated URL for the requested results page + # @return [Page] Page of BindingInstance + def get_page(target_url) + response = @version.domain.request( + 'GET', + target_url + ) + BindingPage.new(@version, response, @solution) + end + - ## - # Retrieve a single page of BindingInstance records from the API. - # Request is executed immediately. - # @param [String] target_url API-generated URL for the requested results page - # @return [Page] Page of BindingInstance - def get_page(target_url) - response = @version.domain.request( - 'GET', - target_url - ) - BindingPage.new(@version, response, @solution) - end - ## - # Provide a user friendly representation - def to_s - '#<Twilio.Chat.V2.BindingList>' - end - end + # Provide a user friendly representation + def to_s + '#<Twilio.Chat.V2.BindingList>' + end + end - class BindingPage < Page - ## - # Initialize the BindingPage - # @param [Version] version Version that contains the resource - # @param [Response] response Response from the API - # @param [Hash] solution Path solution for the resource - # @return [BindingPage] BindingPage - def initialize(version, response, solution) - super(version, response) - # Path Solution - @solution = solution - end + class BindingContext < InstanceContext + ## + # Initialize the BindingContext + # @param [Version] version Version that contains the resource + # @param [String] service_sid The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the Binding resource from. + # @param [String] sid The SID of the Binding resource to fetch. + # @return [BindingContext] BindingContext + def initialize(version, service_sid, sid) + super(version) - ## - # Build an instance of BindingInstance - # @param [Hash] payload Payload response from the API - # @return [BindingInstance] BindingInstance - def get_instance(payload) - BindingInstance.new(@version, payload, service_sid: @solution[:service_sid], ) - end + # Path Solution + @solution = { service_sid: service_sid, sid: sid, } + @uri = "/Services/#{@solution[:service_sid]}/Bindings/#{@solution[:sid]}" - ## - # Provide a user friendly representation - def to_s - '<Twilio.Chat.V2.BindingPage>' - end - end + + end + ## + # Delete the BindingInstance + # @return [Boolean] True if delete succeeds, false otherwise + def delete - class BindingContext < InstanceContext - ## - # Initialize the BindingContext - # @param [Version] version Version that contains the resource - # @param [String] service_sid The SID of the - # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the - # Binding resource from. - # @param [String] sid The SID of the Binding resource to fetch. - # @return [BindingContext] BindingContext - def initialize(version, service_sid, sid) - super(version) + @version.delete('DELETE', @uri) + end - # Path Solution - @solution = {service_sid: service_sid, sid: sid, } - @uri = "/Services/#{@solution[:service_sid]}/Bindings/#{@solution[:sid]}" - end + ## + # Fetch the BindingInstance + # @return [BindingInstance] Fetched BindingInstance + def fetch - ## - # Fetch the BindingInstance - # @return [BindingInstance] Fetched BindingInstance - def fetch - payload = @version.fetch('GET', @uri) + payload = @version.fetch('GET', @uri) + BindingInstance.new( + @version, + payload, + service_sid: @solution[:service_sid], + sid: @solution[:sid], + ) + end - BindingInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], ) - end - ## - # Delete the BindingInstance - # @return [Boolean] true if delete succeeds, false otherwise - def delete - @version.delete('DELETE', @uri) - end + ## + # Provide a user friendly representation + def to_s + context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') + "#<Twilio.Chat.V2.BindingContext #{context}>" + end - ## - # Provide a user friendly representation - def to_s - context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') - "#<Twilio.Chat.V2.BindingContext #{context}>" - end + ## + # Provide a detailed, user friendly representation + def inspect + context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') + "#<Twilio.Chat.V2.BindingContext #{context}>" + end + end - ## - # Provide a detailed, user friendly representation - def inspect - context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') - "#<Twilio.Chat.V2.BindingContext #{context}>" - end - end + class BindingPage < Page + ## + # Initialize the BindingPage + # @param [Version] version Version that contains the resource + # @param [Response] response Response from the API + # @param [Hash] solution Path solution for the resource + # @return [BindingPage] BindingPage + def initialize(version, response, solution) + super(version, response) - class BindingInstance < InstanceResource - ## - # Initialize the BindingInstance - # @param [Version] version Version that contains the resource - # @param [Hash] payload payload that contains response from Twilio - # @param [String] service_sid The SID of the - # {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Binding - # resource is associated with. - # @param [String] sid The SID of the Binding resource to fetch. - # @return [BindingInstance] BindingInstance - def initialize(version, payload, service_sid: nil, sid: nil) - super(version) + # Path Solution + @solution = solution + end - # Marshaled Properties - @properties = { - 'sid' => payload['sid'], - 'account_sid' => payload['account_sid'], - 'service_sid' => payload['service_sid'], - 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), - 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), - 'endpoint' => payload['endpoint'], - 'identity' => payload['identity'], - 'credential_sid' => payload['credential_sid'], - 'binding_type' => payload['binding_type'], - 'message_types' => payload['message_types'], - 'url' => payload['url'], - 'links' => payload['links'], - } + ## + # Build an instance of BindingInstance + # @param [Hash] payload Payload response from the API + # @return [BindingInstance] BindingInstance + def get_instance(payload) + BindingInstance.new(@version, payload, service_sid: @solution[:service_sid]) + end - # Context - @instance_context = nil - @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], } - end + ## + # Provide a user friendly representation + def to_s + '<Twilio.Chat.V2.BindingPage>' + end + end + class BindingInstance < InstanceResource + ## + # Initialize the BindingInstance + # @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 this Binding + # resource. + # @param [String] sid The SID of the Call resource to fetch. + # @return [BindingInstance] BindingInstance + def initialize(version, payload , service_sid: nil, sid: nil) + super(version) + + # Marshaled Properties + @properties = { + 'sid' => payload['sid'], + 'account_sid' => payload['account_sid'], + 'service_sid' => payload['service_sid'], + 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), + 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), + 'endpoint' => payload['endpoint'], + 'identity' => payload['identity'], + 'credential_sid' => payload['credential_sid'], + 'binding_type' => payload['binding_type'], + 'message_types' => payload['message_types'], + 'url' => payload['url'], + 'links' => payload['links'], + } - ## - # Generate an instance context for the instance, the context is capable of - # performing various actions. All instance actions are proxied to the context - # @return [BindingContext] BindingContext for this BindingInstance - def context - unless @instance_context - @instance_context = BindingContext.new(@version, @params['service_sid'], @params['sid'], ) - end - @instance_context - end + # Context + @instance_context = nil + @params = { 'service_sid' => service_sid || @properties['service_sid'] ,'sid' => sid || @properties['sid'] , } + end - ## - # @return [String] The unique string that identifies the resource - def 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 [BindingContext] CallContext for this CallInstance + def context + unless @instance_context + @instance_context = BindingContext.new(@version , @params['service_sid'], @params['sid']) + end + @instance_context + end + + ## + # @return [String] The unique string that we created to identify the Binding resource. + def sid + @properties['sid'] + end + + ## + # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Binding resource. + def account_sid + @properties['account_sid'] + end + + ## + # @return [String] The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Binding resource is associated with. + def service_sid + @properties['service_sid'] + end + + ## + # @return [Time] The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + def date_created + @properties['date_created'] + end + + ## + # @return [Time] The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + def date_updated + @properties['date_updated'] + end + + ## + # @return [String] The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`. + def endpoint + @properties['endpoint'] + end + + ## + # @return [String] The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. + def identity + @properties['identity'] + end + + ## + # @return [String] The SID of the [Credential](https://www.twilio.com/docs/chat/rest/credential-resource) for the binding. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info. + def credential_sid + @properties['credential_sid'] + end + + ## + # @return [BindingType] + def binding_type + @properties['binding_type'] + end + + ## + # @return [Array<String>] The [Programmable Chat message types](https://www.twilio.com/docs/chat/push-notification-configuration#push-types) the binding is subscribed to. + def message_types + @properties['message_types'] + end + + ## + # @return [String] The absolute URL of the Binding resource. + def url + @properties['url'] + end + + ## + # @return [Hash] The absolute URLs of the Binding's [User](https://www.twilio.com/docs/chat/rest/user-resource). + def links + @properties['links'] + end + + ## + # Delete the BindingInstance + # @return [Boolean] True if delete succeeds, false otherwise + def delete - ## - # @return [String] The SID of the Account that created the resource - def account_sid - @properties['account_sid'] - end + context.delete + end - ## - # @return [String] The SID of the Service that the Binding resource is associated with - def service_sid - @properties['service_sid'] - end + ## + # Fetch the BindingInstance + # @return [BindingInstance] Fetched BindingInstance + def fetch - ## - # @return [Time] The ISO 8601 date and time in GMT when the resource was created - def date_created - @properties['date_created'] - end + context.fetch + end - ## - # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated - def date_updated - @properties['date_updated'] - end + ## + # Provide a user friendly representation + def to_s + values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") + "<Twilio.Chat.V2.BindingInstance #{values}>" + end - ## - # @return [String] The unique endpoint identifier for the Binding - def endpoint - @properties['endpoint'] - end + ## + # Provide a detailed, user friendly representation + def inspect + values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") + "<Twilio.Chat.V2.BindingInstance #{values}>" + end + end - ## - # @return [String] The string that identifies the resource's User - def identity - @properties['identity'] + end end - - ## - # @return [String] The SID of the Credential for the binding - def credential_sid - @properties['credential_sid'] - end - - ## - # @return [binding.BindingType] The push technology to use for the binding - def binding_type - @properties['binding_type'] - end - - ## - # @return [Array[String]] The Programmable Chat message types the binding is subscribed to - def message_types - @properties['message_types'] - end - - ## - # @return [String] The absolute URL of the Binding resource - def url - @properties['url'] - end - - ## - # @return [String] The absolute URLs of the Binding's User - def links - @properties['links'] - end - - ## - # Fetch the BindingInstance - # @return [BindingInstance] Fetched BindingInstance - def fetch - context.fetch - end - - ## - # Delete the BindingInstance - # @return [Boolean] true if delete succeeds, false otherwise - def delete - context.delete - end - - ## - # Provide a user friendly representation - def to_s - values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") - "<Twilio.Chat.V2.BindingInstance #{values}>" - end - - ## - # Provide a detailed, user friendly representation - def inspect - values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") - "<Twilio.Chat.V2.BindingInstance #{values}>" - end - end end - end end - end -end \ No newline at end of file +end + +