twilio-ruby 5.53.0 → 5.56.0

data/lib/twilio-ruby/rest/messaging/v1/external_campaign.rb

@@ -94,6 +94,7 @@ module Twilio
 
             # Marshaled Properties
             @properties = {
+                'sid' => payload['sid'],
                 'account_sid' => payload['account_sid'],
                 'campaign_id' => payload['campaign_id'],
                 'messaging_service_sid' => payload['messaging_service_sid'],
@@ -101,6 +102,12 @@ module Twilio
             }
           end
 
+          ##
+          # @return [String] The unique string that identifies a US A2P Compliance resource
+          def sid
+            @properties['sid']
+          end
+
           ##
           # @return [String] The SID of the Account that created the resource
           def account_sid

data/lib/twilio-ruby/rest/messaging/v1/service.rb

@@ -385,8 +385,14 @@ module Twilio
           ##
           # Access the us_app_to_person
           # @return [UsAppToPersonList]
-          # @return [UsAppToPersonContext]
-          def us_app_to_person
+          # @return [UsAppToPersonContext] if sid was passed.
+          def us_app_to_person(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return UsAppToPersonContext.new(@version, @solution[:sid], sid, )
+            end
+
             unless @us_app_to_person
               @us_app_to_person = UsAppToPersonList.new(@version, messaging_service_sid: @solution[:sid], )
             end

data/lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb

@@ -62,23 +62,83 @@ module Twilio
             end
 
             ##
-            # Delete the UsAppToPersonInstance
-            # @return [Boolean] true if delete succeeds, false otherwise
-            def delete
-               @version.delete('DELETE', @uri)
+            # Lists UsAppToPersonInstance 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
 
             ##
-            # Fetch the UsAppToPersonInstance
-            # @return [UsAppToPersonInstance] Fetched UsAppToPersonInstance
-            def fetch
-              payload = @version.fetch('GET', @uri)
+            # Streams UsAppToPersonInstance 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
 
-              UsAppToPersonInstance.new(
-                  @version,
-                  payload,
-                  messaging_service_sid: @solution[:messaging_service_sid],
+            ##
+            # When passed a block, yields UsAppToPersonInstance 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 UsAppToPersonInstance 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 UsAppToPersonInstance
+            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)
+
+              UsAppToPersonPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of UsAppToPersonInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of UsAppToPersonInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
               )
+              UsAppToPersonPage.new(@version, response, @solution)
             end
 
             ##
