Class: Zernio::ProfilesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/zernio-sdk/api/profiles_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProfilesApi

Returns a new instance of ProfilesApi.



19
20
21
 
# File 'lib/zernio-sdk/api/profiles_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/zernio-sdk/api/profiles_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_profile(create_profile_request, opts = {}) ⇒ ProfileCreateResponse

Create profile Creates a new profile with a name, optional description, and color. Names are unique per workspace: a duplicate returns a 409 whose details.existingProfileId carries the id of the existing profile. Send an Idempotency-Key header to make retries safe: a retried create with the same key and body replays the original 201 (same _id) instead of conflicting.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Optional client-generated unique key (e.g. a UUID) that makes create retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.

Returns:



28
29
30
31
 
# File 'lib/zernio-sdk/api/profiles_api.rb', line 28

def create_profile(create_profile_request, opts = {})
  data, _status_code, _headers = create_profile_with_http_info(create_profile_request, opts)
  data
end

#create_profile_with_http_info(create_profile_request, opts = {}) ⇒ Array<(ProfileCreateResponse, Integer, Hash)>

Create profile Creates a new profile with a name, optional description, and color. Names are unique per workspace: a duplicate returns a 409 whose details.existingProfileId carries the id of the existing profile. Send an Idempotency-Key header to make retries safe: a retried create with the same key and body replays the original 201 (same _id) instead of conflicting.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Optional client-generated unique key (e.g. a UUID) that makes create retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.

Returns:

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

    ProfileCreateResponse data, response status code and response headers



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
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/zernio-sdk/api/profiles_api.rb', line 39

