Class CloudAccountClient

Hierarchy

ReactQueryNetworkClient
- CloudAccountClient

Constructors

constructor

new CloudAccountClient(): CloudAccountClient
Returns CloudAccountClient
Overrides ReactQueryNetworkClient.constructor
- Defined in client/cloud-account.ts:13

Properties

cloudAccountByWorkspace

cloudAccountByWorkspace: QueryObject<
    Omit<
        { accountId?: string; id: string; jwtToken: JwtToken },
        "authorization" | "jwtToken",
    > & {},
    CloudAccountDetails[],
> = ...

Gets a list of cloud accounts connected to a workspace

cloudAccounts

cloudAccounts: InfiniteQueryObject<
    Omit<
        {
            $type?: "CustomCloud"
            | "CloudServices";
            environment?: string;
            filter?: string;
            jwtToken: JwtToken;
            page?: number;
            pageSize?: number;
            sortBy?: string;
            sortOrder?: string;
            status?:
                | "Connecting"
                | "Connected"
                | "Disconnected"
                | "Failed"
                | "Unknown";
        },
        "authorization"
        | "jwtToken",
    > & {},
    PaginatedResourceCloudAccountResponse,
    "data",
> = ...

Lists all cloud accounts according to the parameters (paginated).

createCloudAccount

createCloudAccount: MutationObject<
    Omit<
        {
            connectAccountRequestV2: ConnectAccountRequestV2;
            jwtToken: JwtToken;
            stackspotCustomerIp?: string;
        },
        "jwtToken"
        | "connectAccountRequestV2",
    > & { connectAccountRequestV2: FixedConnectAccountRequestV2 },
    CloudAccountDetails,
> = ...

Creates a cloud account.

createCloudServicesAccount

createCloudServicesAccount: MutationObject<
    Omit<
        {
            jwtToken: JwtToken;
            managedAccountProvisionRequest: ManagedAccountProvisionRequest;
            stackspotCustomerIp?: string;
        },
        "jwtToken"
        | "managedAccountProvisionRequest",
    > & { managedAccountProvisionRequest: FixedManagedAccountProvisionRequest },

        | "100 CONTINUE"
        | "101 SWITCHING_PROTOCOLS"
        | "102 PROCESSING"
        | "103 EARLY_HINTS"
        | "103 CHECKPOINT"
        | "200 OK"
        | "201 CREATED"
        | "202 ACCEPTED"
        | "203 NON_AUTHORITATIVE_INFORMATION"
        | "204 NO_CONTENT"
        | "205 RESET_CONTENT"
        | "206 PARTIAL_CONTENT"
        | "207 MULTI_STATUS"
        | "208 ALREADY_REPORTED"
        | "226 IM_USED"
        | "300 MULTIPLE_CHOICES"
        | "301 MOVED_PERMANENTLY"
        | "302 FOUND"
        | "302 MOVED_TEMPORARILY"
        | "303 SEE_OTHER"
        | "304 NOT_MODIFIED"
        | "305 USE_PROXY"
        | "307 TEMPORARY_REDIRECT"
        | "308 PERMANENT_REDIRECT"
        | "400 BAD_REQUEST"
        | "401 UNAUTHORIZED"
        | "402 PAYMENT_REQUIRED"
        | "403 FORBIDDEN"
        | "404 NOT_FOUND"
        | "405 METHOD_NOT_ALLOWED"
        | "406 NOT_ACCEPTABLE"
        | "407 PROXY_AUTHENTICATION_REQUIRED"
        | "408 REQUEST_TIMEOUT"
        | "409 CONFLICT"
        | "410 GONE"
        | "411 LENGTH_REQUIRED"
        | "412 PRECONDITION_FAILED"
        | "413 PAYLOAD_TOO_LARGE"
        | "413 REQUEST_ENTITY_TOO_LARGE"
        | "414 URI_TOO_LONG"
        | "414 REQUEST_URI_TOO_LONG"
        | "415 UNSUPPORTED_MEDIA_TYPE"
        | "416 REQUESTED_RANGE_NOT_SATISFIABLE"
        | "417 EXPECTATION_FAILED"
        | "418 I_AM_A_TEAPOT"
        | "419 INSUFFICIENT_SPACE_ON_RESOURCE"
        | "420 METHOD_FAILURE"
        | "421 DESTINATION_LOCKED"
        | "422 UNPROCESSABLE_ENTITY"
        | "423 LOCKED"
        | "424 FAILED_DEPENDENCY"
        | "425 TOO_EARLY"
        | "426 UPGRADE_REQUIRED"
        | "428 PRECONDITION_REQUIRED"
        | "429 TOO_MANY_REQUESTS"
        | "431 REQUEST_HEADER_FIELDS_TOO_LARGE"
        | "451 UNAVAILABLE_FOR_LEGAL_REASONS"
        | "500 INTERNAL_SERVER_ERROR"
        | "501 NOT_IMPLEMENTED"
        | "502 BAD_GATEWAY"
        | "503 SERVICE_UNAVAILABLE"
        | "504 GATEWAY_TIMEOUT"
        | "505 HTTP_VERSION_NOT_SUPPORTED"
        | "506 VARIANT_ALSO_NEGOTIATES"
        | "507 INSUFFICIENT_STORAGE"
        | "508 LOOP_DETECTED"
        | "509 BANDWIDTH_LIMIT_EXCEEDED"
        | "510 NOT_EXTENDED"
        | "511 NETWORK_AUTHENTICATION_REQUIRED",
