GitHub

API reference for Method.

A query or mutation on a client: call it with the variables (none for an operation without), and partial=True for the decoded data alongside the response's errors. context provides services to the call.

Attributes

AttributeTypeDescription
operation= operation
raw= raw

Functions

__init__

__init__(operation, call, raw=None) -> None
ParameterTypeDescription
operationAnyOperation
callCall
rawRawExecutor | None = None
def __init__(self, operation: AnyOperation, call: Call, raw: RawExecutor | None = None) -> None:
    self.operation = operation
    self._call = call
    self.raw = raw

__call__

__call__(variables: None = None, /, *, partial: Literal[False] = False, headers: HeadersInput | None = None, url_params: UrlParamsInput | None = None, context: Context[Any] | None = None) -> Effect[A_co, GraphQLClientError | ME_co, MR_co]
__call__(variables: None = None, /, *, partial: Literal[True], headers: HeadersInput | None = None, url_params: UrlParamsInput | None = None, context: Context[Any] | None = None) -> Effect[PartialResult[A_co], GraphQLClientError | ME_co, MR_co]
__call__(variables: V_contra, /, *, partial: Literal[False] = False, headers: HeadersInput | None = None, url_params: UrlParamsInput | None = None, context: Context[Any] | None = None) -> Effect[A_co, GraphQLClientError | ME_co, MR_co]
__call__(variables: V_contra, /, *, partial: Literal[True], headers: HeadersInput | None = None, url_params: UrlParamsInput | None = None, context: Context[Any] | None = None) -> Effect[PartialResult[A_co], GraphQLClientError | ME_co, MR_co]
ParameterTypeDescription
variables= None
partial= False
headers= None
url_params= None
context= None
@overload
def __call__(
    self: Method[NoVariables, A_co, ME_co, MR_co],
    variables: None = None,
    /,
    *,
    partial: Literal[False] = False,
    headers: HeadersInput | None = None,
    url_params: UrlParamsInput | None = None,
    context: Context[Any] | None = None,
) -> Effect[A_co, GraphQLClientError | ME_co, MR_co]: ...
@overload
def __call__(
    self: Method[NoVariables, A_co, ME_co, MR_co],
    variables: None = None,
    /,
    *,
    partial: Literal[True],
    headers: HeadersInput | None = None,
    url_params: UrlParamsInput | None = None,
    context: Context[Any] | None = None,
) -> Effect[PartialResult[A_co], GraphQLClientError | ME_co, MR_co]: ...
@overload
def __call__(
    self,
    variables: V_contra,
    /,
    *,
    partial: Literal[False] = False,
    headers: HeadersInput | None = None,
    url_params: UrlParamsInput | None = None,
    context: Context[Any] | None = None,
) -> Effect[A_co, GraphQLClientError | ME_co, MR_co]: ...
@overload
def __call__(
    self,
    variables: V_contra,
    /,
    *,
    partial: Literal[True],
    headers: HeadersInput | None = None,
    url_params: UrlParamsInput | None = None,
    context: Context[Any] | None = None,
) -> Effect[PartialResult[A_co], GraphQLClientError | ME_co, MR_co]: ...
def __call__(
    self,
    variables: object = None,
    /,
    *,
    partial: bool = False,
    headers: HeadersInput | None = None,
    url_params: UrlParamsInput | None = None,
    context: Context[Any] | None = None,
) -> Any:
    options = CallOptions(
        headers=headers, url_params=url_params, context=context, partial=partial
    )
    return self._call(variables, options)