twilio-ruby 5.74.0 → 7.10.1

data/lib/twilio-ruby/rest/frontline_api/v1.rb

@@ -1,45 +1,49 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Frontline
+#    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.
 #
-# frozen_string_literal: true
 
 module Twilio
-  module REST
-    class FrontlineApi
-      class V1 < Version
-        ##
-        # Initialize the V1 version of FrontlineApi
-        def initialize(domain)
-          super
-          @version = 'v1'
-          @users = nil
-        end
-
-        ##
-        # @param [String] sid The SID of the User resource to fetch. This value can be
-        #   either the `sid` or the `identity` of the User resource to fetch.
-        # @return [Twilio::REST::Frontline_api::V1::UserContext] if sid was passed.
-        # @return [Twilio::REST::Frontline_api::V1::UserList]
-        def users(sid=:unset)
-          if sid.nil?
-              raise ArgumentError, 'sid cannot be nil'
-          end
-          if sid == :unset
-              @users ||= UserList.new self
-          else
-              UserContext.new(self, sid)
-          end
-        end
+    module REST
+        class FrontlineApi
+            class V1 < Version
+                ##
+                # Initialize the V1 version of FrontlineApi
+                def initialize(domain)
+                    super
+                    @version = 'v1'
+                    @users = nil
+                end
 