> = ...

Provisions managed accounts in a workspace.

deleteAllCloudAccounts

deleteAllCloudAccounts: MutationObject<
    Omit<
        {
            jwtToken: JwtToken;
            stackspotCustomerIp?: string;
            workspaceId: string;
        },
        "authorization"
        | "jwtToken",
    > & {},
    DeleteCloudAccountResponse,
> = ...

Deletes all accounts in a workspace.

deleteCloudAccount

deleteCloudAccount: MutationObject<
    Omit<
        { id: string; jwtToken: JwtToken; stackspotCustomerIp?: string },
        "authorization" | "jwtToken",
    > & {},
    DeleteCloudAccountResponse,
> = ...

Deletes a cloud account.

managedAccountTemplates

managedAccountTemplates: QueryObject<void, ManagedAccountTemplateResponse[]> = ...

Gets all available templates for the managed Cloud Account.

managesAccountRegions

managesAccountRegions: QueryObject<void, ManagedAccountRegionResponse[]> = ...

Gets all the available regions for the managed Cloud Account.

workflowByWorkspace

workflowByWorkspace: QueryObject<
    Omit<
        { jwtToken: JwtToken; workspaceId: string },
        "authorization" | "jwtToken",
    > & {},
    Workflow,
> = ...

Gets the cloud account workflow of a workspace environment

Methods

`Protected`buildStackSpotError

buildStackSpotError(error: HttpError): StackspotAPIError
Receives an HttpError and returns a StackspotAPIError.
Parameters
- error: HttpError
  the original HttpError created by oazapfts.
Returns StackspotAPIError
Overrides ReactQueryNetworkClient.buildStackSpotError
- Defined in client/cloud-account.ts:17

`Protected`createPermissionFunctionFor

createPermissionFunctionFor<
    Args extends
        | [variables: Record<string, any>, opts?: RequestOpts]
        | [opts?: RequestOpts],
>(
    fn: (...args: Args) => Promise<any>,
): (
    ...args: Args extends [opts?: RequestOpts]
        ? []
        : [variables?: Partial<Args[0]>],
) => Promise<boolean>
Creates a function that checks the permission for a request generated by an oazapfts function.

This is intended to help creating a manual operation.
Type Parameters
- Args extends [variables: Record<string, any>, opts?: RequestOpts] | [opts?: RequestOpts]
Parameters
- fn: (...args: Args) => Promise<any>
  the function generated by oazapfts.
Returns (
    ...args: Args extends [opts?: RequestOpts]
        ? []
        : [variables?: Partial<Args[0]>],
) => Promise<boolean>
a function that receives the variables of fn (if any) and returns a promise that resolves to true if the request is allowed and false otherwise.
Example
```
myOperation = this.mutation({
  // ...
  permission: this.createPermissionFunctionFor(oazapftsFnForMyOperation)
})
```
Inherited from ReactQueryNetworkClient.createPermissionFunctionFor
- Defined in network/ReactQueryNetworkClient.ts:81

`Protected`createRequestFunctionFor

createRequestFunctionFor<
    Args extends
        | [variables: Record<string, any>, opts?: RequestOpts]
        | [opts?: RequestOpts],
    Result,
>(
    fn: (...args: Args) => Promise<Result>,
): (
    ...args: Args extends [opts?: RequestOpts]
        ? [signal: AbortSignal]
        : [signal: AbortSignal, variables: Args[0]],
) => Promise<Result>
Creates a function that runs a oazapfts function with an abort signal.

