Class: VoiceML::SipDomainsResource

Inherits:
BaseResource show all
Defined in:
lib/voiceml/resources/sip.rb

Overview

/SIP/Domains plus the four mapping endpoints.

Constant Summary collapse

DOMAIN_FIELDS = 
{
  'FriendlyName' => :friendly_name,
  'VoiceUrl' => :voice_url,
  'VoiceMethod' => :voice_method,
  'VoiceFallbackUrl' => :voice_fallback_url,
  'VoiceFallbackMethod' => :voice_fallback_method,
  'VoiceStatusCallbackUrl' => :voice_status_callback_url,
  'VoiceStatusCallbackMethod' => :voice_status_callback_method,
  'SipRegistration' => :sip_registration,
  'Secure' => :secure,
  'EmergencyCallingEnabled' => :emergency_calling_enabled,
  'ByocTrunkSid' => :byoc_trunk_sid,
  'EmergencyCallerSid' => :emergency_caller_sid
}.freeze
PAGE_FIELDS = 
{ 'Page' => :page, 'PageSize' => :page_size, 'PageToken' => :page_token }.freeze

Instance Method Summary collapse

Methods inherited from BaseResource

#initialize

Constructor Details

This class inherits a constructor from VoiceML::BaseResource

Instance Method Details

#create(domain_name:, **kwargs) ⇒ Object 



41
42
43
44
 
# File 'lib/voiceml/resources/sip.rb', line 41

def create(domain_name:, **kwargs)
  body = { 'DomainName' => domain_name }.merge(form_params(DOMAIN_FIELDS, kwargs))
  SipDomain.from_hash(@transport.request(:post, path('SIP', 'Domains'), form: body))
end

#create_auth_calls_credential_list_mapping(domain_sid, credential_list_sid:) ⇒ Object 



91
92
93
 
# File 'lib/voiceml/resources/sip.rb', line 91

def create_auth_calls_credential_list_mapping(domain_sid, credential_list_sid:)
  SipDomainMapping.from_hash(@transport.request(:post, path('SIP', 'Domains', domain_sid, 'Auth', 'Calls', 'CredentialListMappings'), form: { 'CredentialListSid' => credential_list_sid }))
end

#create_auth_calls_ip_access_control_list_mapping(domain_sid, ip_access_control_list_sid:) ⇒ Object 



105
106
107
 
# File 'lib/voiceml/resources/sip.rb', line 105

def create_auth_calls_ip_access_control_list_mapping(domain_sid, ip_access_control_list_sid:)
  SipDomainMapping.from_hash(@transport.request(:post, path('SIP', 'Domains', domain_sid, 'Auth', 'Calls', 'IpAccessControlListMappings'), form: { 'IpAccessControlListSid' => ip_access_control_list_sid }))
end

#create_auth_registrations_credential_list_mapping(domain_sid, credential_list_sid:) ⇒ Object 



119
120
121
 
# File 'lib/voiceml/resources/sip.rb', line 119

def create_auth_registrations_credential_list_mapping(domain_sid, credential_list_sid:)
  SipDomainMapping.from_hash(@transport.request(:post, path('SIP', 'Domains', domain_sid, 'Auth', 'Registrations', 'CredentialListMappings'), form: { 'CredentialListSid' => credential_list_sid }))
end

#create_credential_list_mapping(domain_sid, credential_list_sid:) ⇒ Object 



63
64
65
 
# File 'lib/voiceml/resources/sip.rb', line 63

def create_credential_list_mapping(domain_sid, credential_list_sid:)
  SipDomainMapping.from_hash(@transport.request(:post, path('SIP', 'Domains', domain_sid, 'CredentialListMappings'), form: { 'CredentialListSid' => credential_list_sid }))
end

#create_ip_access_control_list_mapping(domain_sid, ip_access_control_list_sid:) ⇒ Object 



77
78
79
 
# File 'lib/voiceml/resources/sip.rb', line 77

def create_ip_access_control_list_mapping(domain_sid, ip_access_control_list_sid:)
  SipDomainMapping.from_hash(@transport.request(:post, path('SIP', 'Domains', domain_sid, 'IpAccessControlListMappings'), form: { 'IpAccessControlListSid' => ip_access_control_list_sid }))
