Class: Falcon::MobileEnrollment

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/mobile_enrollment.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MobileEnrollment

Returns a new instance of MobileEnrollment.



36
37
38
 
# File 'lib/crimson-falcon/api/mobile_enrollment.rb', line 36

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/mobile_enrollment.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#request_device_enrollment_v3(body, opts = {}) ⇒ ApiPostEnrollmentDetailsResponse

Trigger on-boarding process for a mobile device

Parameters:

Options Hash (opts):

  • :action_name (String) —

    Action to perform

  • :filter (String) —

    FQL filter

Returns:



45
46
47
48
 
# File 'lib/crimson-falcon/api/mobile_enrollment.rb', line 45

def request_device_enrollment_v3(body, opts = {})
  data, _status_code, _headers = request_device_enrollment_v3_with_http_info(body, opts)
  data
end

#request_device_enrollment_v3_with_http_info(body, opts = {}) ⇒ Array<(ApiPostEnrollmentDetailsResponse, Integer, Hash)>

Trigger on-boarding process for a mobile device

Parameters:

Options Hash (opts):

  • :action_name (String) —

    Action to perform

  • :filter (String) —

    FQL filter

Returns:



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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/crimson-falcon/api/mobile_enrollment.rb', line 56

def request_device_enrollment_v3_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MobileEnrollment.request_device_enrollment_v3 ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MobileEnrollment.request_device_enrollment_v3"
  end
  allowable_values = ["enroll", "re-enroll"]
  if @api_client.config.client_side_validation && opts[:'action_name'] && !allowable_values.include?(opts[:'action_name'])
    fail ArgumentError, "invalid value for \"action_name\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/enrollments/entities/details/v3'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['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(body)

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

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

  new_options = opts.merge(
    :operation => :"MobileEnrollment.request_device_enrollment_v3",
    :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: MobileEnrollment#request_device_enrollment_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#request_device_enrollment_v4(body, opts = {}) ⇒ ApiPostEnrollmentDetailsResponse

Trigger on-boarding process for a mobile device

Parameters:

Options Hash (opts):

  • :action_name (String) —

    Action to perform

  • :filter (String) —

    FQL filter

Returns:



121
122
123
124
 
# File 'lib/crimson-falcon/api/mobile_enrollment.rb', line 121

def request_device_enrollment_v4(body, opts = {})
  data, _status_code, _headers = request_device_enrollment_v4_with_http_info(body, opts)
  data
end

#request_device_enrollment_v4_with_http_info(body, opts = {}) ⇒ Array<(ApiPostEnrollmentDetailsResponse, Integer, Hash)>

Trigger on-boarding process for a mobile device

Parameters:

Options Hash (opts):

  • :action_name (String) —

    Action to perform

  • :filter (String) —

    FQL filter

Returns:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/crimson-falcon/api/mobile_enrollment.rb', line 132

def request_device_enrollment_v4_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MobileEnrollment.request_device_enrollment_v4 ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MobileEnrollment.request_device_enrollment_v4"
  end
  allowable_values = ["enroll", "re-enroll"]
  if @api_client.config.client_side_validation && opts[:'action_name'] && !allowable_values.include?(opts[:'action_name'])
    fail ArgumentError, "invalid value for \"action_name\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/enrollments/entities/details/v4'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['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(body)

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

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

  new_options = opts.merge(
    :operation => :"MobileEnrollment.request_device_enrollment_v4",
    :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: MobileEnrollment#request_device_enrollment_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end