@ingeno/pipedream-services 1.0.78 → 1.0.83

package/dist/lattice/generated/services/DefaultService.d.ts

@@ -0,0 +1,828 @@
+import type { Competency } from '../models/Competency.js';
+import type { CustomAttribute } from '../models/CustomAttribute.js';
+import type { CustomAttributeValue } from '../models/CustomAttributeValue.js';
+import type { Department } from '../models/Department.js';
+import type { Feedback } from '../models/Feedback.js';
+import type { Goal } from '../models/Goal.js';
+import type { GoalStateEnum } from '../models/GoalStateEnum.js';
+import type { OrderDirection } from '../models/OrderDirection.js';
+import type { Question } from '../models/Question.js';
+import type { QuestionRevision } from '../models/QuestionRevision.js';
+import type { Review } from '../models/Review.js';
+import type { ReviewCycle } from '../models/ReviewCycle.js';
+import type { Reviewee } from '../models/Reviewee.js';
+import type { Tag } from '../models/Tag.js';
+import type { Update } from '../models/Update.js';
+import type { User } from '../models/User.js';
+import type { UserCustomAttribute } from '../models/UserCustomAttribute.js';
+import type { UserStatusEnumWithNullStringValue } from '../models/UserStatusEnumWithNullStringValue.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest.js';
+export declare class DefaultService {
+    readonly httpRequest: BaseHttpRequest;
+    constructor(httpRequest: BaseHttpRequest);
+    /**
+     * Returns a competency with the given id. If cannot find competency, returns a 404
+     * @param id
+     * @returns Competency The resolved response
+     * @throws ApiError
+     */
+    apiCompetency(id: string): CancelablePromise<Competency>;
+    /**
+     * Returns the custom attribute with the given id. If cannot find the custom attribute, returns a 404
+     * @param id
+     * @returns CustomAttribute The resolved response
+     * @throws ApiError
+     */
+    apiCustomAttribute(id: string): CancelablePromise<CustomAttribute>;
+    /**
+     * Returns the custom attribute value with the given id. If cannot find the custom attribute, returns a 404
+     * @param id
+     * @returns CustomAttributeValue The resolved response
+     * @throws ApiError
+     */
+    apiCustomAttributeValue(id: string): CancelablePromise<CustomAttributeValue>;
+    /**
+     * Retuns a department with a given id. If cannot find department, returns a 404
+     * @param id
+     * @returns Department The resolved response
+     * @throws ApiError
+     */
+    apiDepartment(id: string): CancelablePromise<Department>;
+    /**
+     * Returns a paginated list of all departments in Lattice
+     * @param limit
+     * @param startingAfter
+     * @returns any The resolved response
+     * @throws ApiError
+     */
+    apiDepartments(limit?: number, startingAfter?: string): CancelablePromise<{
+        object: 'list';
+        /**
+         * Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
+         */
+        hasMore: boolean;
+        /**
+         * The cursor to use to get the next set of items in the list
+         */
+        endingCursor?: string;
+        data: Array<Department>;
+    }>;
+    /**
+     * Returns a feedback with the given id. If cannot find feedback, returns a 404
+     * @param id
+     * @returns Feedback The resolved response
+     * @throws ApiError
+     */
+    apiFeedback(id: string): CancelablePromise<Feedback>;
+    /**
+     * Returns a paginated list of all continuous feedback in Lattice. Newest feedback will be returned first
+     * @param limit
+     * @param startingAfter
+     * @param onlyPublic
+     * @returns any The resolved response
+     * @throws ApiError
+     */
+    apiFeedbacks(limit?: number, startingAfter?: string, onlyPublic?: boolean): CancelablePromise<{
+        object: 'list';
+        /**
+         * Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
+         */
+        hasMore: boolean;
+        /**
+         * The cursor to use to get the next set of items in the list
+         */
+        endingCursor?: string;
+        data: Array<Feedback>;
+    }>;
+    /**
+     * Returns a goal with the given id. If cannot find goal, returns a 404
+     * @param id
+     * @returns Goal The resolved response
+     * @throws ApiError
+     */
+    apiGoal(id: string): CancelablePromise<Goal>;
+    /**
+     * Returns a paginated list of goals in Lattice
+     * @param limit
+     * @param startingAfter
+     * @param state
+     * @returns any The resolved response
+     * @throws ApiError
+     */
+    apiGoals(limit?: number, startingAfter?: string, state?: GoalStateEnum): CancelablePromise<{
+        object: 'list';
+        /**
+         * Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
+         */
+        hasMore: boolean;
+        /**
+         * The cursor to use to get the next set of items in the list
+         */
+        endingCursor?: string;
+        data: Array<Goal>;
+    }>;
+    /**
+     * Creates a new goal with the provided information
+     * @param requestBody
+     * @returns any Goal created successfully
+     * @throws ApiError
+     */
+    apiCreateGoal(requestBody: {
+        /**
+         * The name of the goal
+         */
+        name: string;
+        /**
+         * Detailed description of the goal
+         */
+        description?: string;
+        /**
+         * Start date for the goal
+         */
+        startDate: string;
+        /**
+         * Due date for the goal
+         */
+        dueDate: string;
+        /**
+         * Priority level (1-10)
+         */
+        priority?: number;
+        /**
+         * Whether the goal is private
+         */
+        private?: boolean;
+        /**
+         * User owner(s) of the goal. One minimum is required.
+         */
+        ownerIds: Array<string>;
+        /**
+         * OKR type, objective or key result
+         */
+        okrType?: 'objective' | 'key_result';
+        /**
+         * The progress amount type for okrType = key results.
+         */
+        amountType?: 'percent' | 'dollar' | 'digit' | 'binary' | null;
+        /**
+         * Starting amount for key results. Required when goal type is key result and amountType is not binary
+         */
+        startingAmount?: number | null;
+        /**
+         * Target amount for key results. Required when goal type is key result and amountType is not binary
+         */
+        goalAmount?: number | null;
+        /**
+         * Whether this is a company goal
+         */
+        companyGoal?: boolean;
+        /**
+         * Department entity ID
+         */
+        departmentId?: string | null;
+        /**
+         * Array of department entity IDs that can view this goal
+         */
+        departmentsVisibleToIds?: Array<string>;
+        /**
+         * Goal cycle entity ID
+         */
+        goalCycleId?: string | null;
+        /**
+         * Array of tag names (max 5 tags)
+         */
+        tagNames?: Array<string>;
+        /**
+         * Whether to save as draft
+         */
+        isDraft?: boolean;
+        /**
+         * Parent goal entity ID
+         */
+        parentId?: string | null;
+    }): CancelablePromise<{
+        data?: {
+            /**
+             * Unique identifier for the goal
+             */
+            entityId?: string;
+            /**
+             * The name of the goal
+             */
+            name?: string;
+            /**
+             * Detailed description of the goal
+             */
+            description?: string;
+            /**
+             * Start date for the goal
+             */
+            startDate?: string;
+            /**
+             * Due date for the goal
+             */
+            dueDate?: string;
+            /**
+             * Priority level (1-10)
+             */
+            priority?: number;
+            /**
+             * Whether the goal is private
+             */
+            private?: boolean;
+            /**
+             * User owner(s) of the goal. One minimum is required.
+             */
+            ownerIds?: Array<string>;
+            /**
+             * OKR type, objective or key result
+             */
+            okrType?: 'objective' | 'key_result';
+            /**
+             * The progress amount type for okrType = key results.
+             */
+            amountType?: 'percent' | 'dollar' | 'digit' | 'binary' | null;
+            /**
+             * Starting amount for key results. Required when goal type is key result and amountType is not binary
+             */
+            startingAmount?: number | null;
+            /**
+             * Target amount for key results. Required when goal type is key result and amountType is not binary
+             */
+            goalAmount?: number | null;
+            /**
+             * Whether this is a company goal
+             */
+            companyGoal?: boolean;
+            /**
+             * Department entity ID
+             */
+            departmentId?: string | null;
+            /**
+             * Goal cycle entity ID
+             */
+            goalCycleId?: string | null;
+            /**
+             * Whether the goal is a draft
+             */
+            isDraft?: boolean;
+            /**
+             * Parent goal entity ID
+             */
+            parentId?: string | null;
+            /**
+             * Array of tags
+             */
+            tags?: Array<{
+                /**
+                 * Tag ID
+                 */
+                id?: number;
+                /**
+                 * Tag name
+                 */
+                name?: string;
+            }>;
+        };
+    }>;
+    /**
+     * Updates an existing goal with the provided information
+     * @param id Unique identifier of the goal to update
+     * @param requestBody
+     * @returns any Goal updated successfully
+     * @throws ApiError
+     */
+    apiUpdateGoal(id: string, requestBody: {
+        /**
+         * The name of the goal
+         */
+        name: string;
+        /**
+         * Detailed description of the goal
+         */
+        description: string;
+        /**
+         * Start date for the goal
+         */
+        startDate: string;
+        /**
+         * Due date for the goal
+         */
+        dueDate: string;
+        /**
+         * Priority level (1-10)
+         */
+        priority: number;
+        /**
+         * Whether the goal is private
+         */
+        private: boolean;
+        /**
+         * User owner(s) of the goal. One minimum is required.
+         */
+        ownerIds: Array<string>;
+        /**
+         * OKR type, objective or key result
+         */
+        okrType: 'objective' | 'key_result';
+        /**
+         * The progress amount type for okrType = key results.
+         */
+        amountType: 'percent' | 'dollar' | 'digit' | 'binary' | null;
+        /**
+         * Starting amount for key results. Required when goal type is key result and amountType is not binary
+         */
+        startingAmount: number | null;
+        /**
+         * Target amount for key results. Required when goal type is key result and amountType is not binary
+         */
+        goalAmount: number | null;
+        /**
+         * Whether this is a company goal
+         */
+        companyGoal: boolean;
+        /**
+         * Department entity ID
+         */
+        departmentId: string | null;
+        /**
+         * Array of department entity IDs that can view this goal
+         */
+        departmentsVisibleToIds: Array<string>;
+        /**
+         * Goal cycle entity ID
+         */
+        goalCycleId: string | null;
+        /**
+         * Array of tag names (max 5 tags)
+         */
+        tagNames: Array<string>;
+        /**
+         * Whether to save as draft
+         */
+        isDraft: boolean;
+        /**
+         * Parent goal entity ID
+         */
+        parentId: string | null;
+    }): CancelablePromise<{
+        data?: {
+            /**
+             * Unique identifier for the goal
+             */
+            entityId?: string;
+            /**
+             * The name of the goal
+             */
+            name?: string;
+            /**
+             * Detailed description of the goal
+             */
+            description?: string;
+            /**
+             * Start date for the goal
+             */
+            startDate?: string;
+            /**
+             * Due date for the goal
+             */
+            dueDate?: string;
+            /**
+             * Priority level (1-10)
+             */
+            priority?: number;
+            /**
+             * Whether the goal is private
+             */
+            private?: boolean;
+            /**
+             * User owner(s) of the goal. One minimum is required.
+             */
+            ownerIds?: Array<string>;
+            /**
+             * OKR type, objective or key result
+             */
+            okrType?: 'objective' | 'key_result';
+            /**
+             * The progress amount type for okrType = key results.
+             */
+            amountType?: 'percent' | 'dollar' | 'digit' | 'binary' | null;
+            /**
+             * Starting amount for key results. Required when goal type is key result and amountType is not binary
+             */
+            startingAmount?: number | null;
+            /**
+             * Target amount for key results. Required when goal type is key result and amountType is not binary
+             */
+            goalAmount?: number | null;
+            /**
+             * Whether this is a company goal
+             */
+            companyGoal?: boolean;
+            /**
+             * Department entity ID
+             */
+            departmentId?: string | null;
+            /**
+             * Goal cycle entity ID
+             */
+            goalCycleId?: string | null;
+            /**
+             * Whether the goal is a draft
+             */
+            isDraft?: boolean;
+            /**
+             * Parent goal entity ID
+             */
+            parentId?: string | null;
+            /**
+             * Array of tags
+             */
+            tags?: Array<{
+                /**
+                 * Tag ID
+                 */
+                id?: number;
+                /**
+                 * Tag name
+                 */
+                name?: string;
+            }>;
+            /**
+             * Array of child goals
+             */
+            childGoals?: Array<{
+                /**
+                 * Child goal entity ID
+                 */
+                entityId?: string;
+                /**
+                 * Child goal name
+                 */
+                name?: string;
+            }>;
+            /**
+             * Array of newly added tags
+             */
+            addedTags?: Array<{
+                /**
+                 * Tag ID
+                 */
+                id?: number;
+                /**
+                 * Tag name
+                 */
+                name?: string;
+            }>;
+            /**
+             * Array of removed tags
+             */
+            removedTags?: Array<{
+                /**
+                 * Tag ID
+                 */
+                id?: number;
+                /**
+                 * Tag name
+                 */
+                name?: string;
+            }>;
+        };
+    }>;
+    /**
+     * Creates a progress update for an existing goal
+     * @param id Unique identifier of the goal to update
+     * @param requestBody
+     * @returns any Goal update created successfully
+     * @throws ApiError
+     */
+    apiCreateGoalUpdate(id: string, requestBody: {
+        /**
+         * Comment about the goal progress
+         */
+        comment: string;
+        /**
+         * Status of the goal
+         */
+        status: 'green' | 'amber' | 'red';
+        /**
+         * Numeric increment for the goal
+         */
+        increment?: number;
+        /**
+         * Whether the goal is complete
+         */
+        complete?: boolean;
+        /**
+         * Whether the goal is incomplete
+         */
+        incomplete?: boolean;
+    }): CancelablePromise<{
+        data?: {
+            /**
+             * Unique identifier for the goal update
+             */
+            entityId?: string;
+            /**
+             * ID of the goal
+             */
+            goalId?: number;
+            /**
+             * ID of the goal update
+             */
+            id?: number;
+            /**
+             * Comment about the goal progress
+             */
+            comment?: string;
+            /**
+             * Status of the goal
+             */
+            status?: 'green' | 'amber' | 'red';
+            /**
+             * Increment value from the goal update (can be string, number, null, or undefined)
+             */
+            increment?: (string | number) | null;
+        };
+    }>;
+    /**
+     * Returns the current user the API token is associated with
+     * @returns User The resolved response
+     * @throws ApiError
+     */
+    apiMe(): CancelablePromise<User>;
+    /**
+     * Returns a review question with the given id. If cannot find review question, returns a 404
+     * @param id
+     * @returns Question The resolved response
+     * @throws ApiError
+     */
+    apiQuestion(id: string): CancelablePromise<Question>;
+    /**
+     * Returns a question revision with the given id. If cannot find question revision, returns a 404
+     * @param id
+     * @returns QuestionRevision The resolved response
+     * @throws ApiError
+     */
+    apiQuestionRevision(id: string): CancelablePromise<QuestionRevision>;
+    /**
+     * Returns a review cycle with the given id. If cannot find review cycle, returns a 404
+     * @param id
+     * @returns ReviewCycle The resolved response
+     * @throws ApiError
+     */
+    apiReviewCycle(id: string): CancelablePromise<ReviewCycle>;
+    /**
+     * Returns a paginated list of all reviewees in a review cycle
+     * @param id
+     * @param limit
+     * @param startingAfter
+     * @returns any The resolved response
+     * @throws ApiError
+     */
+    apiReviewCycleReviewees(id: string, limit?: number, startingAfter?: string): CancelablePromise<{
+        object: 'list';
+        /**
+         * Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
+         */
+        hasMore: boolean;
+        /**
+         * The cursor to use to get the next set of items in the list
+         */
+        endingCursor?: string;
+        data: Array<Reviewee>;
+    }>;
+    /**
+     * Returns a paginated list of all of the reviews for a review cycle
+     * @param id
+     * @param limit
+     * @param startingAfter
+     * @param orderDirection
+     * @param offset
+     * @returns any The resolved response
+     * @throws ApiError
+     */
+    apiReviewCycleReviews(id: string, limit?: number, startingAfter?: string, orderDirection?: OrderDirection, offset?: number): CancelablePromise<{
+        object: 'list';
+        /**
+         * Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
+         */
+        hasMore: boolean;
+        /**
+         * The cursor to use to get the next set of items in the list
+         */
+        endingCursor?: string;
+        data: Array<Review>;
+    }>;
+    /**
+     * Returns a paginated list of all review cycles in Lattice
+     * @param limit
+     * @param startingAfter
+     * @returns any The resolved response
+     * @throws ApiError
+     */
+    apiReviewCycles(limit?: number, startingAfter?: string): CancelablePromise<{
+        object: 'list';
+        /**
+         * Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
+         */
+        hasMore: boolean;
+        /**
+         * The cursor to use to get the next set of items in the list
+         */
+        endingCursor?: string;
+        data: Array<ReviewCycle>;
+    }>;
+    /**
+     * Returns a reviewee with the given id. If cannot find reviewee, returns a 404
+     * @param id
+     * @returns Reviewee The resolved response
+     * @throws ApiError
+     */
+    apiReviewee(id: string): CancelablePromise<Reviewee>;
+    /**
+     * Returns a paginated list of all of the reviews for a reviewee
+     * @param id
+     * @param limit
+     * @param startingAfter
+     * @returns any The resolved response
+     * @throws ApiError
+     */
+    apiRevieweeReviews(id: string, limit?: number, startingAfter?: string): CancelablePromise<{
+        object: 'list';
+        /**
+         * Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
+         */
+        hasMore: boolean;
+        /**
+         * The cursor to use to get the next set of items in the list
+         */
+        endingCursor?: string;
+        data: Array<Review>;
+    }>;
+    /**
+     * Retuns a tag with a given id. If cannot find tag, returns a 404
+     * @param id
+     * @returns Tag The resolved response
+     * @throws ApiError
+     */
+    apiTag(id: string): CancelablePromise<Tag>;
+    /**
+     * Returns a paginated list of all tags in Lattice
+     * @param limit
+     * @param startingAfter
+     * @returns any The resolved response
+     * @throws ApiError
+     */
+    apiTags(limit?: number, startingAfter?: string): CancelablePromise<{
+        object: 'list';
+        /**
+         * Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
+         */
+        hasMore: boolean;
+        /**
+         * The cursor to use to get the next set of items in the list
+         */
+        endingCursor?: string;
+        data: Array<Tag>;
+    }>;
+    /**
+     * Retuns a task with a given id. If cannot find task, returns a 404
+     * @param id
+     * @returns any The resolved response
+     * @throws ApiError
+     */
+    apiTask(id: string): CancelablePromise<Record<string, any>>;
+    /**
+     * Returns an Update with the given id. If cannot find update, returns a 404
+     * @param id
+     * @returns Update The resolved response
+     * @throws ApiError
+     */
+    apiUpdate(id: string): CancelablePromise<Update>;
+    /**
+     * Returns a paginated list of all Updates in Lattice
+     * @param limit
+     * @param startingAfter
+     * @returns any The resolved response
+     * @throws ApiError
+     */
+    apiUpdates(limit?: number, startingAfter?: string): CancelablePromise<{
+        object: 'list';
+        /**
+         * Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
+         */
+        hasMore: boolean;
+        /**
+         * The cursor to use to get the next set of items in the list
+         */
+        endingCursor?: string;
+        data: Array<Update>;
+    }>;
+    /**
+     * Returns a user with the given id. If cannot find user, returns a 404
+     * @param id
+     * @returns User The resolved response
+     * @throws ApiError
+     */
+    apiUser(id: string): CancelablePromise<User>;
+    /**
+     * Returns a list of the user's custom attributes
+     * @param id
+     * @param limit
+     * @param startingAfter
+     * @returns any The resolved response
+     * @throws ApiError
+     */
+    apiUserCustomAttributes(id: string, limit?: number, startingAfter?: string): CancelablePromise<{
+        object: 'list';
+        /**
+         * Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
+         */
+        hasMore: boolean;
+        /**
+         * The cursor to use to get the next set of items in the list
+         */
+        endingCursor?: string;
+        data: Array<UserCustomAttribute>;
+    }>;
+    /**
+     * Returns a list of users that report to a user
+     * @param id
+     * @returns any The resolved response
+     * @throws ApiError
+     */
+    apiUserDirectReports(id: string): CancelablePromise<{
+        object: 'list';
+        /**
+         * Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
+         */
+        hasMore: boolean;
+        /**
+         * The cursor to use to get the next set of items in the list
+         */
+        endingCursor?: string;
+        data: Array<User>;
+    }>;
+    /**
+     * Returns a paginated list of all of the goals owned by a user
+     * @param id
+     * @param limit
+     * @param startingAfter
+     * @param state
+     * @returns any The resolved response
+     * @throws ApiError
+     */
+    apiUserGoals(id: string, limit?: number, startingAfter?: string, state?: GoalStateEnum): CancelablePromise<{
+        object: 'list';
+        /**
+         * Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
+         */
+        hasMore: boolean;
+        /**
+         * The cursor to use to get the next set of items in the list
+         */
+        endingCursor?: string;
+        data: Array<Goal>;
+    }>;
+    /**
+     * Returns a paginated list of tasks in Lattice
+     * @param id
+     * @returns any The resolved response
+     * @throws ApiError
+     */
+    apiUserTasks(id: string): CancelablePromise<{
+        object: 'list';
+        /**
+         * Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
+         */
+        hasMore: boolean;
+        /**
+         * The cursor to use to get the next set of items in the list
+         */
+        endingCursor?: string;
+        data: Array<Record<string, any>>;
+    }>;
+    /**
+     * Returns a paginated list of users in Lattice. By default, returns active users. A 'status' parameter of 'null' will retrieve all users regardless of status.
+     * @param limit
+     * @param startingAfter
+     * @param status
+     * @returns any The resolved response
+     * @throws ApiError
+     */
+    apiUsers(limit?: number, startingAfter?: string, status?: UserStatusEnumWithNullStringValue): CancelablePromise<{
+        object: 'list';
+        /**
+         * Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
+         */
+        hasMore: boolean;
+        /**
+         * The cursor to use to get the next set of items in the list
+         */
+        endingCursor?: string;
+        data: Array<User>;
+    }>;
+}
+//# sourceMappingURL=DefaultService.d.ts.map