twilio-ruby 7.4.4 → 7.10.4

data/lib/twilio-ruby/rest/accounts/v1/messaging_geopermissions.rb

@@ -0,0 +1,285 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Accounts
+#    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 Accounts < AccountsBase
+            class V1 < Version
+                class MessagingGeopermissionsList < ListResource
+                
+                    ##
+                    # Initialize the MessagingGeopermissionsList
+                    # @param [Version] version Version that contains the resource
+                    # @return [MessagingGeopermissionsList] MessagingGeopermissionsList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Messaging/GeoPermissions"
+                        
+                    end
+                    ##
+                    # Fetch the MessagingGeopermissionsInstance
+                    # @param [String] country_code The country code to filter the geo permissions. If provided, only the geo permission for the specified country will be returned.
+                    # @return [MessagingGeopermissionsInstance] Fetched MessagingGeopermissionsInstance
+                    def fetch(
+                        country_code: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'CountryCode' => country_code,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
+                        MessagingGeopermissionsInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Fetch the MessagingGeopermissionsInstanceMetadata
+                    # @param [String] country_code The country code to filter the geo permissions. If provided, only the geo permission for the specified country will be returned.
+                    # @return [MessagingGeopermissionsInstance] Fetched MessagingGeopermissionsInstance
+                    def fetch_with_metadata(
+                      country_code: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'CountryCode' => country_code,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        messaging_geopermissions_instance = MessagingGeopermissionsInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        MessagingGeopermissionsInstanceMetadata.new(
+                            @version,
+                            messaging_geopermissions_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Update the MessagingGeopermissionsInstance
+                    # @param [Array[Hash]] permissions A list of objects where each object represents the Geo Permission to be updated. Each object contains the following fields: `country_code`, unique code for each country of Geo Permission; `type`, permission type of the Geo Permission i.e. country; `enabled`, configure true for enabling the Geo Permission, false for disabling the Geo Permission.
+                    # @return [MessagingGeopermissionsInstance] Updated MessagingGeopermissionsInstance
+                    def update(
+                        permissions: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Permissions' => Twilio.serialize_list(permissions) { |e| Twilio.serialize_object(e) },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('PATCH', @uri, data: data, headers: headers)
+                        MessagingGeopermissionsInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Update the MessagingGeopermissionsInstanceMetadata
+                    # @param [Array[Hash]] permissions A list of objects where each object represents the Geo Permission to be updated. Each object contains the following fields: `country_code`, unique code for each country of Geo Permission; `type`, permission type of the Geo Permission i.e. country; `enabled`, configure true for enabling the Geo Permission, false for disabling the Geo Permission.
+                    # @return [MessagingGeopermissionsInstance] Updated MessagingGeopermissionsInstance
+                    def update_with_metadata(
+                      permissions: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Permissions' => Twilio.serialize_list(permissions) { |e| Twilio.serialize_object(e) },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('PATCH', @uri, data: data, headers: headers)
+                        messaging_geopermissions_instance = MessagingGeopermissionsInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        MessagingGeopermissionsInstanceMetadata.new(
+                            @version,
+                            messaging_geopermissions_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Accounts.V1.MessagingGeopermissionsList>'
+                    end
+                end
+
+                class MessagingGeopermissionsPage < Page
+                    ##
+                    # Initialize the MessagingGeopermissionsPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [MessagingGeopermissionsPage] MessagingGeopermissionsPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of MessagingGeopermissionsInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [MessagingGeopermissionsInstance] MessagingGeopermissionsInstance
+                    def get_instance(payload)
+                        MessagingGeopermissionsInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Accounts.V1.MessagingGeopermissionsPage>'
+                    end
+                end
+
+                class MessagingGeopermissionsPageMetadata < PageMetadata
+                    attr_reader :messaging_geopermissions_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @messaging_geopermissions_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @messaging_geopermissions_page << MessagingGeopermissionsListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @messaging_geopermissions_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Accounts::V1PageMetadata>';
+                    end
+                end
+                class MessagingGeopermissionsListResponse < InstanceListResource
+
+                    # @param [Array<MessagingGeopermissionsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @messaging_geopermissions = data_list.map do |data|
+                        MessagingGeopermissionsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def messaging_geopermissions
+                        @messaging_geopermissions
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class MessagingGeopermissionsInstance < InstanceResource
+                    ##
+                    # Initialize the MessagingGeopermissionsInstance
+                    # @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 MessagingGeopermissions
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [MessagingGeopermissionsInstance] MessagingGeopermissionsInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'permissions' => payload['permissions'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [Hash] A list of objects where each object represents the result of processing a messaging Geo Permission. Each object contains the following fields: `country_code`, the country code of the country for which the permission was updated; `type`, the type of the permission i.e. country; `enabled`, true if the permission is enabled else false; `error_code`, an integer where 0 indicates success and any non-zero value represents an error; and `error_messages`, an array of strings describing specific validation errors encountered. If the request is successful, the error_messages array will be empty.
+                    def permissions
+                        @properties['permissions']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Accounts.V1.MessagingGeopermissionsInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Accounts.V1.MessagingGeopermissionsInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/accounts/v1/safelist.rb

@@ -25,6 +25,7 @@ module Twilio
                     # @return [SafelistList] SafelistList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/SafeList/Numbers"
@@ -32,7 +33,7 @@ module Twilio
                     end
                     ##
                     # Create the SafelistInstance
-                    # @param [String] phone_number The phone number to be added in SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
+                    # @param [String] phone_number The phone number or phone number 1k prefix to be added in SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
                     # @return [SafelistInstance] Created SafelistInstance
                     def create(
                         phone_number: nil
@@ -55,9 +56,40 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the SafelistInstanceMetadata
+                    # @param [String] phone_number The phone number or phone number 1k prefix to be added in SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
+                    # @return [SafelistInstance] Created SafelistInstance
+                    def create_with_metadata(
+                      phone_number: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'PhoneNumber' => phone_number,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        safelist_instance = SafelistInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        SafelistInstanceMetadata.new(
+                            @version,
+                            safelist_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Delete the SafelistInstance
-                    # @param [String] phone_number The phone number to be removed from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
+                    # @param [String] phone_number The phone number or phone number 1k prefix to be removed from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete(
                         phone_number: :unset
@@ -70,12 +102,38 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, params: params, headers: headers)
                     end
 
+                    ##
+                    # Delete the SafelistInstanceMetadata
+                    # @param [String] phone_number The phone number or phone number 1k prefix to be removed from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata(
+                      phone_number: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'PhoneNumber' => phone_number,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, params: params, headers: headers)
+                          safelist_instance = SafelistInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          SafelistInstanceMetadata.new(@version, safelist_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the SafelistInstance
-                    # @param [String] phone_number The phone number to be fetched from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
+                    # @param [String] phone_number The phone number or phone number 1k prefix to be fetched from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
                     # @return [SafelistInstance] Fetched SafelistInstance
                     def fetch(
                         phone_number: :unset
@@ -97,6 +155,36 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the SafelistInstanceMetadata
+                    # @param [String] phone_number The phone number or phone number 1k prefix to be fetched from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
+                    # @return [SafelistInstance] Fetched SafelistInstance
+                    def fetch_with_metadata(
+                      phone_number: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'PhoneNumber' => phone_number,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        safelist_instance = SafelistInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        SafelistInstanceMetadata.new(
+                            @version,
+                            safelist_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
 
 
@@ -115,6 +203,7 @@ module Twilio
                     # @return [SafelistPage] SafelistPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -134,6 +223,66 @@ module Twilio
                         '<Twilio.Accounts.V1.SafelistPage>'
                     end
                 end
+
+                class SafelistPageMetadata < PageMetadata
+                    attr_reader :safelist_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @safelist_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @safelist_page << SafelistListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @safelist_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Accounts::V1PageMetadata>';
+                    end
+                end
+                class SafelistListResponse < InstanceListResource
+
+                    # @param [Array<SafelistInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @safelist = data_list.map do |data|
+                        SafelistInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def safelist
+                        @safelist
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class SafelistInstance < InstanceResource
                     ##
                     # Initialize the SafelistInstance
@@ -147,6 +296,7 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -162,7 +312,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The phone number in SafeList.
+                    # @return [String] The phone number or phone number 1k prefix in SafeList.
                     def phone_number
                         @properties['phone_number']
                     end