Class: TrinsicApi::NetworkApi

Inherits:
Object
  • Object
show all
Defined in:
lib/trinsic_api/api/network_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NetworkApi

Returns a new instance of NetworkApi.



19
20
21
 
# File 'lib/trinsic_api/api/network_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/trinsic_api/api/network_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list_provider_contracts(verification_profile_id, opts = {}) ⇒ ListProviderContractsResponse

List Provider Contracts List the contracts for all Providers available to your App. If your App is in test mode, this call will only return Providers available in test mode. If your App is not in test mode, this call will only return Providers available in production.

Parameters:

  • verification_profile_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/trinsic_api/api/network_api.rb', line 27

def list_provider_contracts(verification_profile_id, opts = {})
  data, _status_code, _headers = list_provider_contracts_with_http_info(verification_profile_id, opts)
  data
end

#list_provider_contracts_with_http_info(verification_profile_id, opts = {}) ⇒ Array<(ListProviderContractsResponse, Integer, Hash)>

List Provider Contracts List the contracts for all Providers available to your App. If your App is in test mode, this call will only return Providers available in test mode. If your App is not in test mode, this call will only return Providers available in production.

Parameters:

  • verification_profile_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/trinsic_api/api/network_api.rb', line 37

def list_provider_contracts_with_http_info(verification_profile_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkApi.list_provider_contracts ...'
  end
  # verify the required parameter 'verification_profile_id' is set
  if @api_client.config.client_side_validation && verification_profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'verification_profile_id' when calling NetworkApi.list_provider_contracts"
  end
  # resource path
  local_var_path = '/api/v1/network/{verificationProfileId}/providers/contracts'.sub('{' + 'verificationProfileId' + '}', CGI.escape(verification_profile_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/problem+json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListProviderContractsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Bearer']

  new_options = opts.merge(
    :operation => :"NetworkApi.list_provider_contracts",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkApi#list_provider_contracts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_providers(verification_profile_id, opts = {}) ⇒ ListProvidersResponse

List Providers List all identity providers available for use

Parameters:

  • verification_profile_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :health (String) —

    Filter providers by health status. Valid values: &quot;online&quot;, &quot;offline&quot;, &quot;all&quot;. Defaults to &quot;all&quot;.

Returns:



91
92
93
94
 
# File 'lib/trinsic_api/api/network_api.rb', line 91

def list_providers(verification_profile_id, opts = {})
  data, _status_code, _headers = list_providers_with_http_info(verification_profile_id, opts)
  data
end

#list_providers_with_http_info(verification_profile_id, opts = {}) ⇒ Array<(ListProvidersResponse, Integer, Hash)>

List Providers List all identity providers available for use

Parameters:

  • verification_profile_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :health (String) —

    Filter providers by health status. Valid values: &quot;online&quot;, &quot;offline&quot;, &quot;all&quot;. Defaults to &quot;all&quot;.

Returns:

  • (Array<(ListProvidersResponse, Integer, Hash)>) —

    ListProvidersResponse data, response status code and response headers



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/trinsic_api/api/network_api.rb', line 102

def list_providers_with_http_info(verification_profile_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkApi.list_providers ...'
  end
  # verify the required parameter 'verification_profile_id' is set
  if @api_client.config.client_side_validation && verification_profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'verification_profile_id' when calling NetworkApi.list_providers"
  end
  # resource path
  local_var_path = '/api/v1/network/{verificationProfileId}/providers'.sub('{' + 'verificationProfileId' + '}', CGI.escape(verification_profile_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'health'] = opts[:'health'] if !opts[:'health'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/problem+json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListProvidersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Bearer']

  new_options = opts.merge(
    :operation => :"NetworkApi.list_providers",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkApi#list_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#recommend_providers(opts = {}) ⇒ RecommendResponse

Recommend Providers Generate provider recommendations based on signals about the user’s location (phone number, countries, states).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



156
157
158
159
 
# File 'lib/trinsic_api/api/network_api.rb', line 156

def recommend_providers(opts = {})
  data, _status_code, _headers = recommend_providers_with_http_info(opts)
  data
end

#recommend_providers_with_http_info(opts = {}) ⇒ Array<(RecommendResponse, Integer, Hash)>

Recommend Providers Generate provider recommendations based on signals about the user&#39;s location (phone number, countries, states).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(RecommendResponse, Integer, Hash)>) —

    RecommendResponse data, response status code and response headers



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/trinsic_api/api/network_api.rb', line 166

def recommend_providers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkApi.recommend_providers ...'
  end
  # resource path
  local_var_path = '/api/v1/network/recommend'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/problem+json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'recommend_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'RecommendResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Bearer']

  new_options = opts.merge(
    :operation => :"NetworkApi.recommend_providers",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkApi#recommend_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end