Class: Mudbase::OrganizationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mudbase/api/organizations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrganizationsApi

Returns a new instance of OrganizationsApi.



19
20
21
 
# File 'lib/mudbase/api/organizations_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/mudbase/api/organizations_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_org_custom_domain(org_id, project_id, add_org_domain_request, opts = {}) ⇒ OrgAddDomainResponse

Add a custom domain Creates a pending domain row; the response domain uses the compact OrgDomainEntryOrgConsole shape (dnsRecords includes the Mudbase ownership TXT). dnsRecords may include Mudbase TXT and routing CNAME only until Mudbase TXT succeeds and Fly ACME (if enabled) provisions a certificate. flyCertificateStatus is typically omitted until Fly ACME runs after first successful verify-dns.

Parameters:

  • org_id (String)
  • project_id (String)
  • add_org_domain_request (AddOrgDomainRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/mudbase/api/organizations_api.rb', line 29

def add_org_custom_domain(org_id, project_id, add_org_domain_request, opts = {})
  data, _status_code, _headers = add_org_custom_domain_with_http_info(org_id, project_id, add_org_domain_request, opts)
  data
end

#add_org_custom_domain_with_http_info(org_id, project_id, add_org_domain_request, opts = {}) ⇒ Array<(OrgAddDomainResponse, Integer, Hash)>

Add a custom domain Creates a pending domain row; the response `domain` uses the compact `OrgDomainEntryOrgConsole` shape (`dnsRecords` includes the Mudbase ownership TXT). `dnsRecords` may include Mudbase TXT and routing CNAME only until Mudbase TXT succeeds and Fly ACME (if enabled) provisions a certificate. `flyCertificateStatus` is typically omitted until Fly ACME runs after first successful `verify-dns`.

Parameters:

  • org_id (String)
  • project_id (String)
  • add_org_domain_request (AddOrgDomainRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    OrgAddDomainResponse data, response status code and response headers



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
96
97
98
99
100
 
# File 'lib/mudbase/api/organizations_api.rb', line 41

def add_org_custom_domain_with_http_info(org_id, project_id, add_org_domain_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.add_org_custom_domain ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.add_org_custom_domain"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling OrganizationsApi.add_org_custom_domain"
  end
  # verify the required parameter 'add_org_domain_request' is set
  if @api_client.config.client_side_validation && add_org_domain_request.nil?
    fail ArgumentError, "Missing the required parameter 'add_org_domain_request' when calling OrganizationsApi.add_org_custom_domain"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/projects/{projectId}/domains'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'projectId' + '}', CGI.escape(project_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(add_org_domain_request)

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

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

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

#create_organization(create_organization_request, opts = {}) ⇒ nil

Create new organization (disabled) Create a new organization. This endpoint is disabled and kept only for backward compatibility in documentation. Requires: OrgBearerAuth (organization-level authentication only).

Parameters:

Returns:

  • (nil) 


107
108
109
110
 
# File 'lib/mudbase/api/organizations_api.rb', line 107

def create_organization(create_organization_request, opts = {})
  create_organization_with_http_info(create_organization_request, opts)
  nil
end

#create_organization_with_http_info(create_organization_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Create new organization (disabled) Create a new organization. This endpoint is disabled and kept only for backward compatibility in documentation. Requires: OrgBearerAuth (organization-level authentication only).

Parameters:

Returns:

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

    nil, response status code and response headers



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
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/mudbase/api/organizations_api.rb', line 117

def create_organization_with_http_info(create_organization_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.create_organization ...'
  end
  # verify the required parameter 'create_organization_request' is set
  if @api_client.config.client_side_validation && create_organization_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_organization_request' when calling OrganizationsApi.create_organization"
  end
  # resource path
  local_var_path = '/api/orgs'

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_org_custom_domain(org_id, project_id, hostname, opts = {}) ⇒ nil

Remove a custom domain

Parameters:

  • org_id (String)
  • project_id (String)
  • hostname (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


176
177
178
179
 
# File 'lib/mudbase/api/organizations_api.rb', line 176

def delete_org_custom_domain(org_id, project_id, hostname, opts = {})
  delete_org_custom_domain_with_http_info(org_id, project_id, hostname, opts)
  nil
end

#delete_org_custom_domain_with_http_info(org_id, project_id, hostname, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove a custom domain

Parameters:

  • org_id (String)
  • project_id (String)
  • hostname (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/mudbase/api/organizations_api.rb', line 187

def delete_org_custom_domain_with_http_info(org_id, project_id, hostname, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.delete_org_custom_domain ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.delete_org_custom_domain"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling OrganizationsApi.delete_org_custom_domain"
  end
  # verify the required parameter 'hostname' is set
  if @api_client.config.client_side_validation && hostname.nil?
    fail ArgumentError, "Missing the required parameter 'hostname' when calling OrganizationsApi.delete_org_custom_domain"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/projects/{projectId}/domains/{hostname}'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s)).sub('{' + 'hostname' + '}', CGI.escape(hostname.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_organization(org_id, opts = {}) ⇒ DeleteOrganization200Response

Delete organization Delete an organization permanently. This is a destructive operation. Requires JWT Bearer token authentication. Both OrgBearerAuth and ProjectBearerAuth are supported (they use the same JWT token format). These are organization-level operations.

Parameters:

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

    the optional parameters

Returns:



246
247
248
249
 
# File 'lib/mudbase/api/organizations_api.rb', line 246

def delete_organization(org_id, opts = {})
  data, _status_code, _headers = delete_organization_with_http_info(org_id, opts)
  data
end

#delete_organization_with_http_info(org_id, opts = {}) ⇒ Array<(DeleteOrganization200Response, Integer, Hash)>

Delete organization Delete an organization permanently. This is a destructive operation. Requires JWT Bearer token authentication. Both OrgBearerAuth and ProjectBearerAuth are supported (they use the same JWT token format). These are organization-level operations.

Parameters:

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

    the optional parameters

Returns:



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/mudbase/api/organizations_api.rb', line 256

def delete_organization_with_http_info(org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.delete_organization ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.delete_organization"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}'.sub('{' + 'orgId' + '}', CGI.escape(org_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] || 'DeleteOrganization200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth', 'ProjectBearerAuth']

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

#delete_sub_organization(org_id, suborg_id, opts = {}) ⇒ DeleteSubOrganization200Response

Delete sub-organization (deprecated)

Parameters:

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

    the optional parameters

Returns:



309
310
311
312
 
# File 'lib/mudbase/api/organizations_api.rb', line 309

def delete_sub_organization(org_id, suborg_id, opts = {})
  data, _status_code, _headers = delete_sub_organization_with_http_info(org_id, suborg_id, opts)
  data
end

#delete_sub_organization_with_http_info(org_id, suborg_id, opts = {}) ⇒ Array<(DeleteSubOrganization200Response, Integer, Hash)>

Delete sub-organization (deprecated)

Parameters:

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

    the optional parameters

Returns:



319
320
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
 
# File 'lib/mudbase/api/organizations_api.rb', line 319

def delete_sub_organization_with_http_info(org_id, suborg_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.delete_sub_organization ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.delete_sub_organization"
  end
  # verify the required parameter 'suborg_id' is set
  if @api_client.config.client_side_validation && suborg_id.nil?
    fail ArgumentError, "Missing the required parameter 'suborg_id' when calling OrganizationsApi.delete_sub_organization"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/suborgs/{suborgId}'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'suborgId' + '}', CGI.escape(suborg_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] || 'DeleteSubOrganization200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth', 'ProjectBearerAuth']

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

#get_org_custom_domain_dns_instructions(org_id, project_id, hostname, opts = {}) ⇒ OrgDnsInstructionsResponse

Get DNS TXT record instructions for one hostname Returns the same shape as list/add for one hostname (URL-encode hostname in the path), including dnsRecords and flyCertificateStatus when applicable. See listOrgCustomDomains for how Fly ACME and Cloudflare SaaS affect those fields.

Parameters:

  • org_id (String)
  • project_id (String)
  • hostname (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



378
379
380
381
 
# File 'lib/mudbase/api/organizations_api.rb', line 378

def get_org_custom_domain_dns_instructions(org_id, project_id, hostname, opts = {})
  data, _status_code, _headers = get_org_custom_domain_dns_instructions_with_http_info(org_id, project_id, hostname, opts)
  data
end

#get_org_custom_domain_dns_instructions_with_http_info(org_id, project_id, hostname, opts = {}) ⇒ Array<(OrgDnsInstructionsResponse, Integer, Hash)>

Get DNS TXT record instructions for one hostname Returns the same shape as list/add for one hostname (URL-encode `hostname` in the path), including `dnsRecords` and `flyCertificateStatus` when applicable. See `listOrgCustomDomains` for how Fly ACME and Cloudflare SaaS affect those fields.

Parameters:

  • org_id (String)
  • project_id (String)
  • hostname (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    OrgDnsInstructionsResponse data, response status code and response headers



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/mudbase/api/organizations_api.rb', line 390

def get_org_custom_domain_dns_instructions_with_http_info(org_id, project_id, hostname, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_org_custom_domain_dns_instructions ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.get_org_custom_domain_dns_instructions"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling OrganizationsApi.get_org_custom_domain_dns_instructions"
  end
  # verify the required parameter 'hostname' is set
  if @api_client.config.client_side_validation && hostname.nil?
    fail ArgumentError, "Missing the required parameter 'hostname' when calling OrganizationsApi.get_org_custom_domain_dns_instructions"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/projects/{projectId}/domains/{hostname}/dns-instructions'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s)).sub('{' + 'hostname' + '}', CGI.escape(hostname.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] || 'OrgDnsInstructionsResponse'

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

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

#get_organization(org_id, opts = {}) ⇒ Organization

Get organization details by ID Get organization details by ID. Requires: OrgBearerAuth (organization-level authentication only).

Parameters:

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

    the optional parameters

Returns:



451
452
453
454
 
# File 'lib/mudbase/api/organizations_api.rb', line 451

def get_organization(org_id, opts = {})
  data, _status_code, _headers = get_organization_with_http_info(org_id, opts)
  data
end

#get_organization_members(org_id, opts = {}) ⇒ GetOrganizationMembers200Response

Get organization members Get all members of an organization. Requires organization-level authentication (JWT Bearer token). API keys are not supported for this endpoint.

Parameters:

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

    the optional parameters

Returns:



514
515
516
517
 
# File 'lib/mudbase/api/organizations_api.rb', line 514

def get_organization_members(org_id, opts = {})
  data, _status_code, _headers = get_organization_members_with_http_info(org_id, opts)
  data
end

#get_organization_members_with_http_info(org_id, opts = {}) ⇒ Array<(GetOrganizationMembers200Response, Integer, Hash)>

Get organization members Get all members of an organization. Requires organization-level authentication (JWT Bearer token). API keys are not supported for this endpoint.

Parameters:

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

    the optional parameters

Returns:



524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'lib/mudbase/api/organizations_api.rb', line 524

def get_organization_members_with_http_info(org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_organization_members ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.get_organization_members"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/members'.sub('{' + 'orgId' + '}', CGI.escape(org_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] || 'GetOrganizationMembers200Response'

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

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

#get_organization_usage(org_id, opts = {}) ⇒ GetOrganizationUsage200Response

Get organization usage and billing Get usage statistics and billing information for an organization. Requires: OrgBearerAuth (organization-level authentication only).

Parameters:

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

    the optional parameters

Returns:



577
578
579
580
 
# File 'lib/mudbase/api/organizations_api.rb', line 577

def get_organization_usage(org_id, opts = {})
  data, _status_code, _headers = get_organization_usage_with_http_info(org_id, opts)
  data
end

#get_organization_usage_with_http_info(org_id, opts = {}) ⇒ Array<(GetOrganizationUsage200Response, Integer, Hash)>

Get organization usage and billing Get usage statistics and billing information for an organization. Requires: OrgBearerAuth (organization-level authentication only).

Parameters:

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

    the optional parameters

Returns:



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/mudbase/api/organizations_api.rb', line 587

def get_organization_usage_with_http_info(org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_organization_usage ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.get_organization_usage"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/usage'.sub('{' + 'orgId' + '}', CGI.escape(org_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] || 'GetOrganizationUsage200Response'

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

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

#get_organization_users(org_id, opts = {}) ⇒ GetOrganizationUsers200Response

List organization users with metadata Get all users in the organization with metadata (email, full name, role, accountStatus, phone, lastLogin, etc.). Optional query status filters by accountStatus (pending, active, suspended). Requires organization access and owner or admin role.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Filter by account status (pending, active, suspended)

Returns:



641
642
643
644
 
# File 'lib/mudbase/api/organizations_api.rb', line 641

def get_organization_users(org_id, opts = {})
  data, _status_code, _headers = get_organization_users_with_http_info(org_id, opts)
  data
end

#get_organization_users_with_http_info(org_id, opts = {}) ⇒ Array<(GetOrganizationUsers200Response, Integer, Hash)>

List organization users with metadata Get all users in the organization with metadata (email, full name, role, accountStatus, phone, lastLogin, etc.). Optional query `status` filters by accountStatus (pending, active, suspended). Requires organization access and owner or admin role.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Filter by account status (pending, active, suspended)

Returns:



652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/mudbase/api/organizations_api.rb', line 652

def get_organization_users_with_http_info(org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_organization_users ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.get_organization_users"
  end
  allowable_values = ["pending", "active", "suspended"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/users'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s))

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

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

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

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

Get organization details by ID Get organization details by ID. Requires: OrgBearerAuth (organization-level authentication only).

Parameters:

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

    the optional parameters

Returns:

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

    Organization data, response status code and response headers



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/mudbase/api/organizations_api.rb', line 461

def get_organization_with_http_info(org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_organization ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.get_organization"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}'.sub('{' + 'orgId' + '}', CGI.escape(org_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] || 'Organization'

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

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

#get_project_users(org_id, project_id, opts = {}) ⇒ GetProjectUsers200Response

List project users with metadata Get all users in a project with metadata (email, full name, role, accountStatus, etc.). Optional query status filters by accountStatus. Project must belong to the organization. Requires owner or admin role.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Filter by account status (pending, active, suspended)

Returns:



712
713
714
715
 
# File 'lib/mudbase/api/organizations_api.rb', line 712

def get_project_users(org_id, project_id, opts = {})
  data, _status_code, _headers = get_project_users_with_http_info(org_id, project_id, opts)
  data
end

#get_project_users_with_http_info(org_id, project_id, opts = {}) ⇒ Array<(GetProjectUsers200Response, Integer, Hash)>

List project users with metadata Get all users in a project with metadata (email, full name, role, accountStatus, etc.). Optional query `status` filters by accountStatus. Project must belong to the organization. Requires owner or admin role.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Filter by account status (pending, active, suspended)

Returns:

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

    GetProjectUsers200Response data, response status code and response headers



724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'lib/mudbase/api/organizations_api.rb', line 724

def get_project_users_with_http_info(org_id, project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_project_users ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.get_project_users"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling OrganizationsApi.get_project_users"
  end
  allowable_values = ["pending", "active", "suspended"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/projects/{projectId}/users'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s))

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

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

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

#get_sub_organizations(org_id, opts = {}) ⇒ GetSubOrganizations200Response

Get sub-organizations (deprecated) Get all sub-organizations under a parent organization. Requires: OrgBearerAuth (organization-level authentication only).

Parameters:

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

    the optional parameters

Returns:



786
787
788
789
 
# File 'lib/mudbase/api/organizations_api.rb', line 786

def get_sub_organizations(org_id, opts = {})
  data, _status_code, _headers = get_sub_organizations_with_http_info(org_id, opts)
  data
end

#get_sub_organizations_with_http_info(org_id, opts = {}) ⇒ Array<(GetSubOrganizations200Response, Integer, Hash)>

Get sub-organizations (deprecated) Get all sub-organizations under a parent organization. Requires: OrgBearerAuth (organization-level authentication only).

Parameters:

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

    the optional parameters

Returns:



796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/mudbase/api/organizations_api.rb', line 796

def get_sub_organizations_with_http_info(org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_sub_organizations ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.get_sub_organizations"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/suborgs'.sub('{' + 'orgId' + '}', CGI.escape(org_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] || 'GetSubOrganizations200Response'

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

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

#get_user_overview(org_id, user_id, opts = {}) ⇒ GetUserOverview200Response

Get user overview and data footprint Get a user's profile plus footprint (files count/size, sessions, API keys, collections in project). Use for dashboard to see everything tied to the user. Requires owner or admin role.

Parameters:

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

    the optional parameters

Returns:



850
851
852
853
 
# File 'lib/mudbase/api/organizations_api.rb', line 850

def get_user_overview(org_id, user_id, opts = {})
  data, _status_code, _headers = get_user_overview_with_http_info(org_id, user_id, opts)
  data
end

#get_user_overview_with_http_info(org_id, user_id, opts = {}) ⇒ Array<(GetUserOverview200Response, Integer, Hash)>

Get user overview and data footprint Get a user's profile plus footprint (files count/size, sessions, API keys, collections in project). Use for dashboard to see everything tied to the user. Requires owner or admin role.

Parameters:

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

    the optional parameters

Returns:

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

    GetUserOverview200Response data, response status code and response headers



861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/mudbase/api/organizations_api.rb', line 861

def get_user_overview_with_http_info(org_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_user_overview ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.get_user_overview"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OrganizationsApi.get_user_overview"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/users/{userId}/overview'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_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] || 'GetUserOverview200Response'

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

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

#internal_custom_domain_addon(internal_custom_domain_addon_request, opts = {}) ⇒ nil

Enable/disable Growth/Scale custom domain add-on (internal)

Parameters:

Returns:

  • (nil) 


917
918
919
920
 
# File 'lib/mudbase/api/organizations_api.rb', line 917

def internal_custom_domain_addon(internal_custom_domain_addon_request, opts = {})
  internal_custom_domain_addon_with_http_info(internal_custom_domain_addon_request, opts)
  nil
end

#internal_custom_domain_addon_with_http_info(internal_custom_domain_addon_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Enable/disable Growth/Scale custom domain add-on (internal)

Parameters:

Returns:

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

    nil, response status code and response headers



926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
 
# File 'lib/mudbase/api/organizations_api.rb', line 926

def internal_custom_domain_addon_with_http_info(internal_custom_domain_addon_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.internal_custom_domain_addon ...'
  end
  # verify the required parameter 'internal_custom_domain_addon_request' is set
  if @api_client.config.client_side_validation && internal_custom_domain_addon_request.nil?
    fail ArgumentError, "Missing the required parameter 'internal_custom_domain_addon_request' when calling OrganizationsApi.internal_custom_domain_addon"
  end
  # resource path
  local_var_path = '/internal/org/custom-domain-addon'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(internal_custom_domain_addon_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#internal_custom_domain_sweep_status(opts = {}) ⇒ nil

Custom domain background sweep status (internal) Returns the last automated custom-domain sweep (TXT recheck + Fly ACME retry), job env flags, and Fly deploy troubleshooting hints when the proxy reports the app is not listening on 0.0.0.0:PORT. Requires header X-Internal-Api-Key (same as other /internal routes).

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


981
982
983
984
 
# File 'lib/mudbase/api/organizations_api.rb', line 981

def internal_custom_domain_sweep_status(opts = {})
  internal_custom_domain_sweep_status_with_http_info(opts)
  nil
end

#internal_custom_domain_sweep_status_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Custom domain background sweep status (internal) Returns the last automated custom-domain sweep (TXT recheck + Fly ACME retry), job env flags, and Fly deploy troubleshooting hints when the proxy reports the app is not listening on 0.0.0.0:PORT. Requires header `X-Internal-Api-Key` (same as other /internal routes).

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'lib/mudbase/api/organizations_api.rb', line 990

def internal_custom_domain_sweep_status_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.internal_custom_domain_sweep_status ...'
  end
  # resource path
  local_var_path = '/internal/custom-domain/sweep-status'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#internal_domain_dns_recheck_batch(opts = {}) ⇒ nil

Batch DNS re-verification for drift (internal)

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1036
1037
1038
1039
 
# File 'lib/mudbase/api/organizations_api.rb', line 1036

def internal_domain_dns_recheck_batch(opts = {})
  internal_domain_dns_recheck_batch_with_http_info(opts)
  nil
end

#internal_domain_dns_recheck_batch_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Batch DNS re-verification for drift (internal)

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
 
# File 'lib/mudbase/api/organizations_api.rb', line 1045

def internal_domain_dns_recheck_batch_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.internal_domain_dns_recheck_batch ...'
  end
  # resource path
  local_var_path = '/internal/domain-dns/recheck-batch'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # 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[:'internal_domain_dns_recheck_batch_request'])

  # return_type
  return_type = opts[:debug_return_type]

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

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

#internal_provision_enterprise(provision_enterprise_request, opts = {}) ⇒ nil

Provision enterprise dedicated API/DB (internal)

Parameters:

Returns:

  • (nil) 


1096
1097
1098
1099
 
# File 'lib/mudbase/api/organizations_api.rb', line 1096

def internal_provision_enterprise(provision_enterprise_request, opts = {})
  internal_provision_enterprise_with_http_info(provision_enterprise_request, opts)
  nil
end

#internal_provision_enterprise_with_http_info(provision_enterprise_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Provision enterprise dedicated API/DB (internal)

Parameters:

Returns:

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

    nil, response status code and response headers



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
 
# File 'lib/mudbase/api/organizations_api.rb', line 1105

def internal_provision_enterprise_with_http_info(provision_enterprise_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.internal_provision_enterprise ...'
  end
  # verify the required parameter 'provision_enterprise_request' is set
  if @api_client.config.client_side_validation && provision_enterprise_request.nil?
    fail ArgumentError, "Missing the required parameter 'provision_enterprise_request' when calling OrganizationsApi.internal_provision_enterprise"
  end
  # resource path
  local_var_path = '/internal/provision-enterprise'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(provision_enterprise_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#invite_sub_organization_member(org_id, suborg_id, invite_member_request, opts = {}) ⇒ InviteSubOrganizationMember200Response

Invite member to sub-organization (deprecated)

Parameters:

  • org_id (String)
  • suborg_id (String)
  • invite_member_request (InviteMemberRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1162
1163
1164
1165
 
# File 'lib/mudbase/api/organizations_api.rb', line 1162

def invite_sub_organization_member(org_id, suborg_id, invite_member_request, opts = {})
  data, _status_code, _headers = invite_sub_organization_member_with_http_info(org_id, suborg_id, invite_member_request, opts)
  data
end

#invite_sub_organization_member_with_http_info(org_id, suborg_id, invite_member_request, opts = {}) ⇒ Array<(InviteSubOrganizationMember200Response, Integer, Hash)>

Invite member to sub-organization (deprecated)

Parameters:

  • org_id (String)
  • suborg_id (String)
  • invite_member_request (InviteMemberRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
 
# File 'lib/mudbase/api/organizations_api.rb', line 1173

def invite_sub_organization_member_with_http_info(org_id, suborg_id, invite_member_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.invite_sub_organization_member ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.invite_sub_organization_member"
  end
  # verify the required parameter 'suborg_id' is set
  if @api_client.config.client_side_validation && suborg_id.nil?
    fail ArgumentError, "Missing the required parameter 'suborg_id' when calling OrganizationsApi.invite_sub_organization_member"
  end
  # verify the required parameter 'invite_member_request' is set
  if @api_client.config.client_side_validation && invite_member_request.nil?
    fail ArgumentError, "Missing the required parameter 'invite_member_request' when calling OrganizationsApi.invite_sub_organization_member"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/suborgs/{suborgId}/invite'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'suborgId' + '}', CGI.escape(suborg_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(invite_member_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth', 'ProjectBearerAuth']

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

#invite_team_member(org_id, invite_member_request, opts = {}) ⇒ InviteTeamMember200Response

Invite team member to organization Send an invitation to a user to join the organization. Requires JWT Bearer token authentication. Both OrgBearerAuth and ProjectBearerAuth are supported (they use the same JWT token format). These are organization-level operations.

Parameters:

  • org_id (String)
  • invite_member_request (InviteMemberRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1240
1241
1242
1243
 
# File 'lib/mudbase/api/organizations_api.rb', line 1240

def invite_team_member(org_id, invite_member_request, opts = {})
  data, _status_code, _headers = invite_team_member_with_http_info(org_id, invite_member_request, opts)
  data
end

#invite_team_member_with_http_info(org_id, invite_member_request, opts = {}) ⇒ Array<(InviteTeamMember200Response, Integer, Hash)>

Invite team member to organization Send an invitation to a user to join the organization. Requires JWT Bearer token authentication. Both OrgBearerAuth and ProjectBearerAuth are supported (they use the same JWT token format). These are organization-level operations.

Parameters:

  • org_id (String)
  • invite_member_request (InviteMemberRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    InviteTeamMember200Response data, response status code and response headers



1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
 
# File 'lib/mudbase/api/organizations_api.rb', line 1251

def invite_team_member_with_http_info(org_id, invite_member_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.invite_team_member ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.invite_team_member"
  end
  # verify the required parameter 'invite_member_request' is set
  if @api_client.config.client_side_validation && invite_member_request.nil?
    fail ArgumentError, "Missing the required parameter 'invite_member_request' when calling OrganizationsApi.invite_team_member"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/invite'.sub('{' + 'orgId' + '}', CGI.escape(org_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(invite_member_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth', 'ProjectBearerAuth']

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

#list_org_custom_domains(org_id, project_id, opts = {}) ⇒ OrgDomainsListResponse

List custom domains and DNS verification hints Returns allowed hostnames for this project, primary hostname (per project), API base URL, and per-domain DNS guidance. Each row uses dnsRecords for the Mudbase ownership TXT (purpose mudbase_ownership) and routing CNAME from Fly dns_requirements.cname when Fly ACME has provisioned (else fallback CUSTOM_DOMAIN_API_CNAME_TARGET), and—when Fly ACME is enabled (FLY_API_TOKEN + CUSTOM_DOMAIN_FLY_ACME_ENABLED)—Fly rows (fly_ownership, acme_challenge, etc.) after the org has passed Mudbase TXT at least once. flyCertificateStatus mirrors Fly’s certificate state when ACME automation is on (e.g. pending_validation, active). cloudflareEdge appears only when Cloudflare SSL-for-SaaS env is configured. Fly ACME and Cloudflare SaaS are mutually exclusive on the server. Requires Growth, Scale, or Enterprise plan (custom domains included in plan features).

Parameters:

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

    the optional parameters

Returns:



1314
1315
1316
1317
 
# File 'lib/mudbase/api/organizations_api.rb', line 1314

def list_org_custom_domains(org_id, project_id, opts = {})
  data, _status_code, _headers = list_org_custom_domains_with_http_info(org_id, project_id, opts)
  data
end

#list_org_custom_domains_with_http_info(org_id, project_id, opts = {}) ⇒ Array<(OrgDomainsListResponse, Integer, Hash)>

List custom domains and DNS verification hints Returns allowed hostnames for this project, primary hostname (per project), API base URL, and per-domain DNS guidance. Each row uses `dnsRecords` for the Mudbase ownership TXT (purpose `mudbase_ownership`) and routing CNAME from Fly `dns_requirements.cname` when Fly ACME has provisioned (else fallback `CUSTOM_DOMAIN_API_CNAME_TARGET`), and—when Fly ACME is enabled (`FLY_API_TOKEN` + `CUSTOM_DOMAIN_FLY_ACME_ENABLED`)—Fly rows (`fly_ownership`, `acme_challenge`, etc.) after the org has passed Mudbase TXT at least once. `flyCertificateStatus` mirrors Fly’s certificate state when ACME automation is on (e.g. `pending_validation`, `active`). `cloudflareEdge` appears only when Cloudflare SSL-for-SaaS env is configured. Fly ACME and Cloudflare SaaS are mutually exclusive on the server. Requires Growth, Scale, or Enterprise plan (custom domains included in plan features).

Parameters:

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

    the optional parameters

Returns:

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

    OrgDomainsListResponse data, response status code and response headers



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
 
# File 'lib/mudbase/api/organizations_api.rb', line 1325

def list_org_custom_domains_with_http_info(org_id, project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.list_org_custom_domains ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.list_org_custom_domains"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling OrganizationsApi.list_org_custom_domains"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/projects/{projectId}/domains'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'projectId' + '}', CGI.escape(project_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] || 'OrgDomainsListResponse'

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

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

#list_organizations(opts = {}) ⇒ ListOrganizations200Response

Get all organizations for user Get all organizations the authenticated user belongs to. Requires: OrgBearerAuth (organization-level authentication only).

Parameters:

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

    the optional parameters

Returns:



1381
1382
1383
1384
 
# File 'lib/mudbase/api/organizations_api.rb', line 1381

def list_organizations(opts = {})
  data, _status_code, _headers = list_organizations_with_http_info(opts)
  data
end

#list_organizations_with_http_info(opts = {}) ⇒ Array<(ListOrganizations200Response, Integer, Hash)>

Get all organizations for user Get all organizations the authenticated user belongs to. Requires: OrgBearerAuth (organization-level authentication only).

Parameters:

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

    the optional parameters

Returns:



1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
 
# File 'lib/mudbase/api/organizations_api.rb', line 1390

def list_organizations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.list_organizations ...'
  end
  # resource path
  local_var_path = '/api/orgs'

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

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

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

#org_custom_domain_platform_ready(org_id, project_id, hostname, opts = {}) ⇒ nil

Notify platform ops that hosting or edge work is ready (email) Legacy optional ping: ops are emailed automatically on first successful Mudbase TXT verify. Use this only for an extra nudge. Sends an email to ops while the domain is in platform setup (after Mudbase TXT verification through later pipeline states). Recipients default to admin@mudhaxkservices.com and admin@mudbase.dev when CUSTOM_DOMAIN_OPS_NOTIFY_EMAILS is unset; override with that env (comma/space-separated). Returns 503 email_provider_not_configured if no email provider is configured (e.g. missing ZEPTOMAIL_SEND_TOKEN).

Parameters:

  • org_id (String)
  • project_id (String)
  • hostname (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1442
1443
1444
1445
 
# File 'lib/mudbase/api/organizations_api.rb', line 1442

def org_custom_domain_platform_ready(org_id, project_id, hostname, opts = {})
  org_custom_domain_platform_ready_with_http_info(org_id, project_id, hostname, opts)
  nil
end

#org_custom_domain_platform_ready_with_http_info(org_id, project_id, hostname, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Notify platform ops that hosting or edge work is ready (email) Legacy optional ping: ops are emailed automatically on first successful Mudbase TXT verify. Use this only for an extra nudge. Sends an email to ops while the domain is in platform setup (after Mudbase TXT verification through later pipeline states). Recipients default to `admin@mudhaxkservices.com` and `admin@mudbase.dev` when `CUSTOM_DOMAIN_OPS_NOTIFY_EMAILS` is unset; override with that env (comma/space-separated). Returns 503 `email_provider_not_configured` if no email provider is configured (e.g. missing `ZEPTOMAIL_SEND_TOKEN`).

Parameters:

  • org_id (String)
  • project_id (String)
  • hostname (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
 
# File 'lib/mudbase/api/organizations_api.rb', line 1455

def org_custom_domain_platform_ready_with_http_info(org_id, project_id, hostname, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.org_custom_domain_platform_ready ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.org_custom_domain_platform_ready"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling OrganizationsApi.org_custom_domain_platform_ready"
  end
  # verify the required parameter 'hostname' is set
  if @api_client.config.client_side_validation && hostname.nil?
    fail ArgumentError, "Missing the required parameter 'hostname' when calling OrganizationsApi.org_custom_domain_platform_ready"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/projects/{projectId}/domains/{hostname}/platform-ready'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s)).sub('{' + 'hostname' + '}', CGI.escape(hostname.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # 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[:'org_custom_domain_platform_ready_request'])

  # return_type
  return_type = opts[:debug_return_type]

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

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

#org_custom_domain_submit_cname(org_id, project_id, hostname, opts = {}) ⇒ OrgPatchDomainResponse

Custom domain step 2 (optional): org confirms routing CNAME was added Usually unnecessary. With Fly ACME default automation, Mudbase TXT verify may already set cname_approved. Legacy pipelines may queue cname_pending_staff until staff approve-cname. Use routingCnameTarget from GET .../projects/{projectId}/domains (Fly dns_requirements.cname when provisioned, else CUSTOM_DOMAIN_API_CNAME_TARGET).

Parameters:

  • org_id (String)
  • project_id (String)
  • hostname (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1521
1522
1523
1524
 
# File 'lib/mudbase/api/organizations_api.rb', line 1521

def org_custom_domain_submit_cname(org_id, project_id, hostname, opts = {})
  data, _status_code, _headers = org_custom_domain_submit_cname_with_http_info(org_id, project_id, hostname, opts)
  data
end

#org_custom_domain_submit_cname_with_http_info(org_id, project_id, hostname, opts = {}) ⇒ Array<(OrgPatchDomainResponse, Integer, Hash)>

Custom domain step 2 (optional): org confirms routing CNAME was added Usually unnecessary. With Fly ACME default automation, Mudbase TXT verify may already set `cname_approved`. Legacy pipelines may queue `cname_pending_staff` until staff `approve-cname`. Use `routingCnameTarget` from `GET .../projects/projectId/domains` (Fly `dns_requirements.cname` when provisioned, else `CUSTOM_DOMAIN_API_CNAME_TARGET`).

Parameters:

  • org_id (String)
  • project_id (String)
  • hostname (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    OrgPatchDomainResponse data, response status code and response headers



1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'lib/mudbase/api/organizations_api.rb', line 1533

def org_custom_domain_submit_cname_with_http_info(org_id, project_id, hostname, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.org_custom_domain_submit_cname ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.org_custom_domain_submit_cname"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling OrganizationsApi.org_custom_domain_submit_cname"
  end
  # verify the required parameter 'hostname' is set
  if @api_client.config.client_side_validation && hostname.nil?
    fail ArgumentError, "Missing the required parameter 'hostname' when calling OrganizationsApi.org_custom_domain_submit_cname"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/projects/{projectId}/domains/{hostname}/submit-cname'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s)).sub('{' + 'hostname' + '}', CGI.escape(hostname.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] || 'OrgPatchDomainResponse'

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

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

#org_custom_domain_submit_platform_dns_verification_deprecated(org_id, project_id, hostname, opts = {}) ⇒ OrgPatchDomainResponse

Deprecated — use POST .../verify-platform-dns Deprecated alias of orgCustomDomainVerifyPlatformDns (same behavior — manual TXT and/or Fly ACME path per server config).

Parameters:

  • org_id (String)
  • project_id (String)
  • hostname (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1596
1597
1598
1599
 
# File 'lib/mudbase/api/organizations_api.rb', line 1596

def org_custom_domain_submit_platform_dns_verification_deprecated(org_id, project_id, hostname, opts = {})
  data, _status_code, _headers = org_custom_domain_submit_platform_dns_verification_deprecated_with_http_info(org_id, project_id, hostname, opts)
  data
end

#org_custom_domain_submit_platform_dns_verification_deprecated_with_http_info(org_id, project_id, hostname, opts = {}) ⇒ Array<(OrgPatchDomainResponse, Integer, Hash)>

Deprecated — use POST .../verify-platform-dns Deprecated alias of `orgCustomDomainVerifyPlatformDns` (same behavior — manual TXT and/or Fly ACME path per server config).

Parameters:

  • org_id (String)
  • project_id (String)
  • hostname (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    OrgPatchDomainResponse data, response status code and response headers



1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
 
# File 'lib/mudbase/api/organizations_api.rb', line 1608

def org_custom_domain_submit_platform_dns_verification_deprecated_with_http_info(org_id, project_id, hostname, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.org_custom_domain_submit_platform_dns_verification_deprecated ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.org_custom_domain_submit_platform_dns_verification_deprecated"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling OrganizationsApi.org_custom_domain_submit_platform_dns_verification_deprecated"
  end
  # verify the required parameter 'hostname' is set
  if @api_client.config.client_side_validation && hostname.nil?
    fail ArgumentError, "Missing the required parameter 'hostname' when calling OrganizationsApi.org_custom_domain_submit_platform_dns_verification_deprecated"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/projects/{projectId}/domains/{hostname}/submit-platform-dns-verification'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s)).sub('{' + 'hostname' + '}', CGI.escape(hostname.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] || 'OrgPatchDomainResponse'

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

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

#org_custom_domain_verify_platform_dns(org_id, project_id, hostname, opts = {}) ⇒ OrgPatchDomainResponse

Custom domain step 3: verify platform DNS (manual TXT or Fly certificate readiness) Manual path (no Fly ACME): After staff PATCH .../platform-dns-verification, the org adds the published TXT and calls this endpoint. The API resolves public TXT at platformDnsVerification.recordName and matches recordValue. On success, status → platform_dns_pending_review until staff POST .../activate. Fly ACME path (default): When Fly ACME is enabled and CUSTOM_DOMAIN_FLY_LEGACY_STAFF_PIPELINE is not set, the org calls this after Mudbase TXT and Fly DNS rows are in place (status typically cname_approved from automated verify-dns). The API triggers Fly POST .../check and GET certificate with bounded retries. On success, status → active and the org may receive the activation email—no staff approve-cname or activate required. Fly legacy: If CUSTOM_DOMAIN_FLY_LEGACY_STAFF_PIPELINE=true, behavior matches the older flow: staff approve-cname may be required first; after a ready Fly cert, status becomes active only when CUSTOM_DOMAIN_FLY_AUTO_ACTIVATE=true, else platform_dns_pending_review until staff activate. platform_dns_verification_failed may include details.flyStatus / details.flyError on the Fly path.

Parameters:

  • org_id (String)
  • project_id (String)
  • hostname (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1671
1672
1673
1674
 
# File 'lib/mudbase/api/organizations_api.rb', line 1671

def org_custom_domain_verify_platform_dns(org_id, project_id, hostname, opts = {})
  data, _status_code, _headers = org_custom_domain_verify_platform_dns_with_http_info(org_id, project_id, hostname, opts)
  data
end

#org_custom_domain_verify_platform_dns_with_http_info(org_id, project_id, hostname, opts = {}) ⇒ Array<(OrgPatchDomainResponse, Integer, Hash)>

Custom domain step 3: verify platform DNS (manual TXT or Fly certificate readiness) Manual path (no Fly ACME): After staff `PATCH .../platform-dns-verification`, the org adds the published TXT and calls this endpoint. The API resolves public TXT at `platformDnsVerification.recordName` and matches `recordValue`. On success, `status` → `platform_dns_pending_review` until staff `POST .../activate`. Fly ACME path (default): When Fly ACME is enabled and `CUSTOM_DOMAIN_FLY_LEGACY_STAFF_PIPELINE` is not set, the org calls this after Mudbase TXT and Fly DNS rows are in place (status typically `cname_approved` from automated verify-dns). The API triggers Fly `POST .../check` and `GET` certificate with bounded retries. On success, `status` → `active` and the org may receive the activation email—no staff `approve-cname` or `activate` required. Fly legacy: If `CUSTOM_DOMAIN_FLY_LEGACY_STAFF_PIPELINE=true`, behavior matches the older flow: staff `approve-cname` may be required first; after a ready Fly cert, `status` becomes `active` only when `CUSTOM_DOMAIN_FLY_AUTO_ACTIVATE=true`, else `platform_dns_pending_review` until staff `activate`. `platform_dns_verification_failed` may include `details.flyStatus` / `details.flyError` on the Fly path.

Parameters:

  • org_id (String)
  • project_id (String)
  • hostname (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    OrgPatchDomainResponse data, response status code and response headers



1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
 
# File 'lib/mudbase/api/organizations_api.rb', line 1683

def org_custom_domain_verify_platform_dns_with_http_info(org_id, project_id, hostname, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.org_custom_domain_verify_platform_dns ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.org_custom_domain_verify_platform_dns"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling OrganizationsApi.org_custom_domain_verify_platform_dns"
  end
  # verify the required parameter 'hostname' is set
  if @api_client.config.client_side_validation && hostname.nil?
    fail ArgumentError, "Missing the required parameter 'hostname' when calling OrganizationsApi.org_custom_domain_verify_platform_dns"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/projects/{projectId}/domains/{hostname}/verify-platform-dns'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s)).sub('{' + 'hostname' + '}', CGI.escape(hostname.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] || 'OrgPatchDomainResponse'

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

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

#patch_org_custom_domain(org_id, project_id, hostname, opts = {}) ⇒ OrgPatchDomainResponse

Update domain status or regenerate verification token

Parameters:

  • org_id (String)
  • project_id (String)
  • hostname (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1746
1747
1748
1749
 
# File 'lib/mudbase/api/organizations_api.rb', line 1746

def patch_org_custom_domain(org_id, project_id, hostname, opts = {})
  data, _status_code, _headers = patch_org_custom_domain_with_http_info(org_id, project_id, hostname, opts)
  data
end

#patch_org_custom_domain_with_http_info(org_id, project_id, hostname, opts = {}) ⇒ Array<(OrgPatchDomainResponse, Integer, Hash)>

Update domain status or regenerate verification token

Parameters:

  • org_id (String)
  • project_id (String)
  • hostname (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

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

    OrgPatchDomainResponse data, response status code and response headers



1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
 
# File 'lib/mudbase/api/organizations_api.rb', line 1758

def patch_org_custom_domain_with_http_info(org_id, project_id, hostname, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.patch_org_custom_domain ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.patch_org_custom_domain"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling OrganizationsApi.patch_org_custom_domain"
  end
  # verify the required parameter 'hostname' is set
  if @api_client.config.client_side_validation && hostname.nil?
    fail ArgumentError, "Missing the required parameter 'hostname' when calling OrganizationsApi.patch_org_custom_domain"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/projects/{projectId}/domains/{hostname}'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s)).sub('{' + 'hostname' + '}', CGI.escape(hostname.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[:'patch_org_domain_request'])

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

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

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

#remove_sub_organization_member(org_id, suborg_id, user_id, opts = {}) ⇒ RemoveTeamMember200Response

Remove member from sub-organization (deprecated)

Parameters:

  • org_id (String)
  • suborg_id (String)
  • user_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1825
1826
1827
1828
 
# File 'lib/mudbase/api/organizations_api.rb', line 1825

def remove_sub_organization_member(org_id, suborg_id, user_id, opts = {})
  data, _status_code, _headers = remove_sub_organization_member_with_http_info(org_id, suborg_id, user_id, opts)
  data
end

#remove_sub_organization_member_with_http_info(org_id, suborg_id, user_id, opts = {}) ⇒ Array<(RemoveTeamMember200Response, Integer, Hash)>

Remove member from sub-organization (deprecated)

Parameters:

  • org_id (String)
  • suborg_id (String)
  • user_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    RemoveTeamMember200Response data, response status code and response headers



1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
 
# File 'lib/mudbase/api/organizations_api.rb', line 1836

def remove_sub_organization_member_with_http_info(org_id, suborg_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.remove_sub_organization_member ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.remove_sub_organization_member"
  end
  # verify the required parameter 'suborg_id' is set
  if @api_client.config.client_side_validation && suborg_id.nil?
    fail ArgumentError, "Missing the required parameter 'suborg_id' when calling OrganizationsApi.remove_sub_organization_member"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OrganizationsApi.remove_sub_organization_member"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/suborgs/{suborgId}/members/{userId}'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'suborgId' + '}', CGI.escape(suborg_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_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] || 'RemoveTeamMember200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth', 'ProjectBearerAuth']

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

#remove_team_member(org_id, user_id, opts = {}) ⇒ RemoveTeamMember200Response

Remove team member from organization Remove a user from the organization. Requires JWT Bearer token authentication. Both OrgBearerAuth and ProjectBearerAuth are supported (they use the same JWT token format). These are organization-level operations.

Parameters:

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

    the optional parameters

Returns:



1898
1899
1900
1901
 
# File 'lib/mudbase/api/organizations_api.rb', line 1898

def remove_team_member(org_id, user_id, opts = {})
  data, _status_code, _headers = remove_team_member_with_http_info(org_id, user_id, opts)
  data
end

#remove_team_member_with_http_info(org_id, user_id, opts = {}) ⇒ Array<(RemoveTeamMember200Response, Integer, Hash)>

Remove team member from organization Remove a user from the organization. Requires JWT Bearer token authentication. Both OrgBearerAuth and ProjectBearerAuth are supported (they use the same JWT token format). These are organization-level operations.

Parameters:

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

    the optional parameters

Returns:

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

    RemoveTeamMember200Response data, response status code and response headers



1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
 
# File 'lib/mudbase/api/organizations_api.rb', line 1909

def remove_team_member_with_http_info(org_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.remove_team_member ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.remove_team_member"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OrganizationsApi.remove_team_member"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/members/{userId}'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_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] || 'RemoveTeamMember200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth', 'ProjectBearerAuth']

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

#set_org_primary_domain(org_id, project_id, set_org_primary_domain_request, opts = {}) ⇒ nil

Set primary custom domain

Parameters:

  • org_id (String)
  • project_id (String)
  • set_org_primary_domain_request (SetOrgPrimaryDomainRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1967
1968
1969
1970
 
# File 'lib/mudbase/api/organizations_api.rb', line 1967

def set_org_primary_domain(org_id, project_id, set_org_primary_domain_request, opts = {})
  set_org_primary_domain_with_http_info(org_id, project_id, set_org_primary_domain_request, opts)
  nil
end

#set_org_primary_domain_with_http_info(org_id, project_id, set_org_primary_domain_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Set primary custom domain

Parameters:

  • org_id (String)
  • project_id (String)
  • set_org_primary_domain_request (SetOrgPrimaryDomainRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
 
# File 'lib/mudbase/api/organizations_api.rb', line 1978

def set_org_primary_domain_with_http_info(org_id, project_id, set_org_primary_domain_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.set_org_primary_domain ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.set_org_primary_domain"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling OrganizationsApi.set_org_primary_domain"
  end
  # verify the required parameter 'set_org_primary_domain_request' is set
  if @api_client.config.client_side_validation && set_org_primary_domain_request.nil?
    fail ArgumentError, "Missing the required parameter 'set_org_primary_domain_request' when calling OrganizationsApi.set_org_primary_domain"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/projects/{projectId}/domains/primary'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(set_org_primary_domain_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#update_member_role(org_id, user_id, update_member_role_request, opts = {}) ⇒ UpdateMemberRole200Response

Update member role Update a member's role in the organization. Requires organization-level authentication (JWT Bearer token). API keys are not supported for this endpoint.

Parameters:

  • org_id (String)
  • user_id (String)
  • update_member_role_request (UpdateMemberRoleRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2044
2045
2046
2047
 
# File 'lib/mudbase/api/organizations_api.rb', line 2044

def update_member_role(org_id, user_id, update_member_role_request, opts = {})
  data, _status_code, _headers = update_member_role_with_http_info(org_id, user_id, update_member_role_request, opts)
  data
end

#update_member_role_with_http_info(org_id, user_id, update_member_role_request, opts = {}) ⇒ Array<(UpdateMemberRole200Response, Integer, Hash)>

Update member role Update a member's role in the organization. Requires organization-level authentication (JWT Bearer token). API keys are not supported for this endpoint.

Parameters:

  • org_id (String)
  • user_id (String)
  • update_member_role_request (UpdateMemberRoleRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    UpdateMemberRole200Response data, response status code and response headers



2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
 
# File 'lib/mudbase/api/organizations_api.rb', line 2056

def update_member_role_with_http_info(org_id, user_id, update_member_role_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.update_member_role ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.update_member_role"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OrganizationsApi.update_member_role"
  end
  # verify the required parameter 'update_member_role_request' is set
  if @api_client.config.client_side_validation && update_member_role_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_member_role_request' when calling OrganizationsApi.update_member_role"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/members/{userId}/role'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_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_member_role_request)

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

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

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

#update_organization(org_id, update_organization_request, opts = {}) ⇒ UpdateOrganization200Response

Update organization Update organization details. Requires organization-level authentication (JWT Bearer token). API keys are not supported for this endpoint.

Parameters:

  • org_id (String)
  • update_organization_request (UpdateOrganizationRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2123
2124
2125
2126
 
# File 'lib/mudbase/api/organizations_api.rb', line 2123

def update_organization(org_id, update_organization_request, opts = {})
  data, _status_code, _headers = update_organization_with_http_info(org_id, update_organization_request, opts)
  data
end

#update_organization_plan(org_id, update_organization_plan_request, opts = {}) ⇒ UpdateOrganizationPlan200Response

Update organization plan

Parameters:

Returns:



2196
2197
2198
2199
 
# File 'lib/mudbase/api/organizations_api.rb', line 2196

def update_organization_plan(org_id, update_organization_plan_request, opts = {})
  data, _status_code, _headers = update_organization_plan_with_http_info(org_id, update_organization_plan_request, opts)
  data
end

#update_organization_plan_with_http_info(org_id, update_organization_plan_request, opts = {}) ⇒ Array<(UpdateOrganizationPlan200Response, Integer, Hash)>

Update organization plan

Parameters:

Returns:



2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
 
# File 'lib/mudbase/api/organizations_api.rb', line 2206

def update_organization_plan_with_http_info(org_id, update_organization_plan_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.update_organization_plan ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.update_organization_plan"
  end
  # verify the required parameter 'update_organization_plan_request' is set
  if @api_client.config.client_side_validation && update_organization_plan_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_organization_plan_request' when calling OrganizationsApi.update_organization_plan"
  end
  # resource path
  local_var_path = '/api/orgs/plan/{orgId}'.sub('{' + 'orgId' + '}', CGI.escape(org_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_organization_plan_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth', 'ProjectBearerAuth']

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

#update_organization_with_http_info(org_id, update_organization_request, opts = {}) ⇒ Array<(UpdateOrganization200Response, Integer, Hash)>

Update organization Update organization details. Requires organization-level authentication (JWT Bearer token). API keys are not supported for this endpoint.

Parameters:

  • org_id (String)
  • update_organization_request (UpdateOrganizationRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
 
# File 'lib/mudbase/api/organizations_api.rb', line 2134

def update_organization_with_http_info(org_id, update_organization_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.update_organization ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.update_organization"
  end
  # verify the required parameter 'update_organization_request' is set
  if @api_client.config.client_side_validation && update_organization_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_organization_request' when calling OrganizationsApi.update_organization"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}'.sub('{' + 'orgId' + '}', CGI.escape(org_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_organization_request)

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

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

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

#update_sub_organization(org_id, suborg_id, update_organization_request, opts = {}) ⇒ UpdateSubOrganization200Response

Update sub-organization (deprecated) Update a sub-organization's configuration. Requires JWT Bearer token authentication. Both OrgBearerAuth and ProjectBearerAuth are supported (they use the same JWT token format). These are organization-level operations.

Parameters:

  • org_id (String)
  • suborg_id (String)
  • update_organization_request (UpdateOrganizationRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2270
2271
2272
2273
 
# File 'lib/mudbase/api/organizations_api.rb', line 2270

def update_sub_organization(org_id, suborg_id, update_organization_request, opts = {})
  data, _status_code, _headers = update_sub_organization_with_http_info(org_id, suborg_id, update_organization_request, opts)
  data
end

#update_sub_organization_member_role(org_id, suborg_id, user_id, update_member_role_request, opts = {}) ⇒ UpdateMemberRole200Response

Update sub-organization member role (deprecated)

Parameters:

  • org_id (String)
  • suborg_id (String)
  • user_id (String)
  • update_member_role_request (UpdateMemberRoleRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2350
2351
2352
2353
 
# File 'lib/mudbase/api/organizations_api.rb', line 2350

def update_sub_organization_member_role(org_id, suborg_id, user_id, update_member_role_request, opts = {})
  data, _status_code, _headers = update_sub_organization_member_role_with_http_info(org_id, suborg_id, user_id, update_member_role_request, opts)
  data
end

#update_sub_organization_member_role_with_http_info(org_id, suborg_id, user_id, update_member_role_request, opts = {}) ⇒ Array<(UpdateMemberRole200Response, Integer, Hash)>

Update sub-organization member role (deprecated)

Parameters:

  • org_id (String)
  • suborg_id (String)
  • user_id (String)
  • update_member_role_request (UpdateMemberRoleRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    UpdateMemberRole200Response data, response status code and response headers



2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
 
# File 'lib/mudbase/api/organizations_api.rb', line 2362

def update_sub_organization_member_role_with_http_info(org_id, suborg_id, user_id, update_member_role_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.update_sub_organization_member_role ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.update_sub_organization_member_role"
  end
  # verify the required parameter 'suborg_id' is set
  if @api_client.config.client_side_validation && suborg_id.nil?
    fail ArgumentError, "Missing the required parameter 'suborg_id' when calling OrganizationsApi.update_sub_organization_member_role"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OrganizationsApi.update_sub_organization_member_role"
  end
  # verify the required parameter 'update_member_role_request' is set
  if @api_client.config.client_side_validation && update_member_role_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_member_role_request' when calling OrganizationsApi.update_sub_organization_member_role"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/suborgs/{suborgId}/members/{userId}/role'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'suborgId' + '}', CGI.escape(suborg_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_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_member_role_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth', 'ProjectBearerAuth']

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

#update_sub_organization_with_http_info(org_id, suborg_id, update_organization_request, opts = {}) ⇒ Array<(UpdateSubOrganization200Response, Integer, Hash)>

Update sub-organization (deprecated) Update a sub-organization's configuration. Requires JWT Bearer token authentication. Both OrgBearerAuth and ProjectBearerAuth are supported (they use the same JWT token format). These are organization-level operations.

Parameters:

  • org_id (String)
  • suborg_id (String)
  • update_organization_request (UpdateOrganizationRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
 
# File 'lib/mudbase/api/organizations_api.rb', line 2282

def update_sub_organization_with_http_info(org_id, suborg_id, update_organization_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.update_sub_organization ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.update_sub_organization"
  end
  # verify the required parameter 'suborg_id' is set
  if @api_client.config.client_side_validation && suborg_id.nil?
    fail ArgumentError, "Missing the required parameter 'suborg_id' when calling OrganizationsApi.update_sub_organization"
  end
  # verify the required parameter 'update_organization_request' is set
  if @api_client.config.client_side_validation && update_organization_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_organization_request' when calling OrganizationsApi.update_sub_organization"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/suborgs/{suborgId}'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'suborgId' + '}', CGI.escape(suborg_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_organization_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth', 'ProjectBearerAuth']

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

#update_user_account_status(org_id, user_id, update_user_account_status_request, opts = {}) ⇒ UpdateUserAccountStatus200Response

Update user account status (activate or suspend) Set a user's account status to active or suspended. Used to approve pending users or suspend/activate accounts. Cannot change status of an organization owner. Requires owner or admin role.

Parameters:

  • org_id (String)
  • user_id (String)
  • update_user_account_status_request (UpdateUserAccountStatusRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2434
2435
2436
2437
 
# File 'lib/mudbase/api/organizations_api.rb', line 2434

def (org_id, user_id, , opts = {})
  data, _status_code, _headers = (org_id, user_id, , opts)
  data
end

#update_user_account_status_with_http_info(org_id, user_id, update_user_account_status_request, opts = {}) ⇒ Array<(UpdateUserAccountStatus200Response, Integer, Hash)>

Update user account status (activate or suspend) Set a user's account status to active or suspended. Used to approve pending users or suspend/activate accounts. Cannot change status of an organization owner. Requires owner or admin role.

Parameters:

  • org_id (String)
  • user_id (String)
  • update_user_account_status_request (UpdateUserAccountStatusRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
 
# File 'lib/mudbase/api/organizations_api.rb', line 2446

def (org_id, user_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.update_user_account_status ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.update_user_account_status"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OrganizationsApi.update_user_account_status"
  end
  # verify the required parameter 'update_user_account_status_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'update_user_account_status_request' when calling OrganizationsApi.update_user_account_status"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/users/{userId}/status'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_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()

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

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

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

#verify_org_custom_domain_dns(org_id, project_id, hostname, opts = {}) ⇒ OrgVerifyCustomDomainDnsSuccessResponse

Verify domain ownership via DNS TXT Looks up TXT at _mudbase-verify.<hostname> for value mudbase-domain-verification=<token>. When the server has CLOUDFLARE_API_TOKEN and CLOUDFLARE_ZONE_ID configured (and Fly ACME is not enabled), a successful verify also creates or refreshes a Cloudflare Custom Hostname (SSL for SaaS) and returns cloudflare with DCV hints. When Fly ACME is enabled (FLY_API_TOKEN + CUSTOM_DOMAIN_FLY_ACME_ENABLED=true + app slug), a successful verify calls Fly’s Certificates API (POST .../certificates/acme) and persists DNS requirements. If Fly returns DNS rows and CUSTOM_DOMAIN_FLY_LEGACY_STAFF_PIPELINE is not set, status advances to cname_approved in the same response (no staff approve-cname); org.domain.cname_staff_queued is not logged for that path. Otherwise (legacy Fly or non-Fly), first success from pending/failed may move to cname_pending_staff and queue staff as before. The 200 response may include dnsRecords, flyCertificateStatus, and routingCnameTarget from Fly’s dns_requirements.cname when provisioned. Cloudflare SaaS and Fly ACME cannot both be enabled; the API process refuses to start if both are configured.

Parameters:

  • org_id (String)
  • project_id (String)
  • hostname (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2514
2515
2516
2517
 
# File 'lib/mudbase/api/organizations_api.rb', line 2514

def verify_org_custom_domain_dns(org_id, project_id, hostname, opts = {})
  data, _status_code, _headers = verify_org_custom_domain_dns_with_http_info(org_id, project_id, hostname, opts)
  data
end

#verify_org_custom_domain_dns_with_http_info(org_id, project_id, hostname, opts = {}) ⇒ Array<(OrgVerifyCustomDomainDnsSuccessResponse, Integer, Hash)>

Verify domain ownership via DNS TXT Looks up TXT at `_mudbase-verify.<hostname>` for value `mudbase-domain-verification=<token>`. When the server has `CLOUDFLARE_API_TOKEN` and `CLOUDFLARE_ZONE_ID` configured (and Fly ACME is not enabled), a successful verify also creates or refreshes a Cloudflare Custom Hostname (SSL for SaaS) and returns `cloudflare` with DCV hints. When Fly ACME is enabled (`FLY_API_TOKEN` + `CUSTOM_DOMAIN_FLY_ACME_ENABLED=true` + app slug), a successful verify calls Fly’s Certificates API (`POST .../certificates/acme`) and persists DNS requirements. If Fly returns DNS rows and `CUSTOM_DOMAIN_FLY_LEGACY_STAFF_PIPELINE` is not set, status advances to `cname_approved` in the same response (no staff `approve-cname`); `org.domain.cname_staff_queued` is not logged for that path. Otherwise (legacy Fly or non-Fly), first success from `pending`/`failed` may move to `cname_pending_staff` and queue staff as before. The 200 response may include `dnsRecords`, `flyCertificateStatus`, and `routingCnameTarget` from Fly’s `dns_requirements.cname` when provisioned. Cloudflare SaaS and Fly ACME cannot both be enabled; the API process refuses to start if both are configured.

Parameters:

  • org_id (String)
  • project_id (String)
  • hostname (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
 
# File 'lib/mudbase/api/organizations_api.rb', line 2526

def verify_org_custom_domain_dns_with_http_info(org_id, project_id, hostname, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsApi.verify_org_custom_domain_dns ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationsApi.verify_org_custom_domain_dns"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling OrganizationsApi.verify_org_custom_domain_dns"
  end
  # verify the required parameter 'hostname' is set
  if @api_client.config.client_side_validation && hostname.nil?
    fail ArgumentError, "Missing the required parameter 'hostname' when calling OrganizationsApi.verify_org_custom_domain_dns"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/projects/{projectId}/domains/{hostname}/verify-dns'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s)).sub('{' + 'hostname' + '}', CGI.escape(hostname.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] || 'OrgVerifyCustomDomainDnsSuccessResponse'

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

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