Class: ZoomUs::TrackingField

Inherits:
Object
  • Object
show all
Defined in:
lib/zoom_us/tracking_field.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TrackingField 



19
20
21
 
# File 'lib/zoom_us/tracking_field.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/zoom_us/tracking_field.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#trackingfield_create(body, opts = {}) ⇒ InlineResponse2018

Create a Tracking Field [Tracking fields](support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.
Use this API to create a new tracking field.
Scope: ‘trackingfield:write:admin`

Prerequisites: * Business, Education, API or higher plan



27
28
29
30
 
# File 'lib/zoom_us/tracking_field.rb', line 27

def trackingfield_create(body, opts = {})
  data, _status_code, _headers = trackingfield_create_with_http_info(body, opts)
  data
end

#trackingfield_create_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse2018, Fixnum, Hash)>

Create a Tracking Field [Tracking fields](support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.&lt;br&gt; Use this API to create a new tracking field.&lt;br&gt;&lt;br&gt; Scope: &#x60;trackingfield:write:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: * Business, Education, API or higher plan



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
 
# File 'lib/zoom_us/tracking_field.rb', line 37

def trackingfield_create_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TrackingFieldApi.trackingfield_create ...'
  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 TrackingFieldApi.trackingfield_create"
  end
  # resource path
  local_var_path = '/tracking_fields'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2018')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrackingFieldApi#trackingfield_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#trackingfield_delete(field_id, opts = {}) ⇒ nil

Delete a Tracking Field [Tracking fields](support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.
Use this API to delete a tracking field.
Scope: ‘trackingfield:write:admin`

Prerequisites: * Business, Education, API or higher plan



81
82
83
84
 
# File 'lib/zoom_us/tracking_field.rb', line 81

def trackingfield_delete(field_id, opts = {})
  trackingfield_delete_with_http_info(field_id, opts)
  nil
end

#trackingfield_delete_with_http_info(field_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Tracking Field [Tracking fields](support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.&lt;br&gt; Use this API to delete a tracking field.&lt;br&gt;&lt;br&gt; Scope: &#x60;trackingfield:write:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: * Business, Education, API or higher plan



91
92
93
94
95
96
97
98
99
100
101
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
 
# File 'lib/zoom_us/tracking_field.rb', line 91

def trackingfield_delete_with_http_info(field_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TrackingFieldApi.trackingfield_delete ...'
  end
  # verify the required parameter 'field_id' is set
  if @api_client.config.client_side_validation && field_id.nil?
    fail ArgumentError, "Missing the required parameter 'field_id' when calling TrackingFieldApi.trackingfield_delete"
  end
  # resource path
  local_var_path = '/tracking_fields/{fieldId}'.sub('{' + 'fieldId' + '}', field_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrackingFieldApi#trackingfield_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#trackingfield_get(field_id, opts = {}) ⇒ InlineResponse2018

Get a Tracking Field [Tracking fields](support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.
When scheduling a meeting, the tracking field will be included in the meeting options.
Use this API to get information on a tracking field.
Scopes: ‘trackingfield:read:admin`

Prerequisites: * Business, Education, API or higher plan



134
135
136
137
 
# File 'lib/zoom_us/tracking_field.rb', line 134

def trackingfield_get(field_id, opts = {})
  data, _status_code, _headers = trackingfield_get_with_http_info(field_id, opts)
  data
end

#trackingfield_get_with_http_info(field_id, opts = {}) ⇒ Array<(InlineResponse2018, Fixnum, Hash)>

Get a Tracking Field [Tracking fields](support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.&lt;br&gt;&lt;br&gt; When scheduling a meeting, the tracking field will be included in the meeting options.&lt;br&gt;Use this API to get information on a tracking field.&lt;br&gt;&lt;br&gt; Scopes: &#x60;trackingfield:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: * Business, Education, API or higher plan



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
 
# File 'lib/zoom_us/tracking_field.rb', line 144

def trackingfield_get_with_http_info(field_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TrackingFieldApi.trackingfield_get ...'
  end
  # verify the required parameter 'field_id' is set
  if @api_client.config.client_side_validation && field_id.nil?
    fail ArgumentError, "Missing the required parameter 'field_id' when calling TrackingFieldApi.trackingfield_get"
  end
  # resource path
  local_var_path = '/tracking_fields/{fieldId}'.sub('{' + 'fieldId' + '}', field_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2018')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrackingFieldApi#trackingfield_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#trackingfield_list(opts = {}) ⇒ Object

List Tracking Fields [Tracking fields](support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.
Use this API to list all the tracking fields on your Zoom account.
Scopes: ‘trackingfield:read:admin`

Prerequisites: * Business, Education, API or higher plan



187
188
189
190
 
# File 'lib/zoom_us/tracking_field.rb', line 187

def trackingfield_list(opts = {})
  data, _status_code, _headers = trackingfield_list_with_http_info(opts)
  data
end

#trackingfield_list_with_http_info(opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

List Tracking Fields [Tracking fields](support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.&lt;br&gt; Use this API to list all the tracking fields on your Zoom account.&lt;br&gt;&lt;br&gt; Scopes: &#x60;trackingfield:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: * Business, Education, API or higher plan



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/zoom_us/tracking_field.rb', line 196

def trackingfield_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TrackingFieldApi.trackingfield_list ...'
  end
  # resource path
  local_var_path = '/tracking_fields'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrackingFieldApi#trackingfield_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#trackingfield_update(field_id, body, opts = {}) ⇒ nil

Update a Tracking Field [Tracking fields](support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.
Use this API to update a tracking field.
Scope: ‘trackingfield:write:admin`

Prerequisites: * Business, Education, API or higher plan



237
238
239
240
 
# File 'lib/zoom_us/tracking_field.rb', line 237

def trackingfield_update(field_id, body, opts = {})
  trackingfield_update_with_http_info(field_id, body, opts)
  nil
end

#trackingfield_update_with_http_info(field_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a Tracking Field [Tracking fields](support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.&lt;br&gt; Use this API to update a tracking field.&lt;br&gt;&lt;br&gt; Scope: &#x60;trackingfield:write:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: * Business, Education, API or higher plan



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/zoom_us/tracking_field.rb', line 248

def trackingfield_update_with_http_info(field_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TrackingFieldApi.trackingfield_update ...'
  end
  # verify the required parameter 'field_id' is set
  if @api_client.config.client_side_validation && field_id.nil?
    fail ArgumentError, "Missing the required parameter 'field_id' when calling TrackingFieldApi.trackingfield_update"
  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 TrackingFieldApi.trackingfield_update"
  end
  # resource path
  local_var_path = '/tracking_fields/{fieldId}'.sub('{' + 'fieldId' + '}', field_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrackingFieldApi#trackingfield_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end