@osdk/client 0.8.0 → 0.10.0

package/build/types/generatedNoCheck/ontology/actions/actionTakesAttachment.d.ts

@@ -1,12 +1,24 @@
-export declare const actionTakesAttachment: {
-    apiName: "actionTakesAttachment";
-    parameters: {
-        attachment: {
-            multiplicity: false;
-            type: "attachment";
-            nullable: false;
-        };
+import type { ActionDefinition } from '@osdk/api';
+import type { ActionReturnTypeForOptions, ApplyActionOptions, NOOP, OsdkActionParameters } from '@osdk/client';
+export type ActionDef$actionTakesAttachment$Params = {
+    attachment: {
+        type: 'attachment';
+        multiplicity: false;
+        nullable: false;
     };
-    description: string;
-    modifiedEntities: {};
 };
+export type actionTakesAttachment$Params = NOOP<OsdkActionParameters<ActionDef$actionTakesAttachment$Params>>;
+export interface actionTakesAttachment {
+    /**
+     * An action which takes an attachmen t
+     */
+    <OP extends ApplyActionOptions>(args: actionTakesAttachment$Params, options?: OP): Promise<ActionReturnTypeForOptions<OP>>;
+}
+export interface ActionDef$actionTakesAttachment extends ActionDefinition<'actionTakesAttachment', never, actionTakesAttachment> {
+    type: 'action';
+    apiName: 'actionTakesAttachment';
+    description: 'An action which takes an attachmen t';
+    modifiedEntities: {};
+    parameters: ActionDef$actionTakesAttachment$Params;
+}
+export declare const actionTakesAttachment: ActionDef$actionTakesAttachment;

package/build/types/generatedNoCheck/ontology/actions/actionTakesObjectSet.d.ts

@@ -1,15 +1,25 @@
-export declare const actionTakesObjectSet: {
-    apiName: "actionTakesObjectSet";
-    parameters: {
-        employees: {
-            multiplicity: false;
-            type: {
-                type: "objectSet";
-                objectSet: "Employee";
-            };
-            nullable: false;
-        };
+import type { ActionDefinition, ObjectSetActionDataType } from '@osdk/api';
+import type { ActionReturnTypeForOptions, ApplyActionOptions, NOOP, OsdkActionParameters } from '@osdk/client';
+import type { EmployeeDef } from '../objects.js';
+export type ActionDef$actionTakesObjectSet$Params = {
+    employees: {
+        type: ObjectSetActionDataType<'Employee', EmployeeDef>;
+        multiplicity: false;
+        nullable: false;
     };
-    description: string;
-    modifiedEntities: {};
 };
+export type actionTakesObjectSet$Params = NOOP<OsdkActionParameters<ActionDef$actionTakesObjectSet$Params>>;
+export interface actionTakesObjectSet {
+    /**
+     * An action which takes an Object Set
+     */
+    <OP extends ApplyActionOptions>(args: actionTakesObjectSet$Params, options?: OP): Promise<ActionReturnTypeForOptions<OP>>;
+}
+export interface ActionDef$actionTakesObjectSet extends ActionDefinition<'actionTakesObjectSet', 'Employee', actionTakesObjectSet> {
+    type: 'action';
+    apiName: 'actionTakesObjectSet';
+    description: 'An action which takes an Object Set';
+    modifiedEntities: {};
+    parameters: ActionDef$actionTakesObjectSet$Params;
+}
+export declare const actionTakesObjectSet: ActionDef$actionTakesObjectSet;

package/build/types/generatedNoCheck/ontology/actions/createOffice.d.ts

@@ -1,35 +1,47 @@
-export declare const createOffice: {
-    apiName: "createOffice";
-    parameters: {
-        officeId: {
-            multiplicity: false;
-            type: "string";
-            nullable: false;
-        };
-        address: {
-            multiplicity: false;
-            type: "string";
-            nullable: true;
-            description: string;
-        };
-        capacity: {
-            multiplicity: false;
-            type: "integer";
-            nullable: true;
-            description: string;
-        };
-        officeNames: {
-            multiplicity: true;
-            type: "string";
-            nullable: true;
-            description: string;
-        };
+import type { ActionDefinition } from '@osdk/api';
+import type { ActionReturnTypeForOptions, ApplyActionOptions, NOOP, OsdkActionParameters } from '@osdk/client';
+export type ActionDef$createOffice$Params = {
+    officeId: {
+        type: 'string';
+        multiplicity: false;
+        nullable: false;
+    };
+    address: {
+        type: 'string';
+        multiplicity: false;
+        nullable: true;
+        description: "The office's physical address (not necessarily shipping address)";
     };
-    description: string;
+    capacity: {
+        type: 'integer';
+        multiplicity: false;
+        nullable: true;
+        description: 'The maximum seated-at-desk capacity of the office (maximum fire-safe capacity may be higher)';
+    };
+    officeNames: {
+        type: 'string';
+        multiplicity: true;
+        nullable: true;
+        description: 'A list of all office names';
+    };
+};
+export type createOffice$Params = NOOP<OsdkActionParameters<ActionDef$createOffice$Params>>;
+export interface createOffice {
+    /**
+     * Create an office's
+     */
+    <OP extends ApplyActionOptions>(args: createOffice$Params, options?: OP): Promise<ActionReturnTypeForOptions<OP>>;
+}
+export interface ActionDef$createOffice extends ActionDefinition<'createOffice', 'Office', createOffice> {
+    type: 'action';
+    apiName: 'createOffice';
+    description: "Create an office's";
     modifiedEntities: {
         Office: {
             created: true;
             modified: false;
         };
     };
-};
+    parameters: ActionDef$createOffice$Params;
+}
+export declare const createOffice: ActionDef$createOffice;

package/build/types/generatedNoCheck/ontology/actions/createOfficeAndEmployee.d.ts

@@ -1,37 +1,47 @@
-export declare const createOfficeAndEmployee: {
-    apiName: "createOfficeAndEmployee";
-    parameters: {
-        officeId: {
-            multiplicity: false;
-            type: "string";
-            nullable: false;
-        };
-        address: {
-            multiplicity: false;
-            type: "string";
-            nullable: true;
-            description: string;
-        };
-        capacity: {
-            multiplicity: false;
-            type: "integer";
-            nullable: true;
-            description: string;
-        };
-        officeNames: {
-            multiplicity: true;
-            type: "string";
-            nullable: true;
-            description: string;
-        };
-        employeeId: {
-            multiplicity: false;
-            type: "integer";
-            nullable: false;
-            description: string;
-        };
+import type { ActionDefinition } from '@osdk/api';
+import type { ActionReturnTypeForOptions, ApplyActionOptions, NOOP, OsdkActionParameters } from '@osdk/client';
+export type ActionDef$createOfficeAndEmployee$Params = {
+    officeId: {
+        type: 'string';
+        multiplicity: false;
+        nullable: false;
+    };
+    address: {
+        type: 'string';
+        multiplicity: false;
+        nullable: true;
+        description: "The office's physical address (not necessarily shipping address)";
     };
-    description: string;
+    capacity: {
+        type: 'integer';
+        multiplicity: false;
+        nullable: true;
+        description: 'The maximum seated-at-desk capacity of the office (maximum fire-safe capacity may be higher)';
+    };
+    officeNames: {
+        type: 'string';
+        multiplicity: true;
+        nullable: true;
+        description: 'A list of all office names';
+    };
+    employeeId: {
+        type: 'integer';
+        multiplicity: false;
+        nullable: false;
+        description: 'New employee Id';
+    };
+};
+export type createOfficeAndEmployee$Params = NOOP<OsdkActionParameters<ActionDef$createOfficeAndEmployee$Params>>;
+export interface createOfficeAndEmployee {
+    /**
+     * Create an office and employee
+     */
+    <OP extends ApplyActionOptions>(args: createOfficeAndEmployee$Params, options?: OP): Promise<ActionReturnTypeForOptions<OP>>;
+}
+export interface ActionDef$createOfficeAndEmployee extends ActionDefinition<'createOfficeAndEmployee', 'Office' | 'Employee', createOfficeAndEmployee> {
+    type: 'action';
+    apiName: 'createOfficeAndEmployee';
+    description: 'Create an office and employee';
     modifiedEntities: {
         Office: {
             created: true;
@@ -42,4 +52,6 @@ export declare const createOfficeAndEmployee: {
             modified: false;
         };
     };
-};
+    parameters: ActionDef$createOfficeAndEmployee$Params;
+}
+export declare const createOfficeAndEmployee: ActionDef$createOfficeAndEmployee;

package/build/types/generatedNoCheck/ontology/actions/index.d.ts

@@ -1,7 +1,7 @@
-export * from './actionTakesAttachment.js';
-export * from './actionTakesObjectSet.js';
-export * from './createOffice.js';
-export * from './createOfficeAndEmployee.js';
-export * from './moveOffice.js';
-export * from './promoteEmployee.js';
-export * from './promoteEmployeeObject.js';
+export { actionTakesAttachment } from './actionTakesAttachment.js';
+export { actionTakesObjectSet } from './actionTakesObjectSet.js';
+export { createOffice } from './createOffice.js';
+export { createOfficeAndEmployee } from './createOfficeAndEmployee.js';
+export { moveOffice } from './moveOffice.js';
+export { promoteEmployee } from './promoteEmployee.js';
+export { promoteEmployeeObject } from './promoteEmployeeObject.js';

package/build/types/generatedNoCheck/ontology/actions/moveOffice.d.ts

@@ -1,35 +1,47 @@
-export declare const moveOffice: {
-    apiName: "moveOffice";
-    parameters: {
-        officeId: {
-            multiplicity: false;
-            type: "string";
-            nullable: false;
-        };
-        newAddress: {
-            multiplicity: false;
-            type: "string";
-            nullable: true;
-            description: string;
-        };
-        newCapacity: {
-            multiplicity: false;
-            type: "integer";
-            nullable: true;
-            description: string;
-        };
-        officeNames: {
-            multiplicity: true;
-            type: "integer";
-            nullable: true;
-            description: string;
-        };
+import type { ActionDefinition } from '@osdk/api';
+import type { ActionReturnTypeForOptions, ApplyActionOptions, NOOP, OsdkActionParameters } from '@osdk/client';
+export type ActionDef$moveOffice$Params = {
+    officeId: {
+        type: 'string';
+        multiplicity: false;
+        nullable: false;
+    };
+    newAddress: {
+        type: 'string';
+        multiplicity: false;
+        nullable: true;
+        description: "The office's new physical address (not necessarily shipping address)";
     };
-    description: string;
+    newCapacity: {
+        type: 'integer';
+        multiplicity: false;
+        nullable: true;
+        description: 'The maximum seated-at-desk capacity of the new office (maximum fire-safe capacity may be higher)';
+    };
+    officeNames: {
+        type: 'integer';
+        multiplicity: true;
+        nullable: true;
+        description: 'A list of all office names';
+    };
+};
+export type moveOffice$Params = NOOP<OsdkActionParameters<ActionDef$moveOffice$Params>>;
+export interface moveOffice {
+    /**
+     * Update an office's physical location
+     */
+    <OP extends ApplyActionOptions>(args: moveOffice$Params, options?: OP): Promise<ActionReturnTypeForOptions<OP>>;
+}
+export interface ActionDef$moveOffice extends ActionDefinition<'moveOffice', 'Office', moveOffice> {
+    type: 'action';
+    apiName: 'moveOffice';
+    description: "Update an office's physical location";
     modifiedEntities: {
         Office: {
             created: false;
             modified: true;
         };
     };
-};
+    parameters: ActionDef$moveOffice$Params;
+}
+export declare const moveOffice: ActionDef$moveOffice;

package/build/types/generatedNoCheck/ontology/actions/promoteEmployee.d.ts

@@ -1,27 +1,39 @@
-export declare const promoteEmployee: {
-    apiName: "promoteEmployee";
-    parameters: {
-        employeeId: {
-            multiplicity: false;
-            type: "integer";
-            nullable: false;
-        };
-        newTitle: {
-            multiplicity: false;
-            type: "string";
-            nullable: false;
-        };
-        newCompensation: {
-            multiplicity: false;
-            type: "double";
-            nullable: false;
-        };
+import type { ActionDefinition } from '@osdk/api';
+import type { ActionReturnTypeForOptions, ApplyActionOptions, NOOP, OsdkActionParameters } from '@osdk/client';
+export type ActionDef$promoteEmployee$Params = {
+    employeeId: {
+        type: 'integer';
+        multiplicity: false;
+        nullable: false;
+    };
+    newTitle: {
+        type: 'string';
+        multiplicity: false;
+        nullable: false;
     };
-    description: string;
+    newCompensation: {
+        type: 'double';
+        multiplicity: false;
+        nullable: false;
+    };
+};
+export type promoteEmployee$Params = NOOP<OsdkActionParameters<ActionDef$promoteEmployee$Params>>;
+export interface promoteEmployee {
+    /**
+     * Update an employee's title and compensation
+     */
+    <OP extends ApplyActionOptions>(args: promoteEmployee$Params, options?: OP): Promise<ActionReturnTypeForOptions<OP>>;
+}
+export interface ActionDef$promoteEmployee extends ActionDefinition<'promoteEmployee', 'Employee', promoteEmployee> {
+    type: 'action';
+    apiName: 'promoteEmployee';
+    description: "Update an employee's title and compensation";
     modifiedEntities: {
         Employee: {
             created: false;
             modified: true;
         };
     };
-};
+    parameters: ActionDef$promoteEmployee$Params;
+}
+export declare const promoteEmployee: ActionDef$promoteEmployee;

package/build/types/generatedNoCheck/ontology/actions/promoteEmployeeObject.d.ts

@@ -1,30 +1,40 @@
-export declare const promoteEmployeeObject: {
-    apiName: "promoteEmployeeObject";
-    parameters: {
-        employee: {
-            multiplicity: false;
-            type: {
-                type: "object";
-                object: "Employee";
-            };
-            nullable: false;
-        };
-        newTitle: {
-            multiplicity: false;
-            type: "string";
-            nullable: false;
-        };
-        newCompensation: {
-            multiplicity: false;
-            type: "double";
-            nullable: false;
-        };
+import type { ActionDefinition, ObjectActionDataType } from '@osdk/api';
+import type { ActionReturnTypeForOptions, ApplyActionOptions, NOOP, OsdkActionParameters } from '@osdk/client';
+import type { EmployeeDef } from '../objects.js';
+export type ActionDef$promoteEmployeeObject$Params = {
+    employee: {
+        type: ObjectActionDataType<'Employee', EmployeeDef>;
+        multiplicity: false;
+        nullable: false;
+    };
+    newTitle: {
+        type: 'string';
+        multiplicity: false;
+        nullable: false;
     };
-    description: string;
+    newCompensation: {
+        type: 'double';
+        multiplicity: false;
+        nullable: false;
+    };
+};
+export type promoteEmployeeObject$Params = NOOP<OsdkActionParameters<ActionDef$promoteEmployeeObject$Params>>;
+export interface promoteEmployeeObject {
+    /**
+     * Update an employee's title and compensation
+     */
+    <OP extends ApplyActionOptions>(args: promoteEmployeeObject$Params, options?: OP): Promise<ActionReturnTypeForOptions<OP>>;
+}
+export interface ActionDef$promoteEmployeeObject extends ActionDefinition<'promoteEmployeeObject', 'Employee', promoteEmployeeObject> {
+    type: 'action';
+    apiName: 'promoteEmployeeObject';
+    description: "Update an employee's title and compensation";
     modifiedEntities: {
         Employee: {
             created: false;
             modified: true;
         };
     };
-};
+    parameters: ActionDef$promoteEmployeeObject$Params;
+}
+export declare const promoteEmployeeObject: ActionDef$promoteEmployeeObject;

package/build/types/generatedNoCheck/ontology/objects/Employee.d.ts

@@ -1,49 +1,44 @@
-export declare const Employee: {
-    apiName: "Employee";
-    description: string;
-    primaryKeyType: "integer";
+import type { ObjectTypeDefinition, ObjectTypeLinkDefinition } from '@osdk/api';
+import type { OfficeDef } from './Office.js';
+export interface EmployeeDef extends ObjectTypeDefinition<'Employee'> {
+    type: 'object';
+    apiName: 'Employee';
+    description: 'A full-time or part-time \n\n employee of our firm';
+    primaryKeyType: 'integer';
     links: {
-        peeps: {
-            multiplicity: true;
-            targetType: "Employee";
-        };
-        lead: {
-            multiplicity: false;
-            targetType: "Employee";
-        };
-        officeLink: {
-            multiplicity: false;
-            targetType: "Office";
-        };
+        peeps: ObjectTypeLinkDefinition<EmployeeDef, true>;
+        lead: ObjectTypeLinkDefinition<EmployeeDef, false>;
+        officeLink: ObjectTypeLinkDefinition<OfficeDef, false>;
     };
     properties: {
         employeeId: {
             multiplicity: false;
-            type: "integer";
+            type: 'integer';
             nullable: false;
         };
         fullName: {
             multiplicity: false;
-            type: "string";
+            type: 'string';
             nullable: true;
         };
         office: {
             multiplicity: false;
-            description: string;
-            type: "string";
+            description: 'The unique "ID" of the employee\'s \\"primary\\" assigned office.\n This is some more text.';
+            type: 'string';
             nullable: true;
         };
         startDate: {
             multiplicity: false;
-            description: string;
-            type: "datetime";
+            description: 'The date the employee was hired (most recently, if they were re-hired)';
+            type: 'datetime';
             nullable: true;
         };
         employeeStatus: {
             multiplicity: false;
-            description: string;
-            type: "stringTimeseries";
+            description: 'TimeSeries of the status of the employee';
+            type: 'stringTimeseries';
             nullable: true;
         };
     };
-};
+}
+export declare const Employee: EmployeeDef;

package/build/types/generatedNoCheck/ontology/objects/ObjectWithTimestampPrimaryKey.d.ts

@@ -1,18 +1,21 @@
-export declare const ObjectWithTimestampPrimaryKey: {
-    apiName: "ObjectWithTimestampPrimaryKey";
-    description: string;
-    primaryKeyType: "timestamp";
+import type { ObjectTypeDefinition } from '@osdk/api';
+export interface ObjectWithTimestampPrimaryKeyDef extends ObjectTypeDefinition<'ObjectWithTimestampPrimaryKey'> {
+    type: 'object';
+    apiName: 'ObjectWithTimestampPrimaryKey';
+    description: 'Object Type With Timestamp Primary Key';
+    primaryKeyType: 'timestamp';
     links: {};
     properties: {
         timestamp: {
             multiplicity: false;
-            type: "timestamp";
+            type: 'timestamp';
             nullable: false;
         };
         value: {
             multiplicity: false;
-            type: "string";
+            type: 'string';
             nullable: true;
         };
     };
-};
+}
+export declare const ObjectWithTimestampPrimaryKey: ObjectWithTimestampPrimaryKeyDef;

package/build/types/generatedNoCheck/ontology/objects/Office.d.ts

@@ -1,35 +1,36 @@
-export declare const Office: {
-    apiName: "Office";
-    description: string;
-    primaryKeyType: "string";
+import type { ObjectTypeDefinition, ObjectTypeLinkDefinition } from '@osdk/api';
+import type { EmployeeDef } from './Employee.js';
+export interface OfficeDef extends ObjectTypeDefinition<'Office'> {
+    type: 'object';
+    apiName: 'Office';
+    description: 'A office in our Company';
+    primaryKeyType: 'string';
     links: {
-        occupants: {
-            multiplicity: true;
-            targetType: "Employee";
-        };
+        occupants: ObjectTypeLinkDefinition<EmployeeDef, true>;
     };
     properties: {
         officeId: {
             multiplicity: false;
-            type: "string";
+            type: 'string';
             nullable: false;
         };
         entrance: {
             multiplicity: false;
-            type: "geopoint";
+            type: 'geopoint';
             nullable: true;
         };
         occupiedArea: {
             multiplicity: false;
-            description: string;
-            type: "geoshape";
+            description: 'The occupied area of the Office';
+            type: 'geoshape';
             nullable: true;
         };
         name: {
             multiplicity: false;
-            description: string;
-            type: "string";
+            description: 'The Name of the Office';
+            type: 'string';
             nullable: true;
         };
     };
-};
+}
+export declare const Office: OfficeDef;

package/build/types/generatedNoCheck/ontology/objects/equipment.d.ts

@@ -1,18 +1,21 @@
-export declare const equipment: {
-    apiName: "equipment";
-    primaryKeyType: "string";
+import type { ObjectTypeDefinition } from '@osdk/api';
+export interface equipmentDef extends ObjectTypeDefinition<'equipment'> {
+    type: 'object';
+    apiName: 'equipment';
+    primaryKeyType: 'string';
     links: {};
     properties: {
         equipmentId: {
             multiplicity: false;
-            description: string;
-            type: "string";
+            description: 'The id of an equipment';
+            type: 'string';
             nullable: false;
         };
         type: {
             multiplicity: false;
-            type: "string";
+            type: 'string';
             nullable: true;
         };
     };
-};
+}
+export declare const equipment: equipmentDef;