Class: Norbelys::OrganizationApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrganizationApi

Returns a new instance of OrganizationApi.



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

def api_client
  @api_client
end

Instance Method Details

#organization_features(opts = {}) ⇒ Features

Get the organization's feature flags Returns the workspace's resolved feature flags (per-org, evaluated at the edge). Use it to conditionally render gated features in a client; server endpoints enforce their own gate independently.

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/norbelys/api/organization_api.rb', line 26

def organization_features(opts = {})
  data, _status_code, _headers = organization_features_with_http_info(opts)
  data
end

#organization_features_with_http_info(opts = {}) ⇒ Array<(Features, Integer, Hash)>

Get the organization's feature flags Returns the workspace's resolved feature flags (per-org, evaluated at the edge). Use it to conditionally render gated features in a client; server endpoints enforce their own gate independently.

Parameters:

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

    the optional parameters

Returns:

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

    Features data, response status code and response headers



35
36
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
 
# File 'lib/norbelys/api/organization_api.rb', line 35

def organization_features_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationApi.organization_features ...'
  end
  # resource path
  local_var_path = '/organization/features'

  # 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] || 'Features'

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

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

#organization_find(opts = {}) ⇒ Organization

Get the organization The workspace this credential acts on: org id, display name, company profile, onboarding and notification state. Read-only — THE first call to confirm "who am I / which tenant is this?".

Parameters:

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

    the optional parameters

Returns:



83
84
85
86
 
# File 'lib/norbelys/api/organization_api.rb', line 83

def organization_find(opts = {})
  data, _status_code, _headers = organization_find_with_http_info(opts)
  data
end

#organization_find_with_http_info(opts = {}) ⇒ Array<(Organization, Integer, Hash)>

Get the organization The workspace this credential acts on: org id, display name, company profile, onboarding and notification state. Read-only — THE first call to confirm &quot;who am I / which tenant is this?&quot;.

Parameters:

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

    the optional parameters

Returns:

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

    Organization data, response status code and response headers



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
129
130
131
132
133
134
 
# File 'lib/norbelys/api/organization_api.rb', line 92

def organization_find_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationApi.organization_find ...'
  end
  # resource path
  local_var_path = '/organization'

  # 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] || 'Organization'

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

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

#organization_pulse(opts = {}) ⇒ OrganizationPulse

Get the workspace pulse One-call workspace briefing: every campaign with its lead count, completion, and engagement funnel over the window (default 7 days), the mailbox fleet rolled up by state and reputation, and the account deliverability headline. THE first read for any "how is everything going?" / status question — prefer it over separately listing programs, senders, and analytics.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :days (Integer)

Returns:



141
142
143
144
 
# File 'lib/norbelys/api/organization_api.rb', line 141

def organization_pulse(opts = {})
  data, _status_code, _headers = organization_pulse_with_http_info(opts)
  data
end

#organization_pulse_with_http_info(opts = {}) ⇒ Array<(OrganizationPulse, Integer, Hash)>

Get the workspace pulse One-call workspace briefing: every campaign with its lead count, completion, and engagement funnel over the window (default 7 days), the mailbox fleet rolled up by state and reputation, and the account deliverability headline. THE first read for any &quot;how is everything going?&quot; / status question — prefer it over separately listing programs, senders, and analytics.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :days (Integer)

Returns:

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

    OrganizationPulse data, response status code and response headers



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
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/norbelys/api/organization_api.rb', line 151

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

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

  # resource path
  local_var_path = '/organization/pulse'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'days'] = opts[:'days'] if !opts[:'days'].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] || 'OrganizationPulse'

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

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

#organization_update(organization_update_params, opts = {}) ⇒ Organization

Update the organization Update the workspace's editable profile and settings: company profile, onboarding state, deliverability alerts, and bounce-handling policy. Idempotent — every field is optional, and calling it with an empty body just reconciles the tenant (it provisions the org's registry row when the user moves faster than the provisioning webhook). Returns the full resolved organization state. Members and invites are managed through Clerk, not this endpoint.

Parameters:

Returns:



209
210
211
212
 
# File 'lib/norbelys/api/organization_api.rb', line 209

def organization_update(organization_update_params, opts = {})
  data, _status_code, _headers = organization_update_with_http_info(organization_update_params, opts)
  data
end

#organization_update_with_http_info(organization_update_params, opts = {}) ⇒ Array<(Organization, Integer, Hash)>

Update the organization Update the workspace's editable profile and settings: company profile, onboarding state, deliverability alerts, and bounce-handling policy. Idempotent — every field is optional, and calling it with an empty body just reconciles the tenant (it provisions the org's registry row when the user moves faster than the provisioning webhook). Returns the full resolved organization state. Members and invites are managed through Clerk, not this endpoint.

Parameters:

Returns:

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

    Organization data, response status code and response headers



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
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
 
# File 'lib/norbelys/api/organization_api.rb', line 219

def organization_update_with_http_info(organization_update_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationApi.organization_update ...'
  end
  # verify the required parameter 'organization_update_params' is set
  if @api_client.config.client_side_validation && organization_update_params.nil?
    fail ArgumentError, "Missing the required parameter 'organization_update_params' when calling OrganizationApi.organization_update"
  end
  # resource path
  local_var_path = '/organization'

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

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

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

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

#organization_usage(opts = {}) ⇒ OrganizationUsage

Get the organization's plan usage The workspace's usage against its plan limits: live campaigns, active contacts, and emails sent this UTC month, each with the cap and an ok/near/reached level, plus the plan itself. Use it to answer "how close am I to my limits?" — the caps are enforced server-side regardless.

Parameters:

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

    the optional parameters

Returns:



276
277
278
279
 
# File 'lib/norbelys/api/organization_api.rb', line 276

def organization_usage(opts = {})
  data, _status_code, _headers = organization_usage_with_http_info(opts)
  data
end

#organization_usage_with_http_info(opts = {}) ⇒ Array<(OrganizationUsage, Integer, Hash)>

Get the organization's plan usage The workspace's usage against its plan limits: live campaigns, active contacts, and emails sent this UTC month, each with the cap and an `ok`/`near`/`reached` level, plus the plan itself. Use it to answer &quot;how close am I to my limits?&quot; — the caps are enforced server-side regardless.

Parameters:

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

    the optional parameters

Returns:

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

    OrganizationUsage data, response status code and response headers



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/norbelys/api/organization_api.rb', line 285

def organization_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationApi.organization_usage ...'
  end
  # resource path
  local_var_path = '/organization/usage'

  # 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] || 'OrganizationUsage'

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

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