Function GraphqlApiFactory

Returns {
    adminCreateCustomResolver(groupId, appId, customResolver, options?) => AxiosPromise<CustomResolver>;
    adminDeleteCustomResolver(groupId, appId, customResolverId, options?) => AxiosPromise<void>;
    adminGetAllCustomResolvers(groupId, appId, options?) => AxiosPromise<any>;
    adminGetCustomResolver(groupId, appId, customResolverId, options?) => AxiosPromise<CustomResolver>;
    adminGetGraphQLConfig(groupId, appId, options?) => AxiosPromise<GraphQLConfig>;
    adminGetGraphQLValidationSettings(groupId, appId, options?) => AxiosPromise<GraphQLValidationSettings>;
    adminModifyCustomResolver(groupId, appId, customResolverId, customResolver, options?) => AxiosPromise<void>;
    adminRunGraphQLOperation(groupId, appId, adminRunGraphQLOperationRequest?, options?) => AxiosPromise<AdminRunGraphQLOperation200Response>;
    adminSetGraphQLValidationSettings(groupId, appId, graphQLValidationSettings, options?) => AxiosPromise<void>;
    adminUpdateGraphQLConfig(groupId, appId, graphQLConfig, options?) => AxiosPromise<void>;
}

• adminCreateCustomResolver:function

  • adminCreateCustomResolver(groupId, appId, customResolver, options?): AxiosPromise<CustomResolver>

  • Create a new custom resolver.

    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.

    • customResolver: CustomResolver

      A valid custom resolver configuration object.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<CustomResolver>

    Summary

    Create a custom resolver

    Throws

• adminDeleteCustomResolver:function

  • adminDeleteCustomResolver(groupId, appId, customResolverId, options?): AxiosPromise<void>

  • Delete an existing custom resolver configuration.

    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.

    • customResolverId: any

      The unique `_id` value of a custom resolver.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Delete a custom resolver

    Throws

• adminGetAllCustomResolvers:function

  • adminGetAllCustomResolvers(groupId, appId, options?): AxiosPromise<any>

  • Get all custom resolver configurations from your app's GraphQL API.

    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: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    Get all custom resolvers

    Throws

• adminGetCustomResolver:function

  • adminGetCustomResolver(groupId, appId, customResolverId, options?): AxiosPromise<CustomResolver>

  • Get a specific custom resolver configuration.

    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.

    • customResolverId: any

      The unique `_id` value of a custom resolver.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<CustomResolver>

    Summary

    Get a custom resolver

    Throws

• adminGetGraphQLConfig:function

  • adminGetGraphQLConfig(groupId, appId, options?): AxiosPromise<GraphQLConfig>

  • Get your app's GraphQL API configuration.

    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: any

      Override http request option.

    Returns AxiosPromise<GraphQLConfig>

    Summary

    Get GraphQL API Configuration

    Throws

• adminGetGraphQLValidationSettings:function

  • adminGetGraphQLValidationSettings(groupId, appId, options?): AxiosPromise<GraphQLValidationSettings>

  • Get the current validation level and action for reads and writes.

    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: any

      Override http request option.

    Returns AxiosPromise<GraphQLValidationSettings>

    Summary

    Get validation settings

    Throws

• adminModifyCustomResolver:function

  • adminModifyCustomResolver(groupId, appId, customResolverId, customResolver, options?): AxiosPromise<void>

  • Modify an existing custom resolver configuration.

    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.

    • customResolverId: any

      The unique `_id` value of a custom resolver.

    • customResolver: CustomResolver

      A valid, updated custom resolver configuration object.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Modify a custom resolver

    Throws

• adminRunGraphQLOperation:function

  • adminRunGraphQLOperation(groupId, appId, adminRunGraphQLOperationRequest?, options?): AxiosPromise<AdminRunGraphQLOperation200Response>

  • Run a query or mutation as a system user that bypasses authentication and data access rules. You can access metadata about your API, including its schema, with an introspection query.

    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 adminRunGraphQLOperationRequest: AdminRunGraphQLOperationRequest

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<AdminRunGraphQLOperation200Response>

    Summary

    Run a query or mutation

    Throws

• adminSetGraphQLValidationSettings:function

  • adminSetGraphQLValidationSettings(groupId, appId, graphQLValidationSettings, options?): AxiosPromise<void>

  • Set the validation level and action for reads and writes.

    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.

    • graphQLValidationSettings: GraphQLValidationSettings

      The updated validation levels and actions.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Modify validation settings

    Throws

• adminUpdateGraphQLConfig:function

  • adminUpdateGraphQLConfig(groupId, appId, graphQLConfig, options?): AxiosPromise<void>

  • Update your app's GraphQL API configuration.

    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.

    • graphQLConfig: GraphQLConfig

      A valid GraphQL API configuration object.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Update GraphQL API Configuration

    Throws