This is intended to help creating a manual operation.
Type Parameters
- Args extends [variables: Record<string, any>, opts?: RequestOpts] | [opts?: RequestOpts]
- Result
Parameters
- fn: (...args: Args) => Promise<Result>
  the function generated by oazapfts.
Returns (
    ...args: Args extends [opts?: RequestOpts]
        ? [signal: AbortSignal]
        : [signal: AbortSignal, variables: Args[0]],
) => Promise<Result>
a function that receives a signal and the variables of fn (if any) and returns the same as fn.
Example
```
myOperation = this.mutation({
  // ...
  request: this.createRequestFunctionFor(oazapftsFnForMyOperation)
})
```
Inherited from ReactQueryNetworkClient.createRequestFunctionFor
- Defined in network/ReactQueryNetworkClient.ts:107

`Protected`fetch

fetch(input: string | URL | Request, init?: RequestInit): Promise<Response>
Makes a request (same signature as globalThis.fetch). This request will prepend the base url to the url and, if there's an active session, include authentication headers.
Parameters
- input: string | URL | Request
  the url or request object.
- Optionalinit: RequestInit
  the fetch options.
Returns Promise<Response>
a promise with the Response.
Inherited from ReactQueryNetworkClient.fetch
- Defined in network/NetworkClient.ts:90

`Protected`infiniteQuery

infiniteQuery<
    Variables extends Record<string, any>,
    Result,
    PageParamName extends string | number | symbol,
    Accumulator extends string | number | symbol,
>(
    config: InfiniteQueryConfig<
        Variables,
        Result,
        PageParamName,
        Accumulator,
    >,
): InfiniteQueryObject<Variables, Result, Accumulator>
Builds a query manually by using a configuration object.
Type Parameters
- Variables extends Record<string, any>
- Result
- PageParamName extends string | number | symbol
- Accumulator extends string | number | symbol
Parameters
- config: InfiniteQueryConfig<Variables, Result, PageParamName, Accumulator>
  the configuration object containing the name, a request function and a permission function.
Returns InfiniteQueryObject<Variables, Result, Accumulator>
Inherited from ReactQueryNetworkClient.infiniteQuery
- Defined in network/ReactQueryNetworkClient.ts:174
infiniteQuery<
    Variables extends Record<string, any>,
    Result,
    PageParamName extends string | number | symbol,
    Accumulator extends string | number | symbol,
>(
    config: Omit<
        InfiniteQueryConfig<Variables, Result, PageParamName, Accumulator>,
        "permission",
    >,
): Omit<
    InfiniteQueryObject<Variables, Result, Accumulator>,
    "isAllowed" | "useAllowed" | "getPermissionKey",
>
Builds a query manually by using a configuration object.
Type Parameters
- Variables extends Record<string, any>
- Result
- PageParamName extends string | number | symbol
- Accumulator extends string | number | symbol
Parameters
- config: Omit<
  InfiniteQueryConfig<Variables, Result, PageParamName, Accumulator>,
  "permission",
  >
  the configuration object containing the name and a request function.
Returns Omit<
InfiniteQueryObject<Variables, Result, Accumulator>,
"isAllowed" | "useAllowed" | "getPermissionKey",
>
Inherited from ReactQueryNetworkClient.infiniteQuery
- Defined in network/ReactQueryNetworkClient.ts:184
infiniteQuery<
    Variables extends Record<string, any>,
    Result,
    PageParamName extends string | number | symbol,
    Accumulator extends string | number | symbol,
>(
    fn: (variables: Variables, opts?: RequestOpts) => Promise<Result>,
    options: Partial<
        InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator>,
    >,
): InfiniteQueryObject<Variables, Result, Accumulator>
Builds a query automatically by using a function generated by oazapfts.
Type Parameters
- Variables extends Record<string, any>
- Result
- PageParamName extends string | number | symbol
- Accumulator extends string | number | symbol
Parameters
- fn: (variables: Variables, opts?: RequestOpts) => Promise<Result>
  the oazapfts function.
- options: Partial<InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator>>
  the configuration for the infinite query.
Returns InfiniteQueryObject<Variables, Result, Accumulator>
Inherited from ReactQueryNetworkClient.infiniteQuery
- Defined in network/ReactQueryNetworkClient.ts:197
infiniteQuery<
    Variables extends { page?: string
    | number; size?: string | number },
    Result extends any[],
    PageParamName extends string | number | symbol = "page",
    Accumulator extends string | number | symbol = "",
