# Schedules

## List schedules

`client.v1.schedules.list(ScheduleListParamsquery?, RequestOptionsoptions?): void`

**get** `/api/v1/schedules`

List schedules

### Parameters

- `query: ScheduleListParams`

  - `cursor?: string`

    Opaque cursor from the previous response `nextCursor`.

  - `includeDeleted?: boolean`

  - `limit?: number`

  - `spaceId?: string`

    Optional space id; when omitted, the user’s default space is used.

### Example

```typescript
import Fluidwave from 'fluidwave';

const client = new Fluidwave();

await client.v1.schedules.list();
```

## Create schedule

`client.v1.schedules.create(ScheduleCreateParamsparams?, RequestOptionsoptions?): void`

**post** `/api/v1/schedules`

Increments the Replicache space version via repVersionIncrement after writing.

### Parameters

- `params: ScheduleCreateParams`

  - `spaceId?: string`

    Optional space id; when omitted, the user’s default space is used.

### Example

```typescript
import Fluidwave from 'fluidwave';

const client = new Fluidwave();

await client.v1.schedules.create();
```

## Get schedule

`client.v1.schedules.retrieve(stringscheduleID, ScheduleRetrieveParamsquery?, RequestOptionsoptions?): void`

**get** `/api/v1/schedules/{scheduleId}`

Get schedule

### Parameters

- `scheduleID: string`

- `query: ScheduleRetrieveParams`

  - `spaceId?: string`

    Optional space id; when omitted, the user’s default space is used.

### Example

```typescript
import Fluidwave from 'fluidwave';

const client = new Fluidwave();

await client.v1.schedules.retrieve('scheduleId');
```

## Update schedule

`client.v1.schedules.update(stringscheduleID, ScheduleUpdateParamsparams?, RequestOptionsoptions?): void`

**patch** `/api/v1/schedules/{scheduleId}`

Increments the Replicache space version via repVersionIncrement after writing.

### Parameters

- `scheduleID: string`

- `params: ScheduleUpdateParams`

  - `spaceId?: string`

    Optional space id; when omitted, the user’s default space is used.

### Example

```typescript
import Fluidwave from 'fluidwave';

const client = new Fluidwave();

await client.v1.schedules.update('scheduleId');
```

## Delete schedule (soft)

`client.v1.schedules.delete(stringscheduleID, ScheduleDeleteParamsparams?, RequestOptionsoptions?): void`

**delete** `/api/v1/schedules/{scheduleId}`

Increments the Replicache space version via repVersionIncrement after writing.

### Parameters

- `scheduleID: string`

- `params: ScheduleDeleteParams`

  - `spaceId?: string`

    Optional space id; when omitted, the user’s default space is used.

### Example

```typescript
import Fluidwave from 'fluidwave';

const client = new Fluidwave();

await client.v1.schedules.delete('scheduleId');
```