mirror of
https://github.com/LukeHagar/log10ts.git
synced 2025-12-06 04:20:12 +00:00
53 lines
4.2 KiB
Markdown
53 lines
4.2 KiB
Markdown
# Sessions
|
|
(*sessions*)
|
|
|
|
## Overview
|
|
|
|
Sessions
|
|
|
|
### Available Operations
|
|
|
|
* [create](#create) - Create a session
|
|
|
|
## create
|
|
|
|
Create a session
|
|
|
|
### Example Usage
|
|
|
|
```typescript
|
|
import { Log10 } from "log10ts";
|
|
|
|
const log10 = new Log10({
|
|
log10Token: "<YOUR_API_KEY_HERE>",
|
|
xLog10Organization: "<value>",
|
|
});
|
|
|
|
async function run() {
|
|
const result = await log10.sessions.create("<value>");
|
|
|
|
// Handle the result
|
|
console.log(result)
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `xLog10Organization` | *string* | :heavy_minus_sign: | N/A |
|
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
|
|
|
|
### Response
|
|
|
|
**Promise\<[operations.CreateSessionResponse](../../models/operations/createsessionresponse.md)\>**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| --------------- | --------------- | --------------- |
|
|
| errors.SDKError | 4xx-5xx | */* |
|