twilio-ruby 6.8.0 → 7.10.7

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

@@ -0,0 +1,231 @@
+##
+#    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 BulkConsentsList < ListResource
+                
+                    ##
+                    # Initialize the BulkConsentsList
+                    # @param [Version] version Version that contains the resource
+                    # @return [BulkConsentsList] BulkConsentsList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Consents/Bulk"
+                        
+                    end
+                    ##
+                    # Create the BulkConsentsInstance
+                    # @param [Array[Hash]] items This is a list of objects that describes a contact's opt-in status. Each object contains the following fields: `contact_id`, which must be a string representing phone number in [E.164 format](https://www.twilio.com/docs/glossary/what-e164); `correlation_id`, a unique 32-character UUID used to uniquely map the request item with the response item; `sender_id`, which can be either a valid messaging service SID or a from phone number; `status`, a string representing the consent status. Can be one of [`opt-in`, `opt-out`]; `source`, a string indicating the medium through which the consent was collected. Can be one of [`website`, `offline`, `opt-in-message`, `opt-out-message`, `others`]; `date_of_consent`, an optional datetime string field in ISO-8601 format that captures the exact date and time when the user gave or revoked consent. If not provided, it will be empty.
+                    # @return [BulkConsentsInstance] Created BulkConsentsInstance
+                    def create(
+                      items: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Items' => Twilio.serialize_list(items) { |e| Twilio.serialize_object(e) },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
+                        BulkConsentsInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the BulkConsentsInstanceMetadata
+                    # @param [Array[Hash]] items This is a list of objects that describes a contact's opt-in status. Each object contains the following fields: `contact_id`, which must be a string representing phone number in [E.164 format](https://www.twilio.com/docs/glossary/what-e164); `correlation_id`, a unique 32-character UUID used to uniquely map the request item with the response item; `sender_id`, which can be either a valid messaging service SID or a from phone number; `status`, a string representing the consent status. Can be one of [`opt-in`, `opt-out`]; `source`, a string indicating the medium through which the consent was collected. Can be one of [`website`, `offline`, `opt-in-message`, `opt-out-message`, `others`]; `date_of_consent`, an optional datetime string field in ISO-8601 format that captures the exact date and time when the user gave or revoked consent. If not provided, it will be empty.
+                    # @return [BulkConsentsInstance] Created BulkConsentsInstance
+                    def create_with_metadata(
+                      items: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Items' => Twilio.serialize_list(items) { |e| Twilio.serialize_object(e) },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        bulk_consents_instance = BulkConsentsInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        BulkConsentsInstanceMetadata.new(
+                            @version,
+                            bulk_consents_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Accounts.V1.BulkConsentsList>'
+                    end
+                end
+
+                class BulkConsentsPage < Page
+                    ##
+                    # Initialize the BulkConsentsPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [BulkConsentsPage] BulkConsentsPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of BulkConsentsInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [BulkConsentsInstance] BulkConsentsInstance
+                    def get_instance(payload)
+                        BulkConsentsInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Accounts.V1.BulkConsentsPage>'
+                    end
+                end
+
+                class BulkConsentsPageMetadata < PageMetadata
+                    attr_reader :bulk_consents_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @bulk_consents_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @bulk_consents_page << BulkConsentsListResponse.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
+                        @bulk_consents_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Accounts::V1PageMetadata>';
+                    end
+                end
+                class BulkConsentsListResponse < InstanceListResource
+
+                    # @param [Array<BulkConsentsInstance>] 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
+                      @bulk_consents = data_list.map do |data|
+                        BulkConsentsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def bulk_consents
+                        @bulk_consents
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class BulkConsentsInstance < InstanceResource
+                    ##
+                    # Initialize the BulkConsentsInstance
+                    # @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 BulkConsents
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [BulkConsentsInstance] BulkConsentsInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'items' => payload['items'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [Hash] A list of objects where each object represents the result of processing a `correlation_id`. Each object contains the following fields: `correlation_id`, a unique 32-character UUID that maps the response to the original request; `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 items
+                        @properties['items']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Accounts.V1.BulkConsentsInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Accounts.V1.BulkConsentsInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,231 @@
+##
+#    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 BulkContactsList < ListResource
+                
+                    ##
+                    # Initialize the BulkContactsList
+                    # @param [Version] version Version that contains the resource
+                    # @return [BulkContactsList] BulkContactsList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Contacts/Bulk"
+                        
+                    end
+                    ##
+                    # Create the BulkContactsInstance
+                    # @param [Array[Hash]] items A list of objects where each object represents a contact's details. Each object includes the following fields: `contact_id`, which must be a string representing phone number in [E.164 format](https://www.twilio.com/docs/glossary/what-e164); `correlation_id`, a unique 32-character UUID that maps the response to the original request; `country_iso_code`, a string representing the country using the ISO format (e.g., US for the United States); and `zip_code`, a string representing the postal code.
+                    # @return [BulkContactsInstance] Created BulkContactsInstance
+                    def create(
+                      items: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Items' => Twilio.serialize_list(items) { |e| Twilio.serialize_object(e) },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
+                        BulkContactsInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the BulkContactsInstanceMetadata
+                    # @param [Array[Hash]] items A list of objects where each object represents a contact's details. Each object includes the following fields: `contact_id`, which must be a string representing phone number in [E.164 format](https://www.twilio.com/docs/glossary/what-e164); `correlation_id`, a unique 32-character UUID that maps the response to the original request; `country_iso_code`, a string representing the country using the ISO format (e.g., US for the United States); and `zip_code`, a string representing the postal code.
+                    # @return [BulkContactsInstance] Created BulkContactsInstance
+                    def create_with_metadata(
+                      items: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Items' => Twilio.serialize_list(items) { |e| Twilio.serialize_object(e) },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        bulk_contacts_instance = BulkContactsInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        BulkContactsInstanceMetadata.new(
+                            @version,
+                            bulk_contacts_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Accounts.V1.BulkContactsList>'
+                    end
+                end
+
+                class BulkContactsPage < Page
+                    ##
+                    # Initialize the BulkContactsPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [BulkContactsPage] BulkContactsPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of BulkContactsInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [BulkContactsInstance] BulkContactsInstance
+                    def get_instance(payload)
+                        BulkContactsInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Accounts.V1.BulkContactsPage>'
+                    end
+                end
+
+                class BulkContactsPageMetadata < PageMetadata
+                    attr_reader :bulk_contacts_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @bulk_contacts_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @bulk_contacts_page << BulkContactsListResponse.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
+                        @bulk_contacts_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Accounts::V1PageMetadata>';
+                    end
+                end
+                class BulkContactsListResponse < InstanceListResource
+
+                    # @param [Array<BulkContactsInstance>] 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
+                      @bulk_contacts = data_list.map do |data|
+                        BulkContactsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def bulk_contacts
+                        @bulk_contacts
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class BulkContactsInstance < InstanceResource
+                    ##
+                    # Initialize the BulkContactsInstance
+                    # @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 BulkContacts
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [BulkContactsInstance] BulkContactsInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'items' => payload['items'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [Hash] A list of objects where each object represents the result of processing a `correlation_id`. Each object contains the following fields: `correlation_id`, a unique 32-character UUID that maps the response to the original request; `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 items
+                        @properties['items']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Accounts.V1.BulkContactsInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Accounts.V1.BulkContactsInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end