@maxim_mazurok/gapi.client.contactcenteraiplatform-v1alpha1 0.1.20251115 → 0.1.20251211
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 +183 -1
- 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://contactcenteraiplatform.googleapis.com/$discovery/rest?version=v1alpha1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20251211
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -102,12 +102,74 @@ declare namespace gapi.client {
|
|
|
102
102
|
/** Required. Hours during which the instance should not be updated. */
|
|
103
103
|
peakHours?: WeeklySchedule[];
|
|
104
104
|
}
|
|
105
|
+
interface Date {
|
|
106
|
+
/** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
|
|
107
|
+
day?: number;
|
|
108
|
+
/** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
|
|
109
|
+
month?: number;
|
|
110
|
+
/** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
|
|
111
|
+
year?: number;
|
|
112
|
+
}
|
|
113
|
+
interface DateList {
|
|
114
|
+
/** Optional. Values in the list. */
|
|
115
|
+
values?: Date[];
|
|
116
|
+
}
|
|
117
|
+
interface DateTime {
|
|
118
|
+
/** Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. */
|
|
119
|
+
day?: number;
|
|
120
|
+
/** Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. */
|
|
121
|
+
hours?: number;
|
|
122
|
+
/** Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. */
|
|
123
|
+
minutes?: number;
|
|
124
|
+
/** Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. */
|
|
125
|
+
month?: number;
|
|
126
|
+
/** Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. */
|
|
127
|
+
nanos?: number;
|
|
128
|
+
/** Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. */
|
|
129
|
+
seconds?: number;
|
|
130
|
+
/** Time zone. */
|
|
131
|
+
timeZone?: TimeZone;
|
|
132
|
+
/** UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. */
|
|
133
|
+
utcOffset?: string;
|
|
134
|
+
/** Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. */
|
|
135
|
+
year?: number;
|
|
136
|
+
}
|
|
105
137
|
interface Early {}
|
|
138
|
+
interface EmployeeInfo {
|
|
139
|
+
/** Required. Unique ID of this employee. */
|
|
140
|
+
id?: string;
|
|
141
|
+
/** Optional. A list of unwanted event intervals for this employee. The start time of the interval must be in the planning horizon. */
|
|
142
|
+
unwantedEventIntervals?: UnwantedEventInterval[];
|
|
143
|
+
}
|
|
106
144
|
interface Empty {}
|
|
145
|
+
interface EventTemplate {
|
|
146
|
+
/** Required. Fixed duration in minutes of this event. */
|
|
147
|
+
durationMinutes?: number;
|
|
148
|
+
/** Required. Unique ID of this template. */
|
|
149
|
+
id?: string;
|
|
150
|
+
/** Optional. Maximum number of minutes after the beginning of a shift that this event can start. */
|
|
151
|
+
maximumMinutesAfterShiftStart?: number;
|
|
152
|
+
/** Optional. Minimum number of minutes after the beginning of a shift that this event can start. */
|
|
153
|
+
minimumMinutesAfterShiftStart?: number;
|
|
154
|
+
/** Required. The time increment (in minutes) used to generate the set of possible event start times between `minimum_minutes_after_shift_start` and `maximum_minutes_after_shift_start`. For example, if the minimum minutes after shift start are 30, maximum minutes after shift start are 45, and the start time increment is 5 minutes, the event can take place 30, 35, 40, or 45 minutes after the start of the shift. */
|
|
155
|
+
startTimeIncrementMinutes?: number;
|
|
156
|
+
}
|
|
107
157
|
interface FeatureConfig {
|
|
108
158
|
/** Optional. If true - enables the agent desktop feature. Default is false. */
|
|
109
159
|
agentDesktopEnabled?: boolean;
|
|
110
160
|
}
|
|
161
|
+
interface GenerateShiftsRequest {
|
|
162
|
+
/** Optional. Employee information that should be considered when generating shifts. */
|
|
163
|
+
employeeInfo?: EmployeeInfo[];
|
|
164
|
+
/** Required. The solver will generate the maximum number of shifts per shift template. */
|
|
165
|
+
planningHorizon?: PlanningHorizon;
|
|
166
|
+
/** Required. Set of shift templates specifying rules for generating shifts. A shift template can be used for generating multiple shifts. */
|
|
167
|
+
shiftTemplates?: ShiftTemplate[];
|
|
168
|
+
/** Optional. Parameters for the solver. */
|
|
169
|
+
solverConfig?: SolverConfig;
|
|
170
|
+
/** Required. All the workforce demands that the generated shifts need to cover. The planning horizon is defined between the earliest start time and the latest end time across all the entries. This field cannot be empty. */
|
|
171
|
+
workforceDemands?: WorkforceDemandList;
|
|
172
|
+
}
|
|
111
173
|
interface GoogleCloudCommonOperationMetadata {
|
|
112
174
|
/** Output only. API version used to start the operation. */
|
|
113
175
|
apiVersion?: string;
|
|
@@ -193,6 +255,12 @@ declare namespace gapi.client {
|
|
|
193
255
|
/** Output only. Name of the verb executed by the operation. */
|
|
194
256
|
verb?: string;
|
|
195
257
|
}
|
|
258
|
+
interface PlanningHorizon {
|
|
259
|
+
/** Required. End of the time interval for the given demand (exclusive). These values are read down to the minute; seconds and all smaller units are ignored. */
|
|
260
|
+
endTime?: DateTime;
|
|
261
|
+
/** Required. Start of the time interval for the given demand (inclusive). These values are read down to the minute; seconds and all smaller units are ignored. */
|
|
262
|
+
startTime?: DateTime;
|
|
263
|
+
}
|
|
196
264
|
interface PrivateAccess {
|
|
197
265
|
/** List of egress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2. */
|
|
198
266
|
egressSettings?: Component[];
|
|
@@ -229,6 +297,38 @@ declare namespace gapi.client {
|
|
|
229
297
|
/** Email address of the first admin users. */
|
|
230
298
|
userEmail?: string;
|
|
231
299
|
}
|
|
300
|
+
interface ShiftTemplate {
|
|
301
|
+
/** Optional. A list of specific employee IDs that can be assigned to shifts generated by this template. If this field is present, there will be `EmployeeSchedule`s in the response for which the `EmployeeSchedule.employee_id` field is set to one of the IDs in this list. The number of employee schedules with an assigned employee ID will be between `minimum_employee_count` and `maximum_employee_count`. If this field is empty, between `minimum_employee_count` and `maximum_employee_count` employees can be assigned to shifts generated by this template and the employee schedules won't have an assigned employee ID. Currently, only one assignable employee ID is supported. */
|
|
302
|
+
assignableEmployeeIds?: string[];
|
|
303
|
+
/** Fixed number of days off per week. An employee has a given day off if they are not assigned to a shift that starts on that day. A week is 7 days and begins on Sunday. */
|
|
304
|
+
daysOffCountPerWeek?: number;
|
|
305
|
+
/** Fixed dates when shifts from this template should not be generated. */
|
|
306
|
+
daysOffDates?: DateList;
|
|
307
|
+
/** Required. Fixed duration of a shift generated by this template. */
|
|
308
|
+
durationMinutes?: number;
|
|
309
|
+
/** Required. Earliest time in the day that a shift can start. This value is specified with hours and minutes; seconds and nanos are ignored. */
|
|
310
|
+
earliestStartTime?: TimeOfDay;
|
|
311
|
+
/** Optional. Rules for generating events for each shift. Exactly one event will be included in each shift for each `EventTemplate` specified. */
|
|
312
|
+
eventTemplates?: EventTemplate[];
|
|
313
|
+
/** Required. Unique ID of this template. */
|
|
314
|
+
id?: string;
|
|
315
|
+
/** Required. Latest time in the day that a shift can start. This value is specified with hours and minutes; seconds and nanos are ignored. If this value is less than the `earliest_start_time`, it may imply an overnight shift. */
|
|
316
|
+
latestStartTime?: TimeOfDay;
|
|
317
|
+
/** Required. Maximum number of employees that can be assigned to all shifts generated by this template on working days. */
|
|
318
|
+
maximumEmployeeCount?: number;
|
|
319
|
+
/** Optional. Minimum number of employees that can be assigned to all shifts generated by this template on working days. */
|
|
320
|
+
minimumEmployeeCount?: number;
|
|
321
|
+
/** Optional. Minimum minutes between the end of one event and the start of the next. */
|
|
322
|
+
minimumIntereventGapMinutes?: number;
|
|
323
|
+
/** Optional. The time increment (in minutes) used to generate the set of possible start times between `earliest_start_time` and `latest_start_time`. For example, if the earliest start time is 8:00, the latest start time is 8:30, and the start time increment is 10 minutes, then all possible start times for this shift template are: 8:00, 8:10, 8:20, and 8:30. */
|
|
324
|
+
startTimeIncrementMinutes?: number;
|
|
325
|
+
}
|
|
326
|
+
interface SolverConfig {
|
|
327
|
+
/** Optional. Maximum time the solver should spend on the problem. If not set, defaults to 1 minute. The choice of a time limit should depend on the size of the problem. To give an example, when solving a 7-day instance with 2 `ShiftTemplates`, each with ~20 possible start times and holding 2 events with ~30 possible start times, and two days off per week, recommended values are: <10s for fast solutions (and likely suboptimal), (10s, 300s) for good quality solutions, and >300s for an exhaustive search. Larger instances may require longer time limits. This value is not a hard limit and it does not account for the communication overhead. The expected latency to solve the problem may slightly exceed this value. */
|
|
328
|
+
maximumProcessingDuration?: string;
|
|
329
|
+
/** Required. Specifies the type of schedule to generate. */
|
|
330
|
+
scheduleType?: string;
|
|
331
|
+
}
|
|
232
332
|
interface Status {
|
|
233
333
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
234
334
|
code?: number;
|
|
@@ -247,6 +347,18 @@ declare namespace gapi.client {
|
|
|
247
347
|
/** Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. */
|
|
248
348
|
seconds?: number;
|
|
249
349
|
}
|
|
350
|
+
interface TimeZone {
|
|
351
|
+
/** IANA Time Zone Database time zone. For example "America/New_York". */
|
|
352
|
+
id?: string;
|
|
353
|
+
/** Optional. IANA Time Zone Database version number. For example "2019a". */
|
|
354
|
+
version?: string;
|
|
355
|
+
}
|
|
356
|
+
interface UnwantedEventInterval {
|
|
357
|
+
/** Required. Duration of the event. */
|
|
358
|
+
durationMinutes?: number;
|
|
359
|
+
/** Required. Start time of the event. */
|
|
360
|
+
startTime?: DateTime;
|
|
361
|
+
}
|
|
250
362
|
interface URIs {
|
|
251
363
|
/** Chat Bot Uri of the ContactCenter */
|
|
252
364
|
chatBotUri?: string;
|
|
@@ -267,6 +379,18 @@ declare namespace gapi.client {
|
|
|
267
379
|
/** Required. Daily start time of the schedule. */
|
|
268
380
|
startTime?: TimeOfDay;
|
|
269
381
|
}
|
|
382
|
+
interface WorkforceDemand {
|
|
383
|
+
/** Optional. Number of employees needed to cover the demand for this interval. */
|
|
384
|
+
employeeCount?: number;
|
|
385
|
+
/** Required. End of the time interval for the given demand (exclusive). These values are read down to the minute; seconds and all smaller units are ignored. */
|
|
386
|
+
endTime?: DateTime;
|
|
387
|
+
/** Required. Start of the time interval for the given demand (inclusive). These values are read down to the minute; seconds and all smaller units are ignored. */
|
|
388
|
+
startTime?: DateTime;
|
|
389
|
+
}
|
|
390
|
+
interface WorkforceDemandList {
|
|
391
|
+
/** Optional. Values in the list. */
|
|
392
|
+
values?: WorkforceDemand[];
|
|
393
|
+
}
|
|
270
394
|
interface ContactCentersResource {
|
|
271
395
|
/** Creates a new ContactCenter in a given project and location. */
|
|
272
396
|
create(request: {
|
|
@@ -642,6 +766,64 @@ declare namespace gapi.client {
|
|
|
642
766
|
}): Request<ListOperationsResponse>;
|
|
643
767
|
}
|
|
644
768
|
interface LocationsResource {
|
|
769
|
+
/** Generates shifts constrained by various parameters. */
|
|
770
|
+
generateShifts(request: {
|
|
771
|
+
/** V1 error format. */
|
|
772
|
+
'$.xgafv'?: string;
|
|
773
|
+
/** OAuth access token. */
|
|
774
|
+
access_token?: string;
|
|
775
|
+
/** Data format for response. */
|
|
776
|
+
alt?: string;
|
|
777
|
+
/** JSONP */
|
|
778
|
+
callback?: string;
|
|
779
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
780
|
+
fields?: string;
|
|
781
|
+
/** 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. */
|
|
782
|
+
key?: string;
|
|
783
|
+
/** OAuth 2.0 token for the current user. */
|
|
784
|
+
oauth_token?: string;
|
|
785
|
+
/** Required. Name of the parent resource associated with the request. Format: projects/{project}/locations/{location} */
|
|
786
|
+
parent: string;
|
|
787
|
+
/** Returns response with indentations and line breaks. */
|
|
788
|
+
prettyPrint?: boolean;
|
|
789
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
790
|
+
quotaUser?: string;
|
|
791
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
792
|
+
upload_protocol?: string;
|
|
793
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
794
|
+
uploadType?: string;
|
|
795
|
+
/** Request body */
|
|
796
|
+
resource: GenerateShiftsRequest;
|
|
797
|
+
}): Request<Operation>;
|
|
798
|
+
generateShifts(
|
|
799
|
+
request: {
|
|
800
|
+
/** V1 error format. */
|
|
801
|
+
'$.xgafv'?: string;
|
|
802
|
+
/** OAuth access token. */
|
|
803
|
+
access_token?: string;
|
|
804
|
+
/** Data format for response. */
|
|
805
|
+
alt?: string;
|
|
806
|
+
/** JSONP */
|
|
807
|
+
callback?: string;
|
|
808
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
809
|
+
fields?: string;
|
|
810
|
+
/** 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. */
|
|
811
|
+
key?: string;
|
|
812
|
+
/** OAuth 2.0 token for the current user. */
|
|
813
|
+
oauth_token?: string;
|
|
814
|
+
/** Required. Name of the parent resource associated with the request. Format: projects/{project}/locations/{location} */
|
|
815
|
+
parent: string;
|
|
816
|
+
/** Returns response with indentations and line breaks. */
|
|
817
|
+
prettyPrint?: boolean;
|
|
818
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
819
|
+
quotaUser?: string;
|
|
820
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
821
|
+
upload_protocol?: string;
|
|
822
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
823
|
+
uploadType?: string;
|
|
824
|
+
},
|
|
825
|
+
body: GenerateShiftsRequest,
|
|
826
|
+
): Request<Operation>;
|
|
645
827
|
/** Gets information about a location. */
|
|
646
828
|
get(request?: {
|
|
647
829
|
/** V1 error format. */
|
package/package.json
CHANGED