Class: Twilio::REST::Numbers::V2::RegulatoryComplianceList::RegulationContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ RegulationContext

Initialize the RegulationContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The unique string that identifies the Regulation resource.



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb', line 193

def initialize(version, sid)
    super(version)
    

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/RegulatoryCompliance/Regulations/#{@solution[:sid]}"

    
end

Instance Method Details

#fetch(include_constraints: :unset) ⇒ RegulationInstance

Fetch the RegulationInstance

Parameters:

  • include_constraints (Boolean) (defaults to: :unset) —

    A boolean parameter indicating whether to include constraints or not for supporting end user, documents and their fields

Returns:



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb', line 207

def fetch(
    include_constraints: :unset
)

    params = Twilio::Values.of({
        'IncludeConstraints' => include_constraints,
    })
    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, params: params, headers: headers)
    RegulationInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#fetch_with_metadata(include_constraints: :unset) ⇒ RegulationInstance

Fetch the RegulationInstanceMetadata

Parameters:

  • include_constraints (Boolean) (defaults to: :unset) —

    A boolean parameter indicating whether to include constraints or not for supporting end user, documents and their fields

Returns:



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb', line 232

def fetch_with_metadata(
  include_constraints: :unset
)

    params = Twilio::Values.of({
        'IncludeConstraints' => include_constraints,
    })
    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
    regulation_instance = RegulationInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    RegulationInstanceMetadata.new(
        @version,
        regulation_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



269
270
271
272
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb', line 269

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Numbers.V2.RegulationContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



262
263
264
265
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb', line 262

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Numbers.V2.RegulationContext #{context}>"
end