@@ -123,6 +183,62 @@ module Twilio
             end
           end
 
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class UsAppToPersonContext < InstanceContext
+            ##
+            # Initialize the UsAppToPersonContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] messaging_service_sid The SID of the {Messaging
+            #   Service}[https://www.twilio.com/docs/messaging/services/api] to fetch the
+            #   resource from.
+            # @param [String] sid The SID of the US A2P Compliance resource to fetch
+            #   `QE2c6890da8086d771620e9b13fadeba0b`.
+            # @return [UsAppToPersonContext] UsAppToPersonContext
+            def initialize(version, messaging_service_sid, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {messaging_service_sid: messaging_service_sid, sid: sid, }
+              @uri = "/Services/#{@solution[:messaging_service_sid]}/Compliance/Usa2p/#{@solution[:sid]}"
+            end
+
+            ##
+            # Delete the UsAppToPersonInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+               @version.delete('DELETE', @uri)
+            end
+
+            ##
+            # Fetch the UsAppToPersonInstance
+            # @return [UsAppToPersonInstance] Fetched UsAppToPersonInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              UsAppToPersonInstance.new(
+                  @version,
+                  payload,
+                  messaging_service_sid: @solution[:messaging_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.UsAppToPersonContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Messaging.V1.UsAppToPersonContext #{context}>"
+            end
+          end
+
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class UsAppToPersonInstance < InstanceResource
@@ -133,12 +249,15 @@ module Twilio
             # @param [String] messaging_service_sid The SID of the {Messaging
             #   Service}[https://www.twilio.com/docs/messaging/services/api] that the resource
             #   is associated with.
+            # @param [String] sid The SID of the US A2P Compliance resource to fetch
+            #   `QE2c6890da8086d771620e9b13fadeba0b`.
             # @return [UsAppToPersonInstance] UsAppToPersonInstance
-            def initialize(version, payload, messaging_service_sid: nil)
+            def initialize(version, payload, messaging_service_sid: nil, sid: nil)
               super(version)
 
               # Marshaled Properties
               @properties = {
+                  'sid' => payload['sid'],
                   'account_sid' => payload['account_sid'],
                   'brand_registration_sid' => payload['brand_registration_sid'],
                   'messaging_service_sid' => payload['messaging_service_sid'],
@@ -155,6 +274,31 @@ module Twilio
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                   'url' => payload['url'],
               }
+
+              # Context
+              @instance_context = nil
+              @params = {'messaging_service_sid' => messaging_service_sid, 'sid' => 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 [UsAppToPersonContext] UsAppToPersonContext for this UsAppToPersonInstance
+            def context
+              unless @instance_context
+                @instance_context = UsAppToPersonContext.new(
+                    @version,
+                    @params['messaging_service_sid'],
+                    @params['sid'],
+                )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The unique string that identifies a US A2P Compliance resource
+            def sid
+              @properties['sid']
             end
 
             ##
@@ -247,16 +391,32 @@ module Twilio
               @properties['url']
             end
 
+            ##
+            # Delete the UsAppToPersonInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              context.delete
+            end
+
+            ##
+            # Fetch the UsAppToPersonInstance
+            # @return [UsAppToPersonInstance] Fetched UsAppToPersonInstance
+            def fetch
+              context.fetch
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
-              "<Twilio.Messaging.V1.UsAppToPersonInstance>"
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Messaging.V1.UsAppToPersonInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
-              "<Twilio.Messaging.V1.UsAppToPersonInstance>"
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Messaging.V1.UsAppToPersonInstance #{values}>"
             end
           end
         end

data/lib/twilio-ruby/rest/supersim/v1/sim.rb

@@ -30,7 +30,7 @@ module Twilio
           # @param [String] iccid The
           #   {ICCID}[https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID] of the
           #   Super SIM to be added to your Account.
-          # @param [String] registration_code The 10 digit code required to claim the Super
+          # @param [String] registration_code The 10-digit code required to claim the Super
           #   SIM for your Account.
           # @return [SimInstance] Created SimInstance
           def create(iccid: nil, registration_code: nil)
@@ -200,6 +200,9 @@ module Twilio
             # Path Solution
             @solution = {sid: sid, }
             @uri = "/Sims/#{@solution[:sid]}"
+
+            # Dependents
+            @billing_periods = nil
           end
 
           ##
@@ -246,6 +249,18 @@ module Twilio
             SimInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
+          ##
+          # Access the billing_periods
+          # @return [BillingPeriodList]
+          # @return [BillingPeriodContext]
+          def billing_periods
+            unless @billing_periods
+              @billing_periods = BillingPeriodList.new(@version, sim_sid: @solution[:sid], )
+            end
+
+            @billing_periods
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
@@ -284,6 +299,7 @@ module Twilio
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                 'url' => payload['url'],
+                'links' => payload['links'],
             }
 
             # Context
@@ -356,6 +372,12 @@ module Twilio
             @properties['url']
           end
 
+          ##
+          # @return [String] The links
+          def links
+            @properties['links']
+          end
+
           ##
           # Fetch the SimInstance
           # @return [SimInstance] Fetched SimInstance
@@ -394,6 +416,13 @@ module Twilio
             )
           end
 
+          ##
+          # Access the billing_periods
+          # @return [billing_periods] billing_periods
+          def billing_periods
+            context.billing_periods
+          end
+
           ##
           # Provide a user friendly representation
           def to_s

data/lib/twilio-ruby/rest/supersim/v1/sim/billing_period.rb

@@ -0,0 +1,231 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Supersim < Domain
+      class V1 < Version
+        class SimContext < InstanceContext
+          class BillingPeriodList < ListResource
+            ##
+            # Initialize the BillingPeriodList
+            # @param [Version] version Version that contains the resource
+            # @param [String] sim_sid The SID of the Super SIM the Billing Period belongs to.
+            # @return [BillingPeriodList] BillingPeriodList
+            def initialize(version, sim_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {sim_sid: sim_sid}
+              @uri = "/Sims/#{@solution[:sim_sid]}/BillingPeriods"
+            end
+
+            ##
+            # Lists BillingPeriodInstance 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 BillingPeriodInstance 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 BillingPeriodInstance 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 BillingPeriodInstance 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 BillingPeriodInstance
+            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)
+
+              BillingPeriodPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of BillingPeriodInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of BillingPeriodInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              BillingPeriodPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Supersim.V1.BillingPeriodList>'
+            end
+          end
+
+          class BillingPeriodPage < Page
+            ##
+            # Initialize the BillingPeriodPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [BillingPeriodPage] BillingPeriodPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of BillingPeriodInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [BillingPeriodInstance] BillingPeriodInstance
+            def get_instance(payload)
+              BillingPeriodInstance.new(@version, payload, sim_sid: @solution[:sim_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Supersim.V1.BillingPeriodPage>'
+            end
+          end
+
+          class BillingPeriodInstance < InstanceResource
+            ##
+            # Initialize the BillingPeriodInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] sim_sid The SID of the Super SIM the Billing Period belongs to.
+            # @return [BillingPeriodInstance] BillingPeriodInstance
+            def initialize(version, payload, sim_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'account_sid' => payload['account_sid'],
+                  'sim_sid' => payload['sim_sid'],
+                  'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']),
+                  'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']),
+                  'period_type' => payload['period_type'],
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+              }
+            end
+
+            ##
+            # @return [String] The SID of the Billing Period
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] The SID of the Account the Super SIM belongs to
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] The SID of the Super SIM the Billing Period belongs to
+            def sim_sid
+              @properties['sim_sid']
+            end
+
+            ##
+            # @return [Time] The start time of the Billing Period
+            def start_time
+              @properties['start_time']
+            end
+
+            ##
+            # @return [Time] The end time of the Billing Period
+            def end_time
+              @properties['end_time']
+            end
+
+            ##
+            # @return [billing_period.BpType] The type of the Billing Period
+            def period_type
+              @properties['period_type']
+            end
+
+            ##
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+            def date_created
+              @properties['date_created']
+            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
+              "<Twilio.Supersim.V1.BillingPeriodInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Supersim.V1.BillingPeriodInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end