@mondaydotcomorg/api
Version:
monday.com API client
1,392 lines (1,391 loc) • 149 kB
TypeScript
import * as graphql from 'graphql';
import { GraphQLClient } from 'graphql-request';
export { ClientError } from 'graphql-request';
import { GraphQLClientRequestHeaders } from 'graphql-request/build/cjs/types';
import { RequestConfig, GraphQLClientResponse } from 'graphql-request/build/esm/types';
type Maybe<T> = T | null;
type InputMaybe<T> = Maybe<T>;
type Exact<T extends {
[key: string]: unknown;
}> = {
[K in keyof T]: T[K];
};
type MakeOptional<T, K extends keyof T> = Omit<T, K> & {
[SubKey in K]?: Maybe<T[SubKey]>;
};
type MakeMaybe<T, K extends keyof T> = Omit<T, K> & {
[SubKey in K]: Maybe<T[SubKey]>;
};
type MakeEmpty<T extends {
[key: string]: unknown;
}, K extends keyof T> = {
[_ in K]?: never;
};
type Incremental<T> = T | {
[P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never;
};
/** All built-in and custom scalars, mapped to their actual values */
type Scalars = {
ID: {
input: string;
output: string;
};
String: {
input: string;
output: string;
};
Boolean: {
input: boolean;
output: boolean;
};
Int: {
input: number;
output: number;
};
Float: {
input: number;
output: number;
};
CompareValue: {
input: any;
output: any;
};
Date: {
input: any;
output: any;
};
File: {
input: any;
output: any;
};
ISO8601DateTime: {
input: any;
output: any;
};
JSON: {
input: any;
output: any;
};
};
/** Your monday.com account */
type Account = {
__typename?: 'Account';
/** The number of active member users in the account */
active_members_count?: Maybe<Scalars['Int']['output']>;
/** The account's country two-letter code in ISO3166 format */
country_code?: Maybe<Scalars['String']['output']>;
/** The first day of the week for the account (sunday / monday) */
first_day_of_the_week: FirstDayOfTheWeek;
/** The account's unique identifier. */
id: Scalars['ID']['output'];
/** The account's logo. */
logo?: Maybe<Scalars['String']['output']>;
/** The account's name. */
name: Scalars['String']['output'];
/** The account's payment plan. */
plan?: Maybe<Plan>;
/** The account's active products */
products?: Maybe<Array<Maybe<AccountProduct>>>;
/** Show weekends in timeline */
show_timeline_weekends: Scalars['Boolean']['output'];
/** The product the account signed up to first. */
sign_up_product_kind?: Maybe<Scalars['String']['output']>;
/** The account's slug. */
slug: Scalars['String']['output'];
/** The account's tier. */
tier?: Maybe<Scalars['String']['output']>;
};
/** The product a workspace is used in. */
type AccountProduct = {
__typename?: 'AccountProduct';
/** The account product default workspace id */
default_workspace_id?: Maybe<Scalars['ID']['output']>;
/** The account product id */
id?: Maybe<Scalars['ID']['output']>;
/**
* The account product kind (core / marketing / crm / software /
* projectManagement / project_management / service / forms / whiteboard).
*/
kind?: Maybe<Scalars['String']['output']>;
};
/** An activity log event */
type ActivityLogType = {
__typename?: 'ActivityLogType';
account_id: Scalars['String']['output'];
created_at: Scalars['String']['output'];
/** The item's column values in string form. */
data: Scalars['String']['output'];
entity: Scalars['String']['output'];
event: Scalars['String']['output'];
id: Scalars['String']['output'];
user_id: Scalars['String']['output'];
};
/** An app install details. */
type AppInstall = {
__typename?: 'AppInstall';
/** The app's unique identifier. */
app_id: Scalars['ID']['output'];
/** An app installer's account details. */
app_install_account: AppInstallAccount;
/** An app installer's user details */
app_install_user: AppInstallUser;
/** The app's version details */
app_version?: Maybe<AppVersion>;
/** The required and approved scopes for an app install. */
permissions?: Maybe<AppInstallPermissions>;
/** Installation date */
timestamp?: Maybe<Scalars['String']['output']>;
};
/** An app installer's account details */
type AppInstallAccount = {
__typename?: 'AppInstallAccount';
/** The app's installer account id. */
id: Scalars['ID']['output'];
};
/** The required and approved scopes for an app install. */
type AppInstallPermissions = {
__typename?: 'AppInstallPermissions';
/** The scopes approved by the account admin */
approved_scopes: Array<Scalars['String']['output']>;
/** The scopes required by the latest live version */
required_scopes: Array<Scalars['String']['output']>;
};
/** An app installer's user details */
type AppInstallUser = {
__typename?: 'AppInstallUser';
/** The app's installer user id. */
id?: Maybe<Scalars['ID']['output']>;
};
/** The app monetization status for the current account */
type AppMonetizationStatus = {
__typename?: 'AppMonetizationStatus';
/** Is apps monetization is supported for the account */
is_supported: Scalars['Boolean']['output'];
};
/** The account subscription details for the app. */
type AppSubscription = {
__typename?: 'AppSubscription';
/** The type of the billing period [monthly/yearly]. */
billing_period?: Maybe<Scalars['String']['output']>;
/** The number of days left until the subscription ends. */
days_left?: Maybe<Scalars['Int']['output']>;
/** Is the subscription a trial */
is_trial?: Maybe<Scalars['Boolean']['output']>;
/** The subscription plan id (on the app's side). */
plan_id: Scalars['String']['output'];
/** The pricing version of subscription plan. */
pricing_version?: Maybe<Scalars['Int']['output']>;
/** The subscription renewal date. */
renewal_date: Scalars['Date']['output'];
};
/** The Operations counter response for the app action. */
type AppSubscriptionOperationsCounter = {
__typename?: 'AppSubscriptionOperationsCounter';
/** The account subscription details for the app. */
app_subscription?: Maybe<AppSubscription>;
/** The new counter value. */
counter_value?: Maybe<Scalars['Int']['output']>;
/** Operations name. */
kind: Scalars['String']['output'];
/** Window key. */
period_key?: Maybe<Scalars['String']['output']>;
};
/** An app's version details. */
type AppVersion = {
__typename?: 'AppVersion';
/** The app's major version. */
major: Scalars['Int']['output'];
/** The app's minor version. */
minor: Scalars['Int']['output'];
/** The app's patch version. */
patch: Scalars['Int']['output'];
/** The app's version text */
text: Scalars['String']['output'];
/** The app's version type. */
type?: Maybe<Scalars['String']['output']>;
};
/** The app monetization information for the current account */
type AppsMonetizationInfo = {
__typename?: 'AppsMonetizationInfo';
/**
* The number of seats in the account, across all products, used to match the
* app’s subscription among apps that utilize the seats-based monetization method
*/
seats_count?: Maybe<Scalars['Int']['output']>;
};
/** A file uploaded to monday.com */
type Asset = {
__typename?: 'Asset';
/** The file's creation date. */
created_at?: Maybe<Scalars['Date']['output']>;
/** The file's extension. */
file_extension: Scalars['String']['output'];
/** The file's size in bytes. */
file_size: Scalars['Int']['output'];
/** The file's unique identifier. */
id: Scalars['ID']['output'];
/** The file's name. */
name: Scalars['String']['output'];
/** original geometry of the asset. */
original_geometry?: Maybe<Scalars['String']['output']>;
/** public url to the asset, valid for 1 hour. */
public_url: Scalars['String']['output'];
/** The user who uploaded the file. */
uploaded_by: User;
/** url to view the asset. */
url: Scalars['String']['output'];
/** url to view the asset in thumbnail mode. Only available for images. */
url_thumbnail?: Maybe<Scalars['String']['output']>;
};
/** The source of the asset */
declare enum AssetsSource {
/** Assets from file columns and item's files gallery */
All = "all",
/** Assets only from file columns */
Columns = "columns",
/** Assets only from item's files gallery */
Gallery = "gallery"
}
/** Result of an batch operation */
type BatchExtendTrialPeriod = {
__typename?: 'BatchExtendTrialPeriod';
/** Details of operations */
details?: Maybe<Array<ExtendTrialPeriod>>;
/** Reason of an error */
reason?: Maybe<Scalars['String']['output']>;
/** Result of a batch operation */
success: Scalars['Boolean']['output'];
};
/** A monday.com board. */
type Board = {
__typename?: 'Board';
/** The board log events. */
activity_logs?: Maybe<Array<Maybe<ActivityLogType>>>;
/** The board's folder unique identifier. */
board_folder_id?: Maybe<Scalars['ID']['output']>;
/** The board's kind (public / private / share). */
board_kind: BoardKind;
/** The board's collaborators */
collaborators: Array<Maybe<User>>;
/** The board's visible columns. */
columns?: Maybe<Array<Maybe<Column>>>;
/** Get the board communication value - typically meeting ID */
communication?: Maybe<Scalars['JSON']['output']>;
/** The creator of the board. */
creator: User;
/** The board's description. */
description?: Maybe<Scalars['String']['output']>;
/** The board's visible groups. */
groups?: Maybe<Array<Maybe<Group>>>;
/** The unique identifier of the board. */
id: Scalars['ID']['output'];
/** The Board's item nickname, one of a predefined set of values, or a custom user value */
item_terminology?: Maybe<Scalars['String']['output']>;
/** The number of items on the board */
items_count?: Maybe<Scalars['Int']['output']>;
/** The board's items (rows). */
items_page: ItemsResponse;
/** The board's name. */
name: Scalars['String']['output'];
/**
* The owner of the board.
* @deprecated This field returned creator of the board. Please use 'creator' or 'owners' fields instead.
*/
owner: User;
/** List of user board owners */
owners: Array<Maybe<User>>;
/** The board's permissions. */
permissions: Scalars['String']['output'];
/** The board's state (all / active / archived / deleted). */
state: State;
/** The board's subscribers. */
subscribers: Array<Maybe<User>>;
/** The board's specific tags. */
tags?: Maybe<Array<Maybe<Tag>>>;
/** List of team board owners */
team_owners?: Maybe<Array<Team>>;
/** The board's team subscribers. */
team_subscribers?: Maybe<Array<Team>>;
/** The top group at this board. */
top_group: Group;
/** The board object type. */
type?: Maybe<BoardObjectType>;
/** The last time the board was updated at. */
updated_at?: Maybe<Scalars['ISO8601DateTime']['output']>;
/** The board's updates. */
updates?: Maybe<Array<Maybe<Update>>>;
/** The Board's url */
url: Scalars['String']['output'];
/** The board's views. */
views?: Maybe<Array<Maybe<BoardView>>>;
/** The workspace that contains this board (null for main workspace). */
workspace?: Maybe<Workspace>;
/** The board's workspace unique identifier (null for main workspace). */
workspace_id?: Maybe<Scalars['ID']['output']>;
};
/** A monday.com board. */
type BoardActivity_LogsArgs = {
column_ids?: InputMaybe<Array<InputMaybe<Scalars['String']['input']>>>;
from?: InputMaybe<Scalars['ISO8601DateTime']['input']>;
group_ids?: InputMaybe<Array<InputMaybe<Scalars['String']['input']>>>;
item_ids?: InputMaybe<Array<Scalars['ID']['input']>>;
limit?: InputMaybe<Scalars['Int']['input']>;
page?: InputMaybe<Scalars['Int']['input']>;
to?: InputMaybe<Scalars['ISO8601DateTime']['input']>;
user_ids?: InputMaybe<Array<Scalars['ID']['input']>>;
};
/** A monday.com board. */
type BoardColumnsArgs = {
ids?: InputMaybe<Array<InputMaybe<Scalars['String']['input']>>>;
types?: InputMaybe<Array<ColumnType>>;
};
/** A monday.com board. */
type BoardGroupsArgs = {
ids?: InputMaybe<Array<InputMaybe<Scalars['String']['input']>>>;
};
/** A monday.com board. */
type BoardItems_PageArgs = {
cursor?: InputMaybe<Scalars['String']['input']>;
limit?: Scalars['Int']['input'];
query_params?: InputMaybe<ItemsQuery>;
};
/** A monday.com board. */
type BoardTeam_OwnersArgs = {
limit?: InputMaybe<Scalars['Int']['input']>;
page?: InputMaybe<Scalars['Int']['input']>;
};
/** A monday.com board. */
type BoardTeam_SubscribersArgs = {
limit?: InputMaybe<Scalars['Int']['input']>;
page?: InputMaybe<Scalars['Int']['input']>;
};
/** A monday.com board. */
type BoardUpdatesArgs = {
ids?: InputMaybe<Array<Scalars['ID']['input']>>;
limit?: InputMaybe<Scalars['Int']['input']>;
page?: InputMaybe<Scalars['Int']['input']>;
};
/** A monday.com board. */
type BoardViewsArgs = {
ids?: InputMaybe<Array<Scalars['ID']['input']>>;
type?: InputMaybe<Scalars['String']['input']>;
};
/** The board attributes available. */
declare enum BoardAttributes {
/** Object that contains available Video conferences on the board. */
Communication = "communication",
/** Board description. */
Description = "description",
/** Board name. */
Name = "name"
}
/** A board duplication */
type BoardDuplication = {
__typename?: 'BoardDuplication';
/** The new board created by the duplication */
board: Board;
/** Was the board duplication performed asynchronously */
is_async: Scalars['Boolean']['output'];
};
/** Edit permissions level for boards. */
declare enum BoardEditPermissions {
/** Assignee */
Assignee = "assignee",
/** Collaborators */
Collaborators = "collaborators",
/** Everyone */
Everyone = "everyone",
/** Owners */
Owners = "owners"
}
/** The board kinds available. */
declare enum BoardKind {
/** Private boards. */
Private = "private",
/** Public boards. */
Public = "public",
/** Shareable boards. */
Share = "share"
}
/** The board object types. */
declare enum BoardObjectType {
/** Parent Board. */
Board = "board",
/** Custom Object. */
CustomObject = "custom_object",
/** Document. */
Document = "document",
/** Sub Items Board. */
SubItemsBoard = "sub_items_board"
}
type BoardRelationValue = ColumnValue & {
__typename?: 'BoardRelationValue';
/** The column that this value belongs to. */
column: Column;
/** A string representing all the names of the linked items, separated by commas */
display_value: Scalars['String']['output'];
/** The column's unique identifier. */
id: Scalars['ID']['output'];
/** The linked items IDs */
linked_item_ids: Array<Scalars['ID']['output']>;
/** The linked items. */
linked_items: Array<Item>;
/** Text representation of the column value. Note: Not all columns support textual value */
text?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The date when column value was last updated. */
updated_at?: Maybe<Scalars['Date']['output']>;
/** The column's raw value in JSON format. */
value?: Maybe<Scalars['JSON']['output']>;
};
/** The board subscriber kind. */
declare enum BoardSubscriberKind {
/** Board owner. */
Owner = "owner",
/** Board subscriber. */
Subscriber = "subscriber"
}
/** A board's view. */
type BoardView = {
__typename?: 'BoardView';
/** The view's unique identifier. */
id: Scalars['ID']['output'];
/** The view's name. */
name: Scalars['String']['output'];
/** The view's settings in a string form. */
settings_str: Scalars['String']['output'];
/** The view's template id if it was duplictated from other */
source_view_id?: Maybe<Scalars['ID']['output']>;
/** The view's type. */
type: Scalars['String']['output'];
/** Specific board view data (supported only for forms) */
view_specific_data_str: Scalars['String']['output'];
};
/** View permissions level for boards. */
declare enum BoardViewPermissions {
AnyAssigneeColumn = "any_assignee_column"
}
/** Options to order by. */
declare enum BoardsOrderBy {
/** The rank order of the board creation time (desc). */
CreatedAt = "created_at",
/** The last time the user making the request used the board (desc). */
UsedAt = "used_at"
}
type ButtonValue = ColumnValue & {
__typename?: 'ButtonValue';
/** The button's color in hex value. */
color?: Maybe<Scalars['String']['output']>;
/** The column that this value belongs to. */
column: Column;
/** The column's unique identifier. */
id: Scalars['ID']['output'];
/** The button's label. */
label: Scalars['String']['output'];
text?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The column's raw value in JSON format. */
value?: Maybe<Scalars['JSON']['output']>;
};
/** The result of adding users to / removing users from a team. */
type ChangeTeamMembershipsResult = {
__typename?: 'ChangeTeamMembershipsResult';
/** The users that team membership update failed for */
failed_users?: Maybe<Array<User>>;
/** The users that team membership update succeeded for */
successful_users?: Maybe<Array<User>>;
};
type CheckboxValue = ColumnValue & {
__typename?: 'CheckboxValue';
/** The column's boolean value. */
checked?: Maybe<Scalars['Boolean']['output']>;
/** The column that this value belongs to. */
column: Column;
/** The column's unique identifier. */
id: Scalars['ID']['output'];
text?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The date when column value was last updated. */
updated_at?: Maybe<Scalars['Date']['output']>;
value?: Maybe<Scalars['JSON']['output']>;
};
type ColorPickerValue = ColumnValue & {
__typename?: 'ColorPickerValue';
/** The color in hex value. */
color?: Maybe<Scalars['String']['output']>;
/** The column that this value belongs to. */
column: Column;
/** The column's unique identifier. */
id: Scalars['ID']['output'];
text?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The date when column value was last updated. */
updated_at?: Maybe<Scalars['Date']['output']>;
/** The column's raw value in JSON format. */
value?: Maybe<Scalars['JSON']['output']>;
};
type Column = {
__typename?: 'Column';
/** Is the column archived or not. */
archived: Scalars['Boolean']['output'];
/** The column's description. */
description?: Maybe<Scalars['String']['output']>;
/** The column's unique identifier. */
id: Scalars['ID']['output'];
/** The column's settings in a string form. */
settings_str: Scalars['String']['output'];
/** The column's title. */
title: Scalars['String']['output'];
/** The column's type. */
type: ColumnType;
/** The column's width. */
width?: Maybe<Scalars['Int']['output']>;
};
/** An object defining a mapping of column between source board and destination board */
type ColumnMappingInput = {
/** The source column's unique identifier. */
source: Scalars['ID']['input'];
/** The target column's unique identifier. */
target?: InputMaybe<Scalars['ID']['input']>;
};
/** The property name of the column to be changed. */
declare enum ColumnProperty {
/** the column description. */
Description = "description",
/** the column title. */
Title = "title"
}
/** The columns to create. */
declare enum ColumnType {
/** Number items according to their order in the group/board */
AutoNumber = "auto_number",
/** Connect data from other boards */
BoardRelation = "board_relation",
/** Perform actions on items by clicking a button */
Button = "button",
/** Check off items and see what's done at a glance */
Checkbox = "checkbox",
/** Manage a design system using a color palette */
ColorPicker = "color_picker",
/** Choose a country */
Country = "country",
/** Add the item's creator and creation date automatically */
CreationLog = "creation_log",
/** Add dates like deadlines to ensure you never drop the ball */
Date = "date",
/** Set up dependencies between items in the board */
Dependency = "dependency",
/** Instantly add collaborative rich text editor */
Doc = "doc",
/** Create a dropdown list of options */
Dropdown = "dropdown",
/** Email team members and clients directly from your board */
Email = "email",
/** Add files & docs to your item */
File = "file",
/** Use functions to manipulate data across multiple columns */
Formula = "formula",
Group = "group",
/** Add times to manage and schedule tasks, shifts and more */
Hour = "hour",
/** Integration is really cool... */
Integration = "integration",
/** Show all item's assignees */
ItemAssignees = "item_assignees",
/** Show a unique ID for each item */
ItemId = "item_id",
/** Add the person that last updated the item and the date */
LastUpdated = "last_updated",
/** Simply hyperlink to any website */
Link = "link",
/** Place multiple locations on a geographic map */
Location = "location",
/** Add large amounts of text without changing column width */
LongText = "long_text",
/** Show and edit columns' data from connected boards */
Mirror = "mirror",
/** Name is really cool... */
Name = "name",
/** Add revenue, costs, time estimations and more */
Numbers = "numbers",
/** Assign people to improve team work */
People = "people",
/** Assign a person to increase ownership and accountability (deprecated) */
Person = "person",
/** Call your contacts directly from monday.com */
Phone = "phone",
/** Show progress by combining status columns in a battery */
Progress = "progress",
/** Rate or rank anything visually */
Rating = "rating",
/** Get an instant overview of where things stand */
Status = "status",
/** Use the subtasks column to create another level of tasks */
Subtasks = "subtasks",
/** Add tags to categorize items across multiple boards */
Tags = "tags",
/** Assign a full team to an item */
Team = "team",
/** Add textual information e.g. addresses, names or keywords */
Text = "text",
/** Easily track time spent on each item, group, and board */
TimeTracking = "time_tracking",
/** Visualize your item’s duration, with a start and end date */
Timeline = "timeline",
/** Unsupported column type */
Unsupported = "unsupported",
/** Vote on an item e.g. pick a new feature or a favorite lunch place */
Vote = "vote",
/** Select the week on which each item should be completed */
Week = "week",
/** Keep track of the time anywhere in the world */
WorldClock = "world_clock"
}
type ColumnValue = {
/** The column that this value belongs to. */
column: Column;
/** The column's unique identifier. */
id: Scalars['ID']['output'];
/** Text representation of the column value. Note: Not all columns support textual value */
text?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The column's raw value in JSON format. */
value?: Maybe<Scalars['JSON']['output']>;
};
/** Complexity data. */
type Complexity = {
__typename?: 'Complexity';
/** The remainder of complexity after the query's execution. */
after: Scalars['Int']['output'];
/** The remainder of complexity before the query's execution. */
before: Scalars['Int']['output'];
/** The specific query's complexity. */
query: Scalars['Int']['output'];
/** How long in seconds before the complexity budget is reset */
reset_in_x_seconds: Scalars['Int']['output'];
};
type Country = {
__typename?: 'Country';
/** The country's two-letter code. */
code: Scalars['String']['output'];
/** The country's name. */
name: Scalars['String']['output'];
};
type CountryValue = ColumnValue & {
__typename?: 'CountryValue';
/** The column that this value belongs to. */
column: Column;
/** The country value. */
country?: Maybe<Country>;
/** The column's unique identifier. */
id: Scalars['ID']['output'];
/** Text representation of the column value. Note: Not all columns support textual value */
text?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The date when column value was last updated. */
updated_at?: Maybe<Scalars['Date']['output']>;
/** The column's raw value in JSON format. */
value?: Maybe<Scalars['JSON']['output']>;
};
type CreateDocBoardInput = {
/** Column id */
column_id: Scalars['String']['input'];
/** Item id */
item_id: Scalars['ID']['input'];
};
type CreateDocInput = {
board?: InputMaybe<CreateDocBoardInput>;
workspace?: InputMaybe<CreateDocWorkspaceInput>;
};
type CreateDocWorkspaceInput = {
/** The doc's kind (public / private / share) */
kind?: InputMaybe<BoardKind>;
/** The doc's name */
name: Scalars['String']['input'];
/** Workspace id */
workspace_id: Scalars['ID']['input'];
};
/** Attributes of the team to be created. */
type CreateTeamAttributesInput = {
/** Whether the team can contain guest users. */
is_guest_team?: InputMaybe<Scalars['Boolean']['input']>;
/** The team's name. */
name: Scalars['String']['input'];
/** The parent team identifier. */
parent_team_id?: InputMaybe<Scalars['ID']['input']>;
/** The team members. Must not be empty, unless allow_empty_team is set. */
subscriber_ids?: InputMaybe<Array<Scalars['ID']['input']>>;
};
/** Options for creating a team. */
type CreateTeamOptionsInput = {
/** Whether to allow a team without any subscribers. */
allow_empty_team?: InputMaybe<Scalars['Boolean']['input']>;
};
type CreationLogValue = ColumnValue & {
__typename?: 'CreationLogValue';
/** The column that this value belongs to. */
column: Column;
/** The date when the item was created. */
created_at: Scalars['Date']['output'];
/** User who created the item */
creator: User;
/** ID of the user who created the item */
creator_id: Scalars['ID']['output'];
/** The column's unique identifier. */
id: Scalars['ID']['output'];
text?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The column's raw value in JSON format. */
value?: Maybe<Scalars['JSON']['output']>;
};
type CustomActivity = {
__typename?: 'CustomActivity';
color?: Maybe<CustomActivityColor>;
icon_id?: Maybe<CustomActivityIcon>;
id?: Maybe<Scalars['ID']['output']>;
name?: Maybe<Scalars['String']['output']>;
type?: Maybe<Scalars['String']['output']>;
};
declare enum CustomActivityColor {
BrinkPink = "BRINK_PINK",
CelticBlue = "CELTIC_BLUE",
CornflowerBlue = "CORNFLOWER_BLUE",
DingyDungeon = "DINGY_DUNGEON",
GoGreen = "GO_GREEN",
Gray = "GRAY",
LightDeepPink = "LIGHT_DEEP_PINK",
LightHotPink = "LIGHT_HOT_PINK",
MayaBlue = "MAYA_BLUE",
MediumTurquoise = "MEDIUM_TURQUOISE",
ParadisePink = "PARADISE_PINK",
PhilippineGreen = "PHILIPPINE_GREEN",
PhilippineYellow = "PHILIPPINE_YELLOW",
SlateBlue = "SLATE_BLUE",
VividCerulean = "VIVID_CERULEAN",
YankeesBlue = "YANKEES_BLUE",
YellowGreen = "YELLOW_GREEN",
YellowOrange = "YELLOW_ORANGE"
}
declare enum CustomActivityIcon {
Ascending = "ASCENDING",
Camera = "CAMERA",
Conference = "CONFERENCE",
Flag = "FLAG",
Gift = "GIFT",
Headphones = "HEADPHONES",
Homekeys = "HOMEKEYS",
Location = "LOCATION",
Notebook = "NOTEBOOK",
Paperplane = "PAPERPLANE",
Plane = "PLANE",
Pliers = "PLIERS",
Tripod = "TRIPOD",
Twoflags = "TWOFLAGS",
Utencils = "UTENCILS"
}
type DateValue = ColumnValue & {
__typename?: 'DateValue';
/** The column that this value belongs to. */
column: Column;
/** The column's date value. */
date?: Maybe<Scalars['String']['output']>;
/** The string representation of selected icon. */
icon?: Maybe<Scalars['String']['output']>;
/** The column's unique identifier. */
id: Scalars['ID']['output'];
/** The formatted date and time in user time zone. */
text?: Maybe<Scalars['String']['output']>;
/** The column's time value. */
time?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The date when column value was last updated. */
updated_at?: Maybe<Scalars['Date']['output']>;
/** The column's raw value in JSON format. */
value?: Maybe<Scalars['JSON']['output']>;
};
type DeleteMarketplaceAppDiscount = {
__typename?: 'DeleteMarketplaceAppDiscount';
/** Slug of an account */
account_slug: Scalars['String']['output'];
/** The id of an app */
app_id: Scalars['ID']['output'];
};
type DeleteMarketplaceAppDiscountResult = {
__typename?: 'DeleteMarketplaceAppDiscountResult';
deleted_discount: DeleteMarketplaceAppDiscount;
};
type DependencyValue = ColumnValue & {
__typename?: 'DependencyValue';
/** The column that this value belongs to. */
column: Column;
/** A string representing all the names of the linked items, separated by commas */
display_value: Scalars['String']['output'];
/** The column's unique identifier. */
id: Scalars['ID']['output'];
/** The linked items ids */
linked_item_ids: Scalars['ID']['output'];
/** The linked items. */
linked_items: Array<Item>;
/** Text representation of the column value. Note: Not all columns support textual value */
text?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The date when column value was last updated. */
updated_at?: Maybe<Scalars['Date']['output']>;
/** The column's raw value in JSON format. */
value?: Maybe<Scalars['JSON']['output']>;
};
/** The period of a discount */
declare enum DiscountPeriod {
Monthly = "MONTHLY",
Yearly = "YEARLY"
}
/** Various documents blocks types, such as text. */
declare enum DocBlockContentType {
/** Bulleted list block */
BulletedList = "bulleted_list",
/** Check list block */
CheckList = "check_list",
/** Code block */
Code = "code",
/** Divider block */
Divider = "divider",
/** Image block */
Image = "image",
/** Large title block */
LargeTitle = "large_title",
/** Layout block */
Layout = "layout",
/** Medium title block */
MediumTitle = "medium_title",
/** Simple text block */
NormalText = "normal_text",
/** Notice block */
NoticeBox = "notice_box",
/** Numbered list block */
NumberedList = "numbered_list",
/** Quote text block */
Quote = "quote",
/** Small title block */
SmallTitle = "small_title",
/** Table block */
Table = "table",
/** Video block */
Video = "video"
}
type DocValue = ColumnValue & {
__typename?: 'DocValue';
/** The column that this value belongs to. */
column: Column;
/** The document file attached to the column. */
file?: Maybe<FileDocValue>;
/** The column's unique identifier. */
id: Scalars['ID']['output'];
/** Text representation of the column value. Note: Not all columns support textual value */
text?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The column's raw value in JSON format. */
value?: Maybe<Scalars['JSON']['output']>;
};
/** Options to order by. */
declare enum DocsOrderBy {
/** The rank order of the document creation time (desc). */
CreatedAt = "created_at",
/** The last time the user making the request viewd the document (desc). */
UsedAt = "used_at"
}
/** A monday.com document. */
type Document = {
__typename?: 'Document';
/** The document's content blocks */
blocks?: Maybe<Array<Maybe<DocumentBlock>>>;
/** The document's creation date. */
created_at?: Maybe<Scalars['Date']['output']>;
/** The document's creator */
created_by?: Maybe<User>;
/** The document's folder unique identifier (null for first level). */
doc_folder_id?: Maybe<Scalars['ID']['output']>;
/** The document's kind (public / private / share). */
doc_kind: BoardKind;
/** The document's unique identifier. */
id: Scalars['ID']['output'];
/** The document's name. */
name: Scalars['String']['output'];
/** The associated board or object's unique identifier. */
object_id: Scalars['ID']['output'];
/** The document's relative url */
relative_url?: Maybe<Scalars['String']['output']>;
/** The document's settings. */
settings?: Maybe<Scalars['JSON']['output']>;
/** The document's direct url */
url?: Maybe<Scalars['String']['output']>;
/** The workspace that contains this document (null for main workspace). */
workspace?: Maybe<Workspace>;
/** The document's workspace unique identifier (null for main workspace). */
workspace_id?: Maybe<Scalars['ID']['output']>;
};
/** A monday.com document. */
type DocumentBlocksArgs = {
limit?: InputMaybe<Scalars['Int']['input']>;
page?: InputMaybe<Scalars['Int']['input']>;
};
/** A monday.com document block. */
type DocumentBlock = {
__typename?: 'DocumentBlock';
/** The block's content. */
content?: Maybe<Scalars['JSON']['output']>;
/** The block's creation date. */
created_at?: Maybe<Scalars['Date']['output']>;
/** The block's creator */
created_by?: Maybe<User>;
/** The block's document unique identifier. */
doc_id?: Maybe<Scalars['ID']['output']>;
/** The block's unique identifier. */
id: Scalars['String']['output'];
/** The block's parent block unique identifier. */
parent_block_id?: Maybe<Scalars['String']['output']>;
/** The block's position on the document. */
position?: Maybe<Scalars['Float']['output']>;
/** The block content type. */
type?: Maybe<Scalars['String']['output']>;
/** The block's last updated date. */
updated_at?: Maybe<Scalars['Date']['output']>;
};
/** A monday.com doc block. */
type DocumentBlockIdOnly = {
__typename?: 'DocumentBlockIdOnly';
/** The block's unique identifier. */
id: Scalars['String']['output'];
};
type DropdownValue = ColumnValue & {
__typename?: 'DropdownValue';
/** The column that this value belongs to. */
column: Column;
/** The column's unique identifier. */
id: Scalars['ID']['output'];
text?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The column's raw value in JSON format. */
value?: Maybe<Scalars['JSON']['output']>;
/** The selected dropdown values. */
values: Array<DropdownValueOption>;
};
type DropdownValueOption = {
__typename?: 'DropdownValueOption';
/** The dropdown item's unique identifier. */
id: Scalars['ID']['output'];
/** The dropdown item's label. */
label: Scalars['String']['output'];
};
/** The board duplicate types available. */
declare enum DuplicateBoardType {
/** Duplicate board with structure and items. */
DuplicateBoardWithPulses = "duplicate_board_with_pulses",
/** Duplicate board with structure, items and updates. */
DuplicateBoardWithPulsesAndUpdates = "duplicate_board_with_pulses_and_updates",
/** Duplicate board with structure. */
DuplicateBoardWithStructure = "duplicate_board_with_structure"
}
type EmailValue = ColumnValue & {
__typename?: 'EmailValue';
/** The column that this value belongs to. */
column: Column;
/** The column's email value. */
email?: Maybe<Scalars['String']['output']>;
/** The column's unique identifier. */
id: Scalars['ID']['output'];
/** The column's text value. It can be the same as email when user didn't enter any text. */
label?: Maybe<Scalars['String']['output']>;
/** Text representation of the column value. Note: Not all columns support textual value */
text?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The date when column value was last updated. */
updated_at?: Maybe<Scalars['Date']['output']>;
/** The column's raw value in JSON format. */
value?: Maybe<Scalars['JSON']['output']>;
};
/** Result of a single operation */
type ExtendTrialPeriod = {
__typename?: 'ExtendTrialPeriod';
/** Account slug */
account_slug: Scalars['String']['output'];
/** Reason of an error */
reason?: Maybe<Scalars['String']['output']>;
/** Result of a single operation */
success: Scalars['Boolean']['output'];
};
type FileAssetValue = {
__typename?: 'FileAssetValue';
/** The asset associated with the file. */
asset: Asset;
/** The asset's id. */
asset_id: Scalars['ID']['output'];
/** The file's creation date. */
created_at: Scalars['Date']['output'];
/** The user who created the file. */
creator?: Maybe<User>;
/** The ID of user who created the file. */
creator_id?: Maybe<Scalars['ID']['output']>;
/** Whether the file is an image. */
is_image: Scalars['Boolean']['output'];
/** The file's name. */
name: Scalars['String']['output'];
};
type FileDocValue = {
__typename?: 'FileDocValue';
/** The file's creation date. */
created_at: Scalars['Date']['output'];
/** The user who created the file. */
creator?: Maybe<User>;
/** The ID of user who created the file. */
creator_id?: Maybe<Scalars['ID']['output']>;
/** The doc associated with the file. */
doc: Document;
/** The file's unique identifier. */
file_id: Scalars['ID']['output'];
/** The associated board or object's unique identifier. */
object_id: Scalars['ID']['output'];
/** The file's url. */
url?: Maybe<Scalars['String']['output']>;
};
type FileLinkValue = {
__typename?: 'FileLinkValue';
/** The file's creation date. */
created_at: Scalars['Date']['output'];
/** The user who created the file. */
creator?: Maybe<User>;
/** The ID of user who created the file. */
creator_id?: Maybe<Scalars['ID']['output']>;
/** The file's id. */
file_id: Scalars['ID']['output'];
/** The file's kind. */
kind: FileLinkValueKind;
/** The file's name. */
name: Scalars['String']['output'];
/** The file's url. */
url?: Maybe<Scalars['String']['output']>;
};
/** The type of a link value stored inside a file column */
declare enum FileLinkValueKind {
/** Box file */
Box = "box",
/** Dropbox file */
Dropbox = "dropbox",
/** Google Drive file */
GoogleDrive = "google_drive",
/** Generic link file */
Link = "link",
/** OneDrive file */
Onedrive = "onedrive"
}
type FileValue = ColumnValue & {
__typename?: 'FileValue';
/** The column that this value belongs to. */
column: Column;
/** The files attached to the column. */
files: Array<FileValueItem>;
/** The column's unique identifier. */
id: Scalars['ID']['output'];
text?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The column's raw value in JSON format. */
value?: Maybe<Scalars['JSON']['output']>;
};
/** A single file in a column. */
type FileValueItem = FileAssetValue | FileDocValue | FileLinkValue;
/** The first day of work week */
declare enum FirstDayOfTheWeek {
/** Monday */
Monday = "monday",
/** Sunday */
Sunday = "sunday"
}
/** A workspace folder containing boards, docs, sub folders, etc. */
type Folder = {
__typename?: 'Folder';
/** The various items in the folder, not including sub-folders and dashboards. */
children: Array<Maybe<Board>>;
/** The folder's color. */
color?: Maybe<FolderColor>;
/** The folder's creation date. */
created_at: Scalars['Date']['output'];
/** The folder's custom icon. */
custom_icon?: Maybe<FolderCustomIcon>;
/** The folder's font weight. */
font_weight?: Maybe<FolderFontWeight>;
/** The folder's unique identifier. */
id: Scalars['ID']['output'];
/** The folder's name. */
name: Scalars['String']['output'];
/** The folder's user owner unique identifier. */
owner_id?: Maybe<Scalars['ID']['output']>;
/** The folder's parent folder. */
parent?: Maybe<Folder>;
/** Sub-folders inside this folder. */
sub_folders: Array<Maybe<Folder>>;
/** The workspace that contains this folder (null id for main workspace). */
workspace: Workspace;
};
/** One value out of a list of valid folder colors */
declare enum FolderColor {
/** aquamarine */
Aquamarine = "AQUAMARINE",
/** bright-blue */
BrightBlue = "BRIGHT_BLUE",
/** bright-green */
BrightGreen = "BRIGHT_GREEN",
/** chili-blue */
ChiliBlue = "CHILI_BLUE",
/** dark-orange */
DarkOrange = "DARK_ORANGE",
/** dark_purple */
DarkPurple = "DARK_PURPLE",
/** dark-red */
DarkRed = "DARK_RED",
/** done-green */
DoneGreen = "DONE_GREEN",
/** indigo */
Indigo = "INDIGO",
/** lipstick */
Lipstick = "LIPSTICK",
/** No color */
Null = "NULL",
/** purple */
Purple = "PURPLE",
/** sofia_pink */
SofiaPink = "SOFIA_PINK",
/** stuck-red */
StuckRed = "STUCK_RED",
/** sunset */
Sunset = "SUNSET",
/** working_orange */
WorkingOrange = "WORKING_ORANGE"
}
/** One value out of a list of valid folder custom icons */
declare enum FolderCustomIcon {
/** Folder */
Folder = "FOLDER",
/** MoreBelow */
Morebelow = "MOREBELOW",
/** MoreBelowFilled */
Morebelowfilled = "MOREBELOWFILLED",
/** No custom icon */
Null = "NULL",
/** Work */
Work = "WORK"
}
/** One value out of a list of valid folder font weights */
declare enum FolderFontWeight {
/** font-weight-bold */
FontWeightBold = "FONT_WEIGHT_BOLD",
/** font-weight-light */
FontWeightLight = "FONT_WEIGHT_LIGHT",
/** font-weight-normal */
FontWeightNormal = "FONT_WEIGHT_NORMAL",
/** font-weight-very-light */
FontWeightVeryLight = "FONT_WEIGHT_VERY_LIGHT",
/** No font weight */
Null = "NULL"
}
type FormulaValue = ColumnValue & {
__typename?: 'FormulaValue';
/** The column that this value belongs to. */
column: Column;
/** The column's unique identifier. */
id: Scalars['ID']['output'];
/** Text representation of the column value. Note: Not all columns support textual value */
text?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The column's raw value in JSON format. */
value?: Maybe<Scalars['JSON']['output']>;
};
type GrantMarketplaceAppDiscount = {
__typename?: 'GrantMarketplaceAppDiscount';
/** The id of an app */
app_id: Scalars['ID']['output'];
/** List of app plan ids */
app_plan_ids: Array<Scalars['String']['output']>;
/** Number of days a discount will be valid */
days_valid: Scalars['Int']['output'];
/** Percentage value of a discount */
discount: Scalars['Int']['output'];
/** Is discount recurring */
is_recurring: Scalars['Boolean']['output'];
period?: Maybe<DiscountPeriod>;
};
type GrantMarketplaceAppDiscountData = {
/** List of app plan ids */
app_plan_ids: Array<Scalars['String']['input']>;
/** Number of days a discount will be valid */
days_valid: Scalars['Int']['input'];
/** Percentage value of a discount */
discount: Scalars['Int']['input'];
/** Is discount recurring */
is_recurring: Scalars['Boolean']['input'];
/** The period of a discount */
period?: InputMaybe<DiscountPeriod>;
};
type GrantMarketplaceAppDiscountResult = {
__typename?: 'GrantMarketplaceAppDiscountResult';
granted_discount: GrantMarketplaceAppDiscount;
};
/** A group of items in a board. */
type Group = {
__typename?: 'Group';
/** Is the group archived or not. */
archived?: Maybe<Scalars['Boolean']['output']>;
/** The group's color. */
color: Scalars['String']['output'];
/** Is the group deleted or not. */
deleted?: Maybe<Scalars['Boolean']['output']>;
/** The group's unique identifier. */
id: Scalars['ID']['output'];
/** The items in the group. */
items_page: ItemsResponse;
/** The group's position in the board. */
position: Scalars['String']['output'];
/** The group's title. */
title: Scalars['String']['output'];
};
/** A group of items in a board. */
type GroupItems_PageArgs = {
cursor?: InputMaybe<Scalars['String']['input']>;
limit?: Scalars['Int']['input'];
query_params?: InputMaybe<ItemsQuery>;
};
/** The group attributes available. */
declare enum GroupAttributes {
/** Group color (one of the supported colors, check the API documentation). */
Color = "color",
/** The group's position in the board. Deprecated! - replaced with relative position */
Position = "position",
/** The group's relative position after another group in the board. */
RelativePositionAfter = "relative_position_after",
/** The group's relative position before another group in the board. */
RelativePositionBefore = "relative_position_before",
/** Group title. */
Title = "title"
}
type GroupValue = ColumnValue & {
__typename?: 'GroupValue';
/** The column that this value belongs to. */
column: Column;
/** The group value. */
group?: Maybe<Group>;
/** The group identifier. */
group_id?: Maybe<Scalars['ID']['output']>;
/** The column's unique identifier. */
id: Scalars['ID']['output'];
/** Text representation of the column value. Note: Not all columns support textual value */
text?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The column's raw value in JSON format. */
value?: Maybe<Scalars['JSON']['output']>;
};
type HourValue = ColumnValue & {
__typename?: 'HourValue';
/** The column that this value belongs to. */
column: Column;
/** Hour */
hour?: Maybe<Scalars['Int']['output']>;
/** The column's unique identifier. */
id: Scalars['ID']['output'];
/** Minute */
minute?: Maybe<Scalars['Int']['output']>;
text?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The date when column value was last updated. */
updated_at?: Maybe<Scalars['Date']['output']>;
/** The column's raw value in JSON format. */
value?: Maybe<Scalars['JSON']['output']>;
};
type IntegrationValue = ColumnValue & {
__typename?: 'IntegrationValue';
/** The column that this value belongs to. */
column: Column;
/** ID of the entity */
entity_id?: Maybe<Scalars['ID']['output']>;
/** The column's unique identifier. */
id: Scalars['ID']['output'];
/** URL of the issue */
issue_api_url?: Maybe<Scalars['ID']['output']>;
/** ID of the issue */
issue_id?: Maybe<Scalars['String']['output']>;
/** Text representation of the column value. Note: Not all columns support textual value */
text?: Maybe<Scalars['String']['output']>;
/** The column's type. */
type: ColumnType;
/** The column's raw value in JSON format. */
value?: Maybe<Scalars['JSON']['output']>;
};
/** An item (table row). */
type Item = {
__typename?: 'Item';
/** The item's assets/files. */
assets?: Maybe<Array<Maybe<Asset>>>;
/** The board that contains this item. */
board?: Maybe<Board>;
/** The item's column values. */
column_values: Array<ColumnValue>;
/** The item's create date. */
created_at?: Maybe<Scalars['Date']['output']>;
/** The item's creator. */
creator?: Maybe<User>;
/** The unique identifier of the item creator. */
creator_id: Scalars['String']['output'];
/** The item's email. */
email: Scalars['String']['output'];
/** The group that contains this item. */
group?: Maybe<Group>;
/** The item's unique identifier. */
id: Scalars['ID']['output'];
/** The item's linked items */
linked_items: Array<Item>;
/** The item's name. */
name: Scalars['String']['output'];
/** The parent item of a subitem. */
parent_item?: Maybe<Item>;
/** The item's relative path */
relative_link?: Maybe<Scalars['String']['output']>;
/** The item's state (all / active / archived / deleted). */
state?: Maybe<State>;
/** The item's subitems. */
subitems?: Maybe<Array<Maybe<Item>>>;
/** The pulses's subscribers. */
subscribers: Array<Maybe<User>>;
/** The item's last update date. */
updated_at?: Maybe<Scalars['Date']['output']>;
/** The item's updates. */
updates?: Maybe<Array<Maybe<Update>>>;
/** The item's link */
url: Scalars['String']['output'];
};
/** An item (table row). */
type ItemAssetsArgs = {
assets_source?: InputMaybe<AssetsSource>;
column_ids?: InputMaybe<Array<InputMaybe<Scalars['String']['input']>>>;
};
/** An item (table row). */
type ItemColumn_ValuesArgs = {
ids?: InputMaybe<Array<Scalars['String']['input']>>;
types?: InputMaybe<Array<ColumnType>>;
};
/** An item (table row). */
type ItemLinked_ItemsArgs = {
link_to_item_column_id: Scalars['String']['input'];
link