end

#delete(domain_sid) ⇒ Object 



54
55
56
57
 
# File 'lib/voiceml/resources/sip.rb', line 54

def delete(domain_sid)
  @transport.request(:delete, path('SIP', 'Domains', domain_sid))
  nil
end

#delete_auth_calls_credential_list_mapping(domain_sid, mapping_sid) ⇒ Object 



97
98
99
 
# File 'lib/voiceml/resources/sip.rb', line 97

def delete_auth_calls_credential_list_mapping(domain_sid, mapping_sid)
  @transport.request(:delete, path('SIP', 'Domains', domain_sid, 'Auth', 'Calls', 'CredentialListMappings', mapping_sid)); nil
end

#delete_auth_calls_ip_access_control_list_mapping(domain_sid, mapping_sid) ⇒ Object 



111
112
113
 
# File 'lib/voiceml/resources/sip.rb', line 111

def delete_auth_calls_ip_access_control_list_mapping(domain_sid, mapping_sid)
  @transport.request(:delete, path('SIP', 'Domains', domain_sid, 'Auth', 'Calls', 'IpAccessControlListMappings', mapping_sid)); nil
end

#delete_auth_registrations_credential_list_mapping(domain_sid, mapping_sid) ⇒ Object 



125
126
127
 
# File 'lib/voiceml/resources/sip.rb', line 125

def delete_auth_registrations_credential_list_mapping(domain_sid, mapping_sid)
  @transport.request(:delete, path('SIP', 'Domains', domain_sid, 'Auth', 'Registrations', 'CredentialListMappings', mapping_sid)); nil
end

#delete_credential_list_mapping(domain_sid, mapping_sid) ⇒ Object 



69
70
71
 
# File 'lib/voiceml/resources/sip.rb', line 69

def delete_credential_list_mapping(domain_sid, mapping_sid)
  @transport.request(:delete, path('SIP', 'Domains', domain_sid, 'CredentialListMappings', mapping_sid)); nil
end

#delete_ip_access_control_list_mapping(domain_sid, mapping_sid) ⇒ Object 



83
84
85
 
# File 'lib/voiceml/resources/sip.rb', line 83

def delete_ip_access_control_list_mapping(domain_sid, mapping_sid)
  @transport.request(:delete, path('SIP', 'Domains', domain_sid, 'IpAccessControlListMappings', mapping_sid)); nil
end

#fetch(domain_sid) ⇒ Object 



46
47
48
 
# File 'lib/voiceml/resources/sip.rb', line 46

def fetch(domain_sid)
  SipDomain.from_hash(@transport.request(:get, path('SIP', 'Domains', domain_sid)))
end

#fetch_auth_calls_credential_list_mapping(domain_sid, mapping_sid) ⇒ Object 



94
95
96
 
# File 'lib/voiceml/resources/sip.rb', line 94

def fetch_auth_calls_credential_list_mapping(domain_sid, mapping_sid)
  SipDomainMapping.from_hash(@transport.request(:get, path('SIP', 'Domains', domain_sid, 'Auth', 'Calls', 'CredentialListMappings', mapping_sid)))
end

#fetch_auth_calls_ip_access_control_list_mapping(domain_sid, mapping_sid) ⇒ Object 



108
109
110
 
# File 'lib/voiceml/resources/sip.rb', line 108

def fetch_auth_calls_ip_access_control_list_mapping(domain_sid, mapping_sid)
  SipDomainMapping.from_hash(@transport.request(:get, path('SIP', 'Domains', domain_sid, 'Auth', 'Calls', 'IpAccessControlListMappings', mapping_sid)))
end

#fetch_auth_registrations_credential_list_mapping(domain_sid, mapping_sid) ⇒ Object 



122
123
124
 
# File 'lib/voiceml/resources/sip.rb', line 122

def fetch_auth_registrations_credential_list_mapping(domain_sid, mapping_sid)
  SipDomainMapping.from_hash(@transport.request(:get, path('SIP', 'Domains', domain_sid, 'Auth', 'Registrations', 'CredentialListMappings', mapping_sid)))
