lib/twilio-ruby/rest/messaging/v1/service/short_code.rb in twilio-ruby-5.77.0 vs lib/twilio-ruby/rest/messaging/v1/service/short_code.rb in twilio-ruby-6.0.0.pre.rc.1
- old
+ new
@@ -1,343 +1,366 @@
##
-# This code was generated by
-# \ / _ _ _| _ _
-# | (_)\/(_)(_|\/| |(/_ v1.0.0
-# / /
+# This code was generated by
+# ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
+# | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
+# | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
#
-# frozen_string_literal: true
+# Twilio - Messaging
+# 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 Messaging < 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 ShortCodeList < ListResource
- ##
- # Initialize the ShortCodeList
- # @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 resource
- # is associated with.
- # @return [ShortCodeList] ShortCodeList
- def initialize(version, service_sid: nil)
- super(version)
+ module REST
+ class Messaging < MessagingBase
+ class V1 < Version
+ class ServiceContext < InstanceContext
- # Path Solution
- @solution = {service_sid: service_sid}
- @uri = "/Services/#{@solution[:service_sid]}/ShortCodes"
- end
+ class ShortCodeList < ListResource
+ ##
+ # Initialize the ShortCodeList
+ # @param [Version] version Version that contains the resource
+ # @return [ShortCodeList] ShortCodeList
+ def initialize(version, service_sid: nil)
+ super(version)
+ # Path Solution
+ @solution = { service_sid: service_sid }
+ @uri = "/Services/#{@solution[:service_sid]}/ShortCodes"
+
+ end
+ ##
+ # Create the ShortCodeInstance
+ # @param [String] short_code_sid The SID of the ShortCode resource being added to the Service.
+ # @return [ShortCodeInstance] Created ShortCodeInstance
+ def create(
+ short_code_sid: nil
+ )
- ##
- # Create the ShortCodeInstance
- # @param [String] short_code_sid The SID of the ShortCode resource being added to
- # the Service.
- # @return [ShortCodeInstance] Created ShortCodeInstance
- def create(short_code_sid: nil)
- data = Twilio::Values.of({'ShortCodeSid' => short_code_sid, })
+ data = Twilio::Values.of({
+ 'ShortCodeSid' => short_code_sid,
+ })
- payload = @version.create('POST', @uri, data: data)
+ payload = @version.create('POST', @uri, data: data)
+ ShortCodeInstance.new(
+ @version,
+ payload,
+ service_sid: @solution[:service_sid],
+ )
+ end
- ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], )
- end
+
+ ##
+ # Lists ShortCodeInstance 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
- ##
- # Lists ShortCodeInstance 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 Instance 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)
- ##
- # Streams ShortCodeInstance 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], )
- page = self.page(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 ShortCodeInstance 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 ShortCodeInstance 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 ShortCodeInstance 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 ShortCodeInstance
+ def page(page_token: :unset, page_number: :unset, page_size: :unset)
+ params = Twilio::Values.of({
+
+ 'PageToken' => page_token,
+ 'Page' => page_number,
+ 'PageSize' => page_size,
+ })
- ##
- # Retrieve a single page of ShortCodeInstance 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 ShortCodeInstance
- 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: params)
- response = @version.page('GET', @uri, params: params)
+ ShortCodePage.new(@version, response, @solution)
+ end
- ShortCodePage.new(@version, response, @solution)
- end
+ ##
+ # Retrieve a single page of ShortCodeInstance records from the API.
+ # Request is executed immediately.
+ # @param [String] target_url API-generated URL for the requested results page
+ # @return [Page] Page of ShortCodeInstance
+ def get_page(target_url)
+ response = @version.domain.request(
+ 'GET',
+ target_url
+ )
+ ShortCodePage.new(@version, response, @solution)
+ end
+
- ##
- # Retrieve a single page of ShortCodeInstance records from the API.
- # Request is executed immediately.
- # @param [String] target_url API-generated URL for the requested results page
- # @return [Page] Page of ShortCodeInstance
- def get_page(target_url)
- response = @version.domain.request(
- 'GET',
- target_url
- )
- ShortCodePage.new(@version, response, @solution)
- end
- ##
- # Provide a user friendly representation
- def to_s
- '#<Twilio.Messaging.V1.ShortCodeList>'
- end
- end
+ # Provide a user friendly representation
+ def to_s
+ '#<Twilio.Messaging.V1.ShortCodeList>'
+ end
+ end
- ##
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
- class ShortCodePage < Page
- ##
- # Initialize the ShortCodePage
- # @param [Version] version Version that contains the resource
- # @param [Response] response Response from the API
- # @param [Hash] solution Path solution for the resource
- # @return [ShortCodePage] ShortCodePage
- def initialize(version, response, solution)
- super(version, response)
- # Path Solution
- @solution = solution
- end
+ ##
+ #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+ class ShortCodeContext < InstanceContext
+ ##
+ # Initialize the ShortCodeContext
+ # @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 resource from.
+ # @param [String] sid The SID of the ShortCode resource to fetch.
+ # @return [ShortCodeContext] ShortCodeContext
+ def initialize(version, service_sid, sid)
+ super(version)
- ##
- # Build an instance of ShortCodeInstance
- # @param [Hash] payload Payload response from the API
- # @return [ShortCodeInstance] ShortCodeInstance
- def get_instance(payload)
- ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], )
- end
+ # Path Solution
+ @solution = { service_sid: service_sid, sid: sid, }
+ @uri = "/Services/#{@solution[:service_sid]}/ShortCodes/#{@solution[:sid]}"
- ##
- # Provide a user friendly representation
- def to_s
- '<Twilio.Messaging.V1.ShortCodePage>'
- end
- end
+
+ end
+ ##
+ # Delete the ShortCodeInstance
+ # @return [Boolean] True if delete succeeds, false otherwise
+ def delete
- ##
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
- class ShortCodeContext < InstanceContext
- ##
- # Initialize the ShortCodeContext
- # @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
- # resource from.
- # @param [String] sid The SID of the ShortCode resource to fetch.
- # @return [ShortCodeContext] ShortCodeContext
- 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]}/ShortCodes/#{@solution[:sid]}"
- end
+ ##
+ # Fetch the ShortCodeInstance
+ # @return [ShortCodeInstance] Fetched ShortCodeInstance
+ def fetch
- ##
- # Delete the ShortCodeInstance
- # @return [Boolean] true if delete succeeds, false otherwise
- def delete
- @version.delete('DELETE', @uri)
- end
+ payload = @version.fetch('GET', @uri)
+ ShortCodeInstance.new(
+ @version,
+ payload,
+ service_sid: @solution[:service_sid],
+ sid: @solution[:sid],
+ )
+ end
- ##
- # Fetch the ShortCodeInstance
- # @return [ShortCodeInstance] Fetched ShortCodeInstance
- def fetch
- payload = @version.fetch('GET', @uri)
- ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
- end
+ ##
+ # Provide a user friendly representation
+ def to_s
+ context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+ "#<Twilio.Messaging.V1.ShortCodeContext #{context}>"
+ end
- ##
- # Provide a user friendly representation
- def to_s
- context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
- "#<Twilio.Messaging.V1.ShortCodeContext #{context}>"
- end
+ ##
+ # Provide a detailed, user friendly representation
+ def inspect
+ context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+ "#<Twilio.Messaging.V1.ShortCodeContext #{context}>"
+ end
+ end
- ##
- # Provide a detailed, user friendly representation
- def inspect
- context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
- "#<Twilio.Messaging.V1.ShortCodeContext #{context}>"
- end
- end
+ class ShortCodePage < Page
+ ##
+ # Initialize the ShortCodePage
+ # @param [Version] version Version that contains the resource
+ # @param [Response] response Response from the API
+ # @param [Hash] solution Path solution for the resource
+ # @return [ShortCodePage] ShortCodePage
+ def initialize(version, response, solution)
+ super(version, response)
- ##
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
- class ShortCodeInstance < InstanceResource
- ##
- # Initialize the ShortCodeInstance
- # @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 resource
- # is associated with.
- # @param [String] sid The SID of the ShortCode resource to fetch.
- # @return [ShortCodeInstance] ShortCodeInstance
- 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']),
- 'short_code' => payload['short_code'],
- 'country_code' => payload['country_code'],
- 'capabilities' => payload['capabilities'],
- 'url' => payload['url'],
- }
+ ##
+ # Build an instance of ShortCodeInstance
+ # @param [Hash] payload Payload response from the API
+ # @return [ShortCodeInstance] ShortCodeInstance
+ def get_instance(payload)
+ ShortCodeInstance.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.Messaging.V1.ShortCodePage>'
+ end
+ end
+ class ShortCodeInstance < InstanceResource
+ ##
+ # Initialize the ShortCodeInstance
+ # @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 ShortCode
+ # resource.
+ # @param [String] sid The SID of the Call resource to fetch.
+ # @return [ShortCodeInstance] ShortCodeInstance
+ 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']),
+ 'short_code' => payload['short_code'],
+ 'country_code' => payload['country_code'],
+ 'capabilities' => payload['capabilities'],
+ 'url' => payload['url'],
+ }
- ##
- # Generate an instance context for the instance, the context is capable of
- # performing various actions. All instance actions are proxied to the context
- # @return [ShortCodeContext] ShortCodeContext for this ShortCodeInstance
- def context
- unless @instance_context
- @instance_context = ShortCodeContext.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 [ShortCodeContext] CallContext for this CallInstance
+ def context
+ unless @instance_context
+ @instance_context = ShortCodeContext.new(@version , @params['service_sid'], @params['sid'])
+ end
+ @instance_context
+ end
+
+ ##
+ # @return [String] The unique string that we created to identify the ShortCode resource.
+ def sid
+ @properties['sid']
+ end
+
+ ##
+ # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ShortCode 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 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 [E.164](https://www.twilio.com/docs/glossary/what-e164) format of the short code.
+ def short_code
+ @properties['short_code']
+ end
+
+ ##
+ # @return [String] The 2-character [ISO Country Code](https://www.iso.org/iso-3166-country-codes.html) of the number.
+ def country_code
+ @properties['country_code']
+ end
+
+ ##
+ # @return [Array<String>] An array of values that describe whether the number can receive calls or messages. Can be: `SMS` and `MMS`.
+ def capabilities
+ @properties['capabilities']
+ end
+
+ ##
+ # @return [String] The absolute URL of the ShortCode resource.
+ def url
+ @properties['url']
+ end
+
+ ##
+ # Delete the ShortCodeInstance
+ # @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 resource is associated with
- def service_sid
- @properties['service_sid']
- end
+ ##
+ # Fetch the ShortCodeInstance
+ # @return [ShortCodeInstance] Fetched ShortCodeInstance
+ 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.Messaging.V1.ShortCodeInstance #{values}>"
+ end
- ##
- # @return [String] The E.164 format of the short code
- def short_code
- @properties['short_code']
- end
+ ##
+ # Provide a detailed, user friendly representation
+ def inspect
+ values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+ "<Twilio.Messaging.V1.ShortCodeInstance #{values}>"
+ end
+ end
- ##
- # @return [String] The 2-character ISO Country Code of the number
- def country_code
- @properties['country_code']
+ end
end
-
- ##
- # @return [Array[String]] An array of values that describe whether the number can receive calls or messages
- def capabilities
- @properties['capabilities']
- end
-
- ##
- # @return [String] The absolute URL of the ShortCode resource
- def url
- @properties['url']
- end
-
- ##
- # Delete the ShortCodeInstance
- # @return [Boolean] true if delete succeeds, false otherwise
- def delete
- context.delete
- end
-
- ##
- # Fetch the ShortCodeInstance
- # @return [ShortCodeInstance] Fetched ShortCodeInstance
- def fetch
- context.fetch
- end
-
- ##
- # Provide a user friendly representation
- def to_s
- values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
- "<Twilio.Messaging.V1.ShortCodeInstance #{values}>"
- end
-
- ##
- # Provide a detailed, user friendly representation
- def inspect
- values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
- "<Twilio.Messaging.V1.ShortCodeInstance #{values}>"
- end
- end
end
- end
end
- end
-end
\ No newline at end of file
+end
+
+