Function FunctionsApiAxiosParamCreator

Returns {
    adminCreateFunction: ((groupId, appId, newFunction, options?) => Promise<RequestArgs>);
    adminDeleteFunction: ((groupId, appId, functionId, options?) => Promise<RequestArgs>);
    adminExecuteFunction: ((userId, runAsSystem, groupId, appId, adminExecuteFunctionRequest, options?) => Promise<RequestArgs>);
    adminExecuteFunctionSource: ((userId, runAsSystem, groupId, appId, adminExecuteFunctionSourceRequest, options?) => Promise<RequestArgs>);
    adminGetFunction: ((groupId, appId, functionId, options?) => Promise<RequestArgs>);
    adminListFunctions: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminUpdateFunction: ((groupId, appId, functionId, options?) => Promise<RequestArgs>);
}

• adminCreateFunction: ((groupId, appId, newFunction, options?) => Promise<RequestArgs>)

  • • (groupId, appId, newFunction, options?): Promise<RequestArgs>

    • Create a new Function.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • newFunction: NewFunction

        The function to create

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Create a new Function

      Throws

• adminDeleteFunction: ((groupId, appId, functionId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, functionId, options?): Promise<RequestArgs>

    • Delete a Function.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • functionId: any

        The unique `_id` value of a function.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Delete a Function

      Throws

• adminExecuteFunction: ((userId, runAsSystem, groupId, appId, adminExecuteFunctionRequest, options?) => Promise<RequestArgs>)

  • • (userId, runAsSystem, groupId, appId, adminExecuteFunctionRequest, options?): Promise<RequestArgs>

    • Execute a function for testing.

      Parameters

      • userId: any

        The user as which to execute the function. Either `user_id` or `run_as_system` is required. You cannot specify both.

      • runAsSystem: any

        Determine whether or not to run as system user. Either `run_as_system` or `user_id` is required. You cannot specify both.

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • adminExecuteFunctionRequest: AdminExecuteFunctionRequest

        The function to execute.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Execute a function

      Throws

• adminExecuteFunctionSource: ((userId, runAsSystem, groupId, appId, adminExecuteFunctionSourceRequest, options?) => Promise<RequestArgs>)

  • • (userId, runAsSystem, groupId, appId, adminExecuteFunctionSourceRequest, options?): Promise<RequestArgs>

    • Execute a function's source code for testing.

      Parameters

      • userId: any

        The user as which to execute the function. Either `user_id` or `run_as_system` is required. You cannot specify both.

      • runAsSystem: any

        Determine whether or not to run as system user. Either `run_as_system` or `user_id` is required. You cannot specify both.

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • adminExecuteFunctionSourceRequest: AdminExecuteFunctionSourceRequest

        The source to execute.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Execute a function's source code for testing

      Throws

• adminGetFunction: ((groupId, appId, functionId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, functionId, options?): Promise<RequestArgs>

    • Retrieve a Function.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • functionId: any

        The unique `_id` value of a function.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Retrieve a Function

      Throws

• adminListFunctions: ((groupId, appId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, options?): Promise<RequestArgs>

    • List Functions.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      List Functions

      Throws

• adminUpdateFunction: ((groupId, appId, functionId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, functionId, options?): Promise<RequestArgs>

    • Update a Function.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • functionId: any

        The unique `_id` value of a function.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Update a Function

      Throws