-        ##
-        # Provide a user friendly representation
-        def to_s
-          '<Twilio::REST::FrontlineApi::V1>'
+                ##
+                # @param [String] sid The SID of the User resource to fetch. This value can be either the `sid` or the `identity` of the User resource to fetch.
+                # @return [Twilio::REST::FrontlineApi::V1::UserContext] if sid was passed.
+                # @return [Twilio::REST::FrontlineApi::V1::UserList]
+                def users(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+                    if sid == :unset
+                        @users ||= UserList.new self
+                    else
+                        UserContext.new(self, sid)
+                    end
+                end
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::FrontlineApi::V1>';
+                end
+            end
         end
-      end
     end
-  end
-end
+end

data/lib/twilio-ruby/rest/frontline_api.rb

@@ -1,47 +1,15 @@
-##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
-#
-# frozen_string_literal: true
-
 module Twilio
   module REST
-    class FrontlineApi < Domain
-      ##
-      # Initialize the FrontlineApi Domain
-      def initialize(twilio)
-        super
-
-        @base_url = 'https://frontline-api.twilio.com'
-        @host = 'frontline-api.twilio.com'
-        @port = 443
-
-        # Versions
-        @v1 = nil
-      end
-
-      ##
-      # Version v1 of frontline_api
-      def v1
-        @v1 ||= V1.new self
-      end
-
+    class FrontlineApi < FrontlineApiBase
       ##
       # @param [String] sid The unique string that we created to identify the User
       #   resource.
       # @return [Twilio::REST::Frontline_api::V1::UserInstance] if sid was passed.
       # @return [Twilio::REST::Frontline_api::V1::UserList]
       def users(sid=:unset)
+        warn "users is deprecated. Use v1.users instead."
         self.v1.users(sid)
       end
-
-      ##
-      # Provide a user friendly representation
-      def to_s
-        '#<Twilio::REST::FrontlineApi>'
-      end
     end
   end
 end

data/lib/twilio-ruby/rest/frontline_api_base.rb

@@ -0,0 +1,38 @@
+##
+ # This code was generated by
+ # ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ #  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ #  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ #
+ # NOTE: This class is auto generated by OpenAPI Generator.
+ # https://openapi-generator.tech
+ # Do not edit the class manually.
+# frozen_string_literal: true
+module Twilio
+  module REST
+    class FrontlineApiBase < Domain
+      ##
+      # Initialize frontlineApi domain
+      #
+      # @param twilio - The twilio client
+      #
+      def initialize(twilio)
+        super(twilio)
+        @base_url =  "https://frontline-api.twilio.com"
+        @host = "frontline-api.twilio.com"
+        @port = 443
+        @v1 = nil
+      end
+
+      def v1
+        @v1 ||= FrontlineApi::V1.new self
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '<Twilio::REST::FrontlineApi::V1>';
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/iam/v1/api_key.rb

@@ -0,0 +1,471 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Iam
+#    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 Iam < IamBase
+            class V1 < Version
+                class ApiKeyList < ListResource
+                
+                    ##
+                    # Initialize the ApiKeyList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ApiKeyList] ApiKeyList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Iam.V1.ApiKeyList>'
+                    end
+                end
+
+
+                class ApiKeyContext < InstanceContext
+                    ##
+                    # Initialize the ApiKeyContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] sid The Twilio-provided string that uniquely identifies the Key resource to update.
+                    # @return [ApiKeyContext] ApiKeyContext
+                    def initialize(version, sid)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = { sid: sid,  }
+                        @uri = "/Keys/#{@solution[:sid]}"
+
+                        
+                    end
+                    ##
+                    # Delete the ApiKeyInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+
+                        @version.delete('DELETE', @uri, headers: headers)
+                    end
+
+                    ##
+                    # Delete the ApiKeyInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          apiKey_instance = ApiKeyInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          ApiKeyInstanceMetadata.new(@version, apiKey_instance, response.headers, response.status_code)
+                    end
+
+                    ##
+                    # Fetch the ApiKeyInstance
+                    # @return [ApiKeyInstance] Fetched ApiKeyInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        ApiKeyInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Fetch the ApiKeyInstanceMetadata
+                    # @return [ApiKeyInstance] Fetched ApiKeyInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        api_key_instance = ApiKeyInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        ApiKeyInstanceMetadata.new(
+                            @version,
+                            api_key_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Update the ApiKeyInstance
+                    # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
+                    # @param [Object] policy The \\\\`Policy\\\\` object is a collection that specifies the allowed Twilio permissions for the restricted key. For more information on the permissions available with restricted API keys, refer to the [Twilio documentation](https://www.twilio.com/docs/iam/api-keys/restricted-api-keys#permissions-available-with-restricted-api-keys).
+                    # @return [ApiKeyInstance] Updated ApiKeyInstance
+                    def update(
+                        friendly_name: :unset, 
+                        policy: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'Policy' => Twilio.serialize_object(policy),
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
+                        ApiKeyInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Update the ApiKeyInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
+                    # @param [Object] policy The \\\\`Policy\\\\` object is a collection that specifies the allowed Twilio permissions for the restricted key. For more information on the permissions available with restricted API keys, refer to the [Twilio documentation](https://www.twilio.com/docs/iam/api-keys/restricted-api-keys#permissions-available-with-restricted-api-keys).
+                    # @return [ApiKeyInstance] Updated ApiKeyInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      policy: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'Policy' => Twilio.serialize_object(policy),
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        api_key_instance = ApiKeyInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        ApiKeyInstanceMetadata.new(
+                            @version,
+                            api_key_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Iam.V1.ApiKeyContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Iam.V1.ApiKeyContext #{context}>"
+                    end
+                end
+
+                class ApiKeyInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ApiKeyInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ApiKeyInstance] api_key_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [ApiKeyInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, api_key_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @api_key_instance = api_key_instance
+                    end
+
+                    def api_key
+                        @api_key_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ApiKeyInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ApiKeyListResponse < InstanceListResource
+                    # @param [Array<ApiKeyInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @api_key_instance = payload.body[key].map do |data|
+                        ApiKeyInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def api_key_instance
+                          @instance
+                      end
+                  end
+
+                class ApiKeyPage < Page
+                    ##
+                    # Initialize the ApiKeyPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ApiKeyPage] ApiKeyPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ApiKeyInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ApiKeyInstance] ApiKeyInstance
+                    def get_instance(payload)
+                        ApiKeyInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Iam.V1.ApiKeyPage>'
+                    end
+                end
+
+                class ApiKeyPageMetadata < PageMetadata
+                    attr_reader :api_key_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @api_key_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @api_key_page << ApiKeyListResponse.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
+                        @api_key_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Iam::V1PageMetadata>';
+                    end
+                end
+                class ApiKeyListResponse < InstanceListResource
+
+                    # @param [Array<ApiKeyInstance>] 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
+                      @api_key = data_list.map do |data|
+                        ApiKeyInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def api_key
+                        @api_key
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class ApiKeyInstance < InstanceResource
+                    ##
+                    # Initialize the ApiKeyInstance
+                    # @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 ApiKey
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ApiKeyInstance] ApiKeyInstance
+                    def initialize(version, payload , sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'friendly_name' => payload['friendly_name'],
+                            'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
+                            'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                            'policy' => payload['policy'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { '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 [ApiKeyContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = ApiKeyContext.new(@version , @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that we created to identify the Key resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The string that you assigned to describe the resource.
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # @return [Hash] The \\`Policy\\` object is a collection that specifies the allowed Twilio permissions for the restricted key. For more information on the permissions available with restricted API keys, refer to the [Twilio documentation](https://www.twilio.com/docs/iam/api-keys/restricted-api-keys#permissions-available-with-restricted-api-keys).
+                    def policy
+                        @properties['policy']
+                    end
+                    
+                    ##
+                    # Delete the ApiKeyInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the ApiKeyInstance
+                    # @return [ApiKeyInstance] Fetched ApiKeyInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Update the ApiKeyInstance
+                    # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
+                    # @param [Object] policy The \\\\`Policy\\\\` object is a collection that specifies the allowed Twilio permissions for the restricted key. For more information on the permissions available with restricted API keys, refer to the [Twilio documentation](https://www.twilio.com/docs/iam/api-keys/restricted-api-keys#permissions-available-with-restricted-api-keys).
+                    # @return [ApiKeyInstance] Updated ApiKeyInstance
+                    def update(
+                        friendly_name: :unset, 
+                        policy: :unset
+                    )
+
+                        context.update(
+                            friendly_name: friendly_name, 
+                            policy: policy, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Iam.V1.ApiKeyInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Iam.V1.ApiKeyInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end