@gobodo/gobodo-api-promise

Gobodo - JavaScript client for @gobodo/gobodo-api-promise Typed Spring MVC v1 API for Gobodo graph metadata. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.2
• Package version: 1.0.2
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @gobodo/gobodo-api-promise --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @gobodo/gobodo-api-promise from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var Gobodo = require('@gobodo/gobodo-api-promise');

var defaultClient = Gobodo.ApiClient.instance;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token"
// Configure Bearer access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new Gobodo.AIApi()
var opts = {
  'siteId': 789, // {Number} 
  'restApplicationId': 789, // {Number} 
  'transactionid': "transactionid_example", // {String} Ignored on reads. Alias: X-Gobodo-Transaction-Id.
  'zeusportalPostas': 789, // {Number} Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
  'zeusportalPostasApp': 789, // {Number} Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
  'zeusportalPostasSite': 789, // {Number} Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
  'zeusportalPostasOrg': 789, // {Number} Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
  'cachekey': ["null"], // {[String]} REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
  'cachescope': "'APPLICATION'", // {String} Scope of the cachekey entry.
  'cacheduration': 56, // {Number} Cache duration override in seconds, capped by the platform maximum.
  'cachegroup': ["null"], // {[String]} Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
  'cacheuser': ["null"], // {[String]} Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
  'invalidationkeys': "invalidationkeys_example" // {String} On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
};
api.getAiConfig(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/graph/api/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- Gobodo.AIApi | getAiConfig | GET /ai/config | Get tenant AI configuration Gobodo.AIApi | getAiProvider | GET /ai/providers/{provider} | Get an AI provider Gobodo.AIApi | getAiProviderConfig | GET /ai/config/{provider} | Get tenant configuration for an AI provider Gobodo.AIApi | getDefaultAiProvider | GET /ai/default-provider | Get the default AI provider Gobodo.AIApi | listAiProviders | GET /ai/providers | List AI providers Gobodo.AIApi | promptAi | POST /ai/prompt | Send a prompt to the default or requested AI provider Gobodo.AIApi | promptAiProvider | POST /ai/prompt/{provider} | Send a prompt to a specific AI provider Gobodo.AIApi | queryAiAnalytics | POST /ai/analytics/query | Run a natural-language analytics query Gobodo.AIApi | queryAiConversationAnalytics | POST /ai/conversations/{conversationId}/analytics | Run a natural-language analytics query in a conversation Gobodo.AIApi | testAiProvider | POST /ai/providers/{provider}/test | Test the platform connection to an AI provider Gobodo.AIApi | testAiProviderConfig | POST /ai/config/{provider}/test | Test the tenant connection to an AI provider Gobodo.AIApi | transcribeAi | POST /ai/transcribe | Transcribe audio with the default or requested AI provider Gobodo.AIApi | transcribeAiProvider | POST /ai/transcribe/{provider} | Transcribe audio with a specific AI provider Gobodo.AIApi | updateAiConfig | PUT /ai/config | Update tenant AI configuration Gobodo.AIConversationsApi | addAiConversationMemory | POST /ai/conversations/{conversationId}/memory | Add a memory to a conversation Gobodo.AIConversationsApi | addAiConversationParticipant | POST /ai/conversations/{conversationId}/participants | Add a conversation participant Gobodo.AIConversationsApi | applyAiSchemaPatch | POST /ai/conversations/{conversationId}/schema-patches/{patchId}/apply | Apply a schema patch with explicit approval Gobodo.AIConversationsApi | attachAiBuildSchema | POST /ai/conversations/{conversationId}/schema | Attach a graph schema to a build conversation Gobodo.AIConversationsApi | attachAiConversationSchemaContext | POST /ai/conversations/{conversationId}/schema-context | Attach graph schema context to a conversation Gobodo.AIConversationsApi | confirmAiBuildProjectName | PUT /ai/conversations/{conversationId}/project-name | Confirm the proposed build project name Gobodo.AIConversationsApi | createAiConversation | POST /ai/conversations | Create a conversation, optionally sending an initial message Gobodo.AIConversationsApi | deleteAiConversation | DELETE /ai/conversations/{conversationId} | Delete a conversation Gobodo.AIConversationsApi | generateAiConversationLaunchTemplate | POST /ai/conversations/{conversationId}/launch-template/generate | Generate a launch template from the conversation Gobodo.AIConversationsApi | generateAiSchemaPatch | POST /ai/conversations/{conversationId}/schema-patches | Generate a schema patch from a prompt Gobodo.AIConversationsApi | getAiConversation | GET /ai/conversations/{conversationId} | Get a conversation Gobodo.AIConversationsApi | getAiConversationMemorySummary | GET /ai/conversations/{conversationId}/memory/summary | Summarize conversation memory Gobodo.AIConversationsApi | getAiSchemaPatch | GET /ai/conversations/{conversationId}/schema-patches/{patchId} | Get a schema patch Gobodo.AIConversationsApi | listAiConversationMemory | GET /ai/conversations/{conversationId}/memory | List memories relevant to a conversation Gobodo.AIConversationsApi | listAiConversationMessages | GET /ai/conversations/{conversationId}/messages | List conversation messages Gobodo.AIConversationsApi | listAiConversationParticipants | GET /ai/conversations/{conversationId}/participants | List conversation participants Gobodo.AIConversationsApi | listAiConversations | GET /ai/conversations | List the current user's conversations Gobodo.AIConversationsApi | listAiSchemaPatches | GET /ai/conversations/{conversationId}/schema-patches | List schema patches in a conversation Gobodo.AIConversationsApi | removeAiConversationParticipant | DELETE /ai/conversations/{conversationId}/participants/{userId} | Remove a conversation participant Gobodo.AIConversationsApi | sendAiConversationMessage | POST /ai/conversations/{conversationId}/messages | Send a message and get the assistant reply Gobodo.AIConversationsApi | startAiBuild | POST /ai/conversations/build | Start or resume an AI build conversation Gobodo.AIConversationsApi | updateAiConversation | PUT /ai/conversations/{conversationId} | Update a conversation Gobodo.AIConversationsApi | updateAiConversationPlan | PUT /ai/conversations/{conversationId}/plan | Update the conversation implementation plan Gobodo.AILaunchTemplatesApi | createAiLaunchTemplateVersion | POST /ai/templates/{templateId}/versions | Create a launch template version Gobodo.AILaunchTemplatesApi | executeAiLaunchTemplate | POST /ai/templates/{templateId}/execute | Execute a saved launch template with explicit approval Gobodo.AILaunchTemplatesApi | exportAiSchemaTemplate | POST /ai/templates/schemas/{schemaId}/export | Export a graph schema as a launch template Gobodo.AILaunchTemplatesApi | generateAiLaunchTemplate | POST /ai/templates/generate | Generate a launch template from a description Gobodo.AILaunchTemplatesApi | generateAiLaunchTemplateInConversation | POST /ai/templates/{conversationId}/generate | Generate a launch template using conversation context Gobodo.AILaunchTemplatesApi | listAiProjectLaunchTemplates | GET /ai/templates/projects/{projectId} | List launch templates in a project Gobodo.AILaunchTemplatesApi | listAiTemplateExecutionResults | GET /ai/templates/conversations/{conversationId}/execution-results | List launch template executions in a conversation Gobodo.AILaunchTemplatesApi | saveAiLaunchTemplate | POST /ai/templates/save | Save a launch template as a draft Gobodo.AILaunchTemplatesApi | validateAiLaunchTemplate | POST /ai/templates/validate | Validate a launch template Gobodo.AIPersonasApi | addAiPersonaMemory | POST /ai/personas/{personaId}/memories | Add a persona memory Gobodo.AIPersonasApi | applyAiPersonaBuilderDraft | POST /ai/personas/{personaId}/builder/apply | Apply persona builder suggestions Gobodo.AIPersonasApi | applyAiPersonaTrainingDraft | POST /ai/personas/{personaId}/training/apply | Apply approved training outputs Gobodo.AIPersonasApi | applyAndPurgeAiPersonaTrainingDraft | POST /ai/personas/{personaId}/training/apply-and-purge | Apply approved training outputs and purge raw media Gobodo.AIPersonasApi | archiveAiPersona | POST /ai/personas/{personaId}/archive | Archive a persona Gobodo.AIPersonasApi | attachAiPersonaSource | POST /ai/personas/{personaId}/sources | Attach a knowledge source to a persona Gobodo.AIPersonasApi | createAiPersona | POST /ai/personas | Create a persona Gobodo.AIPersonasApi | createAiPersonaBuilderDraft | POST /ai/personas/builder/conversations/new | Create a draft persona and start a builder conversation Gobodo.AIPersonasApi | deleteAiPersonaMemory | DELETE /ai/personas/{personaId}/memories/{memoryId} | Delete a persona memory Gobodo.AIPersonasApi | detachAiPersonaSource | DELETE /ai/personas/{personaId}/sources/{sourceRecordId} | Detach a persona knowledge source Gobodo.AIPersonasApi | getAiPersona | GET /ai/personas/{personaId} | Get a persona Gobodo.AIPersonasApi | getAiPersonaBuilderState | GET /ai/personas/{personaId}/builder/state | Get persona builder state Gobodo.AIPersonasApi | getAiPersonaTrainingDraft | GET /ai/personas/{personaId}/training/draft | Get the persona training draft Gobodo.AIPersonasApi | ingestAiPersonaSource | POST /ai/personas/{personaId}/sources/{sourceRecordId}/ingest | Ingest one persona knowledge source Gobodo.AIPersonasApi | ingestAiPersonaSources | POST /ai/personas/{personaId}/ingest | Ingest all persona knowledge sources Gobodo.AIPersonasApi | ingestAiPersonaTraining | POST /ai/personas/{personaId}/training/ingest | Extract training drafts from training sources Gobodo.AIPersonasApi | listAiPersonaMemories | GET /ai/personas/{personaId}/memories | List persona memories Gobodo.AIPersonasApi | listAiPersonaSources | GET /ai/personas/{personaId}/sources | List persona knowledge sources Gobodo.AIPersonasApi | listAiPersonas | GET /ai/personas | List personas, optionally by scope Gobodo.AIPersonasApi | previewAiPersonaBuilderDraft | POST /ai/personas/{personaId}/builder/preview | Preview a persona with builder suggestions applied Gobodo.AIPersonasApi | previewAiPersonaContext | POST /ai/personas/{personaId}/preview | Preview the context a persona would use Gobodo.AIPersonasApi | promoteAiPersonaMemory | POST /ai/personas/{personaId}/promote | Promote conversation memory to a persona Gobodo.AIPersonasApi | promptAiPersona | POST /ai/personas/{personaId}/prompt | Prompt a persona Gobodo.AIPersonasApi | purgeAiPersonaTrainingSources | POST /ai/personas/{personaId}/training/purge | Purge raw persona training media Gobodo.AIPersonasApi | speakAiPersona | POST /ai/personas/{personaId}/speak | Synthesize speech in the persona voice Gobodo.AIPersonasApi | startAiPersonaBuilderConversation | POST /ai/personas/{personaId}/builder/conversations | Start a persona builder conversation Gobodo.AIPersonasApi | suggestAiPersonaBuilderDraft | POST /ai/personas/{personaId}/builder/suggest | Generate persona builder suggestions Gobodo.AIPersonasApi | testAiPersona | POST /ai/personas/{personaId}/test | Test a persona with a prompt Gobodo.AIPersonasApi | testAiPersonaSpeech | POST /ai/personas/{personaId}/speak/test | Test speech synthesis in the persona voice Gobodo.AIPersonasApi | updateAiPersona | PUT /ai/personas/{personaId} | Update a persona; omitted fields are unchanged Gobodo.AIPersonasApi | updateAiPersonaMemory | PUT /ai/personas/{personaId}/memories/{memoryId} | Update a persona memory; omitted fields are unchanged Gobodo.AIPersonasApi | uploadAiPersonaTrainingAudio | POST /ai/personas/{personaId}/training/audio | Upload persona training audio Gobodo.AIPersonasApi | uploadAiPersonaTrainingImage | POST /ai/personas/{personaId}/training/images | Upload a persona training image Gobodo.APIClientsApi | addApiClientToTenantAllowlist | POST /api-clients/tenants/allowed | Gobodo.APIClientsApi | createApiClient | POST /api-clients | Gobodo.APIClientsApi | getApiClient | GET /api-clients/{clientRef} | Get an API client by clientRef (creator or portal admin) Gobodo.APIClientsApi | getApiClientGlobalConfig | GET /admin/api-clients/config | Gobodo.APIClientsApi | getApiClientTenantConfig | GET /api-clients/tenants/config | Gobodo.APIClientsApi | listApiClientTenantAllowlist | GET /api-clients/tenants/allowed | Gobodo.APIClientsApi | listApiClients | GET /api-clients | List the caller's API clients (all clients for portal admins) Gobodo.APIClientsApi | removeApiClientFromTenantAllowlist | DELETE /api-clients/tenants/allowed | Gobodo.APIClientsApi | updateApiClientGlobalConfig | PUT /admin/api-clients/config | Gobodo.APIClientsApi | updateApiClientTenantConfig | PUT /api-clients/tenants/config | Gobodo.APIDiscoveryApi | discoverApi | GET / | Discover Spring API v1 resources Gobodo.AbilitiesApi | checkObjectAuthorization | GET /abilities/check/{objectId} | Gobodo.AbilitiesApi | getMyAbilities | GET /abilities/me | Gobodo.AbilitiesApi | getObjectAbilities | GET /abilities/object/{objectId} | Gobodo.AdminRequestLogConfigApi | getGlobalRequestLogConfig | GET /admin/request-logs/config | Gobodo.AdminRequestLogConfigApi | updateGlobalRequestLogConfig | PUT /admin/request-logs/config | Gobodo.AdsApi | addAdCampaignSites | PUT /ads/campaigns/{id}/sites | Gobodo.AdsApi | createAd | POST /ads | Gobodo.AdsApi | createAdCampaign | POST /ads/campaigns | Gobodo.AdsApi | createAdCampaignAd | POST /ads/campaigns/{id}/ads | Gobodo.AdsApi | getAd | GET /ads/{id} | Gobodo.AdsApi | getAdCampaign | GET /ads/campaigns/{id} | Gobodo.AdsApi | getAdCampaignForAd | GET /ads/{id}/campaign | Gobodo.AdsApi | getNextAdCampaignForCategory | GET /ads/campaigns/next | Gobodo.AdsApi | updateAd | PUT /ads/{id} | Gobodo.AdsApi | updateAdCampaign | PUT /ads/campaigns/{id} | Gobodo.ApcopayApi | chargeApcopayMit | POST /payments/apcopay/mit/charge | Execute a server-side Apcopay merchant-initiated charge Gobodo.ApcopayApi | createApcopayHppSession | POST /payments/apcopay/hpp/session | Create an Apcopay hosted payment page session Gobodo.ApcopayApi | createApcopayPaymentLink | POST /payments/apcopay/paymentlinks | Create an Apcopay payment link Gobodo.ApcopayApi | createApcopayPayout | POST /payments/apcopay/payout | Initiate an Apcopay Direct Connect payout Gobodo.ApcopayApi | createApcopayPayoutOnboarding | POST /payments/apcopay/payout/onboarding | Create an Apcopay hosted payout onboarding session Gobodo.ApcopayApi | getApcopayConfig | GET /payments/apcopay/config | Get tenant Apcopay configuration with masked credentials Gobodo.ApcopayApi | getApcopayTransaction | GET /payments/apcopay/transactions | Retrieve an Apcopay transaction by order reference or PSP id Gobodo.ApcopayApi | listApcopayAccounts | GET /payments/apcopay/accounts | List Apcopay customer accounts for the current user Gobodo.ApcopayApi | receiveApcopayWebhook | POST /payments/apcopay/webhook | Receive a signed Apcopay webhook notification Gobodo.ApcopayApi | testApcopayConfig | POST /payments/apcopay/config/test | Test the tenant Apcopay configuration Gobodo.ApcopayApi | updateApcopayConfig | PUT /payments/apcopay/config | Update tenant Apcopay configuration Gobodo.ApprovalsApi | approveApprovalRequest | POST /approvals/requests/{id}/approve | Gobodo.ApprovalsApi | createApprovalProcess | POST /approvals/processes | Gobodo.ApprovalsApi | deleteApprovalProcess | DELETE /approvals/processes/{id} | Gobodo.ApprovalsApi | getApprovalProcess | GET /approvals/processes/{id} | Gobodo.ApprovalsApi | listApprovalProcesses | GET /approvals/processes | Gobodo.ApprovalsApi | listApprovalRequests | GET /approvals/requests | Gobodo.ApprovalsApi | listPendingApprovalRequests | GET /approvals/requests/pending | Gobodo.ApprovalsApi | reassignApprovalRequest | POST /approvals/requests/{id}/reassign | Gobodo.ApprovalsApi | recallApprovalRequest | POST /approvals/requests/{id}/recall | Gobodo.ApprovalsApi | rejectApprovalRequest | POST /approvals/requests/{id}/reject | Gobodo.ApprovalsApi | submitApprovalRequest | POST /approvals/requests | Submit a record for approval Gobodo.ApprovalsApi | updateApprovalProcess | PUT /approvals/processes/{id} | Gobodo.AuthenticationApi | authLogin | POST /auth/login | Gobodo.AuthenticationApi | authLoginByEmail | POST /auth/login-by-email | Gobodo.AuthenticationApi | authLogout | POST /auth/logout | Gobodo.AuthenticationApi | authPostAsApp | POST /auth/post-as/app/{appId} | Gobodo.AuthenticationApi | authPostAsFunction | POST /auth/post-as/function/{functionId} | Gobodo.AuthenticationApi | authPostAsOrganization | POST /auth/post-as/organization/{organizationId} | Gobodo.AuthenticationApi | authPostAsPage | POST /auth/post-as/page/{pageId} | Gobodo.AuthenticationApi | authPostAsSite | POST /auth/post-as/site/{siteId} | Gobodo.AuthenticationRecoveryApi | completePasswordReset | POST /auth/password-reset/complete | Gobodo.AuthenticationRecoveryApi | completePasswordResetByUser | POST /auth/password-reset/complete/user | Gobodo.AuthenticationRecoveryApi | initiatePasswordReset | POST /auth/password-reset/initiate | Gobodo.AuthenticationRecoveryApi | sendUsernameReminder | POST /auth/username-reminder | Gobodo.AuthenticationRecoveryApi | validatePasswordReset | POST /auth/password-reset/validate | Gobodo.AuthenticationRecoveryApi | validatePasswordResetByUser | POST /auth/password-reset/validate/user | Gobodo.AutomationApi | activateAutomationRule | POST /automation/rules/{id}/activate | Gobodo.AutomationApi | compileProcessDefinition | POST /automation/processes/{id}/compile | Gobodo.AutomationApi | createAutomationRule | POST /automation/rules | Gobodo.AutomationApi | createProcessDefinition | POST /automation/processes | Gobodo.AutomationApi | createScheduledAutomation | POST /automation/scheduled | Gobodo.AutomationApi | deleteAutomationRule | DELETE /automation/rules/{id} | Gobodo.AutomationApi | deleteProcessDefinition | DELETE /automation/processes/{id} | Gobodo.AutomationApi | deleteScheduledAutomation | DELETE /automation/scheduled/{id} | Gobodo.AutomationApi | getAutomationRule | GET /automation/rules/{id} | Gobodo.AutomationApi | getProcessDefinition | GET /automation/processes/{id} | Gobodo.AutomationApi | getScheduledAutomation | GET /automation/scheduled/{id} | Gobodo.AutomationApi | invokeAutomation | POST /automation/invoke | Gobodo.AutomationApi | listAutomationRuleLogs | GET /automation/rules/{id}/logs | Gobodo.AutomationApi | listAutomationRules | GET /automation/rules | Gobodo.AutomationApi | listProcessDefinitions | GET /automation/processes | Gobodo.AutomationApi | listScheduledAutomations | GET /automation/scheduled | Gobodo.AutomationApi | publishProcessDefinition | POST /automation/processes/{id}/publish | Gobodo.AutomationApi | testAutomationRule | POST /automation/rules/{id}/test | Gobodo.AutomationApi | updateAutomationRule | PUT /automation/rules/{id} | Gobodo.AutomationApi | updateProcessDefinition | PUT /automation/processes/{id} | Gobodo.AutomationApi | updateScheduledAutomation | PUT /automation/scheduled/{id} | Gobodo.AutomationTemplatesApi | createAutomationInstance | POST /automation/instances | Gobodo.AutomationTemplatesApi | deleteAutomationInstance | DELETE /automation/instances/{id} | Gobodo.AutomationTemplatesApi | getAutomationInstance | GET /automation/instances/{id} | Gobodo.AutomationTemplatesApi | listAutomationInstances | GET /automation/instances | Gobodo.AutomationTemplatesApi | listAutomationTemplates | GET /automation/templates | Gobodo.AutomationTemplatesApi | testAutomationInstance | POST /automation/instances/{id}/test | Gobodo.AutomationTemplatesApi | updateAutomationInstance | PUT /automation/instances/{id} | Gobodo.BatchesApi | deleteBatch | DELETE /batches/{batchId} | Gobodo.BatchesApi | executeBatch | POST /batches/{batchId}/execute | Gobodo.BatchesApi | exportBatch | POST /batches/{batchId}/export | Gobodo.BatchesApi | getBatch | GET /batches/{batchId} | Gobodo.BatchesApi | getBatchDetail | GET /batches/{batchId}/details/{detailId} | Gobodo.BatchesApi | getBatchExecution | GET /batches/{batchId}/executions/{executionId} | Gobodo.BatchesApi | getBatchExecutionDetail | GET /batches/{batchId}/executions/{executionId}/details/{detailId} | Gobodo.BatchesApi | getBatchExportStatus | GET /batches/{batchId}/export/status | Gobodo.BatchesApi | getLatestBatchExport | GET /batches/{batchId}/export/latest | Gobodo.BatchesApi | listBatchExecutionDetails | GET /batches/{batchId}/executions/{executionId}/details | Gobodo.BatchesApi | listBatchExecutions | GET /batches/{batchId}/executions | Gobodo.BatchesApi | listBatches | GET /batches | Gobodo.BatchesApi | retireBatch | POST /batches/{batchId}/retire | Gobodo.BatchesApi | startBatch | POST /batches | Gobodo.BatchesApi | updateBatch | PATCH /batches/{batchId} | Gobodo.CategoriesApi | addCategoryAdministrator | POST /categories/{categoryId}/administrators | Gobodo.CategoriesApi | createCategory | POST /categories | Gobodo.CategoriesApi | createChildCategory | POST /categories/{parentId}/subcategories | Gobodo.CategoriesApi | getCategoryAdministrators | GET /categories/{categoryId}/administrators | Gobodo.CategoriesApi | getCategoryById | GET /categories/{id} | Gobodo.CategoriesApi | getChildCategories | GET /categories/{id}/subcategories | Gobodo.CategoriesApi | getRootCategory | GET /categories/root | Gobodo.CategoriesApi | removeCategoryAdministrator | DELETE /categories/{categoryId}/administrators/{userId} | Gobodo.CategoriesApi | updateCategory | PUT /categories/{id} | Gobodo.CircleApi | createCircleAccount | POST /payments/circle/account | Create a Circle wallet account for the signed-in user Gobodo.CircleApi | createCirclePaymentIntent | POST /payments/circle/payment-intent | Create a Circle payment intent for the signed-in user Gobodo.CircleApi | createCirclePayout | POST /payments/circle/payout | Pay out funds from the signed-in user's Circle wallet Gobodo.CircleApi | createCircleTransfer | POST /payments/circle/transfer | Transfer funds from the signed-in user's Circle wallet Gobodo.CircleApi | getCircleAccount | GET /payments/circle/account/{accountId} | Get a Circle account the caller owns or manages Gobodo.CircleApi | getCircleAccountBalance | GET /payments/circle/account/{accountId}/balance | Get the balance of a Circle account the caller owns or manages Gobodo.CircleApi | getCircleTransfer | GET /payments/circle/transfer/{transferId} | Get a Circle transfer the caller owns or manages a side of Gobodo.CircleApi | receiveCircleWebhook | POST /payments/circle/webhook | Receive a signed Circle webhook Gobodo.CommentsApi | addCommentReply | POST /comments/{id}/replies | Gobodo.CommentsApi | countCommentsByParent | GET /comments/parent/{parentId}/count | Gobodo.CommentsApi | createComment | POST /comments | Create a comment, or queue it on a batch when batchId is given Gobodo.CommentsApi | deleteComment | DELETE /comments/{id} | Gobodo.CommentsApi | getCommentById | GET /comments/{id} | Gobodo.CommentsApi | listCommentReplies | GET /comments/{id}/replies | Gobodo.CommentsApi | listCommentsByParent | GET /comments/parent/{parentId} | Gobodo.CommentsApi | updateComment | PUT /comments/{id} | Gobodo.CommentsApi | upsertComment | PUT /comments/upsert | Create or update a comment by key Gobodo.CommentsApi | upsertComments | PUT /comments/upsert/batch | Create or update several comments by key Gobodo.CurrencyApi | createCurrency | POST /payments/currency | Gobodo.CurrencyApi | getCurrency | GET /payments/currency/{currencyId} | Gobodo.CurrencyApi | getCurrencyHolder | GET /payments/currency/{currencyId}/holders/{userId} | Requires currency manage permission Gobodo.CurrencyApi | getCurrencyLedger | GET /payments/currency/{currencyId}/ledger | Requires currency manage permission Gobodo.CurrencyApi | getCurrencyRegistrationStatus | GET /payments/currency/{currencyId}/registration | Whether the currency is registered with a minter (the root category when minterId is omitted) Gobodo.CurrencyApi | listCurrencies | GET /payments/currency | Gobodo.CurrencyApi | listCurrencyHolders | GET /payments/currency/{currencyId}/holders | Requires currency manage permission Gobodo.CurrencyApi | listMinterCurrencies | GET /payments/currency/minters/{minterId}/currencies | Gobodo.CurrencyApi | registerCurrencyMinter | POST /payments/currency/registrations | Register a currency with a minter; requires currency manage permission Gobodo.CurrencyApi | updateCurrency | PUT /payments/currency/{currencyId} | Replace a currency's settings; requires edit permission on the currency Gobodo.DataSyncApi | createDataSync | POST /datasyncs | Create a new data sync configuration Gobodo.DataSyncApi | dataSyncExport | POST /datasyncs/{syncId}/export | Export graph changes to the external data source Gobodo.DataSyncApi | dataSyncWebhook | POST /datasyncs/{syncId}/webhook | Handle inbound sync webhook Gobodo.DataSyncApi | deleteDataSync | DELETE /datasyncs/{syncId} | Delete a data sync Gobodo.DataSyncApi | getDataSyncById | GET /datasyncs/{syncId} | Get a data sync by id Gobodo.DataSyncApi | getDataSyncsByGraph | GET /datasyncs | Get all data syncs for a graph Gobodo.DataSyncApi | runDataSyncMigration | POST /datasyncs/{syncId}/migrate | Run a one-time migration Gobodo.DataSyncApi | startDataSync | POST /datasyncs/{syncId}/sync | Start real-time synchronization Gobodo.DataSyncApi | stopDataSync | DELETE /datasyncs/{syncId}/sync | Stop real-time synchronization Gobodo.DataSyncApi | testDataSyncConnection | POST /datasyncs/test-connection | Test a data source connection without creating a sync Gobodo.DataSyncApi | updateDataSync | PUT /datasyncs/{syncId} | Update a data sync configuration Gobodo.DatasheetImportsApi | createDatasheetImport | POST /datasheet-imports | Upload a datasheet and create an import into a container Gobodo.DatasheetImportsApi | deleteDatasheetImportGeolocation | DELETE /datasheet-imports/{id}/geolocation | Stop geocoding created objects Gobodo.DatasheetImportsApi | deleteDatasheetImportMapping | DELETE /datasheet-imports/{id}/mappings/{sheetProp} | Remove a column mapping Gobodo.DatasheetImportsApi | getDatasheetImport | GET /datasheet-imports/{id} | Get a datasheet import with its columns and mappings Gobodo.DatasheetImportsApi | getDatasheetImportMapping | GET /datasheet-imports/{id}/mappings/{sheetProp} | Get the property a column is mapped to Gobodo.DatasheetImportsApi | listDatasheetImports | GET /datasheet-imports | List the imports of a container Gobodo.DatasheetImportsApi | previewDatasheetImport | GET /datasheet-imports/{id}/preview | Preview the first rows of the datasheet Gobodo.DatasheetImportsApi | replaceDatasheetImportFile | PUT /datasheet-imports/{id}/file | Replace the datasheet of an import Gobodo.DatasheetImportsApi | runDatasheetImport | POST /datasheet-imports/{id}/run | Run the import once and return the created ids Gobodo.DatasheetImportsApi | setDatasheetImportEndLookup | PUT /datasheet-imports/{id}/end-lookup | Set how a relationship import finds end objects Gobodo.DatasheetImportsApi | setDatasheetImportGeolocation | PUT /datasheet-imports/{id}/geolocation | Geocode created objects from a column Gobodo.DatasheetImportsApi | setDatasheetImportMapping | PUT /datasheet-imports/{id}/mappings/{sheetProp} | Map a column to an object property Gobodo.DatasheetImportsApi | setDatasheetImportPrivacy | PUT /datasheet-imports/{id}/privacy | Set privacy flags for created objects Gobodo.DatasheetImportsApi | setDatasheetImportStartLookup | PUT /datasheet-imports/{id}/start-lookup | Set how a relationship import finds start objects Gobodo.DocumentPartTypesApi | getDocumentPartTypeById | GET /documents/parts/types/{id} | Gobodo.DocumentPartTypesApi | listDocumentPartTypes | GET /documents/parts/types | Gobodo.DocumentPartTypesApi | listPlatformDocumentPartTypeCatalog | GET /documents/parts/types/platform/catalog | Gobodo.DocumentPartTypesApi | listPlatformDocumentPartTypeDefaults | GET /documents/parts/types/platform/defaults | Gobodo.DocumentPartTypesApi | seedPlatformDocumentPartTypes | POST /documents/parts/types/platform/seed | Seed platform document part types (portal admin) Gobodo.DocumentPartsApi | addChildDocumentParts | POST /documents/parts/{id}/parts | Gobodo.DocumentPartsApi | changeDocumentPartType | PUT /documents/parts/{id}/type/{typeId} | Gobodo.DocumentPartsApi | copyDocumentPart | POST /documents/parts/{id}/copy | Gobodo.DocumentPartsApi | createDocumentPart | POST /documents/parts | Create a standalone document part Gobodo.DocumentPartsApi | deleteDocumentPart | DELETE /documents/parts/{id} | Gobodo.DocumentPartsApi | getChildDocumentPartByPage | GET /documents/parts/{id}/parts/{pageNum} | Gobodo.DocumentPartsApi | getDocumentPartById | GET /documents/parts/{id} | Gobodo.DocumentPartsApi | listChildDocumentParts | GET /documents/parts/{id}/parts | Gobodo.DocumentPartsApi | moveDocumentPart | PUT /documents/parts/{id}/move | Move a part into a document or another part Gobodo.DocumentPartsApi | updateDocumentPart | PUT /documents/parts/{id} | Gobodo.DocumentTypesApi | getDocumentTypeById | GET /documents/types/{id} | Gobodo.DocumentTypesApi | listDocumentTypes | GET /documents/types | Gobodo.DocumentsApi | addDocumentPartsToDocument | POST /documents/{id}/parts | Gobodo.DocumentsApi | changeDocumentStatus | PUT /documents/{id}/status | Gobodo.DocumentsApi | copyDocument | POST /documents/{id}/copy | Gobodo.DocumentsApi | countDocuments | GET /documents/count | Gobodo.DocumentsApi | createDocument | POST /documents | Gobodo.DocumentsApi | deleteDocument | DELETE /documents/{id} | Gobodo.DocumentsApi | getDocumentById | GET /documents/{id} | Gobodo.DocumentsApi | getDocumentPartOfDocumentByPage | GET /documents/{id}/parts/{pageNum} | Gobodo.DocumentsApi | listDocumentPartsOfDocument | GET /documents/{id}/parts | Gobodo.DocumentsApi | listDocuments | GET /documents | List documents with legacy container and relationship filters Gobodo.DocumentsApi | updateDocument | PUT /documents/{id} | Gobodo.EmailsApi | createPageEmailAddress | POST /emails/pages/{pageId} | Gobodo.EmailsApi | createUserEmailAddress | POST /emails/users/{userId} | Gobodo.EmailsApi | listPageEmailAddresses | GET /emails/pages/{pageId} | Gobodo.EmailsApi | listUserEmailAddresses | GET /emails/users/{userId} | Gobodo.EmailsApi | sendEmail | POST /emails/send | Gobodo.ExternalProvidersControllerApi | listExternalProviderCatalog | GET /external-providers/catalog | List enabled external-provider definitions adoptable by tenants Gobodo.ExternalProvidersControllerApi | listExternalProviderConnections | GET /external-providers/connections | List tenant connections to external providers Gobodo.ExternalProvidersControllerApi | listExternalProviderDefinitions | GET /external-providers/definitions | List all external-provider definitions (platform admin) Gobodo.ExternalProvidersControllerApi | retireExternalProviderDefinition | PUT /external-providers/definitions/{externalProviderId}/retire | Retire an external-provider definition (platform admin) Gobodo.ExternalProvidersControllerApi | setExternalProviderConnectionEnabled | PUT /external-providers/connections/{externalProviderId}/enabled | Enable or disable a provider for the tenant Gobodo.ExternalProvidersControllerApi | setExternalProviderCredentials | PUT /external-providers/connections/{externalProviderId}/credentials | Set or rotate provider credentials (write-only) Gobodo.ExternalProvidersControllerApi | setExternalProviderDefinitionEnabled | PUT /external-providers/definitions/{externalProviderId}/enabled | Enable or disable an external-provider definition (platform admin) Gobodo.ExternalProvidersControllerApi | upsertExternalProviderConnection | PUT /external-providers/connections/{externalProviderId} | Create or update the tenant connection for a provider Gobodo.ExternalProvidersControllerApi | upsertExternalProviderDefinition | POST /external-providers/definitions | Create or update an external-provider definition (platform admin) Gobodo.FieldsApi | createActionTypeField | POST /actiontype/{id}/fields | Gobodo.FieldsApi | createContainerField | POST /fields/containers/{objectType}/{objectId} | Gobodo.FieldsApi | createField | POST /fields | Gobodo.FieldsApi | createFields | POST /fields/batch | Gobodo.FieldsApi | createObjectTypeField | POST /objecttype/{id}/fields | Gobodo.FieldsApi | createRelationshipTypeField | POST /relationshiptype/{id}/fields | Gobodo.FieldsApi | deleteField | DELETE /fields/{id} | Gobodo.FieldsApi | getActionTypeField | GET /actiontype/{id}/fields/{name} | Gobodo.FieldsApi | getField | GET /fields/{id} | Gobodo.FieldsApi | getObjectTypeField | GET /objecttype/{id}/fields/{name} | Gobodo.FieldsApi | getRelationshipTypeField | GET /relationshiptype/{id}/fields/{name} | Gobodo.FieldsApi | updateField | PUT /fields/{id} | Gobodo.FilesApi | countFiles | GET /files/count | Gobodo.FilesApi | getFileById | GET /files/{id} | Gobodo.FilesApi | getFileContent | GET /files/{id}/content | Gobodo.FilesApi | listFiles | GET /files | Gobodo.FilesApi | updateFile | PUT /files/{id} | Gobodo.FilesApi | uploadFile | POST /files | Gobodo.FilesApi | uploadFileBase64 | POST /files/base64 | Gobodo.FlowWebhooksApi | flowWebhookEvaluateCondition | POST /flows/webhook/evaluate-condition | Gobodo.FlowWebhooksApi | flowWebhookExecuteAction | POST /flows/webhook/execute-action | Gobodo.FlowWebhooksApi | flowWebhookExecuteFlow | POST /flows/webhook/execute-flow | Gobodo.FlowWebhooksApi | flowWebhookExecuteFunction | POST /flows/webhook/execute-function | Gobodo.FlowWebhooksApi | flowWebhookExecuteQuery | POST /flows/webhook/execute-query | Gobodo.FlowWebhooksApi | flowWebhookFinalize | POST /flows/webhook/finalize | Gobodo.FlowWebhooksApi | flowWebhookPrepareLoop | POST /flows/webhook/prepare-loop | Gobodo.FlowsApi | activateFlow | POST /flows/{flowId}/activate | Gobodo.FlowsApi | createFlow | POST /flows | Gobodo.FlowsApi | createFlowRun | POST /flows/{flowId}/runs | Gobodo.FlowsApi | deactivateFlow | POST /flows/{flowId}/deactivate | Gobodo.FlowsApi | deleteFlow | DELETE /flows/{flowId} | Gobodo.FlowsApi | executeFlow | POST /flows/{flowId}/execute | Gobodo.FlowsApi | getFlow | GET /flows/{flowId} | Gobodo.FlowsApi | getFlowExecution | GET /flows/{flowId}/executions/{executionId} | Gobodo.FlowsApi | getFlowGobodoSteps | GET /flows/{flowId}/steps/gobodo | Gobodo.FlowsApi | getFlowWorkflowSteps | GET /flows/{flowId}/steps | Gobodo.FlowsApi | listFlowExecutions | GET /flows/{flowId}/executions | Gobodo.FlowsApi | listFlowRuns | GET /flows/{flowId}/runs | Gobodo.FlowsApi | listFlows | GET /flows | Gobodo.FlowsApi | listN8nNodeTypes | GET /flows/n8n/node-types | Gobodo.FlowsApi | lookupN8nNodeTypes | POST /flows/n8n/node-types/lookup | Gobodo.FlowsApi | putFlowGobodoSteps | PUT /flows/{flowId}/steps/gobodo | Gobodo.FlowsApi | putFlowWorkflowSteps | PUT /flows/{flowId}/steps | Gobodo.FlowsApi | registerFlowSchedule | PUT /flows/{flowId}/schedule | Gobodo.FlowsApi | registerFlowTrigger | PUT /flows/{flowId}/trigger | Gobodo.FlowsApi | updateFlow | PUT /flows/{flowId} | Gobodo.FormsApi | createForm | POST /forms | Gobodo.FormsApi | createFormSection | POST /forms/{id}/sections | Gobodo.FormsApi | createFormSubsection | POST /forms/sections/{id}/sections | Gobodo.FormsApi | getForm | GET /forms/{id} | Gobodo.FormsApi | getFormSection | GET /forms/sections/{id} | Gobodo.FormsApi | getFormSubmission | GET /forms/submissions/{id} | Gobodo.FormsApi | listFormFields | GET /forms/{id}/fields | Gobodo.FormsApi | listFormSectionFields | GET /forms/sections/{id}/fields | Gobodo.FormsApi | updateForm | PUT /forms/{id} | Gobodo.FormsApi | updateFormSection | PUT /forms/sections/{id} | Gobodo.FunctionsApi | addActionTypeMethod | POST /functions/action-types/{id}/methods | Gobodo.FunctionsApi | addFunctionConfig | POST /functions/{id}/configs/{environment} | Gobodo.FunctionsApi | addGraphFunctionIds | PUT /functions/graphs/{id}/ids | Gobodo.FunctionsApi | addGraphFunctions | PUT /functions/graphs/{id} | Gobodo.FunctionsApi | addObjectTypeMethod | POST /functions/object-types/{id}/methods | Gobodo.FunctionsApi | addRelationshipTypeMethod | POST /functions/relationship-types/{id}/methods | Gobodo.FunctionsApi | addSchemaFunctions | PUT /functions/schemas/{id} | Gobodo.FunctionsApi | createFunction | POST /functions | Gobodo.FunctionsApi | deleteFunction | DELETE /functions/{id} | Gobodo.FunctionsApi | getFunction | GET /functions/{id} | Gobodo.FunctionsApi | getFunctionConfig | GET /functions/{id}/configs/{environment} | Gobodo.FunctionsApi | getGraphFunctionByName | GET /functions/graphs/{id}/{name} | Gobodo.FunctionsApi | getSchemaFunctionByName | GET /functions/schemas/{id}/{name} | Gobodo.FunctionsApi | invokeFunction | POST /functions/{id}/invoke | Gobodo.FunctionsApi | invokeFunctionPut | PUT /functions/{id}/invoke | Gobodo.FunctionsApi | invokeFunctionWithQuery | GET /functions/{id}/invoke | Gobodo.FunctionsApi | listActionTypeMethods | GET /functions/action-types/{id}/methods | Gobodo.FunctionsApi | listAllGraphFunctions | GET /functions/graphs/{id}/all | Gobodo.FunctionsApi | listFunctionSubscriptions | GET /functions/{id}/subscriptions | Gobodo.FunctionsApi | listGraphFunctions | GET /functions/graphs/{id} | Gobodo.FunctionsApi | listMyFunctions | GET /functions/mine | Gobodo.FunctionsApi | listObjectTypeMethods | GET /functions/object-types/{id}/methods | Gobodo.FunctionsApi | listRelationshipTypeMethods | GET /functions/relationship-types/{id}/methods | Gobodo.FunctionsApi | listSchemaFunctions | GET /functions/schemas/{id} | Gobodo.FunctionsApi | subscribeFunctionToTopics | PUT /functions/{id}/subscriptions | Gobodo.FunctionsApi | updateFunction | PUT /functions/{id} | Gobodo.FunctionsApi | updateFunctionConfig | PUT /functions/configs/{configId} | Gobodo.GeocodeApi | createGeocode | POST /geocode | Gobodo.GeocodeApi | geocodeObject | POST /geocode/objects/{objectId} | Gobodo.GeocodeApi | getGeocode | GET /geocode/{id} | Gobodo.GobodoManagementApi | addOrganizationMembers | PUT /organizations/{organizationId}/members | Gobodo.GobodoManagementApi | addProjectCollaborators | POST /projects/{id}/collaborators | Gobodo.GobodoManagementApi | addProjectResource | POST /projects/{id}/resources/{resourceId} | Gobodo.GobodoManagementApi | addProjectSchema | POST /projects/{id}/schemas/{schemaId} | Gobodo.GobodoManagementApi | createOrganization | POST /organizations | Gobodo.GobodoManagementApi | createProject | POST /projects | Gobodo.GobodoManagementApi | deleteOrganization | DELETE /organizations/{organizationId} | Delete an organization (organization or platform admin) Gobodo.GobodoManagementApi | deleteProject | DELETE /projects/{id} | Gobodo.GobodoManagementApi | getOrganization | GET /organizations/{organizationId} | Gobodo.GobodoManagementApi | getProject | GET /projects/{id} | Gobodo.GobodoManagementApi | inviteOrganizationMembers | POST /organizations/{organizationId}/invites | Gobodo.GobodoManagementApi | listOrganizationAdministrators | GET /organizations/{organizationId}/administrators | Gobodo.GobodoManagementApi | listOrganizationMembers | GET /organizations/{organizationId}/members | Gobodo.GobodoManagementApi | listOrganizations | GET /organizations | Gobodo.GobodoManagementApi | listProjectCollaborators | GET /projects/{id}/collaborators | Gobodo.GobodoManagementApi | listProjectSchemas | GET /projects/{id}/schemas | Gobodo.GobodoManagementApi | listProjectTopics | GET /projects/{id}/topics | Gobodo.GobodoManagementApi | listProjects | GET /projects | Gobodo.GobodoManagementApi | updateOrganization | **P