>(
    fn: (variables: Variables, opts?: RequestOpts) => Promise<Result>,
    options?: Partial<
        InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator>,
    >,
): InfiniteQueryObject<Variables, Result, Accumulator>
Builds a query automatically by using a function generated by oazapfts with the variables page and size.
Type Parameters
- Variables extends { page?: string | number; size?: string | number }
- Result extends any[]
- PageParamName extends string | number | symbol = "page"
- Accumulator extends string | number | symbol = ""
Parameters
- fn: (variables: Variables, opts?: RequestOpts) => Promise<Result>
  the oazapfts function that returns an array.
- Optionaloptions: Partial<InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator>>
  optional configuration for the infinite query. By default, it will use the variables page and size of the function passed in the first parameter.
Returns InfiniteQueryObject<Variables, Result, Accumulator>
Inherited from ReactQueryNetworkClient.infiniteQuery
- Defined in network/ReactQueryNetworkClient.ts:212
infiniteQuery<
    Variables extends Record<string, any>,
    Result,
    PageParamName extends string,
    Accumulator extends string | number | symbol,
>(
    fn: (variables: Variables, opts?: RequestOpts) => Promise<Result>,
    options: Partial<
        InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator>,
    >,
): InfiniteQueryObject<Variables, Result, Accumulator>
Builds a query automatically by using a function generated by oazapfts in which the variables pageParamName is a string which can be used for dynamic indexing.
Type Parameters
- Variables extends Record<string, any>
- Result
- PageParamName extends string
- Accumulator extends string | number | symbol
Parameters
- fn: (variables: Variables, opts?: RequestOpts) => Promise<Result>
  the oazapfts function that returns an array.
- options: Partial<InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator>>
  optional configuration for the infinite query. By default, it will use the variables page and size of the function passed in the first parameter.
Returns InfiniteQueryObject<Variables, Result, Accumulator>
Inherited from ReactQueryNetworkClient.infiniteQuery
- Defined in network/ReactQueryNetworkClient.ts:228

`Protected`isFreemium

isFreemium(): boolean
Checks whether or not the current account is freemium.

Returns boolean
true if it's a freemium account, false otherwise.
Inherited from ReactQueryNetworkClient.isFreemium
- Defined in network/NetworkClient.ts:137

`Protected`mutation

mutation<
    Args extends [AbortSignal, Record<string, any>]
    | [AbortSignal],
    Result,
>(
    config: OperationConfig<Args, Result>,
): MutationObject<Args extends [AbortSignal] ? void : Args[1], Result>
Builds a mutation manually by using a configuration object.
Type Parameters
- Args extends [AbortSignal, Record<string, any>] | [AbortSignal]
- Result
Parameters
- config: OperationConfig<Args, Result>
  the configuration object containing the name, a request function and a permission function.
Returns MutationObject<Args extends [AbortSignal] ? void : Args[1], Result>
Inherited from ReactQueryNetworkClient.mutation
- Defined in network/ReactQueryNetworkClient.ts:276
mutation<
    Args extends [AbortSignal, Record<string, any>]
    | [AbortSignal],
    Result,
>(
    config: Omit<OperationConfig<Args, Result>, "permission">,
): Omit<
    MutationObject<Args extends [AbortSignal] ? void : Args[1], Result>,
    keyof OperationObject<any>,
>
Builds a mutation manually by using a configuration object.
Type Parameters
- Args extends [AbortSignal, Record<string, any>] | [AbortSignal]
- Result
Parameters
- config: Omit<OperationConfig<Args, Result>, "permission">
  the configuration object containing the name and a request function.
Returns Omit<
MutationObject<Args extends [AbortSignal] ? void : Args[1], Result>,
keyof OperationObject<any>,
>
Inherited from ReactQueryNetworkClient.mutation
- Defined in network/ReactQueryNetworkClient.ts:283
mutation<
    Args extends
        | [opts?: RequestOpts]
        | [variables: Record<string, any>, opts?: RequestOpts],
    Result,
>(
    fn: (...args: Args) => Promise<Result>,
): Args extends [variables: Variables, opts?: RequestOpts]
    ? MutationObject<Variables, Result>
    : MutationObject<void, Result>
