mudbase 1.2.10 → 1.2.11

data/docs/OrganizationsApi.md

@@ -1,516 +0,0 @@
-# Mudbase::OrganizationsApi
-
-All URIs are relative to *https://cloud.mudbase.dev*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**organizations_add_domain**](OrganizationsApi.md#organizations_add_domain) | **POST** /api/orgs/{orgId}/projects/{projectId}/domains | Add custom domain |
-| [**organizations_list_domains**](OrganizationsApi.md#organizations_list_domains) | **GET** /api/orgs/{orgId}/projects/{projectId}/domains | List custom domains and DNS TXT hints |
-| [**organizations_patch_domain**](OrganizationsApi.md#organizations_patch_domain) | **PATCH** /api/orgs/{orgId}/projects/{projectId}/domains/{hostname} | Patch domain status or regenerate token |
-| [**organizations_remove_domain**](OrganizationsApi.md#organizations_remove_domain) | **DELETE** /api/orgs/{orgId}/projects/{projectId}/domains/{hostname} | Remove custom domain |
-| [**organizations_report_domain_platform_ready**](OrganizationsApi.md#organizations_report_domain_platform_ready) | **POST** /api/orgs/{orgId}/projects/{projectId}/domains/{hostname}/platform-ready | Notify platform ops hosting / edge ready |
-| [**organizations_set_primary_domain**](OrganizationsApi.md#organizations_set_primary_domain) | **PATCH** /api/orgs/{orgId}/projects/{projectId}/domains/primary | Set primary custom domain |
-| [**organizations_verify_domain_dns**](OrganizationsApi.md#organizations_verify_domain_dns) | **POST** /api/orgs/{orgId}/projects/{projectId}/domains/{hostname}/verify-dns | Verify domain via DNS TXT |
-
-
-## organizations_add_domain
-
-> organizations_add_domain(org_id, project_id, organizations_add_domain_request)
-
-Add custom domain
-
-### Examples
-
-```ruby
-require 'time'
-require 'mudbase'
-# setup authorization
-Mudbase.configure do |config|
-  # Configure Bearer authorization (JWT): BearerToken
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = Mudbase::OrganizationsApi.new
-org_id = 'org_id_example' # String | 
-project_id = 'project_id_example' # String | 
-organizations_add_domain_request = Mudbase::OrganizationsAddDomainRequest.new({hostname: 'hostname_example'}) # OrganizationsAddDomainRequest | 
-
-begin
-  # Add custom domain
-  api_instance.organizations_add_domain(org_id, project_id, organizations_add_domain_request)
-rescue Mudbase::ApiError => e
-  puts "Error when calling OrganizationsApi->organizations_add_domain: #{e}"
-end
-```
-
-#### Using the organizations_add_domain_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-
-> <Array(nil, Integer, Hash)> organizations_add_domain_with_http_info(org_id, project_id, organizations_add_domain_request)
-
-```ruby
-begin
-  # Add custom domain
-  data, status_code, headers = api_instance.organizations_add_domain_with_http_info(org_id, project_id, organizations_add_domain_request)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue Mudbase::ApiError => e
-  puts "Error when calling OrganizationsApi->organizations_add_domain_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **org_id** | **String** |  |  |
-| **project_id** | **String** |  |  |
-| **organizations_add_domain_request** | [**OrganizationsAddDomainRequest**](OrganizationsAddDomainRequest.md) |  |  |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[BearerToken](../README.md#BearerToken)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## organizations_list_domains
-
-> organizations_list_domains(org_id, project_id)
-
-List custom domains and DNS TXT hints
-
-Owner/admin. Domains are per project. Returns dnsTxtHost, dnsTxtValue, platformActivationPending (dns_verified waiting for ops), and customDomainLiveForApiTraffic (active or legacy verified). 
-
-### Examples
-
-```ruby
-require 'time'
-require 'mudbase'
-# setup authorization
-Mudbase.configure do |config|
-  # Configure Bearer authorization (JWT): BearerToken
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = Mudbase::OrganizationsApi.new
-org_id = 'org_id_example' # String | 
-project_id = 'project_id_example' # String | 
-
-begin
-  # List custom domains and DNS TXT hints
-  api_instance.organizations_list_domains(org_id, project_id)
-rescue Mudbase::ApiError => e
-  puts "Error when calling OrganizationsApi->organizations_list_domains: #{e}"
-end
-```
-
-#### Using the organizations_list_domains_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-
-> <Array(nil, Integer, Hash)> organizations_list_domains_with_http_info(org_id, project_id)
-
-```ruby
-begin
-  # List custom domains and DNS TXT hints
-  data, status_code, headers = api_instance.organizations_list_domains_with_http_info(org_id, project_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue Mudbase::ApiError => e
-  puts "Error when calling OrganizationsApi->organizations_list_domains_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **org_id** | **String** |  |  |
-| **project_id** | **String** |  |  |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[BearerToken](../README.md#BearerToken)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## organizations_patch_domain
-
-> organizations_patch_domain(org_id, project_id, hostname, opts)
-
-Patch domain status or regenerate token
-
-### Examples
-
-```ruby
-require 'time'
-require 'mudbase'
-# setup authorization
-Mudbase.configure do |config|
-  # Configure Bearer authorization (JWT): BearerToken
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = Mudbase::OrganizationsApi.new
-org_id = 'org_id_example' # String | 
-project_id = 'project_id_example' # String | 
-hostname = 'hostname_example' # String | 
-opts = {
-  organizations_patch_domain_request: Mudbase::OrganizationsPatchDomainRequest.new # OrganizationsPatchDomainRequest | 
-}
-
-begin
-  # Patch domain status or regenerate token
-  api_instance.organizations_patch_domain(org_id, project_id, hostname, opts)
-rescue Mudbase::ApiError => e
-  puts "Error when calling OrganizationsApi->organizations_patch_domain: #{e}"
-end
-```
-
-#### Using the organizations_patch_domain_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-
-> <Array(nil, Integer, Hash)> organizations_patch_domain_with_http_info(org_id, project_id, hostname, opts)
-
-```ruby
-begin
-  # Patch domain status or regenerate token
-  data, status_code, headers = api_instance.organizations_patch_domain_with_http_info(org_id, project_id, hostname, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue Mudbase::ApiError => e
-  puts "Error when calling OrganizationsApi->organizations_patch_domain_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **org_id** | **String** |  |  |
-| **project_id** | **String** |  |  |
-| **hostname** | **String** |  |  |
-| **organizations_patch_domain_request** | [**OrganizationsPatchDomainRequest**](OrganizationsPatchDomainRequest.md) |  | [optional] |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[BearerToken](../README.md#BearerToken)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: Not defined
-
-
-## organizations_remove_domain
-
-> organizations_remove_domain(org_id, project_id, hostname)
-
-Remove custom domain
-
-### Examples
-
-```ruby
-require 'time'
-require 'mudbase'
-# setup authorization
-Mudbase.configure do |config|
-  # Configure Bearer authorization (JWT): BearerToken
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = Mudbase::OrganizationsApi.new
-org_id = 'org_id_example' # String | 
-project_id = 'project_id_example' # String | 
-hostname = 'hostname_example' # String | 
-
-begin
-  # Remove custom domain
-  api_instance.organizations_remove_domain(org_id, project_id, hostname)
-rescue Mudbase::ApiError => e
-  puts "Error when calling OrganizationsApi->organizations_remove_domain: #{e}"
-end
-```
-
-#### Using the organizations_remove_domain_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-
-> <Array(nil, Integer, Hash)> organizations_remove_domain_with_http_info(org_id, project_id, hostname)
-
-```ruby
-begin
-  # Remove custom domain
-  data, status_code, headers = api_instance.organizations_remove_domain_with_http_info(org_id, project_id, hostname)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue Mudbase::ApiError => e
-  puts "Error when calling OrganizationsApi->organizations_remove_domain_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **org_id** | **String** |  |  |
-| **project_id** | **String** |  |  |
-| **hostname** | **String** |  |  |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[BearerToken](../README.md#BearerToken)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## organizations_report_domain_platform_ready
-
-> organizations_report_domain_platform_ready(org_id, project_id, hostname, opts)
-
-Notify platform ops hosting / edge ready
-
-Legacy optional ops email. First Mudbase TXT success already emails ops. Allowed during platform setup after Mudbase TXT. Recipients default to admin@mudhaxkservices.com and admin@mudbase.dev when CUSTOM_DOMAIN_OPS_NOTIFY_EMAILS is unset. Returns 503 email_provider_not_configured if no email provider is configured. Does not change domain status.
-
-### Examples
-
-```ruby
-require 'time'
-require 'mudbase'
-# setup authorization
-Mudbase.configure do |config|
-  # Configure Bearer authorization (JWT): BearerToken
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = Mudbase::OrganizationsApi.new
-org_id = 'org_id_example' # String | 
-project_id = 'project_id_example' # String | 
-hostname = 'hostname_example' # String | 
-opts = {
-  organizations_report_domain_platform_ready_request: Mudbase::OrganizationsReportDomainPlatformReadyRequest.new # OrganizationsReportDomainPlatformReadyRequest | 
-}
-
-begin
-  # Notify platform ops hosting / edge ready
-  api_instance.organizations_report_domain_platform_ready(org_id, project_id, hostname, opts)
-rescue Mudbase::ApiError => e
-  puts "Error when calling OrganizationsApi->organizations_report_domain_platform_ready: #{e}"
-end
-```
-
-#### Using the organizations_report_domain_platform_ready_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-
-> <Array(nil, Integer, Hash)> organizations_report_domain_platform_ready_with_http_info(org_id, project_id, hostname, opts)
-
-```ruby
-begin
-  # Notify platform ops hosting / edge ready
-  data, status_code, headers = api_instance.organizations_report_domain_platform_ready_with_http_info(org_id, project_id, hostname, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue Mudbase::ApiError => e
-  puts "Error when calling OrganizationsApi->organizations_report_domain_platform_ready_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **org_id** | **String** |  |  |
-| **project_id** | **String** |  |  |
-| **hostname** | **String** |  |  |
-| **organizations_report_domain_platform_ready_request** | [**OrganizationsReportDomainPlatformReadyRequest**](OrganizationsReportDomainPlatformReadyRequest.md) |  | [optional] |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[BearerToken](../README.md#BearerToken)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: Not defined
-
-
-## organizations_set_primary_domain
-
-> organizations_set_primary_domain(org_id, project_id, organizations_set_primary_domain_request)
-
-Set primary custom domain
-
-### Examples
-
-```ruby
-require 'time'
-require 'mudbase'
-# setup authorization
-Mudbase.configure do |config|
-  # Configure Bearer authorization (JWT): BearerToken
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = Mudbase::OrganizationsApi.new
-org_id = 'org_id_example' # String | 
-project_id = 'project_id_example' # String | 
-organizations_set_primary_domain_request = Mudbase::OrganizationsSetPrimaryDomainRequest.new({hostname: 'hostname_example'}) # OrganizationsSetPrimaryDomainRequest | 
-
-begin
-  # Set primary custom domain
-  api_instance.organizations_set_primary_domain(org_id, project_id, organizations_set_primary_domain_request)
-rescue Mudbase::ApiError => e
-  puts "Error when calling OrganizationsApi->organizations_set_primary_domain: #{e}"
-end
-```
-
-#### Using the organizations_set_primary_domain_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-
-> <Array(nil, Integer, Hash)> organizations_set_primary_domain_with_http_info(org_id, project_id, organizations_set_primary_domain_request)
-
-```ruby
-begin
-  # Set primary custom domain
-  data, status_code, headers = api_instance.organizations_set_primary_domain_with_http_info(org_id, project_id, organizations_set_primary_domain_request)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue Mudbase::ApiError => e
-  puts "Error when calling OrganizationsApi->organizations_set_primary_domain_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **org_id** | **String** |  |  |
-| **project_id** | **String** |  |  |
-| **organizations_set_primary_domain_request** | [**OrganizationsSetPrimaryDomainRequest**](OrganizationsSetPrimaryDomainRequest.md) |  |  |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[BearerToken](../README.md#BearerToken)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: Not defined
-
-
-## organizations_verify_domain_dns
-
-> organizations_verify_domain_dns(org_id, project_id, hostname)
-
-Verify domain via DNS TXT
-
-On first success from pending/failed, status becomes cname_pending_staff; ops email once; audit org.domain.txt_verified and org.domain.cname_staff_queued.
-
-### Examples
-
-```ruby
-require 'time'
-require 'mudbase'
-# setup authorization
-Mudbase.configure do |config|
-  # Configure Bearer authorization (JWT): BearerToken
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = Mudbase::OrganizationsApi.new
-org_id = 'org_id_example' # String | 
-project_id = 'project_id_example' # String | 
-hostname = 'hostname_example' # String | 
-
-begin
-  # Verify domain via DNS TXT
-  api_instance.organizations_verify_domain_dns(org_id, project_id, hostname)
-rescue Mudbase::ApiError => e
-  puts "Error when calling OrganizationsApi->organizations_verify_domain_dns: #{e}"
-end
-```
-
-#### Using the organizations_verify_domain_dns_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-
-> <Array(nil, Integer, Hash)> organizations_verify_domain_dns_with_http_info(org_id, project_id, hostname)
-
-```ruby
-begin
-  # Verify domain via DNS TXT
-  data, status_code, headers = api_instance.organizations_verify_domain_dns_with_http_info(org_id, project_id, hostname)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue Mudbase::ApiError => e
-  puts "Error when calling OrganizationsApi->organizations_verify_domain_dns_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **org_id** | **String** |  |  |
-| **project_id** | **String** |  |  |
-| **hostname** | **String** |  |  |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[BearerToken](../README.md#BearerToken)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-

data/docs/OrganizationsPatchDomainRequest.md

@@ -1,20 +0,0 @@
-# Mudbase::OrganizationsPatchDomainRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **status** | **String** | Org self-serve only pending or failed. Live (active) is set by platform admin. | [optional] |
-| **regenerate_token** | **Boolean** |  | [optional] |
-
-## Example
-
-```ruby
-require 'mudbase'
-
-instance = Mudbase::OrganizationsPatchDomainRequest.new(
-  status: null,
-  regenerate_token: null
-)
-```
-

data/docs/OrganizationsReportDomainPlatformReadyRequest.md

@@ -1,18 +0,0 @@
-# Mudbase::OrganizationsReportDomainPlatformReadyRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **note** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'mudbase'
-
-instance = Mudbase::OrganizationsReportDomainPlatformReadyRequest.new(
-  note: null
-)
-```
-

data/docs/OrganizationsSetPrimaryDomainRequest.md

@@ -1,18 +0,0 @@
-# Mudbase::OrganizationsSetPrimaryDomainRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **hostname** | **String** |  |  |
-
-## Example
-
-```ruby
-require 'mudbase'
-
-instance = Mudbase::OrganizationsSetPrimaryDomainRequest.new(
-  hostname: null
-)
-```
-