Class: Plivo::Resources::ComplianceApplicationsInterface
- Inherits:
-
Base::ResourceInterface
- Object
- Base::ResourceInterface
- Plivo::Resources::ComplianceApplicationsInterface
- Defined in:
- lib/plivo/resources/regulatory_compliance.rb
Constant Summary
Constants included from Utils
Instance Method Summary collapse
-
#create(compliance_requirement_id: nil, end_user_id: nil, alias_: nil, document_ids: nil, end_user_type: nil, country_iso2: nil, number_type: nil) ⇒ ComplianceApplication
Create a ComplianceApplication.
-
#delete(compliance_application_id) ⇒ Object
Delete a ComplianceApplication.
-
#get(compliance_application_id) ⇒ ComplianceApplication
Get a ComplianceApplication.
-
#initialize(client, resource_list_json = nil) ⇒ ComplianceApplicationsInterface
constructor
A new instance of ComplianceApplicationsInterface.
-
#list(options = nil) ⇒ Hash
List all ComplianceApplications.
-
#submit(compliance_application_id) ⇒ Object
Submit a ComplianceApplication.
-
#update(compliance_application_id, document_ids) ⇒ ComplianceApplication
Update a ComplianceApplication.
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) ⇒ ComplianceApplicationsInterface
Returns a new instance of ComplianceApplicationsInterface.
470 471 472 473 474 475 |
# File 'lib/plivo/resources/regulatory_compliance.rb', line 470 def initialize(client, resource_list_json = nil) @_name = 'ComplianceApplication' @_resource_type = ComplianceApplication @_identifier_string = 'compliance_application' super end |
Instance Method Details
#create(compliance_requirement_id: nil, end_user_id: nil, alias_: nil, document_ids: nil, end_user_type: nil, country_iso2: nil, number_type: nil) ⇒ ComplianceApplication
Create a ComplianceApplication
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 |
# File 'lib/plivo/resources/regulatory_compliance.rb', line 538 def create(compliance_requirement_id: nil, end_user_id: nil, alias_: nil, document_ids: nil, end_user_type: nil, country_iso2: nil, number_type: nil ) valid_param?(:compliance_requirement_id, compliance_requirement_id, [String, Symbol], false) valid_param?(:end_user_id, end_user_id, [String, Symbol], false) valid_param?(:alias_, alias_, [String, Symbol], false) valid_param?(:country_iso2, country_iso2, [String, Symbol], false) valid_param?(:number_type, number_type, [String, Symbol], false) valid_param?(:document_ids, document_ids, [Array], false) if !document_ids.nil? document_ids.each do |document_id| valid_param?(:document_id, document_id, [String, Symbol], true) end end if !end_user_type.nil? end_user_type = end_user_type.downcase valid_param?(:end_user_type, end_user_type, [String, Symbol], false, %w[business individual]) end params = { compliance_requirement_id: compliance_requirement_id, end_user_id: end_user_id, end_user_type: end_user_type, country_iso2: country_iso2, number_type: number_type, document_ids: document_ids, alias: alias_ }.delete_if { |key, value| value.nil? } perform_create(params, false) end |
#delete(compliance_application_id) ⇒ Object
Delete a ComplianceApplication
596 597 598 599 600 |
# File 'lib/plivo/resources/regulatory_compliance.rb', line 596 def delete(compliance_application_id) valid_param?(:compliance_application_id, compliance_application_id, [String, Symbol], true) ComplianceApplication.new(@_client, resource_id: compliance_application_id).delete end |
#get(compliance_application_id) ⇒ ComplianceApplication
Get a ComplianceApplication
480 481 482 483 |
# File 'lib/plivo/resources/regulatory_compliance.rb', line 480 def get(compliance_application_id) valid_param?(:compliance_application_id, compliance_application_id, [String, Symbol], true) perform_get(compliance_application_id) end |
#list(options = nil) ⇒ Hash
List all ComplianceApplications
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
# File 'lib/plivo/resources/regulatory_compliance.rb', line 490 def list( = nil) return perform_list if .nil? valid_param?(:options, , Hash, true) params = {} params_expected = %i[ end_user_id country_iso2 number_type status ] params_expected.each do |param| if .key?(param) && valid_param?(param, [param], [String, Symbol], false) params[param] = [param] end end if .key?(:end_user_type) && valid_param?(:end_user_type, [:end_user_type].capitalize, [String, Symbol], false, %w[Business Individual]) params[:end_user_type] = [:end_user_type].capitalize end if .key?(:alias) && valid_param?(:alias, [:alias],[String, Symbol], false) params[:alias] = [:alias] end %i[offset limit].each do |param| if .key?(param) && valid_param?(param, [param], [Integer], true) params[param] = [param] end end raise_invalid_request("Offset can't be negative") if .key?(:offset) && [:offset] < 0 if .key?(:limit) && ([:limit] > 20 || [:limit] <= 0) raise_invalid_request('The maximum number of results that can be '\ "fetched is 20. limit can't be more than 20 or less than 1") end perform_list(params) end |
#submit(compliance_application_id) ⇒ Object
Submit a ComplianceApplication
604 605 606 607 |
# File 'lib/plivo/resources/regulatory_compliance.rb', line 604 def submit(compliance_application_id) valid_param?(:compliance_application_id, compliance_application_id, [String, Symbol], true) perform_submit(compliance_application_id) end |
#update(compliance_application_id, document_ids) ⇒ ComplianceApplication
Update a ComplianceApplication
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 |
# File 'lib/plivo/resources/regulatory_compliance.rb', line 578 def update(compliance_application_id, document_ids) valid_param?(:compliance_application_id, compliance_application_id, [String, Symbol], true) valid_param?(:document_ids, document_ids, [Array], true) document_ids.each do |document_id| valid_param?(:document_id, document_id, [String, Symbol], true) end params = { compliance_application_id: compliance_application_id, document_ids: document_ids } ComplianceApplication.new(@_client, resource_id: compliance_application_id).update(params) end |