Function ValuesApiFp

Returns {
    adminCreateValue(groupId, appId, newValue, options?) => Promise<((axios?, basePath?) => AxiosPromise<NewValue>)>;
    adminDeleteValue(groupId, appId, valueId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminGetValue(groupId, appId, valueId, options?) => Promise<((axios?, basePath?) => AxiosPromise<Value>)>;
    adminListValues(groupId, appId, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    adminUpdateValue(groupId, appId, valueId, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
}

• adminCreateValue:function

  • adminCreateValue(groupId, appId, newValue, options?): Promise<((axios?, basePath?) => AxiosPromise<NewValue>)>

  • Define a Value in an application.

    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.

    • newValue: NewValue

      The value to create.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<NewValue>)>

    Summary

    Define a Value in an application

    Throws

• adminDeleteValue:function

  • adminDeleteValue(groupId, appId, valueId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Delete a value defined in an application.

    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.

    • valueId: any

      The unique `_id` value of a value.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Delete a value defined in an application.

    Throws

• adminGetValue:function

  • adminGetValue(groupId, appId, valueId, options?): Promise<((axios?, basePath?) => AxiosPromise<Value>)>

  • Retrieve a value definition from an application.

    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.

    • valueId: any

      The unique `_id` value of a value.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<Value>)>

    Summary

    Retrieve a value definition from an application

    Throws

• adminListValues:function

  • adminListValues(groupId, appId, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • List all values defined in an application.

    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<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    List all values defined in an application.

    Throws

• adminUpdateValue:function

  • adminUpdateValue(groupId, appId, valueId, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • Update a value definition in an application.

    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.

    • valueId: any

      The unique `_id` value of a value.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    Update a value definition in an application

    Throws