MCPcopy Create free account

hub / github.com/algolia/algoliasearch-client-javascript / functions

Functions918 in github.com/algolia/algoliasearch-client-javascript

FunctiondeleteABTest
* Deletes an A/B test by its ID. * * Required API Key ACLs: * - editSettings * @param deleteABTest - The deleteABTest object.
packages/abtesting/src/abtestingV3Client.ts:430
FunctiondeleteABTest
* Deletes an A/B test by its ID. * * Required API Key ACLs: * - editSettings * @param deleteABTest - The deleteABTest object.
packages/client-abtesting/src/abtestingClient.ts:426
FunctiondeleteABTestWithHTTPInfo
* Deletes an A/B test by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requester captures the
packages/abtesting/src/abtestingV3Client.ts:458
FunctiondeleteABTestWithHTTPInfo
* Deletes an A/B test by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requester captures the
packages/client-abtesting/src/abtestingClient.ts:454
FunctiondeleteAgent
* Delete the specified agent. * * Required API Key ACLs: * - editSettings * @param deleteAgent - The deleteAgent object. * @
packages/agent-studio/src/agentStudioClient.ts:1228
FunctiondeleteAgentConversations
* Deletes the conversations matching the given filers. * * Required API Key ACLs: * - logs * @param deleteAgentConversations - Th
packages/agent-studio/src/agentStudioClient.ts:1287
FunctiondeleteAgentConversationsWithHTTPInfo
* Deletes the conversations matching the given filers. * * Resolves with the full HTTP response information: status code, headers (when the
packages/agent-studio/src/agentStudioClient.ts:1331
FunctiondeleteAgentWithHTTPInfo
* Delete the specified agent. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them),
packages/agent-studio/src/agentStudioClient.ts:1256
FunctiondeleteAllowedDomain
* Remove an allowed domain by id. * * Required API Key ACLs: * - editSettings * @param deleteAllowedDomain - The deleteAllowedDom
packages/agent-studio/src/agentStudioClient.ts:1372
FunctiondeleteAllowedDomainWithHTTPInfo
* Remove an allowed domain by id. * * Resolves with the full HTTP response information: status code, headers (when the requester captures th
packages/agent-studio/src/agentStudioClient.ts:1408
FunctiondeleteApiKey
* Deletes the API key. * * Required API Key ACLs: * - admin * @param deleteApiKey - The deleteApiKey object. * @param delete
packages/client-search/src/searchClient.ts:1834
FunctiondeleteApiKeyWithHTTPInfo
* Deletes the API key. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw bo
packages/client-search/src/searchClient.ts:1862
FunctiondeleteAuthentication
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination. * * Required AP
packages/ingestion/src/ingestionClient.ts:1000
FunctiondeleteAuthenticationWithHTTPInfo
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination. * * Resolves wi
packages/ingestion/src/ingestionClient.ts:1036
FunctiondeleteBy
* This operation doesn\'t accept empty filters. This operation is resource-intensive. Use it only if you can\'t get the object IDs of the records you
packages/client-search/src/searchClient.ts:1892
FunctiondeleteByWithHTTPInfo
* This operation doesn\'t accept empty filters. This operation is resource-intensive. Use it only if you can\'t get the object IDs of the records you
packages/client-search/src/searchClient.ts:1927
FunctiondeleteComposition
* Delete a composition from the current Algolia application. * * Required API Key ACLs: * - editSettings * @param deleteCompositi
packages/composition/src/compositionClient.ts:443
FunctiondeleteCompositionRule
* Delete a Composition Rule from the specified Composition ID. * * Required API Key ACLs: * - editSettings * @param deleteComposi
packages/composition/src/compositionClient.ts:510
FunctiondeleteCompositionRuleWithHTTPInfo
* Delete a Composition Rule from the specified Composition ID. * * Resolves with the full HTTP response information: status code, headers (w
packages/composition/src/compositionClient.ts:546
FunctiondeleteCompositionWithHTTPInfo
* Delete a composition from the current Algolia application. * * Resolves with the full HTTP response information: status code, headers (whe
packages/composition/src/compositionClient.ts:477
FunctiondeleteConfig
* Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the
packages/client-query-suggestions/src/querySuggestionsClient.ts:421
FunctiondeleteConfigWithHTTPInfo
* Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the
packages/client-query-suggestions/src/querySuggestionsClient.ts:449
FunctiondeleteConversation
* Deletes the conversation with the given ID. * * Required API Key ACLs: * - logs * @param deleteConversation - The deleteConvers
packages/agent-studio/src/agentStudioClient.ts:1442
FunctiondeleteConversationWithHTTPInfo
* Deletes the conversation with the given ID. * * Resolves with the full HTTP response information: status code, headers (when the requester
packages/agent-studio/src/agentStudioClient.ts:1478
FunctiondeleteDestination
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks. * * Required API Key ACLs: * - addObje
packages/ingestion/src/ingestionClient.ts:1070
FunctiondeleteDestinationWithHTTPInfo
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks. * * Resolves with the full HTTP response inf
packages/ingestion/src/ingestionClient.ts:1106
FunctiondeleteIndex
* Deletes an index and all its settings. - Deleting an index doesn\'t delete its analytics data. - If you try to delete a non-existing index, the ope
packages/client-search/src/searchClient.ts:1959
FunctiondeleteIndexWithHTTPInfo
* Deletes an index and all its settings. - Deleting an index doesn\'t delete its analytics data. - If you try to delete a non-existing index, the ope
packages/client-search/src/searchClient.ts:1987
FunctiondeleteObject
* Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch).
packages/client-search/src/searchClient.ts:2017
FunctiondeleteObjectWithHTTPInfo
* Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch).
packages/client-search/src/searchClient.ts:2053
FunctiondeleteObjects
* Helper: Deletes every records for the given objectIDs. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at mo
packages/client-search/src/searchClient.ts:596
FunctiondeleteProvider
* Delete Provider. * * Required API Key ACLs: * - editSettings * @param deleteProvider - The deleteProvider object. * @param
packages/agent-studio/src/agentStudioClient.ts:1511
FunctiondeleteProviderWithHTTPInfo
* Delete Provider. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body a
packages/agent-studio/src/agentStudioClient.ts:1542
FunctiondeleteRecommendRule
* Deletes a Recommend rule from a recommendation scenario. * * Required API Key ACLs: * - editSettings * @param deleteRecommendRu
packages/recommend/src/recommendClient.ts:464
FunctiondeleteRecommendRuleWithHTTPInfo
* Deletes a Recommend rule from a recommendation scenario. * * Resolves with the full HTTP response information: status code, headers (when
packages/recommend/src/recommendClient.ts:504
FunctiondeleteRule
* Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-rules).
packages/client-search/src/searchClient.ts:2088
FunctiondeleteRuleWithHTTPInfo
* Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-rules).
packages/client-search/src/searchClient.ts:2129
FunctiondeleteSecretKey
* Delete Secret Key. * * Required API Key ACLs: * - admin * @param deleteSecretKey - The deleteSecretKey object. * @param de
packages/agent-studio/src/agentStudioClient.ts:1574
FunctiondeleteSecretKeyWithHTTPInfo
* Delete Secret Key. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body
packages/agent-studio/src/agentStudioClient.ts:1605
FunctiondeleteSource
* Deletes a source from the list of allowed sources. * * Required API Key ACLs: * - admin * @param deleteSource - The deleteSourc
packages/client-search/src/searchClient.ts:2166
FunctiondeleteSource
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks. * * Required API Key ACLs: * - addObject *
packages/ingestion/src/ingestionClient.ts:1140
FunctiondeleteSourceWithHTTPInfo
* Deletes a source from the list of allowed sources. * * Resolves with the full HTTP response information: status code, headers (when the re
packages/client-search/src/searchClient.ts:2194
FunctiondeleteSourceWithHTTPInfo
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks. * * Resolves with the full HTTP response information:
packages/ingestion/src/ingestionClient.ts:1170
FunctiondeleteSynonym
* Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/searc
packages/client-search/src/searchClient.ts:2225
FunctiondeleteSynonymWithHTTPInfo
* Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/searc
packages/client-search/src/searchClient.ts:2266
FunctiondeleteTask
* Deletes a task by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param delete
packages/ingestion/src/ingestionClient.ts:1201
FunctiondeleteTaskV1
* Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead. * * Required API Key ACLs: * - addObject * - deleteI
packages/ingestion/src/ingestionClient.ts:1264
FunctiondeleteTaskV1WithHTTPInfo
* Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead. * * Resolves with the full HTTP response information: status cod
packages/ingestion/src/ingestionClient.ts:1296
FunctiondeleteTaskWithHTTPInfo
* Deletes a task by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), r
packages/ingestion/src/ingestionClient.ts:1231
FunctiondeleteTransformation
* Deletes a transformation by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @pa
packages/ingestion/src/ingestionClient.ts:1327
FunctiondeleteTransformationWithHTTPInfo
* Deletes a transformation by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requester capture
packages/ingestion/src/ingestionClient.ts:1363
FunctiondeleteUser
* Deletes a user profile. * * Required API Key ACLs: * - search * - browse * - recommendation * @param deleteUser - T
packages/advanced-personalization/src/advancedPersonalizationClient.ts:430
FunctiondeleteUserData
* Permanently deletes all messages for the given user token. Does not delete conversations. * * Required API Key ACLs: * - logs *
packages/agent-studio/src/agentStudioClient.ts:1637
FunctiondeleteUserDataWithHTTPInfo
* Permanently deletes all messages for the given user token. Does not delete conversations. * * Resolves with the full HTTP response informa
packages/agent-studio/src/agentStudioClient.ts:1665
FunctiondeleteUserProfile
* Deletes a user profile. The response includes a date and time when the user profile can safely be considered deleted. * * Required API Ke
packages/client-personalization/src/personalizationClient.ts:357
FunctiondeleteUserProfileWithHTTPInfo
* Deletes a user profile. The response includes a date and time when the user profile can safely be considered deleted. * * Resolves with t
packages/client-personalization/src/personalizationClient.ts:388
FunctiondeleteUserToken
* Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hour
packages/client-insights/src/insightsClient.ts:354
FunctiondeleteUserTokenWithHTTPInfo
* Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hour
packages/client-insights/src/insightsClient.ts:382
FunctiondeleteUserWithHTTPInfo
* Deletes a user profile. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw
packages/advanced-personalization/src/advancedPersonalizationClient.ts:460
FunctiondisableTask
* Disables a task. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param disableTask - T
packages/ingestion/src/ingestionClient.ts:1397
FunctiondisableTaskV1
* Disables a task using the v1 endpoint. Use `disableTask` instead. * * Required API Key ACLs: * - addObject * - deleteIndex
packages/ingestion/src/ingestionClient.ts:1460
FunctiondisableTaskV1WithHTTPInfo
* Disables a task using the v1 endpoint. Use `disableTask` instead. * * Resolves with the full HTTP response information: status code, heade
packages/ingestion/src/ingestionClient.ts:1492
FunctiondisableTaskWithHTTPInfo
* Disables a task. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body a
packages/ingestion/src/ingestionClient.ts:1427
FunctionenableTask
* Enables a task. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param enableTask - The
packages/ingestion/src/ingestionClient.ts:1523
FunctionenableTaskV1
* Enables a task using the v1 endpoint. Use `enableTask` instead. * * Required API Key ACLs: * - addObject * - deleteIndex
packages/ingestion/src/ingestionClient.ts:1586
FunctionenableTaskV1WithHTTPInfo
* Enables a task using the v1 endpoint. Use `enableTask` instead. * * Resolves with the full HTTP response information: status code, headers
packages/ingestion/src/ingestionClient.ts:1618
FunctionenableTaskWithHTTPInfo
* Enables a task. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body an
packages/ingestion/src/ingestionClient.ts:1553
Functionerror
(message: string, args?: any | undefined)
packages/logger-console/src/logger.ts:35
Functionerror
(_message: string, _args?: any | undefined)
packages/client-common/src/logger/createNullLogger.ts:11
FunctionestimateABTest
* Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical t
packages/abtesting/src/abtestingV3Client.ts:486
FunctionestimateABTest
* Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical t
packages/client-abtesting/src/abtestingClient.ts:482
FunctionestimateABTestWithHTTPInfo
* Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical t
packages/abtesting/src/abtestingV3Client.ts:520
FunctionestimateABTestWithHTTPInfo
* Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical t
packages/client-abtesting/src/abtestingClient.ts:516
FunctionexportConversations
* Exports all conversations based on the passed filters. * * Required API Key ACLs: * - logs * @param exportConversations - The e
packages/agent-studio/src/agentStudioClient.ts:1696
FunctionexportConversationsWithHTTPInfo
* Exports all conversations based on the passed filters. * * Resolves with the full HTTP response information: status code, headers (when th
packages/agent-studio/src/agentStudioClient.ts:1740
FunctionforgeSecuredUserToken
({ secretKey, secretKeyId, userId, expiresIn = 24 * 3600, // 24 hours }: { s
packages/agent-studio/builds/node.ts:53
FunctionforgeSecuredUserToken
({ secretKey, secretKeyId, userId, expiresIn = 24 * 3600, // 24 hours }: { s
packages/agent-studio/builds/fetch.ts:53
Functionget
( key: Record<string, any> | string, defaultValue: () => Promise<TValue>, events: CacheEvent
packages/client-common/src/cache/createBrowserLocalStorageCache.ts:61
Functionget
( _key: Record<string, any> | string, defaultValue: () => Promise<TValue>, events: CacheEven
packages/client-common/src/cache/createNullCache.ts:5
Functionget
( key: Record<string, any> | string, defaultValue: () => Promise<TValue>, events: CacheEvent
packages/client-common/src/cache/createMemoryCache.ts:7
Functionget
( key: Record<string, any> | string, defaultValue: () => Promise<TValue>, events: CacheEvent
packages/client-common/src/cache/createFallbackableCache.ts:13
Functionget
()
packages/client-common/src/__tests__/cache/browser-local-storage-cache.test.ts:7
Functionget
()
packages/client-common/src/__tests__/cache/fallbackable-cache.test.ts:12
FunctiongetABTest
* Retrieves the details for an A/B test by its ID. * * Required API Key ACLs: * - analytics * @param getABTest - The getABTest ob
packages/abtesting/src/abtestingV3Client.ts:557
FunctiongetABTest
* Retrieves the details for an A/B test by its ID. * * Required API Key ACLs: * - analytics * @param getABTest - The getABTest ob
packages/client-abtesting/src/abtestingClient.ts:553
FunctiongetABTestWithHTTPInfo
* Retrieves the details for an A/B test by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requ
packages/abtesting/src/abtestingV3Client.ts:585
FunctiongetABTestWithHTTPInfo
* Retrieves the details for an A/B test by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requ
packages/client-abtesting/src/abtestingClient.ts:581
FunctiongetAddToCartRate
* Retrieves the add-to-cart rate for all your searches with at least one add-to-cart event, including a daily breakdown. By default, the analyzed per
packages/client-analytics/src/analyticsClient.ts:401
FunctiongetAddToCartRateWithHTTPInfo
* Retrieves the add-to-cart rate for all your searches with at least one add-to-cart event, including a daily breakdown. By default, the analyzed per
packages/client-analytics/src/analyticsClient.ts:451
FunctiongetAgent
* Retrieve details of the specified agent. * * Required API Key ACLs: * - settings * @param getAgent - The getAgent object.
packages/agent-studio/src/agentStudioClient.ts:1780
FunctiongetAgentWithHTTPInfo
* Retrieve details of the specified agent. * * Resolves with the full HTTP response information: status code, headers (when the requester ca
packages/agent-studio/src/agentStudioClient.ts:1808
FunctiongetAllConfigs
* Retrieves all Query Suggestions configurations of your Algolia application. * * Required API Key ACLs: * - settings * @param re
packages/client-query-suggestions/src/querySuggestionsClient.ts:476
FunctiongetAllConfigsWithHTTPInfo
* Retrieves all Query Suggestions configurations of your Algolia application. * * Resolves with the full HTTP response information: status c
packages/client-query-suggestions/src/querySuggestionsClient.ts:500
FunctiongetAllowedDomain
* Get a single allowed domain by id. * * Required API Key ACLs: * - settings * @param getAllowedDomain - The getAllowedDomain obj
packages/agent-studio/src/agentStudioClient.ts:1838
FunctiongetAllowedDomainWithHTTPInfo
* Get a single allowed domain by id. * * Resolves with the full HTTP response information: status code, headers (when the requester captures
packages/agent-studio/src/agentStudioClient.ts:1874
FunctiongetApiKey
* Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your applic
packages/client-search/src/searchClient.ts:2303
FunctiongetApiKeyWithHTTPInfo
* Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your applic
packages/client-search/src/searchClient.ts:2331
FunctiongetAppTask
* Checks the status of a given application task. * * Required API Key ACLs: * - editSettings * @param getAppTask - The getAppTask
packages/client-search/src/searchClient.ts:2360
FunctiongetAppTaskWithHTTPInfo
* Checks the status of a given application task. * * Resolves with the full HTTP response information: status code, headers (when the reques
packages/client-search/src/searchClient.ts:2388
FunctiongetAuthentication
* Retrieves an authentication resource by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSetting
packages/ingestion/src/ingestionClient.ts:1649
← previousnext →401–500 of 918, ranked by callers