def create_profile_with_http_info(create_profile_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProfilesApi.create_profile ...'
  end
  # verify the required parameter 'create_profile_request' is set
  if @api_client.config.client_side_validation && create_profile_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_profile_request' when calling ProfilesApi.create_profile"
  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 ProfilesApi.create_profile, the character length must be smaller than or equal to 255.'
  end

  # resource path
  local_var_path = '/v1/profiles'

  # 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(create_profile_request)

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

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

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

#delete_profile(profile_id, opts = {}) ⇒ ProfileDeleteResponse

Delete profile Permanently deletes a profile. Active connected accounts block deletion (returns 400) - disconnect them first. Any remaining disconnected accounts and provisioned WhatsApp numbers are moved to another of your profiles (a new one is created only if needed), never deleted.

Parameters:

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

    the optional parameters

Returns:



102
103
104
105
 
# File 'lib/zernio-sdk/api/profiles_api.rb', line 102

def delete_profile(profile_id, opts = {})
  data, _status_code, _headers = delete_profile_with_http_info(profile_id, opts)
  data
end

#delete_profile_with_http_info(profile_id, opts = {}) ⇒ Array<(ProfileDeleteResponse, Integer, Hash)>

Delete profile Permanently deletes a profile. Active connected accounts block deletion (returns 400) - disconnect them first. Any remaining disconnected accounts and provisioned WhatsApp numbers are moved to another of your profiles (a new one is created only if needed), never deleted.

Parameters:

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

    the optional parameters

Returns:

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

    ProfileDeleteResponse data, response status code and response headers



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/zernio-sdk/api/profiles_api.rb', line 112

def delete_profile_with_http_info(profile_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProfilesApi.delete_profile ...'
  end
  # verify the required parameter 'profile_id' is set
  if @api_client.config.client_side_validation && profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'profile_id' when calling ProfilesApi.delete_profile"
  end
  # resource path
  local_var_path = '/v1/profiles/{profileId}'.sub('{' + 'profileId' + '}', CGI.escape(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(['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] || 'ProfileDeleteResponse'

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

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

#get_profile(profile_id, opts = {}) ⇒ ProfileGetResponse

Get profile Returns a single profile by ID, including its name, color, and default status.

Parameters:

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

    the optional parameters

Returns:



165
166
167
168
 
# File 'lib/zernio-sdk/api/profiles_api.rb', line 165

def get_profile(profile_id, opts = {})
  data, _status_code, _headers = get_profile_with_http_info(profile_id, opts)
  data
end

#get_profile_with_http_info(profile_id, opts = {}) ⇒ Array<(ProfileGetResponse, Integer, Hash)>

Get profile Returns a single profile by ID, including its name, color, and default status.

Parameters:

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

    the optional parameters

Returns:

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

    ProfileGetResponse 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
219
220
221
 
# File 'lib/zernio-sdk/api/profiles_api.rb', line 175

def get_profile_with_http_info(profile_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile ...'
  end
  # verify the required parameter 'profile_id' is set
  if @api_client.config.client_side_validation && profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'profile_id' when calling ProfilesApi.get_profile"
  end
  # resource path
  local_var_path = '/v1/profiles/{profileId}'.sub('{' + 'profileId' + '}', CGI.escape(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(['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] || 'ProfileGetResponse'

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

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

#list_profiles(opts = {}) ⇒ ProfilesListResponse

List profiles Returns profiles sorted default-first, then by creation date. Filter with name (exact match) and paginate with limit/skip; without those params the full list is returned unchanged. Use includeOverLimit=true to include profiles that exceed the plan limit.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_over_limit (Boolean) —

    When true, includes over-limit profiles (marked with isOverLimit: true). (default to false)

  • :name (String) —

    Exact-match filter on the profile name. Useful to recover a profile id after an ambiguous create (timeout followed by a 409 on retry).

  • :limit (Integer) —

    Page size. When limit or skip is present, the response includes total and skip (and echoes limit).

  • :skip (Integer) —

    Number of profiles to skip, applied after sorting and filtering.

Returns:



231
232
233
234
 
# File 'lib/zernio-sdk/api/profiles_api.rb', line 231

def list_profiles(opts = {})
  data, _status_code, _headers = list_profiles_with_http_info(opts)
  data
end

#list_profiles_with_http_info(opts = {}) ⇒ Array<(ProfilesListResponse, Integer, Hash)>

List profiles Returns profiles sorted default-first, then by creation date. Filter with name (exact match) and paginate with limit/skip; without those params the full list is returned unchanged. Use includeOverLimit=true to include profiles that exceed the plan limit.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_over_limit (Boolean) —

    When true, includes over-limit profiles (marked with isOverLimit: true). (default to false)

  • :name (String) —

    Exact-match filter on the profile name. Useful to recover a profile id after an ambiguous create (timeout followed by a 409 on retry).

  • :limit (Integer) —

    Page size. When limit or skip is present, the response includes total and skip (and echoes limit).

  • :skip (Integer) —

    Number of profiles to skip, applied after sorting and filtering.

Returns:

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

    ProfilesListResponse data, response status code and response headers



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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/zernio-sdk/api/profiles_api.rb', line 244

def list_profiles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProfilesApi.list_profiles ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ProfilesApi.list_profiles, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ProfilesApi.list_profiles, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'skip'].nil? && opts[:'skip'] < 0
    fail ArgumentError, 'invalid value for "opts[:"skip"]" when calling ProfilesApi.list_profiles, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/v1/profiles'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'includeOverLimit'] = opts[:'include_over_limit'] if !opts[:'include_over_limit'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].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] || 'ProfilesListResponse'

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

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

#update_profile(profile_id, update_profile_request, opts = {}) ⇒ ProfileUpdateResponse

Update profile Updates a profile's name, description, color, or default status.

Parameters:

  • profile_id (String)
  • update_profile_request (UpdateProfileRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



310
311
312
313
 
# File 'lib/zernio-sdk/api/profiles_api.rb', line 310

def update_profile(profile_id, update_profile_request, opts = {})
  data, _status_code, _headers = update_profile_with_http_info(profile_id, update_profile_request, opts)
  data
end

#update_profile_with_http_info(profile_id, update_profile_request, opts = {}) ⇒ Array<(ProfileUpdateResponse, Integer, Hash)>

Update profile Updates a profile's name, description, color, or default status.

Parameters:

  • profile_id (String)
  • update_profile_request (UpdateProfileRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    ProfileUpdateResponse data, response status code and response headers



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/zernio-sdk/api/profiles_api.rb', line 321

def update_profile_with_http_info(profile_id, update_profile_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProfilesApi.update_profile ...'
  end
  # verify the required parameter 'profile_id' is set
  if @api_client.config.client_side_validation && profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'profile_id' when calling ProfilesApi.update_profile"
  end
  # verify the required parameter 'update_profile_request' is set
  if @api_client.config.client_side_validation && update_profile_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_profile_request' when calling ProfilesApi.update_profile"
  end
  # resource path
  local_var_path = '/v1/profiles/{profileId}'.sub('{' + 'profileId' + '}', CGI.escape(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(['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(update_profile_request)

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

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

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