Class: Plivo::Resources::ComplianceRequirementsInterface

Inherits:
Base::ResourceInterface show all
Defined in:
lib/plivo/resources/regulatory_compliance.rb

Constant Summary

Constants included from Utils

Utils::TYPE_WHITELIST

Instance Method Summary collapse

Methods included from Utils

GetSortedQueryParamString?, compute_signatureV3?, expected_type?, expected_value?, generate_url?, getMapFromQueryString?, is_one_among_string_url?, multi_valid_param?, raise_invalid_request, valid_account?, valid_date_format?, valid_mainaccount?, valid_multiple_destination_integers?, valid_multiple_destination_nos?, valid_param?, valid_range?, valid_signature?, valid_signatureV3?, valid_subaccount?, valid_url?

Constructor Details

#initialize(client, resource_list_json = nil) ⇒ ComplianceRequirementsInterface

Returns a new instance of ComplianceRequirementsInterface.



394
395
396
397
398
399
 
# File 'lib/plivo/resources/regulatory_compliance.rb', line 394

def initialize(client, resource_list_json = nil)
  @_name = 'ComplianceRequirement'
  @_resource_type = ComplianceRequirement
  @_identifier_string = 'compliance_requirement'
  super
end

Instance Method Details

#get(compliance_requirement_id) ⇒ ComplianceRequirement

Get a ComplianceRequirement

Parameters:

  • compliance_requirement_id (String)

Returns:



404
405
406
407
 
# File 'lib/plivo/resources/regulatory_compliance.rb', line 404

def get(compliance_requirement_id)
  valid_param?(:compliance_requirement_id, compliance_requirement_id, [String, Symbol], true)
  perform_get(compliance_requirement_id)
end

#list(options = nil) ⇒ Object

List all ComplianceRequirements A combination of country_iso2, number_type, end_user_type OR phone_number, end_user_type can be used to fetch compliance requirements.

Parameters:

  • options (Hash) (defaults to: nil) —

    a customizable set of options

Options Hash (options):

  • :country_iso2 (String)
  • :number_type (String)
  • :phone_number (String)
  • :end_user_type (String) 


416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/plivo/resources/regulatory_compliance.rb', line 416

def list(options = nil)
  valid_param?(:options, options, Hash, true)

  params = {}
  params_expected = %i[ country_iso2 number_type phone_number ]
  params_expected.each do |param|
    if options.key?(param) &&
       valid_param?(param, options[param], [String, Symbol], false)
      params[param] = options[param]
    end
  end

  if options.key?(:end_user_type) &&
    valid_param?(:end_user_type, options[:end_user_type].capitalize, [String, Symbol], false, %w[Business Individual])
    params[:end_user_type] = options[:end_user_type].capitalize
  end

  perform_get_without_identifier(params)
end