Builds a mutation automatically by using a function generated by oazapfts.
Type Parameters
- Args extends [opts?: RequestOpts] | [variables: Record<string, any>, opts?: RequestOpts]
- Result
Parameters
- fn: (...args: Args) => Promise<Result>
  the oazapfts function.
Returns Args extends [variables: Variables, opts?: RequestOpts]
? MutationObject<Variables, Result>
: MutationObject<void, Result>
Inherited from ReactQueryNetworkClient.mutation
- Defined in network/ReactQueryNetworkClient.ts:290

`Protected`query

query<Args extends [AbortSignal, Record<string, any>] | [AbortSignal], Result>(
config: OperationConfig<Args, Result>,
): QueryObject<Args extends [AbortSignal] ? void : Args[1], Result>
Builds a query manually by using a configuration object.
Type Parameters
- Args extends [AbortSignal, Record<string, any>] | [AbortSignal]
- Result
Parameters
- config: OperationConfig<Args, Result>
  the configuration object containing the name, a request function and a permission function.
Returns QueryObject<Args extends [AbortSignal] ? void : Args[1], Result>
Inherited from ReactQueryNetworkClient.query
- Defined in network/ReactQueryNetworkClient.ts:134
query<Args extends [AbortSignal, Record<string, any>] | [AbortSignal], Result>(
    config: Omit<OperationConfig<Args, Result>, "permission">,
): Omit<
    QueryObject<Args extends [AbortSignal] ? void : Args[1], Result>,
    "isAllowed" | "useAllowed" | "getPermissionKey",
>
Builds a query manually by using a configuration object.
Type Parameters
- Args extends [AbortSignal, Record<string, any>] | [AbortSignal]
- Result
Parameters
- config: Omit<OperationConfig<Args, Result>, "permission">
  the configuration object containing the name and a request function.
Returns Omit<
QueryObject<Args extends [AbortSignal] ? void : Args[1], Result>,
"isAllowed" | "useAllowed" | "getPermissionKey",
>
Inherited from ReactQueryNetworkClient.query
- Defined in network/ReactQueryNetworkClient.ts:141
query<
    Args extends
        | [opts?: RequestOpts]
        | [variables: Record<string, any>, opts?: RequestOpts],
    Result,
>(
    fn: (...args: Args) => Promise<Result>,
): Args extends [variables: Variables, opts?: RequestOpts]
    ? QueryObject<Variables, Result>
    : QueryObject<void, Result>
Builds a query automatically by using a function generated by oazapfts.
Type Parameters
- Args extends [opts?: RequestOpts] | [variables: Record<string, any>, opts?: RequestOpts]
- Result
Parameters
- fn: (...args: Args) => Promise<Result>
  the oazapfts function.
Returns Args extends [variables: Variables, opts?: RequestOpts]
? QueryObject<Variables, Result>
: QueryObject<void, Result>
Inherited from ReactQueryNetworkClient.query
- Defined in network/ReactQueryNetworkClient.ts:148

`Protected`requestPermission

requestPermission(
    method: HTTPMethod,
    path: string,
    body?: string | object,
): Promise<boolean>
Verifies if the current user is allowed to send the given request.
Parameters
- method: HTTPMethod
  the request's method.
- path: string
  the path to the resource.
- Optionalbody: string | object
  the request's body.
Returns Promise<boolean>
a promise that resolves to true if it's allowed or false otherwise.
Inherited from ReactQueryNetworkClient.requestPermission
- Defined in network/NetworkClient.ts:66

`Protected`resolveURL

resolveURL(path: string): URL
Builds a URL with the baseUrl of this network client and the path passed as parameter.
Parameters
- path: string
  the path to the resource.
Returns URL
a full URL.
Inherited from ReactQueryNetworkClient.resolveURL
- Defined in network/NetworkClient.ts:50

`Protected`stream

stream(
input: string | URL | Request,
init?: RequestInit,
): Promise<FetchEventStream>
Reads an EventSource from the endpoint. Differently than the original specification, this allows common HTTP requests with method and body to be made.
Parameters
- input: string | URL | Request
  the url or request object.
- Optionalinit: RequestInit
  the fetch options.
Returns Promise<FetchEventStream>
a promise with a FetchEventStream, which is an AsyncGenerator.
Example
```
let events = this.stream('url', options)
for await (let event of events) {
  console.log('<<', event.data)
}
```
Inherited from ReactQueryNetworkClient.stream
- Defined in network/NetworkClient.ts:121

`Static`setup