end

#fetch_credential_list_mapping(domain_sid, mapping_sid) ⇒ Object 



66
67
68
 
# File 'lib/voiceml/resources/sip.rb', line 66

def fetch_credential_list_mapping(domain_sid, mapping_sid)
  SipDomainMapping.from_hash(@transport.request(:get, path('SIP', 'Domains', domain_sid, 'CredentialListMappings', mapping_sid)))
end

#fetch_ip_access_control_list_mapping(domain_sid, mapping_sid) ⇒ Object 



80
81
82
 
# File 'lib/voiceml/resources/sip.rb', line 80

def fetch_ip_access_control_list_mapping(domain_sid, mapping_sid)
  SipDomainMapping.from_hash(@transport.request(:get, path('SIP', 'Domains', domain_sid, 'IpAccessControlListMappings', mapping_sid)))
end

#list(**kwargs) ⇒ Object 



37
38
39
 
# File 'lib/voiceml/resources/sip.rb', line 37

def list(**kwargs)
  SipDomainList.new(@transport.request(:get, path('SIP', 'Domains'), params: form_params(PAGE_FIELDS, kwargs)))
end

#list_auth_calls_credential_list_mappings(domain_sid, **kwargs) ⇒ Object

— Auth/Calls/CredentialListMappings —



88
89
90
 
# File 'lib/voiceml/resources/sip.rb', line 88

def list_auth_calls_credential_list_mappings(domain_sid, **kwargs)
  SipCredentialListMappingList.new(@transport.request(:get, path('SIP', 'Domains', domain_sid, 'Auth', 'Calls', 'CredentialListMappings'), params: form_params(PAGE_FIELDS, kwargs)))
end

#list_auth_calls_ip_access_control_list_mappings(domain_sid, **kwargs) ⇒ Object

— Auth/Calls/IpAccessControlListMappings —



102
103
104
 
# File 'lib/voiceml/resources/sip.rb', line 102

def list_auth_calls_ip_access_control_list_mappings(domain_sid, **kwargs)
  SipIpAccessControlListMappingList.new(@transport.request(:get, path('SIP', 'Domains', domain_sid, 'Auth', 'Calls', 'IpAccessControlListMappings'), params: form_params(PAGE_FIELDS, kwargs)))
end

#list_auth_registrations_credential_list_mappings(domain_sid, **kwargs) ⇒ Object

— Auth/Registrations/CredentialListMappings —



116
117
118
 
# File 'lib/voiceml/resources/sip.rb', line 116

def list_auth_registrations_credential_list_mappings(domain_sid, **kwargs)
  SipCredentialListMappingList.new(@transport.request(:get, path('SIP', 'Domains', domain_sid, 'Auth', 'Registrations', 'CredentialListMappings'), params: form_params(PAGE_FIELDS, kwargs)))
end

#list_credential_list_mappings(domain_sid, **kwargs) ⇒ Object

— Historical CredentialList mappings —



60
61
62
 
# File 'lib/voiceml/resources/sip.rb', line 60

def list_credential_list_mappings(domain_sid, **kwargs)
  SipCredentialListMappingList.new(@transport.request(:get, path('SIP', 'Domains', domain_sid, 'CredentialListMappings'), params: form_params(PAGE_FIELDS, kwargs)))
end

#list_ip_access_control_list_mappings(domain_sid, **kwargs) ⇒ Object

— Historical IpAccessControlList mappings —



74
75
76
 
# File 'lib/voiceml/resources/sip.rb', line 74

def list_ip_access_control_list_mappings(domain_sid, **kwargs)
  SipIpAccessControlListMappingList.new(@transport.request(:get, path('SIP', 'Domains', domain_sid, 'IpAccessControlListMappings'), params: form_params(PAGE_FIELDS, kwargs)))
end

#update(domain_sid, **kwargs) ⇒ Object 



50
51
52
 
# File 'lib/voiceml/resources/sip.rb', line 50

def update(domain_sid, **kwargs)
  SipDomain.from_hash(@transport.request(:post, path('SIP', 'Domains', domain_sid), form: form_params(DOMAIN_FIELDS, kwargs)))
end