@ofocus/sdk 0.1.0

package/docs/sdk.querytasks.md

@@ -0,0 +1,54 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [queryTasks](./sdk.querytasks.md)
+
+## queryTasks() function
+
+Query tasks from OmniFocus with optional filters.
+
+**Signature:**
+
+```typescript
+export declare function queryTasks(options?: TaskQueryOptions): Promise<CliOutput<OFTask[]>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[TaskQueryOptions](./sdk.taskqueryoptions.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[CliOutput](./sdk.clioutput.md)<!-- -->&lt;[OFTask](./sdk.oftask.md)<!-- -->\[\]&gt;&gt;
+

package/docs/sdk.runapplescript.md

@@ -0,0 +1,52 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [runAppleScript](./sdk.runapplescript.md)
+
+## runAppleScript() function
+
+Execute an AppleScript and return the result. The script should return a value that can be parsed as JSON for structured data.
+
+**Signature:**
+
+```typescript
+export declare function runAppleScript<T>(script: string): Promise<AppleScriptResult<T>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+script
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[AppleScriptResult](./sdk.applescriptresult.md)<!-- -->&lt;T&gt;&gt;
+

package/docs/sdk.runapplescriptfile.md

@@ -0,0 +1,68 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [runAppleScriptFile](./sdk.runapplescriptfile.md)
+
+## runAppleScriptFile() function
+
+Execute an AppleScript file.
+
+**Signature:**
+
+```typescript
+export declare function runAppleScriptFile<T>(filePath: string, args?: string[]): Promise<AppleScriptResult<T>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+filePath
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+args
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[AppleScriptResult](./sdk.applescriptresult.md)<!-- -->&lt;T&gt;&gt;
+

package/docs/sdk.success.md

@@ -0,0 +1,52 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [success](./sdk.success.md)
+
+## success() function
+
+Create a successful CLI output.
+
+**Signature:**
+
+```typescript
+export declare function success<T>(data: T): CliOutput<T>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+data
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[CliOutput](./sdk.clioutput.md)<!-- -->&lt;T&gt;
+

package/docs/sdk.tagqueryoptions.md

@@ -0,0 +1,58 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [TagQueryOptions](./sdk.tagqueryoptions.md)
+
+## TagQueryOptions interface
+
+Options for querying tags.
+
+**Signature:**
+
+```typescript
+export interface TagQueryOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[parent?](./sdk.tagqueryoptions.parent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

package/docs/sdk.tagqueryoptions.parent.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [TagQueryOptions](./sdk.tagqueryoptions.md) &gt; [parent](./sdk.tagqueryoptions.parent.md)
+
+## TagQueryOptions.parent property
+
+**Signature:**
+
+```typescript
+parent?: string | undefined;
+```

package/docs/sdk.taskqueryoptions.available.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [TaskQueryOptions](./sdk.taskqueryoptions.md) &gt; [available](./sdk.taskqueryoptions.available.md)
+
+## TaskQueryOptions.available property
+
+**Signature:**
+
+```typescript
+available?: boolean | undefined;
+```

package/docs/sdk.taskqueryoptions.completed.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [TaskQueryOptions](./sdk.taskqueryoptions.md) &gt; [completed](./sdk.taskqueryoptions.completed.md)
+
+## TaskQueryOptions.completed property
+
+**Signature:**
+
+```typescript
+completed?: boolean | undefined;
+```

package/docs/sdk.taskqueryoptions.dueafter.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [TaskQueryOptions](./sdk.taskqueryoptions.md) &gt; [dueAfter](./sdk.taskqueryoptions.dueafter.md)
+
+## TaskQueryOptions.dueAfter property
+
+**Signature:**
+
+```typescript
+dueAfter?: string | undefined;
+```

package/docs/sdk.taskqueryoptions.duebefore.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [TaskQueryOptions](./sdk.taskqueryoptions.md) &gt; [dueBefore](./sdk.taskqueryoptions.duebefore.md)
+
+## TaskQueryOptions.dueBefore property
+
+**Signature:**
+
+```typescript
+dueBefore?: string | undefined;
+```

package/docs/sdk.taskqueryoptions.flagged.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [TaskQueryOptions](./sdk.taskqueryoptions.md) &gt; [flagged](./sdk.taskqueryoptions.flagged.md)
+
+## TaskQueryOptions.flagged property
+
+**Signature:**
+
+```typescript
+flagged?: boolean | undefined;
+```

package/docs/sdk.taskqueryoptions.md

@@ -0,0 +1,172 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [TaskQueryOptions](./sdk.taskqueryoptions.md)
+
+## TaskQueryOptions interface
+
+Options for querying tasks.
+
+**Signature:**
+
+```typescript
+export interface TaskQueryOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[available?](./sdk.taskqueryoptions.available.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[completed?](./sdk.taskqueryoptions.completed.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[dueAfter?](./sdk.taskqueryoptions.dueafter.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[dueBefore?](./sdk.taskqueryoptions.duebefore.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[flagged?](./sdk.taskqueryoptions.flagged.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[project?](./sdk.taskqueryoptions.project.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[tag?](./sdk.taskqueryoptions.tag.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

package/docs/sdk.taskqueryoptions.project.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [TaskQueryOptions](./sdk.taskqueryoptions.md) &gt; [project](./sdk.taskqueryoptions.project.md)
+
+## TaskQueryOptions.project property
+
+**Signature:**
+
+```typescript
+project?: string | undefined;
+```

package/docs/sdk.taskqueryoptions.tag.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [TaskQueryOptions](./sdk.taskqueryoptions.md) &gt; [tag](./sdk.taskqueryoptions.tag.md)
+
+## TaskQueryOptions.tag property
+
+**Signature:**
+
+```typescript
+tag?: string | undefined;
+```

package/docs/sdk.taskupdateoptions.defer.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [TaskUpdateOptions](./sdk.taskupdateoptions.md) &gt; [defer](./sdk.taskupdateoptions.defer.md)
+
+## TaskUpdateOptions.defer property
+
+**Signature:**
+
+```typescript
+defer?: string | undefined;
+```

package/docs/sdk.taskupdateoptions.due.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [TaskUpdateOptions](./sdk.taskupdateoptions.md) &gt; [due](./sdk.taskupdateoptions.due.md)
+
+## TaskUpdateOptions.due property
+
+**Signature:**
+
+```typescript
+due?: string | undefined;
+```

package/docs/sdk.taskupdateoptions.flag.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [TaskUpdateOptions](./sdk.taskupdateoptions.md) &gt; [flag](./sdk.taskupdateoptions.flag.md)
+
+## TaskUpdateOptions.flag property
+
+**Signature:**
+
+```typescript
+flag?: boolean | undefined;
+```