setup(sessionManager: SessionManager, env: Env): void
Sets up all network clients. Must be called before attempting to make any request.
Parameters
- sessionManager: SessionManager
  An object with functions capable of checking, retrieving and ending the current session.
- env: Env
  The environment to send the requests to.
Returns void
Inherited from ReactQueryNetworkClient.setup
- Defined in network/NetworkClient.ts:36

Class CloudAccountClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CloudAccountClient

Properties

cloudAccountByWorkspace

cloudAccounts

createCloudAccount

createCloudServicesAccount

deleteAllCloudAccounts

deleteCloudAccount

managedAccountTemplates

managesAccountRegions

workflowByWorkspace

Methods

ProtectedbuildStackSpotError

Parameters

Returns StackspotAPIError

ProtectedcreatePermissionFunctionFor

Type Parameters

Parameters

Returns ( ...args: Args extends [opts?: RequestOpts] ? [] : [variables?: Partial<Args[0]>],) => Promise<boolean>

Example

ProtectedcreateRequestFunctionFor

Type Parameters

Parameters

Returns ( ...args: Args extends [opts?: RequestOpts] ? [signal: AbortSignal] : [signal: AbortSignal, variables: Args[0]],) => Promise<Result>

Example

Protectedfetch

Parameters

Returns Promise<Response>

ProtectedinfiniteQuery

Type Parameters

Parameters

Returns InfiniteQueryObject<Variables, Result, Accumulator>

Type Parameters

Parameters

Returns Omit< InfiniteQueryObject<Variables, Result, Accumulator>, "isAllowed" | "useAllowed" | "getPermissionKey",>

Type Parameters

Parameters

Returns InfiniteQueryObject<Variables, Result, Accumulator>

Type Parameters

Parameters

Returns InfiniteQueryObject<Variables, Result, Accumulator>

Type Parameters

Parameters

Returns InfiniteQueryObject<Variables, Result, Accumulator>

ProtectedisFreemium

Returns boolean

Protectedmutation

Type Parameters

Parameters

Returns MutationObject<Args extends [AbortSignal] ? void : Args[1], Result>

Type Parameters

Parameters

Returns Omit< MutationObject<Args extends [AbortSignal] ? void : Args[1], Result>, keyof OperationObject<any>,>

Type Parameters

Parameters

Returns Args extends [variables: Variables, opts?: RequestOpts] ? MutationObject<Variables, Result> : MutationObject<void, Result>

Protectedquery

Type Parameters

Parameters

Returns QueryObject<Args extends [AbortSignal] ? void : Args[1], Result>

Type Parameters

Parameters

Returns Omit< QueryObject<Args extends [AbortSignal] ? void : Args[1], Result>, "isAllowed" | "useAllowed" | "getPermissionKey",>

Type Parameters

Parameters

Returns Args extends [variables: Variables, opts?: RequestOpts] ? QueryObject<Variables, Result> : QueryObject<void, Result>

ProtectedrequestPermission

Parameters

Returns Promise<boolean>

ProtectedresolveURL

Parameters

Returns URL

`Protected`buildStackSpotError

`Protected`createPermissionFunctionFor

Returns (
...args: Args extends [opts?: RequestOpts]
? []
: [variables?: Partial<Args[0]>],
) => Promise<boolean>

`Protected`createRequestFunctionFor

Returns (
...args: Args extends [opts?: RequestOpts]
? [signal: AbortSignal]
: [signal: AbortSignal, variables: Args[0]],
) => Promise<Result>

`Protected`fetch

`Protected`infiniteQuery

Returns Omit<
InfiniteQueryObject<Variables, Result, Accumulator>,
"isAllowed" | "useAllowed" | "getPermissionKey",
>

`Protected`isFreemium

`Protected`mutation

Returns Omit<
MutationObject<Args extends [AbortSignal] ? void : Args[1], Result>,
keyof OperationObject<any>,
>

Returns Args extends [variables: Variables, opts?: RequestOpts]
? MutationObject<Variables, Result>
: MutationObject<void, Result>

`Protected`query

Returns Omit<
QueryObject<Args extends [AbortSignal] ? void : Args[1], Result>,
"isAllowed" | "useAllowed" | "getPermissionKey",
>

Returns Args extends [variables: Variables, opts?: RequestOpts]
? QueryObject<Variables, Result>
: QueryObject<void, Result>

`Protected`requestPermission

`Protected`resolveURL

`Protected`stream

`Static`setup