import type { EmptyResponse } from '../models/EmptyResponse'; import type { StatusUpdateCompact } from '../models/StatusUpdateCompact'; import type { StatusUpdateRequest } from '../models/StatusUpdateRequest'; import type { StatusUpdateResponse } from '../models/StatusUpdateResponse'; import type { CancelablePromise } from '../core/CancelablePromise'; import type { BaseHttpRequest } from '../core/BaseHttpRequest'; export declare class StatusUpdatesService { readonly httpRequest: BaseHttpRequest; constructor(httpRequest: BaseHttpRequest); /** * Get a status update * Returns the complete record for a single status update. * @returns any Successfully retrieved the specified object's status updates. * @throws ApiError */ getStatus({ statusGid, optPretty, optFields, }: { /** * The status update to get. */ statusGid: string; /** * Provides “pretty” output. * Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. */ optPretty?: boolean; /** * Defines fields to return. * Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. * The id of included objects will always be returned, regardless of the field options. */ optFields?: Array; }): CancelablePromise<{ data?: StatusUpdateResponse; }>; /** * Delete a status update * Deletes a specific, existing status update. * * Returns an empty data record. * @returns any Successfully deleted the specified status. * @throws ApiError */ deleteStatus({ statusGid, optPretty, optFields, }: { /** * The status update to get. */ statusGid: string; /** * Provides “pretty” output. * Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. */ optPretty?: boolean; /** * Defines fields to return. * Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. * The id of included objects will always be returned, regardless of the field options. */ optFields?: Array; }): CancelablePromise<{ data?: EmptyResponse; }>; /** * Get status updates from an object * Returns the compact status update records for all updates on the object. * @returns any Successfully retrieved the specified object's status updates. * @throws ApiError */ getStatusesForObject({ parent, optPretty, optFields, limit, offset, createdSince, }: { /** * Globally unique identifier for object to fetch statuses from. Must be a GID for a project, portfolio, or goal. */ parent: string; /** * Provides “pretty” output. * Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. */ optPretty?: boolean; /** * Defines fields to return. * Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. * The id of included objects will always be returned, regardless of the field options. */ optFields?: Array; /** * Results per page. * The number of objects to return per page. The value must be between 1 and 100. */ limit?: number; /** * Offset token. * An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. * 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' */ offset?: string; /** * Only return statuses that have been created since the given time. */ createdSince?: string; }): CancelablePromise<{ data?: Array; }>; /** * Create a status update * Creates a new status update on an object. * Returns the full record of the newly created status update. * @returns any Successfully created a new status update. * @throws ApiError */ createStatusForObject({ requestBody, optPretty, optFields, limit, offset, }: { /** * The status update to create. */ requestBody: { data?: StatusUpdateRequest; }; /** * Provides “pretty” output. * Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. */ optPretty?: boolean; /** * Defines fields to return. * Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. * The id of included objects will always be returned, regardless of the field options. */ optFields?: Array; /** * Results per page. * The number of objects to return per page. The value must be between 1 and 100. */ limit?: number; /** * Offset token. * An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. * 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' */ offset?: string; }): CancelablePromise<{ data?: StatusUpdateResponse; }>; }