Class: Norbelys::FieldsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/norbelys/api/fields_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FieldsApi

Returns a new instance of FieldsApi.



19
20
21
 
# File 'lib/norbelys/api/fields_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/norbelys/api/fields_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#fields_archive(id, opts = {}) ⇒ Field

Delete a field Soft-delete a custom field so it stops appearing in the UI, the merge-tag catalog, and segment filters. The values already stored under its code on each person are kept, so the field can be restored without data loss.

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/norbelys/api/fields_api.rb', line 27

def fields_archive(id, opts = {})
  data, _status_code, _headers = fields_archive_with_http_info(id, opts)
  data
end

#fields_archive_with_http_info(id, opts = {}) ⇒ Array<(Field, Integer, Hash)>

Delete a field Soft-delete a custom field so it stops appearing in the UI, the merge-tag catalog, and segment filters. The values already stored under its `code` on each person are kept, so the field can be restored without data loss.

Parameters:

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

    the optional parameters

Returns:

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

    Field data, response status code and response headers



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/norbelys/api/fields_api.rb', line 37

def fields_archive_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FieldsApi.fields_archive ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FieldsApi.fields_archive"
  end
  # resource path
  local_var_path = '/fields/{id}'.sub('{' + 'id' + '}', CGI.escape(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(['application/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] || 'Field'

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

  new_options = opts.merge(
    :operation => :"FieldsApi.fields_archive",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FieldsApi#fields_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fields_create(field_create_params, opts = {}) ⇒ Field

Create a custom field Create a custom person-field. Its code becomes the {{ code }} merge tag used in templates and the key it is filtered by in segments; omit code to auto-derive a slug from the label. A dropdown field must also supply its options.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:



91
92
93
94
 
# File 'lib/norbelys/api/fields_api.rb', line 91

def fields_create(field_create_params, opts = {})
  data, _status_code, _headers = fields_create_with_http_info(field_create_params, opts)
  data
end

#fields_create_with_http_info(field_create_params, opts = {}) ⇒ Array<(Field, Integer, Hash)>

Create a custom field Create a custom person-field. Its `code` becomes the `code }` merge tag used in templates and the key it is filtered by in segments; omit `code` to auto-derive a slug from the label. A `dropdown` field must also supply its `options`.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:

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

    Field 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
150
151
152
153
154
155
156
157
158
 
# File 'lib/norbelys/api/fields_api.rb', line 102

def fields_create_with_http_info(field_create_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FieldsApi.fields_create ...'
  end
  # verify the required parameter 'field_create_params' is set
  if @api_client.config.client_side_validation && field_create_params.nil?
    fail ArgumentError, "Missing the required parameter 'field_create_params' when calling FieldsApi.fields_create"
  end
  if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling FieldsApi.fields_create, the character length must be smaller than or equal to 255.'
  end

  # resource path
  local_var_path = '/fields'

  # 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(['application/json']) unless header_params['Accept']
  # 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
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

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

#fields_list(opts = {}) ⇒ FieldList

List custom fields List all of the org's custom person-fields, in display order. The entire set is returned in one response — there is no pagination, because the set is small. System fields (email, telephone, first/last name) are not included here; only tenant-created custom fields.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_archived (Boolean)

Returns:



165
166
167
168
 
# File 'lib/norbelys/api/fields_api.rb', line 165

def fields_list(opts = {})
  data, _status_code, _headers = fields_list_with_http_info(opts)
  data
end

#fields_list_with_http_info(opts = {}) ⇒ Array<(FieldList, Integer, Hash)>

List custom fields List all of the org's custom person-fields, in display order. The entire set is returned in one response — there is no pagination, because the set is small. System fields (email, telephone, first/last name) are not included here; only tenant-created custom fields.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_archived (Boolean)

Returns:

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

    FieldList data, response status code and response headers



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
214
215
216
217
218
 
# File 'lib/norbelys/api/fields_api.rb', line 175

def fields_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FieldsApi.fields_list ...'
  end
  # resource path
  local_var_path = '/fields'

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

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

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

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

#fields_update(id, opts = {}) ⇒ Field

Update a field Update a field's label, type, options, or filterability. The code is immutable after create — live templates and segments reference it — so it cannot be changed here.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



226
227
228
229
 
# File 'lib/norbelys/api/fields_api.rb', line 226

def fields_update(id, opts = {})
  data, _status_code, _headers = fields_update_with_http_info(id, opts)
  data
end

#fields_update_with_http_info(id, opts = {}) ⇒ Array<(Field, Integer, Hash)>

Update a field Update a field's label, type, options, or filterability. The `code` is immutable after create — live templates and segments reference it — so it cannot be changed here.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Field data, response status code and response headers



237
238
239
240
241
242
243
244
245
246
247
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
 
# File 'lib/norbelys/api/fields_api.rb', line 237

def fields_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FieldsApi.fields_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FieldsApi.fields_update"
  end
  # resource path
  local_var_path = '/fields/{id}'.sub('{' + 'id' + '}', CGI.escape(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(['application/json']) unless header_params['Accept']
  # 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(opts[:'field_update_params'])

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

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

  new_options = opts.merge(
    :operation => :"FieldsApi.fields_update",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FieldsApi#fields_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end