Class: Twilio::REST::Accounts::V1::BulkConsentsList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/accounts/v1/bulk_consents.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ BulkConsentsList

Initialize the BulkConsentsList

Parameters:

  • version (Version) —

    Version that contains the resource



26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/accounts/v1/bulk_consents.rb', line 26

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/Consents/Bulk"
    
end

Instance Method Details

#create(items: nil) ⇒ BulkConsentsInstance

Create the BulkConsentsInstance

Parameters:

  • items (Array[Hash]) (defaults to: nil) —

    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](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.

Returns:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/twilio-ruby/rest/accounts/v1/bulk_consents.rb', line 38

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_with_metadata(items: nil) ⇒ BulkConsentsInstance

Create the BulkConsentsInstanceMetadata

Parameters:

  • items (Array[Hash]) (defaults to: nil) —

    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](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.

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/twilio-ruby/rest/accounts/v1/bulk_consents.rb', line 63

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

#to_s ⇒ Object

Provide a user friendly representation



94
95
96
 
# File 'lib/twilio-ruby/rest/accounts/v1/bulk_consents.rb', line 94

def to_s
    '#<Twilio.Accounts.V1.BulkConsentsList>'
end