@maxim_mazurok/gapi.client.chat-v1 0.0.20240324 → 0.0.20240331
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +42 -42
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://chat.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240331
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -458,11 +458,11 @@ declare namespace gapi.client {
|
|
|
458
458
|
interface GoogleAppsCardV1MaterialIcon {
|
|
459
459
|
/** Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. */
|
|
460
460
|
fill?: boolean;
|
|
461
|
-
/** Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified,
|
|
461
|
+
/** Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. */
|
|
462
462
|
grade?: number;
|
|
463
463
|
/** The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. */
|
|
464
464
|
name?: string;
|
|
465
|
-
/** The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified,
|
|
465
|
+
/** The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. */
|
|
466
466
|
weight?: number;
|
|
467
467
|
}
|
|
468
468
|
interface GoogleAppsCardV1OnClick {
|
|
@@ -508,7 +508,7 @@ declare namespace gapi.client {
|
|
|
508
508
|
label?: string;
|
|
509
509
|
/** For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items. */
|
|
510
510
|
multiSelectMaxSelectedItems?: number;
|
|
511
|
-
/** For multiselect menus, the number of text characters that a user inputs before the
|
|
511
|
+
/** For multiselect menus, the number of text characters that a user inputs before the app queries autocomplete and displays suggested items in the menu. If unspecified, defaults to 0 characters for static data sources and 3 characters for external data sources. */
|
|
512
512
|
multiSelectMinQueryLength?: number;
|
|
513
513
|
/** The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/ui/read-form-data). */
|
|
514
514
|
name?: string;
|
|
@@ -724,7 +724,7 @@ declare namespace gapi.client {
|
|
|
724
724
|
state?: string;
|
|
725
725
|
}
|
|
726
726
|
interface MembershipBatchCreatedEventData {
|
|
727
|
-
/** A list of
|
|
727
|
+
/** A list of new memberships. */
|
|
728
728
|
memberships?: MembershipCreatedEventData[];
|
|
729
729
|
}
|
|
730
730
|
interface MembershipBatchDeletedEventData {
|
|
@@ -736,15 +736,15 @@ declare namespace gapi.client {
|
|
|
736
736
|
memberships?: MembershipUpdatedEventData[];
|
|
737
737
|
}
|
|
738
738
|
interface MembershipCreatedEventData {
|
|
739
|
-
/** The
|
|
739
|
+
/** The new membership. */
|
|
740
740
|
membership?: Membership;
|
|
741
741
|
}
|
|
742
742
|
interface MembershipDeletedEventData {
|
|
743
|
-
/** The deleted membership. Only `name` and `state` are populated. */
|
|
743
|
+
/** The deleted membership. Only the `name` and `state` fields are populated. */
|
|
744
744
|
membership?: Membership;
|
|
745
745
|
}
|
|
746
746
|
interface MembershipUpdatedEventData {
|
|
747
|
-
/** The
|
|
747
|
+
/** The updated membership. */
|
|
748
748
|
membership?: Membership;
|
|
749
749
|
}
|
|
750
750
|
interface Message {
|
|
@@ -802,7 +802,7 @@ declare namespace gapi.client {
|
|
|
802
802
|
threadReply?: boolean;
|
|
803
803
|
}
|
|
804
804
|
interface MessageBatchCreatedEventData {
|
|
805
|
-
/** A list of
|
|
805
|
+
/** A list of new messages. */
|
|
806
806
|
messages?: MessageCreatedEventData[];
|
|
807
807
|
}
|
|
808
808
|
interface MessageBatchDeletedEventData {
|
|
@@ -814,15 +814,15 @@ declare namespace gapi.client {
|
|
|
814
814
|
messages?: MessageUpdatedEventData[];
|
|
815
815
|
}
|
|
816
816
|
interface MessageCreatedEventData {
|
|
817
|
-
/** The
|
|
817
|
+
/** The new message. */
|
|
818
818
|
message?: Message;
|
|
819
819
|
}
|
|
820
820
|
interface MessageDeletedEventData {
|
|
821
|
-
/** The deleted message. Only `name`, `createTime`, `deleteTime`, and `deletionMetadata` are populated. */
|
|
821
|
+
/** The deleted message. Only the `name`, `createTime`, `deleteTime`, and `deletionMetadata` fields are populated. */
|
|
822
822
|
message?: Message;
|
|
823
823
|
}
|
|
824
824
|
interface MessageUpdatedEventData {
|
|
825
|
-
/** The
|
|
825
|
+
/** The updated message. */
|
|
826
826
|
message?: Message;
|
|
827
827
|
}
|
|
828
828
|
interface OnClick {
|
|
@@ -850,7 +850,7 @@ declare namespace gapi.client {
|
|
|
850
850
|
user?: User;
|
|
851
851
|
}
|
|
852
852
|
interface ReactionBatchCreatedEventData {
|
|
853
|
-
/** A list of
|
|
853
|
+
/** A list of new reactions. */
|
|
854
854
|
reactions?: ReactionCreatedEventData[];
|
|
855
855
|
}
|
|
856
856
|
interface ReactionBatchDeletedEventData {
|
|
@@ -858,7 +858,7 @@ declare namespace gapi.client {
|
|
|
858
858
|
reactions?: ReactionDeletedEventData[];
|
|
859
859
|
}
|
|
860
860
|
interface ReactionCreatedEventData {
|
|
861
|
-
/** The
|
|
861
|
+
/** The new reaction. */
|
|
862
862
|
reaction?: Reaction;
|
|
863
863
|
}
|
|
864
864
|
interface ReactionDeletedEventData {
|
|
@@ -950,51 +950,51 @@ declare namespace gapi.client {
|
|
|
950
950
|
guidelines?: string;
|
|
951
951
|
}
|
|
952
952
|
interface SpaceEvent {
|
|
953
|
-
/** Time
|
|
953
|
+
/** Time when the event occurred. */
|
|
954
954
|
eventTime?: string;
|
|
955
|
-
/** Type of the
|
|
955
|
+
/** Type of space event. Each event type has a batch version, which represents multiple instances of the event type that occur in a short period of time. For `spaceEvents.list()` requests, omit batch event types in your query filter. By default, the server returns both event type and its batch version. Supported event types for [messages](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages): * New message: `google.workspace.chat.message.v1.created` * Updated message: `google.workspace.chat.message.v1.updated` * Deleted message: `google.workspace.chat.message.v1.deleted` * Multiple new messages: `google.workspace.chat.message.v1.batchCreated` * Multiple updated messages: `google.workspace.chat.message.v1.batchUpdated` * Multiple deleted messages: `google.workspace.chat.message.v1.batchDeleted` Supported event types for [memberships](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members): * New membership: `google.workspace.chat.membership.v1.created` * Updated membership: `google.workspace.chat.membership.v1.updated` * Deleted membership: `google.workspace.chat.membership.v1.deleted` * Multiple new memberships: `google.workspace.chat.membership.v1.batchCreated` * Multiple updated memberships: `google.workspace.chat.membership.v1.batchUpdated` * Multiple deleted memberships: `google.workspace.chat.membership.v1.batchDeleted` Supported event types for [reactions](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.reactions): * New reaction: `google.workspace.chat.reaction.v1.created` * Deleted reaction: `google.workspace.chat.reaction.v1.deleted` * Multiple new reactions: `google.workspace.chat.reaction.v1.batchCreated` * Multiple deleted reactions: `google.workspace.chat.reaction.v1.batchDeleted` Supported event types about the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces): * Updated space: `google.workspace.chat.space.v1.updated` * Multiple space updates: `google.workspace.chat.space.v1.batchUpdated` */
|
|
956
956
|
eventType?: string;
|
|
957
|
-
/**
|
|
957
|
+
/** Event payload for multiple new memberships. Event type: `google.workspace.chat.membership.v1.batchCreated` */
|
|
958
958
|
membershipBatchCreatedEventData?: MembershipBatchCreatedEventData;
|
|
959
|
-
/**
|
|
959
|
+
/** Event payload for multiple deleted memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted` */
|
|
960
960
|
membershipBatchDeletedEventData?: MembershipBatchDeletedEventData;
|
|
961
|
-
/**
|
|
961
|
+
/** Event payload for multiple updated memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated` */
|
|
962
962
|
membershipBatchUpdatedEventData?: MembershipBatchUpdatedEventData;
|
|
963
|
-
/**
|
|
963
|
+
/** Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created` */
|
|
964
964
|
membershipCreatedEventData?: MembershipCreatedEventData;
|
|
965
|
-
/**
|
|
965
|
+
/** Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted` */
|
|
966
966
|
membershipDeletedEventData?: MembershipDeletedEventData;
|
|
967
|
-
/**
|
|
967
|
+
/** Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated` */
|
|
968
968
|
membershipUpdatedEventData?: MembershipUpdatedEventData;
|
|
969
|
-
/**
|
|
969
|
+
/** Event payload for multiple new messages. Event type: `google.workspace.chat.message.v1.batchCreated` */
|
|
970
970
|
messageBatchCreatedEventData?: MessageBatchCreatedEventData;
|
|
971
|
-
/**
|
|
971
|
+
/** Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted` */
|
|
972
972
|
messageBatchDeletedEventData?: MessageBatchDeletedEventData;
|
|
973
|
-
/**
|
|
973
|
+
/** Event payload for multiple updated messages. Event type: `google.workspace.chat.message.v1.batchUpdated` */
|
|
974
974
|
messageBatchUpdatedEventData?: MessageBatchUpdatedEventData;
|
|
975
|
-
/**
|
|
975
|
+
/** Event payload for a new message. Event type: `google.workspace.chat.message.v1.created` */
|
|
976
976
|
messageCreatedEventData?: MessageCreatedEventData;
|
|
977
|
-
/**
|
|
977
|
+
/** Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted` */
|
|
978
978
|
messageDeletedEventData?: MessageDeletedEventData;
|
|
979
|
-
/**
|
|
979
|
+
/** Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated` */
|
|
980
980
|
messageUpdatedEventData?: MessageUpdatedEventData;
|
|
981
|
-
/**
|
|
981
|
+
/** Resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}` */
|
|
982
982
|
name?: string;
|
|
983
|
-
/**
|
|
983
|
+
/** Event payload for multiple new reactions. Event type: `google.workspace.chat.reaction.v1.batchCreated` */
|
|
984
984
|
reactionBatchCreatedEventData?: ReactionBatchCreatedEventData;
|
|
985
|
-
/**
|
|
985
|
+
/** Event payload for multiple deleted reactions. Event type: `google.workspace.chat.reaction.v1.batchDeleted` */
|
|
986
986
|
reactionBatchDeletedEventData?: ReactionBatchDeletedEventData;
|
|
987
|
-
/**
|
|
987
|
+
/** Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created` */
|
|
988
988
|
reactionCreatedEventData?: ReactionCreatedEventData;
|
|
989
|
-
/**
|
|
989
|
+
/** Event payload for a deleted reaction. Event type: `google.workspace.chat.reaction.v1.deleted` */
|
|
990
990
|
reactionDeletedEventData?: ReactionDeletedEventData;
|
|
991
|
-
/**
|
|
991
|
+
/** Event payload for multiple updates to a space. Event type: `google.workspace.chat.space.v1.batchUpdated` */
|
|
992
992
|
spaceBatchUpdatedEventData?: SpaceBatchUpdatedEventData;
|
|
993
|
-
/**
|
|
993
|
+
/** Event payload for a space update. Event type: `google.workspace.chat.space.v1.updated` */
|
|
994
994
|
spaceUpdatedEventData?: SpaceUpdatedEventData;
|
|
995
995
|
}
|
|
996
996
|
interface SpaceUpdatedEventData {
|
|
997
|
-
/** The
|
|
997
|
+
/** The updated space. */
|
|
998
998
|
space?: Space;
|
|
999
999
|
}
|
|
1000
1000
|
interface Status {
|
|
@@ -1769,7 +1769,7 @@ declare namespace gapi.client {
|
|
|
1769
1769
|
reactions: ReactionsResource;
|
|
1770
1770
|
}
|
|
1771
1771
|
interface SpaceEventsResource {
|
|
1772
|
-
/** Returns
|
|
1772
|
+
/** Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). To get an event, the authenticated user must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event). */
|
|
1773
1773
|
get(request?: {
|
|
1774
1774
|
/** V1 error format. */
|
|
1775
1775
|
'$.xgafv'?: string;
|
|
@@ -1783,7 +1783,7 @@ declare namespace gapi.client {
|
|
|
1783
1783
|
fields?: string;
|
|
1784
1784
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1785
1785
|
key?: string;
|
|
1786
|
-
/** Required. The resource name of the event. Format: `spaces/{space}/spaceEvents/{spaceEvent}` */
|
|
1786
|
+
/** Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}` */
|
|
1787
1787
|
name: string;
|
|
1788
1788
|
/** OAuth 2.0 token for the current user. */
|
|
1789
1789
|
oauth_token?: string;
|
|
@@ -1796,7 +1796,7 @@ declare namespace gapi.client {
|
|
|
1796
1796
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1797
1797
|
uploadType?: string;
|
|
1798
1798
|
}): Request<SpaceEvent>;
|
|
1799
|
-
/** Lists
|
|
1799
|
+
/** Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). To list events, the authenticated user must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events). */
|
|
1800
1800
|
list(request?: {
|
|
1801
1801
|
/** V1 error format. */
|
|
1802
1802
|
'$.xgafv'?: string;
|
|
@@ -1808,17 +1808,17 @@ declare namespace gapi.client {
|
|
|
1808
1808
|
callback?: string;
|
|
1809
1809
|
/** Selector specifying which fields to include in a partial response. */
|
|
1810
1810
|
fields?: string;
|
|
1811
|
-
/** Required. A query filter.
|
|
1811
|
+
/** Required. A query filter. You must specify at least one event type (`event_type`) using the has `:` operator. To filter by multiple event types, use the `OR` operator. Omit batch event types in your filter. The request automatically returns any related batch events. For example, if you filter by new reactions (`google.workspace.chat.reaction.v1.created`), the server also returns batch new reactions events (`google.workspace.chat.reaction.v1.batchCreated`). For a list of supported event types, see the [`SpaceEvents` reference documentation](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.event_type). Optionally, you can also filter by start time (`start_time`) and end time (`end_time`): * `start_time`: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days. * `end_time`: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request. To specify a start or end time, use the equals `=` operator and format in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339). To filter by both `start_time` and `end_time`, use the `AND` operator. For example, the following queries are valid: ``` start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00" ``` ``` start_time="2023-08-23T19:20:33+00:00" AND (event_types:"google.workspace.chat.space.v1.updated" OR event_types:"google.workspace.chat.message.v1.created") ``` The following queries are invalid: ``` start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00" ``` ``` event_types:"google.workspace.chat.space.v1.updated" AND event_types:"google.workspace.chat.message.v1.created" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error. */
|
|
1812
1812
|
filter?: string;
|
|
1813
1813
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1814
1814
|
key?: string;
|
|
1815
1815
|
/** OAuth 2.0 token for the current user. */
|
|
1816
1816
|
oauth_token?: string;
|
|
1817
|
-
/** Optional. The maximum number of space events returned. The service
|
|
1817
|
+
/** Optional. The maximum number of space events returned. The service might return fewer than this value. Negative values return an `INVALID_ARGUMENT` error. */
|
|
1818
1818
|
pageSize?: number;
|
|
1819
1819
|
/** A page token, received from a previous list space events call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. */
|
|
1820
1820
|
pageToken?: string;
|
|
1821
|
-
/** Required.
|
|
1821
|
+
/** Required. Resource name of the [Google Chat space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) where the events occurred. Format: `spaces/{space}`. */
|
|
1822
1822
|
parent: string;
|
|
1823
1823
|
/** Returns response with indentations and line breaks. */
|
|
1824
1824
|
prettyPrint?: boolean;
|