Cloudflare.AISearchToken (Cloudflare v0.5.0)

Copy Markdown View Source

AI Search Tokens

Create new tokens.

POST /accounts/{account_id}/ai-search/tokens

Responses

201 Returns the created Object

Data is at body["result"]

{
  "cf_api_id": "*string*",
  "created_at": "*string*",
  "created_by": "*string*",
  "enabled": "*boolean*",
  "id": "*string*",
  "legacy": "*boolean*",
  "modified_at": "*string*",
  "modified_by": "*string*",
  "name": "*string*"
}
400 Input Validation Error
{
  "errors": [
    {
      "code": "*number*",
      "message": "*string*",
      "path": [
        "*string*"
      ]
    }
  ],
  "success": "*boolean*"
}

List tokens.

GET /accounts/{account_id}/ai-search/tokens

Responses

200 List objects

Data is at body["result"]

[
  {
    "cf_api_id": "*string*",
    "created_at": "*string*",
    "created_by": "*string*",
    "enabled": "*boolean*",
    "id": "*string*",
    "legacy": "*boolean*",
    "modified_at": "*string*",
    "modified_by": "*string*",
    "name": "*string*"
  }
]
400 Bad Request.
{
  "errors": [
    {
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Update tokens.

PUT /accounts/{account_id}/ai-search/tokens/{id}

Responses

200 Returns the updated Object

Data is at body["result"]

{
  "cf_api_id": "*string*",
  "created_at": "*string*",
  "created_by": "*string*",
  "enabled": "*boolean*",
  "id": "*string*",
  "legacy": "*boolean*",
  "modified_at": "*string*",
  "modified_by": "*string*",
  "name": "*string*"
}
400 Input Validation Error
{
  "errors": [
    {
      "code": "*number*",
      "message": "*string*",
      "path": [
        "*string*"
      ]
    }
  ],
  "success": "*boolean*"
}
404 Not Found
{
  "errors": [
    {
      "code": "*number*",
      "message": "*string*"
    }
  ],
  "success": "*boolean*"
}

Read tokens.

GET /accounts/{account_id}/ai-search/tokens/{id}

Responses

200 Returns a single object if found

Data is at body["result"]

{
  "cf_api_id": "*string*",
  "created_at": "*string*",
  "created_by": "*string*",
  "enabled": "*boolean*",
  "id": "*string*",
  "legacy": "*boolean*",
  "modified_at": "*string*",
  "modified_by": "*string*",
  "name": "*string*"
}
404 Not Found
{
  "errors": [
    {
      "code": "*number*",
      "message": "*string*"
    }
  ],
  "success": "*boolean*"
}

Delete tokens.

DELETE /accounts/{account_id}/ai-search/tokens/{id}

Responses

200 Returns the Object if it was successfully deleted

Data is at body["result"]

{
  "cf_api_id": "*string*",
  "created_at": "*string*",
  "created_by": "*string*",
  "enabled": "*boolean*",
  "id": "*string*",
  "legacy": "*boolean*",
  "modified_at": "*string*",
  "modified_by": "*string*",
  "name": "*string*"
}
404 Not Found
{
  "errors": [
    {
      "code": "*number*",
      "message": "*string*"
    }
  ],
  "success": "*boolean*"
}

Summary

Functions

client(opts \\ [])
create(body, opts \\ [])
create!(body, opts \\ [])
delete(id, opts \\ [])
delete!(id, opts \\ [])
index(opts \\ [])
index!(opts \\ [])
path_for(id, opts \\ [])
show(id, opts \\ [])
show!(id, opts \\ [])
update(id, body, opts \\ [])
update!(id, body, opts \\ [])

Functions

client(opts \\ [])

@spec client(Restlax.Resource.action_options()) :: module()

create(body, opts \\ [])

@spec create(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  {:ok, map()} | {:error, term()}

create!(body, opts \\ [])

@spec create!(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  map() | no_return()

delete(id, opts \\ [])

@spec delete(id :: term(), opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

delete!(id, opts \\ [])

@spec delete!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  map() | no_return()

index(opts \\ [])

@spec index(opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

index!(opts \\ [])

@spec index!(opts :: Restlax.Resource.action_options()) :: map() | no_return()

path_for(id, opts \\ [])

@spec path_for(term(), [{:action, String.t()}]) :: String.t()

show(id, opts \\ [])

@spec show(id :: term(), opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

show!(id, opts \\ [])

@spec show!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  map() | no_return()

update(id, body, opts \\ [])

@spec update(
  id :: term(),
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) :: {:ok, map()} | {:error, term()}

update!(id, body, opts \\ [])

@spec update!(
  id :: term(),
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) :: map() | no_return()